PApax8
Invoices

List Invoices

Fetch a paginated list of invoices. Default page is 0 and default size is 10. The maximum page size is 200

get/invoices

Request

  • Base URL
    https://api.pax8.com/v1
  • URL
    https://api.pax8.com/v1/invoices
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://token-manager.pax8.com/oauth/token

Query parameters

pagenumber

The page number to request in the invoices list

sizenumber

Returns this number of invoices per page

sort'invoiceDate' | 'dueDate' | 'status' | 'partnerName' | 'total' | 'balance' | 'carriedBalance'

Return invoices sorted by this field and direction Formatted as fieldName,direction - ex. sort=invoiceDate,desc

status'Unpaid' | 'Paid' | 'Void' | 'Carried' | 'Nothing Due' | 'Credited'

Return only invoices matching this status value

invoiceDatestring yyyy-MM-dd
Example:2000-10-31

Return only invoices matching this invoiceDate value

invoiceDateRangeStartstring yyyy-MM-dd
Example:2000-10-31

Return only invoices with an invoiceDate greater than or equal to this date

invoiceDateRangeEndstring yyyy-MM-dd
Example:2001-10-31

Return only invoices with an invoiceDate less than or equal to this date

dueDatestring yyyy-MM-dd
Example:2000-10-31

Return only invoices matching this dueDate value

totalnumber

Return only invoices matching this total value

balancenumber

Return only invoices matching this balance value

carriedBalancenumber

Return only invoices matching this carriedBalance value

companyIdstring uuid
Example:f7fc273a-8d86-45c9-a26f-ffd42416adda

Return only invoices matching this companyId value

Response

Successful operation

Example response

{
  "page": {
    "size": 50,
    "totalElements": 237,
    "totalPages": 5,
    "number": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.