List pro-forma invoices

Returns one page of pro-forma invoices whose invoice status is active.

GET /proforma_invoices

cURL

cURL

curl -X GET "$EXSITED_BASE_URL/api/v4/proforma_invoices?limit=20" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Lists pro-forma invoices one page at a time, under data, paged by cursor. Only pro-forma invoices whose invoice status is active are listed. To filter, add filter_<field>=<value>, or filter_<field>_<operator>=<value> with an operator such as gte or contains.

The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set host to your Exsited API host name and paste an access token from Get an access token.

Authorizations

Authorization · string · header · required

An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.

Query Parameters

limit · integer

The most records to return on one page.

Example:

20

cursor · string

The next_cursor value from the previous page, to fetch the page after it.

sort · string

The field to sort by. Put - in front for descending order, such as -created_on.

Example:

"-created_on"

Response

200

One page of pro-forma invoices, under data, with pagination.