Sign in

v1

latestOpenAPI 3.0.42026-07-2286621993.2 KB
search-invoices

Search for invoices

Searches for and lists invoices that match search criteria. If you pass multiple criteria, the response lists invoices that match all criteria.

post/v2/invoicing/search-invoices

Query parameters

pageinteger

The zero-relative start index of the entire list of items that are returned in the response. So, the combination of page=1 and page_size=20 returns the first 20 items.

page_sizeinteger

The number of webhook event notifications to return in the response.

total_requiredboolean

Indicates whether the to show <code>total_pages</code> and <code>total_items</code> in the response.

Request body

recipient_emailstring

Filters the search by the email address.

recipient_first_namestring

Filters the search by the recipient first name.

recipient_last_namestring

Filters the search by the recipient last name.

recipient_business_namestring

Filters the search by the recipient business name.

invoice_numberstring

Filters the search by the invoice number.

statusInvoiceStatus[]

An array of status values.

referencestring

The reference data. Includes a Purchase Order (PO) number.

currency_codestring ppaas_common_currency_code_v2

The three-character ISO-4217 currency code that identifies the currency.

memostring

A private bookkeeping memo for the user.

archivedboolean

Indicates whether to list merchant-archived invoices in the response. Value is:<ul><li><code>true</code>. Response lists only merchant-archived invoices.</li><li><code>false</code>. Response lists only unarchived invoices.</li><li><code>null</code>. Response lists all invoices.</li></ul>

fieldsFields[]

A CSV file of fields to return for the user, if available. Because the invoice object can be very large, field filtering is required. Valid collection fields are <code>items</code>, <code>payments</code>, <code>refunds</code>, <code>additional_recipients_info</code>, and <code>attachments</code>.

Response

A successful request returns the HTTP 200 OK status code and a JSON response body that lists the invoices that match the search criteria.

total_pagesinteger

The total number of pages that are available for the search criteria. <blockquote><strong>Note:</strong> Clients MUST NOT assume that the value of total_pages is constant. The value MAY change from one request to the next</blockquote>

total_itemsinteger

The total number of invoices that match the search criteria.<blockquote><strong>Note:</strong> Clients MUST NOT assume that the value of <code>total_items</code> is constant. The value MAY change from one request to the next.</blockquote>