Get Started
Usage API
More information

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

Description

Returns the detailed information about an invoice sample.

Parameters

This method doesn't have any parameters.

Example
GET api/2.0/crm/invoice/sample
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": "Description",
        "Quantity": 0.0,
        "Price": 0.0,
        "Discount": 0.0,
        "id": 1234
      }
    ],
    "id": 1234,
    "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
  }
}

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</Description>
      <Quantity>0</Quantity>
      <Price>0</Price>
      <Discount>0</Discount>
      <id>1234</id>
    </InvoiceLines>
    <id>1234</id>
    <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>
  </response>
</result>