List AR invoices

get

https://api.smoothpos.net/arinvoices.json

Returns your accounts receivable invoices, 50 at a time by default, with their lines and payments. Page through them with the X-Next-Page header.

Note: the invoice's counterparty comes back in fields named supplier/supplier_id.

See Filtering, sorting and search for how the filters, ranges and sort work.

Required permission (any one of these):

Group	Permission
Finance	List and view ar invoices
Finance	Create, edit and delete ar invoices (includes view)

Query Params

limit

integer

1 to 250

Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

cursor

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

since_id

integer

Only return invoices with an ID greater than or equal to this one. Note that this one is inclusive: the record with this ID is returned too.

invoice_number

string

Partial match on invoice_number.

supplier_ids

string

Comma-separated list matched against supplier_id.

created_min

date-time

Greater than (not including) the created.

created_max

date-time

Less than (not including) the created.

due_min

date-time

Greater than (not including) the due_date.

due_max

date-time

Less than (not including) the due_date.

invoice_date_min

date-time

Greater than (not including) the invoice_date.

invoice_date_max

date-time

Less than (not including) the invoice_date.

supplier_id

string

^\d+(,\d+)*$

Matches one supplier ID or a comma-separated list (up to 200). supplier works as an alias.

journal_id

string

^\d+(,\d+)*$

Matches one journal id or a comma-separated list (up to 200).

invoice_date_from

string

From this invoice date. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

invoice_date_to

string

Up to this invoice date. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

due_date_from

string

From this due date. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

due_date_to

string

Up to this due date. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_from

string

From this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_to

string

Up to this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_from

string

From this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_to

string

Up to this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

string

Text search: matches records where any of invoice_number contains this text (up to 200 characters).

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, created, updated, duedate, invoicedate, invoicenumber. The older sort_field=key&sort=asc|desc style still works.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success.

404Not found. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: not authorised