List invoices

List sales invoices with their product lines and linked customer orders, optionally filtered by available attributes. Cancelled invoices are left out unless the request filters by invoice_id or by status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer | null

Database ID of the invoice. Cancelled invoices are returned when this filter is given.

string | null

A unique number to identify the invoice. Partial match.

integer | null

Database ID of the customer.

string | null

A unique number to identify the customer. Partial match.

string | null

A name of the customer. Partial match.

integer | null

Database ID of a customer order linked to the invoice.

string | null

A unique number to identify a customer order linked to the invoice. Partial match. An RMA order code also matches.

integer | null

Database ID of the RMA order.

string | null

A unique number to identify the RMA order. Partial match.

integer | null

Database ID of the pricelist.

string | null

A unique number to identify the pricelist. Partial match.

string | null

A name of the pricelist. Partial match.

integer | null

ID of invoice billing address.

string | null

Billing address of the invoice. Partial match. An exact country name or two- or three-letter ISO code also matches structured addresses.

enum

Type of invoice. One value or a list, for example ?type=30 or ?type[]=30&type[]=40.


  • 10 - Quotation
  • 20 - Pro-forma invoice
  • 25 - Prepayment invoice
  • 30 - Invoice
  • 40 - Credit-invoice
  • 50 - Order confirmation
enum

Status of invoice. One value or a list, for example ?status=20 or ?status[]=20&status[]=30. Cancelled invoices are returned when this filter is given.


  • 10 - Dummy
  • 20 - Unpaid
  • 30 - Paid partially
  • 40 - Paid
  • 50 - Cancelled
integer | null

Database ID of the user who added the invoice.

integer | null

Database ID of the manager responsible for the customer.

string | null

Minimum invoice total price in the account default currency before tax. May be negative.

string | null

Maximum invoice total price in the account default currency before tax. May be negative.

string | null

Minimum invoice total price in customer's currency before tax. May be negative.

string | null

Maximum invoice total price in customer's currency before tax. May be negative.

string | null

Minimum tax sum of the invoice in the account default currency. May be negative.

string | null

Maximum tax sum of the invoice in the account default currency. May be negative.

string | null

Minimum tax sum of the invoice in customer's currency. May be negative.

string | null

Maximum tax sum of the invoice in customer's currency. May be negative.

string | null

Minimum percentage of tax.

string | null

Maximum percentage of tax.

string | null

Minimum total price of the invoice with tax in the account default currency.

string | null

Maximum total price of the invoice with tax in the account default currency.

string | null

Minimum total price of the invoice with tax in customer's currency.

string | null

Maximum total price of the invoice with tax in customer's currency.

string | null

Minimum paid amount in the account default currency.

string | null

Maximum paid amount in the account default currency.

string | null

Minimum paid amount in customer's currency.

string | null

Maximum paid amount in customer's currency.

string | null

Minimum unpaid amount in the account default currency.

string | null

Maximum unpaid amount in the account default currency.

string | null

Minimum unpaid amount in customer's currency.

string | null

Maximum unpaid amount in customer's currency.

integer | null

Minimum creation date and time as UNIX timestamp.

integer | null

Maximum creation date and time as UNIX timestamp. The whole of that day is covered.

integer | null

Minimum due date as UNIX timestamp.

integer | null

Maximum due date as UNIX timestamp. The whole of that day is covered.

integer | null

Minimum date and time of the last payment as UNIX timestamp.

integer | null

Maximum date and time of the last payment as UNIX timestamp. The whole of that day is covered.

string | null

Free text of the invoice. Partial match.

custom_values
array of objects | null

Conditions on custom fields of the invoice or of its customer. All of them must hold. Example for a text field: ?custom_values[0][field_id]=1&custom_values[0][value]=abc. Replace 1 with your custom field ID; use indices 0, 1, etc. for separate conditions.

custom_values
integer

Maximum number of records to return (1–1000).

integer

Number of records to skip for pagination.

Responses

401

Unauthorized

413

Content Too Large - please use smaller ´limit´

429

Too many requests

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json