API Reference
  1. MRPeasy REST API
  2. Sales invoices

Create an invoice

post
https://api.mrpeasy.com/rest/v1/invoices
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

A unique number to identify the invoice.

integer
required

Database ID of the customer.

customer_orders
array of objects

All customer orders linked to the invoice. Use this instead of the legacy cust_ord_id field.

customer_orders
integer
deprecated

Database ID of the customer order. Legacy single-order field. Use customer_orders instead.

integer

Database ID of the RMA order. Mutually exclusive with customer_orders and legacy cust_ord_id.

integer
enum
required

Required.

Type of invoice.

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

Required.

Status of invoice.

  • 10 - Dummy
  • 20 - Unpaid
  • 30 - Paid partially
  • 40 - Paid
  • 50 - Cancelled
Allowed:
integer

Database ID of the pricelist.

integer

ID of invoice billing address.

Billing address as text, as a structured address object, or null.

integer

Date and time when this invoice was created as Unix timestamp.

integer

Date when this invoice should be paid as Unix timestamp.

string

Free text.

integer

Database ID of the currency.

number

Percentage of discount.

number | null

Sum of discount.

number | null

Sum of discount in customer's currency.

number | null

Percentage of tax.

number | null

Percentage of pre-payment in a pre-payment invoice.

number | null

Sum of a pre-payment invoice or sum of allocated pre-payment in an invoice.

number | null

Sum of a pre-payment invoice or sum of allocated pre-payment in an invoice, in customer's currency.

number | null

Sum of a pre-payment invoice or sum of allocated pre-payment in an invoice, with tax.

number | null

Sum of a pre-payment invoice or sum of allocated pre-payment in an invoice, with tax in customer's currency.

number | null

Tax sum of the invoice in the default currency.

number | null

Tax sum of the invoice in customer's currency.

number

Currency rate of the invoice.

products
array of objects
required

Array of products that are sold.

products*
Responses

429

Rate limited - another request is running

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?