Get invoices

GET /api/2.0/crm/invoice/filter

Request

Returns a list of invoices matching the parameters 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

statusarray of integer

Invoice status

issueDateFromstring

Invoice start issue date

issueDateTostring

Invoice end issue date

dueDateFromstring

Invoice start due date

dueDateTostring

Invoice end due date

entityTypestring

Invoice entity type

entityidinteger

Invoice entity ID

currencystring

Invoice currency (abbreviation)

Examples

GET /api/2.0/crm/invoice/filter HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/crm/invoice/filter \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of invoices

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