Get Started
Portal api methods
Help

GET api/2.0/crm/invoice/bynumber This function requires authentication

Description

Returns the detailed information about the invoice with the Number specified in the request

Parameters
Name Description Type Example
number
sent in url
Invoice number string some text
Example
GET api/2.0/crm/invoice/bynumber?number=some+text
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Invoice

Example Response

application/json

{
  "status": 0,
  "response": {
    "invoiceLines": [
      {
        "invoiceID": 0,
        "invoiceItemID": 0,
        "invoiceTax1ID": 0,
        "invoiceTax2ID": 0,
        "sortOrder": 0,
        "description": "",
        "quantity": 0,
        "price": 0.0,
        "discount": 0.0,
        "id": 0
      }
    ],
    "status": {
      "title": "Draft",
      "id": 1
    },
    "number": "",
    "issueDate": "2019-06-18T22:26:03.9892668Z",
    "templateType": 0,
    "contact": null,
    "consignee": null,
    "entity": null,
    "dueDate": "2019-06-18T22:26:03.9892668Z",
    "language": "",
    "currency": {
      "title": "Chinese Yuan",
      "symbol": "¥",
      "abbreviation": "CNY",
      "cultureName": "CN",
      "isConvertable": true,
      "isBasic": false
    },
    "exchangeRate": 1.0,
    "purchaseOrderNumber": "",
    "terms": "",
    "description": "",
    "fileID": -1,
    "createOn": "2019-06-18T22:26:03.9892668Z",
    "createBy": {
      "id": "00000000-0000-0000-0000-000000000000",
      "displayName": "Mike Zanyatski",
      "title": "Manager",
      "avatarSmall": "url to small avatar",
      "profileUrl": ""
    },
    "cost": 0.0,
    "canEdit": true,
    "canDelete": true,
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <invoiceLines>
      <invoiceID>0</invoiceID>
      <invoiceItemID>0</invoiceItemID>
      <invoiceTax1ID>0</invoiceTax1ID>
      <invoiceTax2ID>0</invoiceTax2ID>
      <sortOrder>0</sortOrder>
      <description></description>
      <quantity>0</quantity>
      <price>0</price>
      <discount>0</discount>
      <id>0</id>
    </invoiceLines>
    <status>
      <title>Draft</title>
      <id>1</id>
    </status>
    <number></number>
    <issueDate>2019-06-18T22:26:03.9892668Z</issueDate>
    <templateType>0</templateType>
    <contact />
    <consignee />
    <entity />
    <dueDate>2019-06-18T22:26:03.9892668Z</dueDate>
    <language></language>
    <currency>
      <title>Chinese Yuan</title>
      <symbol>¥</symbol>
      <abbreviation>CNY</abbreviation>
      <cultureName>CN</cultureName>
      <isConvertable>true</isConvertable>
      <isBasic>false</isBasic>
    </currency>
    <exchangeRate>1</exchangeRate>
    <purchaseOrderNumber></purchaseOrderNumber>
    <terms></terms>
    <description></description>
    <fileID>-1</fileID>
    <createOn>2019-06-18T22:26:03.9892668Z</createOn>
    <createBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createBy>
    <cost>0</cost>
    <canEdit>true</canEdit>
    <canDelete>true</canDelete>
    <id>0</id>
  </response>
</result>