<- Invoices API

Invoices API

All versions ->

Search invoices

POST

 /v2/invoices/search

Searches for invoices from a location specified in the filter.

You can optionally specify customers in the filter for whom to retrieve invoices. In the current implementation, you can only specify one location and optionally one customer.

The response is paginated. If truncated, the response includes a cursor that you use in a subsequent request to retrieve the next set of invoices.

Permissions:INVOICES_READ

Guide

Search invoices

Try in API Explorer
Link to section

Request body

Example code

Link to section

query

Required

Describes the query criteria for searching invoices.

Link to section

limit

integer(32-bit)

The maximum number of invoices to return (200 is the maximum limit). If not provided, the server uses a default limit of 100 invoices.

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query.

For more information, see Pagination.

Link to section

Response fields

Link to section

invoices

The list of invoices returned by the search.

Link to section

cursor

string

When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of invoices. If empty, this is the final response. For more information, see Pagination.

Link to section

errors

Information about errors encountered during the request.