Request Information

Returns information about a sales receipt.

Example URL:
v2.0/SalesReceipts/{id}
NameDescriptionTypeAdditional information
id

Sales receipt Id

integer

Required

id

Sales receipt Id

integer

Required

None.

Response Information

SalesReceiptApiModel
NameDescriptionTypeAdditional information
CurrencyId

The currency id.

integer

None.

DateOfIssue

Date of issue

date

None.

DocumentNumber

DocumentNumber

string

None.

DocumentSerialNumber

Document Serial Number

integer

None.

EetResponsibility

Responsibility for handlig of electronic records of sales

EetResponsibility

Used in Cz legislation.

ExchangeRate

Exchange rate

decimal number

None.

ExchangeRateAmount

Exchange rate amount

decimal number

None.

Exported

Export to another accounting software indication. (It is recommended to use only one external accounting software beside iDoklad.)

ExportedState

None.

ExternalDocumentNumber

Number assigned by external application.

string

None.

Id

Resource identifier

integer

Readonly

Imported

Flag indicating whether the entity was imported from a different system.

ImportedState

None.

IsAccounted

Flag for accounted sales receipts.

boolean

None.

IsCumulative

Cummulative sales receipt

boolean

None.

IsEet

Flag indicating whether the sales receipt is registered in EET.

boolean

None.

IsIncomeTax

Include subject to income tax

boolean

Used in Cz legislation.

MyDocumentAddress

Your contact information

DocumentAddressApiModel

None.

Name

The name of the sales receipt.

string

None.

PartnerDocumentAddress

Contact information of the sales receipt partner, if one exists

DocumentAddressApiModel

None.

PartnerId

Id of the contact on the sales receipt, if one exists

integer

None.

RecountVersion

Recount Version

RecountVersion

None.

RegisteredSale

Registered sale

RegisteredSaleApiModel

Used in Cz legislation.

SalesPosEquipmentId

POS equipment Id.

integer

Used in Cz legislation.

SalesReceiptItems

List of items.

Collection of SalesReceiptItemApiModel

None.

SalesReceiptPayments

List of payments.

Collection of SalesReceiptPaymentApiModel

None.

TotalVat

Total amount of VAT in used currency

decimal number

None.

TotalVatHc

Total amount of VAT in home currency

decimal number

None.

TotalWithoutVat

Total amount without VAT in the used currency.

decimal number

None.

TotalWithoutVatHc

Total amount without VAT in home currency

decimal number

None.

TotalWithVat

Total amount with VAT in used currency

decimal number

None.

TotalWithVatHc

Total amount with VAT in home currency

decimal number

None.

Sample:
{
  "CurrencyId": 1,
  "DateOfIssue": "2021-05-11T10:26:34.2578689+00:00",
  "DocumentNumber": "sample string 3",
  "DocumentSerialNumber": 4,
  "EetResponsibility": 0,
  "ExchangeRate": 5.0,
  "ExchangeRateAmount": 6.0,
  "Exported": 0,
  "ExternalDocumentNumber": "sample string 7",
  "Imported": 0,
  "IsAccounted": true,
  "IsCumulative": true,
  "IsEet": true,
  "MyDocumentAddress": {
    "AccountNumber": "sample string 1",
    "Bank": "sample string 2",
    "BankNumberCode": "sample string 3",
    "City": "sample string 4",
    "Country": "sample string 5",
    "CountryId": 1,
    "DateLastChange": "2021-05-11T10:26:34.2578689+00:00",
    "Email": "sample string 7",
    "Fax": "sample string 8",
    "Firstname": "sample string 9",
    "Iban": "sample string 10",
    "IdentificationNumber": "sample string 11",
    "Mobile": "sample string 12",
    "NickName": "sample string 13",
    "Phone": "sample string 14",
    "PostalCode": "sample string 15",
    "Street": "sample string 16",
    "Surname": "sample string 17",
    "Swift": "sample string 18",
    "Title": "sample string 19",
    "VatIdentificationNumber": "sample string 20",
    "VatIdentificationNumberSk": "sample string 21",
    "Www": "sample string 22",
    "Id": 23
  },
  "Name": "sample string 11",
  "PartnerDocumentAddress": {
    "AccountNumber": "sample string 1",
    "Bank": "sample string 2",
    "BankNumberCode": "sample string 3",
    "City": "sample string 4",
    "Country": "sample string 5",
    "CountryId": 1,
    "DateLastChange": "2021-05-11T10:26:34.2578689+00:00",
    "Email": "sample string 7",
    "Fax": "sample string 8",
    "Firstname": "sample string 9",
    "Iban": "sample string 10",
    "IdentificationNumber": "sample string 11",
    "Mobile": "sample string 12",
    "NickName": "sample string 13",
    "Phone": "sample string 14",
    "PostalCode": "sample string 15",
    "Street": "sample string 16",
    "Surname": "sample string 17",
    "Swift": "sample string 18",
    "Title": "sample string 19",
    "VatIdentificationNumber": "sample string 20",
    "VatIdentificationNumberSk": "sample string 21",
    "Www": "sample string 22",
    "Id": 23
  },
  "PartnerId": 1,
  "RegisteredSale": {
    "BaseTaxBasicRateHc": 1.0,
    "BaseTaxReducedRate1Hc": 2.0,
    "BaseTaxReducedRate2Hc": 3.0,
    "BaseTaxZeroRateHc": 4.0,
    "Bkp": "sample string 5",
    "CancelledRegisteredSaleId": 1,
    "CashVoucherId": 1,
    "DateOfAnswer": "2021-05-11T10:26:34.2578689+00:00",
    "DateOfSale": "2021-05-11T10:26:34.2578689+00:00",
    "DateOfSend": "2021-05-11T10:26:34.2578689+00:00",
    "DocumentNumber": "sample string 9",
    "DocumentType": 0,
    "EetRegime": 0,
    "ErrorCode": 10,
    "ErrorText": "sample string 11",
    "Fik": "sample string 12",
    "IsCanceled": true,
    "IsFirstReport": true,
    "IssuedInvoiceId": 1,
    "IssuedInvoicePaymentId": 1,
    "Pkp": "sample string 15",
    "ReceiptNumber": "sample string 16",
    "SalesOfficeDesignation": 17,
    "SalesPosEquipmentDesignation": "sample string 18",
    "SalesPosEquipmentId": 1,
    "SalesReceiptId": 1,
    "Status": 0,
    "TaxBasicRateHc": 19.0,
    "TaxReducedRate1Hc": 20.0,
    "TaxReducedRate2Hc": 21.0,
    "TotalAdvancePayment": 22.0,
    "TotalFromAdvancePayment": 23.0,
    "TotalTravelServiceHc": 24.0,
    "TotalUsedGoodsBasicRateHc": 25.0,
    "TotalUsedGoodsReducedRate1Hc": 26.0,
    "TotalUsedGoodsReducedRate2Hc": 27.0,
    "TotalWithVatHc": 28.0,
    "Uuid": "e379c401-5af7-48de-9612-ed4779897f52",
    "VatIdentificationNumber": "sample string 30",
    "Id": 31
  },
  "SalesPosEquipmentId": 1,
  "SalesReceiptItems": [
    {
      "Amount": 1.0,
      "CashVoucherItemId": 1,
      "ItemType": 0,
      "Name": "sample string 2",
      "Price": 3.0,
      "PriceListItemId": 1,
      "PriceTotalWithoutVat": 4.0,
      "PriceTotalWithoutVatHc": 5.0,
      "PriceTotalWithVat": 6.0,
      "PriceTotalWithVatHc": 7.0,
      "PriceType": 0,
      "Rank": 8,
      "SalesReceiptId": 9,
      "Unit": "sample string 10",
      "VatRate": 11.0,
      "VatRateType": 0,
      "VatTotal": 12.0,
      "VatTotalHc": 13.0,
      "Id": 14
    }
  ],
  "SalesReceiptPayments": [
    {
      "PaymentAmount": 1.0,
      "PaymentOptionId": 2,
      "PaymentTransactionCode": "sample string 3",
      "SalesReceiptId": 4,
      "Id": 5
    }
  ],
  "TotalVat": 12.0,
  "TotalVatHc": 13.0,
  "TotalWithoutVat": 14.0,
  "TotalWithoutVatHc": 15.0,
  "TotalWithVat": 16.0,
  "TotalWithVatHc": 17.0,
  "IsIncomeTax": true,
  "RecountVersion": 0,
  "Id": 18
}
Sample:
<SalesReceiptApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.SalesReceipt">
  <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">18</Id>
  <Links xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Links>
  <CurrencyId>1</CurrencyId>
  <DateOfIssue>2021-05-11T10:26:34.2578689+00:00</DateOfIssue>
  <DocumentNumber>sample string 3</DocumentNumber>
  <DocumentSerialNumber>4</DocumentSerialNumber>
  <EetResponsibility>Idoklad</EetResponsibility>
  <ExchangeRate>5</ExchangeRate>
  <ExchangeRateAmount>6</ExchangeRateAmount>
  <Exported>0</Exported>
  <ExternalDocumentNumber>sample string 7</ExternalDocumentNumber>
  <Imported>NotImported</Imported>
  <IsAccounted>true</IsAccounted>
  <IsCumulative>true</IsCumulative>
  <IsEet>true</IsEet>
  <IsIncomeTax>true</IsIncomeTax>
  <MyDocumentAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
    <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">23</Id>
    <Links xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Links>
    <d2p1:AccountNumber>sample string 1</d2p1:AccountNumber>
    <d2p1:Bank>sample string 2</d2p1:Bank>
    <d2p1:BankNumberCode>sample string 3</d2p1:BankNumberCode>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:Country>sample string 5</d2p1:Country>
    <d2p1:CountryId>1</d2p1:CountryId>
    <d2p1:DateLastChange>2021-05-11T10:26:34.2578689+00:00</d2p1:DateLastChange>
    <d2p1:Email>sample string 7</d2p1:Email>
    <d2p1:Fax>sample string 8</d2p1:Fax>
    <d2p1:Firstname>sample string 9</d2p1:Firstname>
    <d2p1:Iban>sample string 10</d2p1:Iban>
    <d2p1:IdentificationNumber>sample string 11</d2p1:IdentificationNumber>
    <d2p1:Mobile>sample string 12</d2p1:Mobile>
    <d2p1:NickName>sample string 13</d2p1:NickName>
    <d2p1:Phone>sample string 14</d2p1:Phone>
    <d2p1:PostalCode>sample string 15</d2p1:PostalCode>
    <d2p1:Street>sample string 16</d2p1:Street>
    <d2p1:Surname>sample string 17</d2p1:Surname>
    <d2p1:Swift>sample string 18</d2p1:Swift>
    <d2p1:Title>sample string 19</d2p1:Title>
    <d2p1:VatIdentificationNumber>sample string 20</d2p1:VatIdentificationNumber>
    <d2p1:VatIdentificationNumberSk>sample string 21</d2p1:VatIdentificationNumberSk>
    <d2p1:Www>sample string 22</d2p1:Www>
  </MyDocumentAddress>
  <Name>sample string 11</Name>
  <PartnerDocumentAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
    <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">23</Id>
    <Links xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Links>
    <d2p1:AccountNumber>sample string 1</d2p1:AccountNumber>
    <d2p1:Bank>sample string 2</d2p1:Bank>
    <d2p1:BankNumberCode>sample string 3</d2p1:BankNumberCode>
    <d2p1:City>sample string 4</d2p1:City>
    <d2p1:Country>sample string 5</d2p1:Country>
    <d2p1:CountryId>1</d2p1:CountryId>
    <d2p1:DateLastChange>2021-05-11T10:26:34.2578689+00:00</d2p1:DateLastChange>
    <d2p1:Email>sample string 7</d2p1:Email>
    <d2p1:Fax>sample string 8</d2p1:Fax>
    <d2p1:Firstname>sample string 9</d2p1:Firstname>
    <d2p1:Iban>sample string 10</d2p1:Iban>
    <d2p1:IdentificationNumber>sample string 11</d2p1:IdentificationNumber>
    <d2p1:Mobile>sample string 12</d2p1:Mobile>
    <d2p1:NickName>sample string 13</d2p1:NickName>
    <d2p1:Phone>sample string 14</d2p1:Phone>
    <d2p1:PostalCode>sample string 15</d2p1:PostalCode>
    <d2p1:Street>sample string 16</d2p1:Street>
    <d2p1:Surname>sample string 17</d2p1:Surname>
    <d2p1:Swift>sample string 18</d2p1:Swift>
    <d2p1:Title>sample string 19</d2p1:Title>
    <d2p1:VatIdentificationNumber>sample string 20</d2p1:VatIdentificationNumber>
    <d2p1:VatIdentificationNumberSk>sample string 21</d2p1:VatIdentificationNumberSk>
    <d2p1:Www>sample string 22</d2p1:Www>
  </PartnerDocumentAddress>
  <PartnerId>1</PartnerId>
  <RecountVersion>None</RecountVersion>
  <RegisteredSale xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
    <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">31</Id>
    <Links xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Links>
    <d2p1:BaseTaxBasicRateHc>1</d2p1:BaseTaxBasicRateHc>
    <d2p1:BaseTaxReducedRate1Hc>2</d2p1:BaseTaxReducedRate1Hc>
    <d2p1:BaseTaxReducedRate2Hc>3</d2p1:BaseTaxReducedRate2Hc>
    <d2p1:BaseTaxZeroRateHc>4</d2p1:BaseTaxZeroRateHc>
    <d2p1:Bkp>sample string 5</d2p1:Bkp>
    <d2p1:CancelledRegisteredSaleId>1</d2p1:CancelledRegisteredSaleId>
    <d2p1:CashVoucherId>1</d2p1:CashVoucherId>
    <d2p1:DateOfAnswer>2021-05-11T10:26:34.2578689+00:00</d2p1:DateOfAnswer>
    <d2p1:DateOfSale>2021-05-11T10:26:34.2578689+00:00</d2p1:DateOfSale>
    <d2p1:DateOfSend>2021-05-11T10:26:34.2578689+00:00</d2p1:DateOfSend>
    <d2p1:DocumentNumber>sample string 9</d2p1:DocumentNumber>
    <d2p1:DocumentType>IssuedInvoice</d2p1:DocumentType>
    <d2p1:EetRegime>None</d2p1:EetRegime>
    <d2p1:ErrorCode>10</d2p1:ErrorCode>
    <d2p1:ErrorText>sample string 11</d2p1:ErrorText>
    <d2p1:Fik>sample string 12</d2p1:Fik>
    <d2p1:IsCanceled>true</d2p1:IsCanceled>
    <d2p1:IsFirstReport>true</d2p1:IsFirstReport>
    <d2p1:IssuedInvoiceId>1</d2p1:IssuedInvoiceId>
    <d2p1:IssuedInvoicePaymentId>1</d2p1:IssuedInvoicePaymentId>
    <d2p1:Pkp>sample string 15</d2p1:Pkp>
    <d2p1:ReceiptNumber>sample string 16</d2p1:ReceiptNumber>
    <d2p1:SalesOfficeDesignation>17</d2p1:SalesOfficeDesignation>
    <d2p1:SalesPosEquipmentDesignation>sample string 18</d2p1:SalesPosEquipmentDesignation>
    <d2p1:SalesPosEquipmentId>1</d2p1:SalesPosEquipmentId>
    <d2p1:SalesReceiptId>1</d2p1:SalesReceiptId>
    <d2p1:Status>New</d2p1:Status>
    <d2p1:TaxBasicRateHc>19</d2p1:TaxBasicRateHc>
    <d2p1:TaxReducedRate1Hc>20</d2p1:TaxReducedRate1Hc>
    <d2p1:TaxReducedRate2Hc>21</d2p1:TaxReducedRate2Hc>
    <d2p1:TotalAdvancePayment>22</d2p1:TotalAdvancePayment>
    <d2p1:TotalFromAdvancePayment>23</d2p1:TotalFromAdvancePayment>
    <d2p1:TotalTravelServiceHc>24</d2p1:TotalTravelServiceHc>
    <d2p1:TotalUsedGoodsBasicRateHc>25</d2p1:TotalUsedGoodsBasicRateHc>
    <d2p1:TotalUsedGoodsReducedRate1Hc>26</d2p1:TotalUsedGoodsReducedRate1Hc>
    <d2p1:TotalUsedGoodsReducedRate2Hc>27</d2p1:TotalUsedGoodsReducedRate2Hc>
    <d2p1:TotalWithVatHc>28</d2p1:TotalWithVatHc>
    <d2p1:Uuid>e379c401-5af7-48de-9612-ed4779897f52</d2p1:Uuid>
    <d2p1:VatIdentificationNumber>sample string 30</d2p1:VatIdentificationNumber>
  </RegisteredSale>
  <SalesPosEquipmentId>1</SalesPosEquipmentId>
  <SalesReceiptItems>
    <SalesReceiptItemApiModel>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">14</Id>
      <Links xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Links>
      <Amount>1</Amount>
      <CashVoucherItemId>1</CashVoucherItemId>
      <ItemType>0</ItemType>
      <Name>sample string 2</Name>
      <Price>3</Price>
      <PriceListItemId>1</PriceListItemId>
      <PriceTotalWithVat>6</PriceTotalWithVat>
      <PriceTotalWithVatHc>7</PriceTotalWithVatHc>
      <PriceTotalWithoutVat>4</PriceTotalWithoutVat>
      <PriceTotalWithoutVatHc>5</PriceTotalWithoutVatHc>
      <PriceType>0</PriceType>
      <Rank>8</Rank>
      <SalesReceiptId>9</SalesReceiptId>
      <Unit>sample string 10</Unit>
      <VatRate>11</VatRate>
      <VatRateType>0</VatRateType>
      <VatTotal>12</VatTotal>
      <VatTotalHc>13</VatTotalHc>
    </SalesReceiptItemApiModel>
  </SalesReceiptItems>
  <SalesReceiptPayments>
    <SalesReceiptPaymentApiModel>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">5</Id>
      <Links xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Links>
      <PaymentAmount>1</PaymentAmount>
      <PaymentOptionId>2</PaymentOptionId>
      <PaymentTransactionCode>sample string 3</PaymentTransactionCode>
      <SalesReceiptId>4</SalesReceiptId>
    </SalesReceiptPaymentApiModel>
  </SalesReceiptPayments>
  <TotalVat>12</TotalVat>
  <TotalVatHc>13</TotalVatHc>
  <TotalWithVat>16</TotalWithVat>
  <TotalWithVatHc>17</TotalWithVatHc>
  <TotalWithoutVat>14</TotalWithoutVat>
  <TotalWithoutVatHc>15</TotalWithoutVatHc>
</SalesReceiptApiModel>