Returns a list of invoices matching the parameters specified in the request.
| Name | Description | Type | Example |
|
status
sent in url
|
Invoice status
optional
|
Draft, Sent, Rejected, Paid, Archived | Draft |
|
issueDateFrom
sent in url
|
Invoice start issue date | Date and Time | Roundtrip format: 2008-04-10T06-30-00.000Z |
|
issueDateTo
sent in url
|
Invoice end issue date | Date and Time | Roundtrip format: 2008-04-10T06-30-00.000Z |
|
dueDateFrom
sent in url
|
Invoice start due date | Date and Time | Roundtrip format: 2008-04-10T06-30-00.000Z |
|
dueDateTo
sent in url
|
Invoice end due date | Date and Time | Roundtrip format: 2008-04-10T06-30-00.000Z |
|
entityType
sent in url
|
Invoice entity type | string | some text |
|
entityid
sent in url
|
Invoice entity ID | number | 1234 |
|
currency
sent in url
|
Invoice currency (abbreviation)
Allowed values: EUR, RUB etc. You can get the whole list of available currencies by API
|
string | some text |
GET api/2.0/crm/invoice/filter?status=%22Draft%22&issueDateFrom=%222008-04-10T06-30-00.000Z%22&issueDateTo=%222008-04-10T06-30-00.000Z%22&dueDateFrom=%222008-04-10T06-30-00.000Z%22&dueDateTo=%222008-04-10T06-30-00.000Z%22&entityType=%22some+text%22&entityid=1234¤cy=%22some+text%22 Host: yourportal.onlyoffice.com Content-Type: application/json Accept: application/json
List of invoices
application/json
{
"status": 0,
"response": [
{
"Status": {
"Title": "Title",
"id": 1234
},
"Number": "",
"IssueDate": "2020-12-14T22:13:41.5378233Z",
"TemplateType": 0,
"Contact": {
"SmallFotoUrl": "url to foto",
"MediumFotoUrl": "url to foto",
"DisplayName": "Tadjeddine Bachir",
"IsCompany": false,
"AccessList": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
}
],
"IsPrivate": true,
"IsShared": false,
"ShareType": 0,
"Currency": {
"Title": "Chinese Yuan",
"Symbol": "¥",
"Abbreviation": "CNY",
"CultureName": "CN",
"IsConvertable": true,
"IsBasic": false
},
"CanEdit": true,
"CanDelete": true,
"id": 1234
},
"Consignee": {
"SmallFotoUrl": "url to foto",
"MediumFotoUrl": "url to foto",
"DisplayName": "Tadjeddine Bachir",
"IsCompany": false,
"AccessList": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
}
],
"IsPrivate": true,
"IsShared": false,
"ShareType": 0,
"Currency": {
"Title": "Chinese Yuan",
"Symbol": "¥",
"Abbreviation": "CNY",
"CultureName": "CN",
"IsConvertable": true,
"IsBasic": false
},
"CanEdit": true,
"CanDelete": true,
"id": 1234
},
"Entity": {
"EntityType": "opportunity",
"EntityId": 123445,
"EntityTitle": "Household appliances internet shop"
},
"DueDate": "2020-12-14T22:13:41.5378233Z",
"Language": "",
"Currency": {
"Title": "Chinese Yuan",
"Symbol": "¥",
"Abbreviation": "CNY",
"CultureName": "CN",
"IsConvertable": true,
"IsBasic": false
},
"ExchangeRate": 10.0,
"PurchaseOrderNumber": "",
"Terms": "",
"Description": "",
"FileID": -1,
"CreateOn": "2020-12-14T22:13:41.5378233Z",
"CreateBy": {
"Id": "00000000-0000-0000-0000-000000000000",
"DisplayName": "Mike Zanyatski",
"Title": "Manager",
"AvatarSmall": "url to small avatar",
"ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
},
"Cost": 0.0,
"CanEdit": true,
"CanDelete": true,
"id": 1234
}
]
}
text/xml
<result>
<status>0</status>
<response>
<Status>
<Title>Title</Title>
<id>1234</id>
</Status>
<Number />
<IssueDate>2020-12-14T22:13:41.5378233Z</IssueDate>
<TemplateType>0</TemplateType>
<Contact>
<SmallFotoUrl>url to foto</SmallFotoUrl>
<MediumFotoUrl>url to foto</MediumFotoUrl>
<DisplayName>Tadjeddine Bachir</DisplayName>
<IsCompany>False</IsCompany>
<AccessList>
<Id>00000000-0000-0000-0000-000000000000</Id>
<DisplayName>Mike Zanyatski</DisplayName>
<Title>Manager</Title>
<AvatarSmall>url to small avatar</AvatarSmall>
<ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</AccessList>
<IsPrivate>True</IsPrivate>
<IsShared>False</IsShared>
<ShareType>0</ShareType>
<Currency>
<Title>Chinese Yuan</Title>
<Symbol>¥</Symbol>
<Abbreviation>CNY</Abbreviation>
<CultureName>CN</CultureName>
<IsConvertable>True</IsConvertable>
<IsBasic>False</IsBasic>
</Currency>
<CanEdit>True</CanEdit>
<CanDelete>True</CanDelete>
<id>1234</id>
</Contact>
<Consignee>
<SmallFotoUrl>url to foto</SmallFotoUrl>
<MediumFotoUrl>url to foto</MediumFotoUrl>
<DisplayName>Tadjeddine Bachir</DisplayName>
<IsCompany>False</IsCompany>
<AccessList>
<Id>00000000-0000-0000-0000-000000000000</Id>
<DisplayName>Mike Zanyatski</DisplayName>
<Title>Manager</Title>
<AvatarSmall>url to small avatar</AvatarSmall>
<ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</AccessList>
<IsPrivate>True</IsPrivate>
<IsShared>False</IsShared>
<ShareType>0</ShareType>
<Currency>
<Title>Chinese Yuan</Title>
<Symbol>¥</Symbol>
<Abbreviation>CNY</Abbreviation>
<CultureName>CN</CultureName>
<IsConvertable>True</IsConvertable>
<IsBasic>False</IsBasic>
</Currency>
<CanEdit>True</CanEdit>
<CanDelete>True</CanDelete>
<id>1234</id>
</Consignee>
<Entity>
<EntityType>opportunity</EntityType>
<EntityId>123445</EntityId>
<EntityTitle>Household appliances internet shop</EntityTitle>
</Entity>
<DueDate>2020-12-14T22:13:41.5378233Z</DueDate>
<Language />
<Currency>
<Title>Chinese Yuan</Title>
<Symbol>¥</Symbol>
<Abbreviation>CNY</Abbreviation>
<CultureName>CN</CultureName>
<IsConvertable>True</IsConvertable>
<IsBasic>False</IsBasic>
</Currency>
<ExchangeRate>10</ExchangeRate>
<PurchaseOrderNumber />
<Terms />
<Description />
<FileID>-1</FileID>
<CreateOn>2020-12-14T22:13:41.5378233Z</CreateOn>
<CreateBy>
<Id>00000000-0000-0000-0000-000000000000</Id>
<DisplayName>Mike Zanyatski</DisplayName>
<Title>Manager</Title>
<AvatarSmall>url to small avatar</AvatarSmall>
<ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
</CreateBy>
<Cost>0</Cost>
<CanEdit>True</CanEdit>
<CanDelete>True</CanDelete>
<id>1234</id>
</response>
</result>