Xero

항목, 작업, 조치

모든 Integration Connectors는 연결된 애플리케이션의 객체에 대한 추상화 레이어를 제공합니다. 이 추상화를 통해서만 애플리케이션의 객체에 액세스할 수 있습니다. 추상화는 항목, 작업, 조치로 노출됩니다.

• 항목: 연결된 애플리케이션 또는 서비스에서 항목은 객체 또는 속성 모음으로 간주될 수 있습니다. 항목의 정의는 커넥터마다 다릅니다. 예를 들어 데이터베이스 커넥터에서는 테이블이 항목이고, 파일 서버 커넥터에서는 폴더가 항목이며 메시징 시스템 커넥터에서는 큐가 항목입니다.

  그러나 커넥터가 항목을 지원하지 않거나 항목을 포함하지 않을 수 있으며, 이 경우 Entities 목록이 비어 있습니다.

• 작업: 작업은 항목에 대해 수행할 수 있는 활동입니다. 항목에서 다음 작업을 수행할 수 있습니다.
  • 목록
  • 가져오기
  • 만들기
  • 업데이트
  • 삭제

  사용 가능한 목록에서 항목을 선택하면 항목에 사용 가능한 작업 목록이 생성됩니다. 작업에 대한 자세한 설명은 커넥터 태스크의 항목 작업을 참조하세요. 그러나 커넥터가 항목 작업을 지원하지 않으면 이렇게 지원되지 않는 작업은 Operations 목록에 나열되지 않습니다.

• 조치: 커넥터 인터페이스를 통해 통합에 제공되는 첫 번째 클래스 함수입니다. 조치를 사용하면 항목을 변경할 수 있습니다. 조치는 커넥터마다 다릅니다. 일반적으로 조치에는 입력 매개변수와 출력 매개변수가 있습니다. 하지만 커넥터가 조치를 지원하지 않을 수 있으며 이 경우 Actions 목록이 비어 있습니다.

시스템 제한사항

Xero 커넥터는 노드별로 초당 트랜잭션 5개를 처리할 수 있으며 이 한도를 초과하는 트랜잭션을 제한합니다. 그러나 Xero 커넥터가 처리할 수 있는 트랜잭션 수는 Xero 인스턴스에서 적용하는 제약 조건에 따라 달라집니다. 자세한 내용은 Xero API 비율 한도를 참조하세요. 기본적으로 Integration Connectors는 가용성을 높이기 위해 연결에 2개의 노드를 할당합니다.

Integration Connectors에 적용되는 한도에 대한 자세한 내용은 한도를 참조하세요.

작업

이 섹션에는 커넥터가 지원하는 작업 중 일부가 나와 있습니다. 작업을 구성하는 방법은 작업 예시를 참조하세요.

DownloadAttachment 작업

이 작업을 수행하면 연결을 다운로드합니다.

DownloadAttachment 작업의 입력 매개변수

DownloadAttachment 작업의 출력 매개변수

이 작업은 다운로드가 성공하면 상태 200(OK)을 반환합니다.

DownloadAttachment 작업을 구성하는 방법은 작업 예시를 참조하세요.

UploadAttachment 작업

이 작업을 수행하면 연결을 업로드할 수 있습니다.

UploadAttachment 작업의 입력 매개변수

UploadAttachment 작업의 출력 매개변수

이 작업은 객체 업로드가 성공하면 상태 200(OK)을 반환합니다.

UploadAttachment 작업을 구성하는 방법은 작업 예시를 참조하세요.

ListAttachment 작업

이 작업을 수행하면 테이블의 모든 첨부파일을 나열할 수 있습니다.

ListAttachment 작업의 입력 매개변수

ListAttachment 작업의 출력 매개변수

이 작업은 삭제가 성공하면 상태 200(OK)을 반환합니다.

ListAttachment 작업을 구성하는 방법은 작업 예시를 참조하세요.

SendInvoiceMail 작업

이 작업을 수행하면 인보이스를 보낸 사람에게 이메일을 보낼 수 있습니다.

SendInvoiceMail 작업의 입력 매개변수

SendInvoiceMail 작업의 출력 매개변수

이 작업은 이동 작업이 성공하면 상태 200(OK)을 반환합니다.

SendInvoiceMail 작업을 구성하는 방법은 작업 예시를 참조하세요.

UploadFile 작업

이 작업을 수행하면 파일을 업로드할 수 있습니다.

UploadFile 작업의 입력 매개변수

UploadFile 작업의 출력 파라미터

이 작업은 객체 업로드가 성공하면 상태 200(OK)을 반환합니다.

UploadFile 작업을 구성하는 방법은 작업 예시를 참조하세요.

작업 예시

이 섹션에서는 이 커넥터에서 일부 작업을 수행하는 방법을 설명합니다.

예시 - 연결 다운로드

이 예시에서는 연결을 다운로드합니다.

1. Configure connector task 대화상자에서 Actions를 클릭합니다.
2. DownloadAttachment 조치를 선택한 다음 완료를 클릭합니다.
3. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

   {
   "Filename": "Xero_Test.txt",
   "Table": "Contacts",
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41"
   }

작업이 성공하면 DownloadAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "True",
"Content": "Test content"
}]

예시 - 연결 업로드

이 예시에서는 연결을 업로드합니다.

1. Configure connector task 대화상자에서 Actions를 클릭합니다.
2. UploadAttachment 조치를 선택한 다음 완료를 클릭합니다.
3. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

   {
   "Filename": "Xero_Test.txt",
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
   "ContentType": "txt",
   "Table": "Contacts",
   "Content": "Test content upload attachment"
   }

작업이 성공하면 UploadAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": null,
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Test.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27",
"IncludeOnline": null,
"_": ""
}, {
"Success": null,
"AttachmentId": null,
"FileName": null,
"URL": null,
"MimeType": null,
"ContentLength": null,
"IncludeOnline": null,
"_": null
}]

예시 - 연결 나열

이 예시에서는 지정된 테이블의 첨부파일을 나열합니다.

1. Configure connector task 대화상자에서 Actions를 클릭합니다.
2. ListAttachment 조치를 선택한 다음 완료를 클릭합니다.
3. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

   {
   "ObjectId": "6a92a3ab-87cf-4f2f-8beb-ecb4f8ae4d41",
   "Table": "Contacts"
   }

작업이 성공하면 ListAttachment 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"AttachmentId": "5ba982a6-9294-45a7-bdda-5f134b0d69d5",
"FileName": "Xero_Limit_Testing.txt",
"URL": "https://api.xero.com/api.xro/2.0/Contacts/6a92a3ab-87cf-4f2f-8bwb-fcb4f8ae4d41/Attachments/Xero_Test.txt",
"MimeType": "text/plain",
"ContentLength": "27"
}]

예시 - 인보이스 이메일 전송

이 예시에서는 지정된 인보이스에 대한 이메일을 보냅니다.

1. Configure connector task 대화상자에서 Actions를 클릭합니다.
2. SendInvoiceMail 조치를 선택한 다음 완료를 클릭합니다.
3. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

   {
   "InvoiceId": "016a64c7-be0b-45a2-acae-13057fdf1566"
   }

작업이 성공하면 SendInvoiceMail 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "true"
}]

예시 - 파일 업로드

이 예시에서는 파일을 업로드합니다.

1. Configure connector task 대화상자에서 Actions를 클릭합니다.
2. UploadFile 조치를 선택한 다음 완료를 클릭합니다.
3. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

   {
   "Name": "Sample1.txt",
   "Content": "This is a sample file"
   }

작업이 성공하면 UploadFile 태스크의 connectorOutputPayload 응답 매개변수가 다음과 비슷한 값을 갖습니다.

[{
"Success": "true",
"FileId": "09039c7b-35a2-473d-aa79-16fe00b8d460",
"Name": "Sample1.txt",
"FolderId": "36e5115d-a9b6-4c22-baf3-40a8b28ee71d",
"MimeType": "text/plain",
"Size": 26.0,
"User_Id": "c1e33cc9-eb61-45cb-9e46-3ea4121cbdc6",
"User_Name": "test_user_1@test.com",
"User_FirstName": "John",
"User_LastName": "Smith",
"User_FullName": "John Smith",
"Created": "2023-12-18 17:38:53.01",
"Updated": "2023-12-18 17:38:53.01"
}]

항목 작업 예시

이 섹션에서는 이 커넥터에서 일부 항목 작업을 수행하는 방법을 보여줍니다.

예시 - 모든 레코드 나열

이 예시에서는 Accounts 항목의 모든 레코드를 나열합니다.

1. Configure connector task 대화상자에서 Entities를 클릭합니다.
2. Entity 목록에서 Accounts를 선택합니다.
3. List 작업을 선택한 후 완료를 클릭합니다.
4. 원하는 경우 커넥터 태스크의 태스크 입력 섹션에서 필터 절을 지정하여 결과 집합을 필터링할 수 있습니다. 예를 들면 City='Bangalore'입니다. 논리 연산자를 사용하여 필터 조건을 여러 개 지정할 수도 있습니다. 예를 들면 City='Bangalore' and region='asia-south2'입니다.

예시 - 인보이스 가져오기

이 예시에서는 Invoices 항목에서 지정된 ID가 있는 인보이스를 가져옵니다.

1. Configure connector task 대화상자에서 Entities를 클릭합니다.
2. Entity 목록에서 Invoices를 선택합니다.
3. Get 작업을 선택한 후 완료를 클릭합니다.
4. 커넥터 태스크의 태스크 입력 섹션에서 EntityId를 클릭한 후 기본값 필드에 1|016a64c7-be0b-45a2-acae-13057fdf1566을 입력합니다.

   여기서 1|016a64c7-be0b-45a2-acae-13057fdf1566는 Invoices 항목의 기본 키 값입니다.

예시 - 인보이스 만들기

이 예시에서는 Invoices 항목에 인보이스를 만듭니다.

1. Configure connector task 대화상자에서 Entities를 클릭합니다.
2. Entity 목록에서 Invoices를 선택합니다.
3. Create 작업을 선택한 후 완료를 클릭합니다.
4. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

   {
   "Type": "ACCPAY",
   "ContactName": "ContactName1",
   "LineItem_Description": "LineItemDescription"
   }

   통합이 완료되면 커넥터 태스크의 connectorOutputPayload 필드에 다음과 유사한 값이 포함됩니다.

   {
   "Id": "1|7b29efe9-dacd-47bb-85a6-0c0640ce25de"
   }

예시 - 레코드 업데이트

이 예시에서는 AssetTypes 항목의 레코드를 업데이트합니다.

1. Configure connector task 대화상자에서 Entities를 클릭합니다.
2. Entity 목록에서 AssetTypes를 선택합니다.
3. Update 작업을 선택한 후 완료를 클릭합니다.
4. 커넥터 태스크의 태스크 입력 섹션에서 connectorInputPayload를 클릭한 후 Default Value 필드에 다음과 유사한 값을 입력합니다.

   {
   "BookDepreciationSetting_DepreciationRate": 10.0
   }

5. entityId를 클릭한 후 기본값 필드에 f8d43548-25b0-4cc3-8f59-d97106974fe8을 입력합니다.

   통합이 성공하면 커넥터 태스크의 connectorOutputPayload 필드에 다음과 유사한 값이 포함됩니다.

   {
   "AssetTypeId": "f8d43548-25b0-4cc3-8f59-d97106974fe8"
   }

예시 - 파일 삭제

이 예시에서는 Files 항목에서 지정된 ID가 있는 파일을 삭제합니다.

1. Configure connector task 대화상자에서 Entities를 클릭합니다.
2. Entity 목록에서 Files를 선택합니다.
3. Delete 작업을 선택한 후 완료를 클릭합니다.
4. 커넥터 태스크의 태스크 입력 섹션에서 entityId를 클릭한 후 기본값 필드에 421c82f0-38fb-4074-a679-63b04c0d8832을 입력합니다.