Actions18
- Customers Actions
- Deposits Actions
- Invoices Actions
Invoices → Update Invoices
AI-generatedSummary
Update an existing invoice record by specifying its ID, required status, and any other optional fields to modify.
Inputs
- Id (required) — The numerical ID of the invoice to update.
- Status (required) — The new status of the invoice. Allowed values: Draft, Posted, Paid, Processing, Void.
- Additional Fields — Optional fields such as externalUri, invoice and due dates, company name, customer message, document number, purchase order number, contract, billing address details, auto process flag, and metadata to update on the invoice.
- Options — Additional settings including custom JSON body (merged with specified fields), custom HTTP headers, query filters, batching parameters, debug mode to capture request details, pagination settings, and request timeout in milliseconds.
Output shape
a single JSON object representing the updated invoice record or error details if the update fails.
The operation performs an HTTP PUT request to /api/merchant/v1/Invoices/{id} with the provided fields merged with any custom body. Batching and debug options are supported. If multiple input items are provided, each is processed in turn, optionally with delays to avoid rate limits. Errors can be handled optionally with continueOnFail.