<- Invoices API

Invoices API

All versions ->

List invoices

GET

 /v2/invoices

Returns a list of invoices for a given location.

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

List invoices

Try in API Explorer
Link to section

Query parameters

Example code

Link to section

location_id

string

Required

The ID of the location for which to list 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

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

Response fields

Link to section

invoices

The invoices retrieved.

Link to section

cursor

string

When a response is truncated, it includes a cursor that you can use in a subsequent request to retrieve 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.