Xero v2

Xero is an online accounting platform used to manage organizations, contacts, invoices, payments, and other finance records through the Xero Accounting API.

The Flowgear Xero Node lets you run template-driven Xero Accounting API operations in a Workflow by using an OAuth Connection, a selected tenant, and action-based methods generated from the embedded OpenAPI document.

Revision History

0.0.0.1 - Initial release.
0.0.0.8 - Maintenance release.
0.0.0.9 - Get rows now return Xero data unchanged, and mutation rows include a top-level Flowgear object.
0.0.0.10 - Renamed the methods to Query, Create, Update, and Delete.
0.1.0.0 - Runtime overhaul.
0.1.1.0 - Query now retrieves the first page before returning and loads later pages as the Workflow consumes rows.
0.1.1.1 - Designer templates now retain inherited fields when OpenAPI schemas use constraints-only allOf overlays.
0.1.1.3 - Maintenance 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 tenantId value for the Xero organization you want to query.
Client ID String OAuth client identifier from your Xero app registration.
Client Secret Masked OAuth client secret from your Xero app registration.
Scopes String Space-delimited Xero scopes requested during authorization.
Access Token Masked OAuth access token used for Xero API requests.
Refresh Token Masked OAuth refresh token used to renew the access token.
List Of Tenants String 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 organization, Flowgear can select that tenantId automatically during Refresh Metadata.
  • If you leave Scopes blank, the Node uses its default Xero scope set: offline_access accounting.transactions accounting.reports.read accounting.journals.read accounting.settings accounting.contacts accounting.attachments.
  • 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 HTTP method assigned to the selected action surface.

Query

Executes a Xero Accounting API query operation from the selected template. This method only allows Xero GET operations.

Parameter Type Description
Connection Connection Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Path and query parameters required by the selected Xero operation.
Return Type Description
Response Array Xero data rows from the selected query operation. Query rows do not include the Flowgear object.

Create

Executes a Xero Accounting API create operation from the selected template. This method only allows Xero POST operations.

Parameter Type Description
Connection Connection Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Path and query parameters required by the selected Xero operation.
Items Array JSON request body for the selected Xero operation.
Return Type Description
Response Array Output rows from the selected create operation. Mutation rows append a top-level Flowgear object with IsSuccess, Message, and Request.

Update

Executes a Xero Accounting API update operation from the selected template. This method only allows Xero PUT operations.

Parameter Type Description
Connection Connection Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Path and query parameters required by the selected Xero operation.
Items Array JSON request body for the selected Xero operation.
Return Type Description
Response Array Output rows from the selected update operation. Mutation rows append a top-level Flowgear object with IsSuccess, Message, and Request.

Delete

Executes a Xero Accounting API DELETE operation from the selected template.

Parameter Type Description
Connection Connection Xero Connection to use for the request.
OperationId String Identifies the Xero operation selected by the template.
Options Object Path and query parameters required by the selected Xero operation.
Return Type Description
Response Array Output rows from the selected DELETE operation. Mutation rows append a top-level Flowgear object with IsSuccess, Message, and Request.

Usage Notes

  • Select a method template instead of entering raw endpoint details manually.
  • Flowgear manages paging for Query 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.
  • Query returns zero rows when Xero returns no matching records.
  • Query surfaces failures on the first provider call as errors instead of converting them into result rows.
  • Create, Update, and Delete append a top-level Flowgear object. Flowgear.Request contains only the values passed into the request.
  • Create and Update send the first input item before returning and process later items as the Workflow consumes rows.
  • Xero validation and provider errors on mutation-style methods 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 organization, you must choose the correct tenantId manually from List Of Tenants.