Skip to main content

Update invoice status

This endpoint allows you to update the status of an existing invoice. Typical actions: mark as paid, sent, cancelled (void), or overdue.

Endpoint

POST https://canadamotorjobs.com/api/v1/{locale}/invoices/update-status

Parameters

ParameterTypeDescriptionRequired
idstringThe invoice identifierRequired
statusstringThe new invoice status (e.g.: paid, sent, void, overdue)Required
paid_datestringPayment date (YYYY-MM-DD HH:MM:SS), if status is paidOptional if status = paid
payment_methodstringPayment method (e.g.: credit_card, bank_transfer, stripe_pm_id), if status is paidNo
transaction_idstringPayment transaction ID, if status is paidNo
notesstringAdditional notes on the status changeNo
api_tokenstringYour API keyrequired or bearer token

Errors

CodeMessage
401Unauthorized
404Not Found
422Unprocessable Entity (e.g.: invalid status, status transition not allowed)
500Internal Server Error