Retrieve Invoices

get

https://api.test.payadvantage.com.au/v3/invoices

Manage merchant invoices. Invoices allows for line items. Invoices status lifecycle is: (Draft → Sent → Paid / Cancelled). You can also connect an invoice to any payment.

Returns a paged list of invoices for the merchant. Supports filtering by status, customer, date issued, date due, and amount.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 0

Defaults to 0

Responses are paged to return a limited amount of records. This parameter is used to retrieve a specific page number.

per_page

integer

0 to 1000

Defaults to 100

The number of records per page to retrieve.

sort

array of strings

A comma seperated list of fields to sort by. Fields prefixed with a "-" will sort in descending order.
The fields include: dateissued,-dateissued,datedue,-datedue

sort

Allowed:

status

array of strings

Filter by invoice status. Comma-separated list of: draft, approved, paid, cancelled.

status

code

string

length between 6 and 6

Filter by invoice code (exact match, 6 chars).

number

string

length between 1 and 50

Filter by invoice number (partial match).

customer.code

string

length between 6 and 6

Filter by customer code.

customer.name

string

length between 1 and 100

Filter by customer name (partial match).

dateupdated

date-time

length between 8 and 33

^(\d\d\d\d\-\d\d\-\d\dT\d\d:\d\d(:\d\d(\.\d{1,7})?(Z|([+\-]\d\d:\d\d))?)?)$|^\d{8}$

Filter by last-updated date. Use dateupdatedfrom and dateupdatedto for a range.

dateupdatedfrom

date-time

length between 8 and 33

^(\d\d\d\d\-\d\d\-\d\dT\d\d:\d\d(:\d\d(\.\d{1,7})?(Z|([+\-]\d\d:\d\d))?)?)$|^\d{8}$

Filter by last-updated date. Use dateupdatedfrom and dateupdatedto for a range.

dateupdatedto

date-time

length between 8 and 33

^(\d\d\d\d\-\d\d\-\d\dT\d\d:\d\d(:\d\d(\.\d{1,7})?(Z|([+\-]\d\d:\d\d))?)?)$|^\d{8}$

Filter by last-updated date. Use dateupdatedfrom and dateupdatedto for a range.

dateissued

date

length between 8 and 10