Global API
...
Request
Invoice

Read

1min

You can read all the Invoices from Xero without passing any filters. However, to retrieve specific records based on any filter conditions, you can add the following filters as "queryParameters" as shown in the below example.

Param Name

Type

Description

order

String

Order by any element returned

page

String

Up to 100 invoices will be returned per call, with line items shown for each, when the page parameter is used. e.g. page=1

includeArchived

Boolean

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

IDs

String

Filter by a comma-separated list of InvoicesIDs

ContactIDs

String

Filter by a comma-separated list of ContactIDs

Statuses

String

Filter by a comma-separated list of Statuses

InvoiceNumbers

String

Filter by a comma-separated list of InvoiceNumbers

where

String

Filter using the where parameter. We recommend you limit filtering to the optimised elements only.



Request
Response




Updated 03 Mar 2023
Did this page help you?