JSON API » invoices » invoices/update
Updates an existing invoice.
Input parameters
Requires authentication and the commerce role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| id | Integer | ID of invoice to update. | Yes | |
| status | String | Status. "approved", "cancelled", "due", "overdue", "paid", "payment_refused", "pending", "prepaid", "queued", or "superceded". | No | Current value. |
Responses
| Code | Description |
|---|---|
| 204 | Success. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 404 | The invoice does not exist, or you do not have permission to view it. |
Data returned
No data is returned.
Example: Changing the status
{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |