Xero

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

• Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.

  However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.

• Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
  • List
  • Get
  • Create
  • Update
  • Delete

  Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.

• Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. Normally, an action will have some input parameters, and an output parameter. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

System limitations

The Xero connector can process 5 transaction per second, per node, and throttles any transactions beyond this limit. However, the number transactions that the Xero connector can process also depends on the constraints imposed by the Xero instance. For more information, see Xero API rate limits. By default, Integration Connectors allocates 2 nodes (for better availability) for a connection.

For information on the limits applicable to Integration Connectors, see Limits.

Actions

This section lists some of the actions supported by the connector. To understand how to configure the actions, see Action examples.

DownloadAttachment action

This action downloads an attachment.

Input parameters of the DownloadAttachment action

Output parameters of the DownloadAttachment action

This action returns the status 200 (OK) if the download is successful.

To understand how to configure the DownloadAttachment action, see Action examples.

UploadAttachment action

This action lets you upload an attachment.

Input parameters of the UploadAttachment action

Output parameters of the UploadAttachment action

This action returns the status 200 (OK) if the object upload is successful.

To understand how to configure the UploadAttachment action, see Action examples.

ListAttachment Action

This action lets you list all the attachments of a table.

Input parameters of the ListAttachment action

Output parameters of the ListAttachment action

This action returns the status 200 (OK) if the deletion is successful.

To understand how to configure the ListAttachment action, see Action examples.

SendInvoiceMail action

This action let you send emails to an invoicer.

Input parameters of the SendInvoiceMail action

Output parameters of the SendInvoiceMail action

This action returns the status 200 (OK) if the move operation is successful.

To understand how to configure the SendInvoiceMail action, see Action examples.

UploadFile action

This action lets you upload a file.

Input parameters of the UploadFile action

Output parameters of the UploadFile action

This action returns the status 200 (OK) if the object upload is successful.

To understand how to configure the UploadFile action, see Action examples.

Action examples

This section describes how to perform some of the actions in this connector.

Example - Download an attachment

This example downloads an attachment.

1. In the Configure connector task dialog, click Actions.
2. Select the DownloadAttachment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the DownloadAttachment task's connectorOutputPayload response parameter will have a value similar to the following:

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

Example - Upload an attachment

This example uploads an attachment.

1. In the Configure connector task dialog, click Actions.
2. Select the UploadAttachment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the UploadAttachment task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"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
}]

Example - List attachments

This example lists the attachments of the specified table.

1. In the Configure connector task dialog, click Actions.
2. Select the ListAttachment action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the ListAttachment task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"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"
}]

Example - Send an invoice email

This example sends an email for the specified invoice.

1. In the Configure connector task dialog, click Actions.
2. Select the SendInvoiceMail action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the SendInvoiceMail task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"Success": "true"
}]

Example - Upload a file

This example uploads a file.

1. In the Configure connector task dialog, click Actions.
2. Select the UploadFile action, and then click Done.
3. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

If the action is successful, the UploadFile task's connectorOutputPayload response parameter will have a value similar to the following:

[{
"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": "[email protected]",
"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"
}]

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all records

This example lists all the records in the Accounts entity.

1. In the Configure connector task dialog, click Entities.
2. Select Accounts from the Entity list.
3. Select the List operation, and then click Done.
4. Optionally, in Task Input section of the Connectors task, you can filter your result set by specifying a filter clause. For example, City='Bangalore'. You can also specify multiple filter conditions by using the logic operators. For example, City='Bangalore' and region='asia-south2'.

Example - Get an invoice

This example gets an invoice with the specified ID from the Invoices entity.

1. In the Configure connector task dialog, click Entities.
2. Select Invoices from the Entity list.
3. Select the Get operation, and then click Done.
4. In the Task Input section of the Connectors task, click EntityId and then enter 1|016a64c7-be0b-45a2-acae-13057fdf1566 in the Default Value field.

   Here, 1|016a64c7-be0b-45a2-acae-13057fdf1566 is a primary key value in the Invoices entity.

Example - Create an invoice

This example creates an invoice in the Invoices entity.

1. In the Configure connector task dialog, click Entities.
2. Select Invoices from the Entity list.
3. Select the Create operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

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

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

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

Example - Update a record

This example updates a record in the AssetTypes entity.

1. In the Configure connector task dialog, click Entities.
2. Select AssetTypes from the Entity list.
3. Select the Update operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
   "BookDepreciationSetting_DepreciationRate": 10.0
   }

5. Click entityId, and then enter f8d43548-25b0-4cc3-8f59-d97106974fe8 in the Default Value field.

   If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:

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

Example - Delete a file

This example deletes the file with the specified ID from the Files entity.

1. In the Configure connector task dialog, click Entities.
2. Select Files from the Entity list.
3. Select the Delete operation, and then click Done.
4. In the Task Input section of the Connectors task, click entityId and then enter 421c82f0-38fb-4074-a679-63b04c0d8832 in the Default Value field.