Get Invoice
xero.get_invoice
ActionCRM & salesconnection required
Calls the Xero API with the connection's credentials.
Fetch one invoice, with its line items, by Xero invoice id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Xero
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- tenant_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
invoice_id The Xero InvoiceID (a GUID) of the invoice to fetch. | string | Yes | — | — | — |
tenant_id Xero organisation (tenant) id for this call; overrides the connection's. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
invoice The invoice as Xero returned it, in PascalCase. | object | — |
invoice_id The Xero identifier of the invoice. | string | — |
validation_errors Messages Xero attached to the record; empty when it was accepted. | array | — |
{
"invoice": {},
"invoice_id": "",
"validation_errors": []
}See Get Invoice run in a workflow.
In a technical demo we add the Xero connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.