Update an invoice

put

https://api.mrpeasy.com/rest/v1/invoices/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Database ID of the resource

Body Params

code

string

A unique number to identify the invoice.

customer_id

integer

Database ID of the customer.

type

integer

enum

Type of invoice.

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

Allowed:

status

integer

enum

Status of invoice.

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

Allowed:

pricelist_id

integer

Database ID of the pricelist.

billing_address_id

integer

ID of invoice billing address.

billing_address

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

created

integer

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

due_date

integer

Date when this invoice should be paid as Unix timestamp.

free_text

string

Free text.

discount_rate

number

Percentage of discount.

discount_sum

number | null

Sum of discount.

discount_sum_cur

number | null

Sum of discount in customer's currency.

tax_rate

number | null

Percentage of tax.

prepayment_rate

number | null

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

prepayment_sum

number | null

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

prepayment_sum_cur

number | null

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

prepayment_tax_sum

number | null

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

prepayment_tax_sum_cur

number | null

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

tax_sum

number | null

Tax sum of the invoice in the default currency.

tax_sum_cur

number | null

Tax sum of the invoice in customer's currency.

products

array of objects

If omitted, existing invoice lines remain unchanged.

Provided line_id values are updated.
Lines without line_id are created.
Existing invoice lines missing from provided line_id values are deleted.

products

Responses

202

Invoice updated

404

Resource not found

429

Rate limited - another request is running

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400Validation failed

401Authentication failed