Navigation Menu

Get entity invoices

GET /api/2.0/crm/{entityType:(contact|person|company|opportunity)}/invoicelist/{entityid:[0-9]+}

Request

Returns a list of all the invoices related to the entity with the ID and type 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

entityTypestring

Invoice entity type

entityidinteger

Invoice entity ID

Examples

GET /api/2.0/crm/%7BentityType:(contact%7Cperson%7Ccompany%7Copportunity)%7D/invoicelist/%7Bentityid:[0-9]+%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request GET \
  --url 'https://example.com/api/2.0/crm/%7BentityType:(contact%7Cperson%7Ccompany%7Copportunity)%7D/invoicelist/%7Bentityid:[0-9]+%7D' \
  --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

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).