Use this method to update the properties of an existing invoice.
URL
(PUT) invoices/{invoiceid}
PARAMETERS
token | The token obtained on connection | Required |
invoiceid | The id of the invoice to modify. | Required |
command | A json containing the invoice information (see below) | Required |
JSON format of "command" parameter
Add only the fields you want to change to a json object:
Example to update these 3 fields: { "CustomFields": …, "Labels": …, "Status": … }
| Status | Status of the invoice. See ApiInvoice for details. | Optional |
| Comments | Comments about the invoice. | Optional |
| HeaderLine | The header line of the invoice. | Optional |
| Labels | Set a label: "Labels": [ { "Id": 10, "Value": 1 }, … ] Clear a label: "Labels": [ { "Id": 10, "Value": null }, … ] See Custom labels to get the list of labels. | Optional |
| CustomFields | A json array containing a list of custom field ids and values. See below for details.
Example:
CustomFields: [ {
"Id": "CustomStr1",
"Value": "My field"
},
{
"Id": "CustomStr5",
"Value": "A-2233"
} ]
See Custom fields to get the list of custom fields. | Optional |
JSON format of field "CustomFields"
| Id | The custom string id such as 'CustomStr1', 'CustomStr2', etc. Use method settings/customfields to obtain all available ids. | Required |
| Value | The value to set for the custom string. | Required |