Update an invoice

PUT /api/2.0/crm/invoice/{id:[0-9]+}

Request

Updates the selected invoice with the parameters (contact ID, consignee ID, etc.) specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

idinteger

Invoice ID

issueDatestring

New invoice issue date

templateTypeinteger

New invoice template type

contactIdinteger

New invoice contact ID

consigneeIdinteger

New invoice consignee ID

entityIdinteger

New invoice entity ID

billingAddressIDinteger

New invoice billing address ID

deliveryAddressIDinteger

New invoice delivery address ID

dueDatestring

New invoice due date

languagestring

New invoice language

currencystring

New invoice currency (abbreviation)

exchangeRatenumber

New invoice exchange rate

purchaseOrderNumberstring

New invoice purchase order number

termsstring

New invoice terms

descriptionstring

New invoice description

invoiceLinesarray of object

New list of invoice lines

IDintegerformat: int32

Examples

PUT /api/2.0/crm/invoice/%7Bid:[0-9]+%7D HTTP/1.1
Accept: application/json
Content-Length: 85
Content-Type: application/json
Host: example.com

{
  "invoiceLines": [
    {
      "value": {
        "ID": "1234"
      }
    }
  ]
}

curl --request PUT \
  --url 'https://example.com/api/2.0/crm/invoice/%7Bid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceLines": [
    {
      "value": {
        "ID": "1234"
      }
    }
  ]
}'

Responses

200

Updated invoice

InvoiceLinesarray of object

InvoiceIDintegerformat: int32

InvoiceItemIDintegerformat: int32

InvoiceTax1IDintegerformat: int32

InvoiceTax2IDintegerformat: int32

SortOrderintegerformat: int32

Descriptionstring

Quantitynumberformat: double

Pricenumberformat: double

Discountnumberformat: double

IDintegerformat: int32

Statusobject

Titlestring

IDintegerformat: int32

Numberstring

IssueDatestring

TemplateTypeenum of integerformat: int32

[0 - Eur, 1 - Rus]

Can be one of: Eur, Rus.

Contactobject

SmallFotoUrlstring

MediumFotoUrlstring

DisplayNamestring

IsCompanyboolean

AccessListarray of object

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

IsPrivateboolean

IsSharedboolean

ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject

Titlestring

Symbolstring

Abbreviationstring

CultureNamestring

IsConvertableboolean

IsBasicboolean

CanEditboolean

CanDeleteboolean

IDintegerformat: int32

Consigneeobject

SmallFotoUrlstring

MediumFotoUrlstring

DisplayNamestring

IsCompanyboolean

AccessListarray of object

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

IsPrivateboolean

IsSharedboolean

ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject

Titlestring

Symbolstring

Abbreviationstring

CultureNamestring

IsConvertableboolean

IsBasicboolean

CanEditboolean

CanDeleteboolean

IDintegerformat: int32

Entityobject

EntityTypestring

EntityIdintegerformat: int32

EntityTitlestring

DueDatestring

Languagestring

Currencyobject

Titlestring

Symbolstring

Abbreviationstring

CultureNamestring

IsConvertableboolean

IsBasicboolean

ExchangeRatenumberformat: double

PurchaseOrderNumberstring

Termsstring

Descriptionstring

FileIDintegerformat: int32

CreateOnstring

CreateByobject

Idstringformat: uuid

DisplayNamestring

Titlestring

AvatarSmallstring

ProfileUrlstring

Costnumberformat: double

CanEditboolean

CanDeleteboolean

IDintegerformat: int32

401

Unauthorized