Create an invoice

POST /api/2.0/crm/invoice

Request

Creates an 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

numberstring

Invoice number

issueDatestring

Invoice issue date

templateTypeinteger

Invoice template type

contactIdinteger

Invoice contact ID

consigneeIdinteger

Invoice consignee ID

entityIdinteger

Invoice entity ID

billingAddressIDinteger

Invoice billing address ID

deliveryAddressIDinteger

Invoice delivery address ID

dueDatestring

Invoice due date

languagestring

Invoice language

currencystring

Invoice currency (abbreviation)

exchangeRatenumber

Invoice exchange rate

purchaseOrderNumberstring

Invoice purchase order number

termsstring

Invoice terms

descriptionstring

Invoice description

invoiceLinesarray of object

List of invoice lines

IDintegerformat: int32

Examples

POST /api/2.0/crm/invoice HTTP/1.1
Accept: application/json
Content-Length: 85
Content-Type: application/json
Host: example.com

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

curl --request POST \
  --url https://example.com/api/2.0/crm/invoice \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceLines": [
    {
      "value": {
        "ID": "1234"
      }
    }
  ]
}'

Responses

200

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