<- Invoices API

Invoices API

All versions ->

Update invoiceBeta

PUT

 /v2/invoices/{invoice_id}

Updates an invoice by modifying field values, clearing field values, or both as specified in the request.

There are no restrictions to updating an invoice in a draft state. However, there are guidelines for updating a published invoice. For more information, see Update an invoice.

Permissions:ORDERS_WRITE, INVOICES_WRITE
Try in API Explorer
Link to section

Path parameters

Example code

Link to section

invoice_id

string

Required

The id of the invoice to update.

Link to section

Request body

Link to section

invoice

Required

The invoice fields to update. You need to only specify the fields you want to change. The current invoice version must be specified in the version field. For more information, see Update an invoice.

Link to section

idempotency_key

string

A unique string that identifies the UpdateInvoice request. If you do not provide idempotency_key (or provide an empty string as the value), the endpoint treats each request as independent.

For more information, see Idempotency.

Max Length
128
Link to section

fields_to_clear

string [ ]

Link to section

Response fields

Link to section

invoice

The updated invoice.

Link to section

errors

Information about errors encountered during the request.