GET /Invoices

Servers

Request headers

Name Type Required Description
If-Modified-Since String No

Only records created or modified since this timestamp will be returned

xero-tenant-id String Yes

Xero identifier for Tenant

Query parameters

Name Type Required Description
where String No

Filter by an any element

Statuses[] Array No

Filter by a comma-separated list Statuses. For faster response times we recommend using these explicit parameters instead of passing OR conditions into the Where filter.

unitdp Integer No

e.g. unitdp=4 – (Unit Decimal Places) You can opt in to use four decimal places for unit amounts

summaryOnly Boolean No

Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.

Default value: false

createdByMyApp Boolean No

When set to true you'll only retrieve Invoices created by your app

ContactIDs[] Array No

Filter by a comma-separated list of ContactIDs.

IDs[] Array No

Filter by a comma-separated list of InvoicesIDs.

InvoiceNumbers[] Array No

Filter by a comma-separated list of InvoiceNumbers.

searchTerm String No

Search parameter that performs a case-insensitive text search across the fields e.g. InvoiceNumber, Reference.

page Integer No

e.g. page=1 – Up to 100 invoices will be returned in a single API call with line items shown for each invoice

order String No

Order by an any element

includeArchived Boolean No

e.g. includeArchived=true - Invoices with a status of ARCHIVED will be included in the response

pageSize Integer No

Number of records to retrieve per page

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.