Update an invoice

patch

https://core.sivo.com/sellers/{seller_id}/invoices/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

seller_id

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

An object id with prefix

string

required

^[a-z]{3,7}_[0-9A-Za-z]{27}$

An object id with prefix

Body Params

Update a seller

buyer_id

string

^[a-z]{3,7}_[0-9A-Za-z]{27}$

Identifier for the buyer

currency

string

^[A-Z]{3}$

ISO 4217 currency code for all monetary amounts on this invoice

country

string

^(?!UK$)[A-Z]{2}$

ISO 3166-1 alpha-2 country code where the invoice is issued

amount_due

integer

Total amount due on the invoice

amount_paid

integer

≥ 0

Amount already paid on this invoice

amount_remaining

integer

Amount still remaining to be paid

invoice_date

date

Date when the invoice was issued

due_date

date

Date when the payment is due

total

integer

≥ 0

Total amount of the invoice including all charges, shipping, tax, etc.

supplier_id

string | null

^[a-z]{3,7}_[0-9A-Za-z]{27}$

Identifier for the supplier, if different from seller

invoice_pdf

uri | null

URL to the PDF version of the invoice

billing_reason

string | null

Reason for billing the buyer

payment_method

string | null

Payment method used or to be used for this invoice

charges

integer | null

≥ 0

Amount of charges applied to this invoice

discount

integer | null

≥ 0

Amount of discount applied to this invoice

shipping

integer | null

≥ 0

Shipping costs included in this invoice

tax

integer | null

≥ 0

Tax amount applied to this invoice

fiscal_invoice_id

^cfdi:.*$

Fiscal invoice identifier

CFDI (Comprobante Fiscal Digital por Internet - Mexico) - A UUID identifier for Mexican digital fiscal invoices with cfdi: prefix

metadata

object | null

Additional custom data associated with this invoice

Headers

if-match

date-time

required

ETag value for Optimistic Concurrency Control (OCC). Should contain the last known updated_at timestamp in ISO 8601 format.

Response

Language

Credentials

Loading…

Response

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

application/json

200Successful operation