latestOpenAPI 3.0.0Apache 2.02026-08-06199181.1 MB

e0d144609998

Invoices

List invoices

List all invoices

get/invoices

Query parameters

account_idinteger

Search Invoices by account Id

account_namestring

Search Invoices by account name

account_numberinteger

Search Invoices by account number

{"stackTrail":"paths:/invoices:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Search Invoices by balance due

invoice_datestring

Search Invoices by invoice date

due_onstring

Search Invoices by due on date

invoice_numberstring

Search Invoices by invoice number

{"stackTrail":"paths:/invoices:get:parameters:7:schema","oasType":"schema","type":"unknown"}

Search for non taxable invoices

organization_idstring

Search Invoices by organization id

{"stackTrail":"paths:/invoices:get:parameters:9:schema","oasType":"schema","type":"unknown"}

Search Invoices by payments made

statusstring

Search Invoices by status

{"stackTrail":"paths:/invoices:get:parameters:11:schema","oasType":"schema","type":"unknown"}

Search Invoices by sub-total

{"stackTrail":"paths:/invoices:get:parameters:12:schema","oasType":"schema","type":"unknown"}

Search Invoices by sub-total after discount

{"stackTrail":"paths:/invoices:get:parameters:13:schema","oasType":"schema","type":"unknown"}

Search Invoices by total

{"stackTrail":"paths:/invoices:get:parameters:14:schema","oasType":"schema","type":"unknown"}

Search Invoices by total discount

{"stackTrail":"paths:/invoices:get:parameters:15:schema","oasType":"schema","type":"unknown"}

Search Invoices by total tax

voucher_header_idinteger

Search Invoices by voucher header id

modified_onstring

Search Invoices by last modify date

filtersobject

Filter invoices by the above query parameters. <br /> <b>Example:</b> { "total[gt]" : 6000 } which will search for invoices that have a total greater than "6000".

sort[asc]'balance_due' | 'invoice_date' | 'invoice_number' | 'payment_made' | 'total'

Sort invoices in ascending order

sort[desc]'balance_due' | 'invoice_date' | 'invoice_number' | 'payment_made' | 'total'

Sort invoices in descending order

pageinteger

The particular page to return

per_pageinteger

The number of items to return per page Default: 50 Limit: 200

Response

Successful operation