Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use this method to update the properties of an existing invoice.


Child pages (Children Display)

URL

(PUT) invoices/{invoiceid}

...

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": … }

 

StatusStatus of the invoice. See ApiInvoice for details.Optional
CommentsComments about the invoice.Optional
HeaderLineThe header line of the invoice.Optional
Labels

Set a label: "Labels": [ { "Id": 10, "Value": 1 }, … ]

Clear a label: "Labels": [ { "Id": 10, "Value": null }, … ]

See chapter REF _Ref362347538 \r \h 12.5

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:

 

Code Block
CustomFields: [ {
	"Id": "CustomStr1", 
	"Value": "My field" 
}, 
{ 
	"Id": "CustomStr5", 
	"Value": "A-2233" 
} ]
See chapter REF _Ref362517235 \r \h 12.4

 

See Custom fields to get the list of custom fields.

Optional

 

JSON format of field "CustomFields"

 

IdThe custom string id such as 'CustomStr1', 'CustomStr2', etc. Use method settings/customfields to obtain all available ids.Required
ValueThe value to set for the custom string.Required