Xero

Use the Xero Node to run Xero Accounting API operations in a Workflow.

Revision History

0.0.0.1 - Initial release.

Connection

The Xero Connection stores the OAuth settings, tokens, and tenant selection used for Xero Accounting API requests.

Property Type Description
Xero Tenant ID String Store the tenantId value for the Xero organisation you want to query.
Client ID String Store the OAuth client identifier from your Xero app registration.
Client Secret Masked Store the OAuth client secret from your Xero app registration.
Scopes String Store the space-delimited Xero scopes requested during authorization.
Access Token Masked Store the OAuth access token used for Xero API requests.
Refresh Token Masked Store the OAuth refresh token used to renew the access token.
List Of Tenants String Store the raw tenant list returned by Xero when you run Refresh Metadata.

Setup Notes

Create a Xero Connection before you use this Node in a Workflow.

Use a Xero OAuth app registration and enter the Client ID and Client Secret on the Connection.

Connect the account so Flowgear can generate the Access Token and Refresh Token used for runtime execution.

Run Refresh Metadata after the account is connected to populate List Of Tenants. Use that result to choose the correct Xero Tenant ID.

If the connected account has access to only one Xero organisation, Flowgear can select that tenantId automatically during Refresh Metadata.

If you leave Scopes blank, the Node uses its default Xero scope set.

When you test the Connection, Flowgear verifies that the selected tenant can access the Xero Accounting API.

Methods

The Xero Node exposes four methods. These methods use templates generated from the embedded Xero OpenAPI document and only allow operations that match the selected HTTP verb.

Get

Use Get when you want to execute a Xero Accounting API GET operation from the selected template.

Parameter Type Description
Connection Connection Choose the Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Supply the path and query parameters required by the selected Xero operation.
Return Type Description
Response Array Returns the normalized output rows from the selected GET operation.

Post

Use Post when you want to execute a Xero Accounting API POST operation from the selected template.

Parameter Type Description
Connection Connection Choose the Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Supply the path and query parameters required by the selected Xero operation.
Items Array Supply the JSON request body for the selected Xero operation.
Return Type Description
Response Array Returns the normalized output rows from the selected POST operation.

Put

Use Put when you want to execute a Xero Accounting API PUT operation from the selected template.

Parameter Type Description
Connection Connection Choose the Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Supply the path and query parameters required by the selected Xero operation.
Items Array Supply the JSON request body for the selected Xero operation.
Return Type Description
Response Array Returns the normalized output rows from the selected PUT operation.

Delete

Use Delete when you want to execute a Xero Accounting API DELETE operation from the selected template.

Parameter Type Description
Connection Connection Choose the Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Supply the path and query parameters required by the selected Xero operation.
Return Type Description
Response Array Returns the normalized output rows from the selected DELETE operation.

Usage Notes

Select a method template instead of entering raw endpoint details manually.

Flowgear manages paging for Get operations, so template options do not expose page or pageSize.

Flowgear normalizes Xero response envelopes so your Workflow receives business rows instead of raw transport wrappers where possible.

All method outputs include the standard Flowgear fields status, statusMessage, and errorMessage.

Xero validation and provider errors are surfaced in the returned rows so your Workflow can handle partial or item-level failures.

Known Issues

When the connected account has access to more than one Xero organisation, you must choose the correct tenantId manually from List Of Tenants.