List invoices

get

https://api.mrpeasy.com/rest/v1/invoices

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

invoice_id

integer

Database ID of the invoice.

code

string

A unique number to identify the invoice.

customer_id

integer

Database ID of the customer.

customer_code

string

A unique number to identify the customer.

customer_name

string

A name of the customer.

cust_ord_id

integer

Database ID of the customer order.

customer_order_code

string

A unique number to identify the customer order.

rma_ord_id

integer

Database ID of the RMA order.

rma_order_code

string

A unique number to identify the RMA order.

pricelist_id

integer

Database ID of the pricelist.

pricelist_code

string

A unique number to identify the pricelist.

pricelist_title

string

A name of the pricelist.

billing_address_id

integer

ID of invoice billing address.

billing_address

string

Billing address as a text or an array.

type

array of objects

Type of invoice.

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

type

Allowed:

status

array of objects

Status of invoice.

10 - Dummy
20 - Unpaid
30 - Paid partially
40 - Paid
50 - Cancelled

Arrays are supported, for example ?status[]=10&status[]=20.

status

Allowed:

user_id

integer

Database ID of the user responsible for the customer.

manager_id

integer

Database ID of the manager responsible for the customer.

subtotal_price_cur_min

string

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

subtotal_price_cur_max

string

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

tax_sum_cur_min

string

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

tax_sum_cur_max

string

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

tax_rate_min

number

Minimum percentage of tax.

tax_rate_max

number

Maximum percentage of tax.

total_tax_price_cur_min

string

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

total_tax_price_cur_max

string

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

paid_sum_cur_min

string

Minimum paid amount in customer's currency.

paid_sum_cur_max

string

Maximum paid amount in customer's currency.

unpaid_sum_cur_min

string

Minimum unpaid amount in customer's currency.

unpaid_sum_cur_max

string

Maximum unpaid amount in customer's currency.

created_min

integer

Minimum creation timestamp (Unix timestamp).

created_max

integer

Maximum creation timestamp (Unix timestamp).

due_date_min

integer

Minimum due date (Unix timestamp).

due_date_max

integer

Maximum due date (Unix timestamp).

free_text

string

Free text.

last_payment_min

integer

Minimum last payment timestamp (Unix timestamp).

last_payment_max

integer

Maximum last payment timestamp (Unix timestamp).

Headers

Range

string

Pagination range (e.g., items=0-99, items=200-249)

Responses

429

Rate limited - another request is running

200List of invoices

206Partial content

400Validation failed

401Authentication failed