APapp4legal
Invoices

List invoices

Changed on

List all invoices

get/invoices

Request

Query parameters

account_idinteger

Search Invoices by account Id

account_namestring

Search Invoices by account name

account_numberinteger

Search Invoices by account number

balance_dueunknown

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

non_taxableunknown

Search for non taxable invoices

organization_idstring

Search Invoices by organization id

payment_madeunknown

Search Invoices by payments made

statusstring

Search Invoices by status

sub_totalunknown

Search Invoices by sub-total

sub_total_after_discountunknown

Search Invoices by sub-total after discount

totalunknown

Search Invoices by total

total_discountunknown

Search Invoices by total discount

total_taxunknown

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

Changes

  • e0d144609998Revision changes
    • info

      api operation id getList removed and replaced with 083e1828fec9624bd07c41d35b2d358b

    • info

      the endpoint scheme security passport was added to the API

    • info

      added the new optional query request parameter due_on

    • info

      added the new optional query request parameter modified_on