v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01235140905.8 KB
Accounting

Retrieves sales invoices or purchase bills

get/Invoices

Query parameters

wherestring

Filter by an any element

orderstring

Order by an any element

IDsstring[]

Filter by a comma-separated list of InvoicesIDs.

InvoiceNumbersstring[]

Filter by a comma-separated list of InvoiceNumbers.

ContactIDsstring[]

Filter by a comma-separated list of ContactIDs.

Statusesstring[]

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.

pageinteger

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

includeArchivedboolean

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

createdByMyAppboolean

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

unitdpinteger

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

summaryOnlyboolean

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.

pageSizeinteger

Number of records to retrieve per page

searchTermstring

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

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

Success - return response of type Invoices array with all Invoices