Request Information
Returns sales receipt with related entities by Id.
Example URL:
v2.0/SalesReceipts/{id}/Expand
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Sales receipt Id |
integer |
Required |
| id |
Sales receipt Id |
integer |
Required |
None.
Response Information
SalesReceiptApiModelExpand
| Name | Description | Type | Additional information |
|---|---|---|---|
| Currency |
Currency model |
CurrencyApiModel |
None. |
| 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. |
| Partner |
Info about purchaser from the address book |
ContactApiModelExpand |
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. |
| VatRegime |
VAT regime |
VatRegime |
None. |
Sample:
{
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"Partner": {
"BankAccounts": [
{
"Bank": {
"Code": "sample string 1",
"Country": {
"Code": "sample string 1",
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"CurrencyId": 2,
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"Name": "sample string 4",
"NumberCode": "sample string 5",
"Swift": "sample string 6",
"IsOutOfDate": true,
"Id": 8
},
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"IsDefault": true,
"CurrencyId": 3,
"AccountNumber": "sample string 4",
"BankId": 1,
"Iban": "sample string 5",
"Name": "sample string 6",
"Swift": "sample string 7",
"Id": 8
}
],
"Country": {
"Code": "sample string 1",
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"CurrencyId": 2,
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"AddressIdg": "a8bf5fad-6f53-488c-b83b-73ddc00d72e7",
"CreditCheck": 0,
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"DefaultBankAccount": {
"Bank": {
"Code": "sample string 1",
"Country": {
"Code": "sample string 1",
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"CurrencyId": 2,
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"Name": "sample string 4",
"NameEnglish": "sample string 5",
"IsEuMember": true,
"Id": 7
},
"CountryId": 2,
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"Name": "sample string 4",
"NumberCode": "sample string 5",
"Swift": "sample string 6",
"IsOutOfDate": true,
"Id": 8
},
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"DateLastChange": "2024-11-04T20:38:18.0994931+00:00",
"IsDefault": true,
"CurrencyId": 3,
"AccountNumber": "sample string 4",
"BankId": 1,
"Iban": "sample string 5",
"Name": "sample string 6",
"Swift": "sample string 7",
"Id": 8
},
"Id": 3,
"CompanyName": "sample string 4",
"CountryId": 5,
"IsRegisteredForVatOnPay": true,
"DefaultInvoiceMaturity": 1,
"City": "sample string 7",
"DiscountPercentage": 1.0,
"Email": "sample string 8",
"Fax": "sample string 9",
"Firstname": "sample string 10",
"IdentificationNumber": "sample string 11",
"IsSendReminder": true,
"Mobile": "sample string 12",
"Phone": "sample string 13",
"PostalCode": "sample string 14",
"Street": "sample string 15",
"Surname": "sample string 16",
"Title": "sample string 17",
"VatIdentificationNumber": "sample string 18",
"VatIdentificationNumberSk": "sample string 19",
"Www": "sample string 20"
},
"CurrencyId": 1,
"DateOfIssue": "2024-11-04T20:38:18.0994931+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": "2024-11-04T20:38:18.0994931+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": "2024-11-04T20:38:18.0994931+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": "2024-11-04T20:38:18.0994931+00:00",
"DateOfSale": "2024-11-04T20:38:18.0994931+00:00",
"DateOfSend": "2024-11-04T20:38:18.0994931+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": "438d149e-c2aa-4041-8f6d-130e22fbdc7f",
"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,
"VatRegime": 0,
"Id": 18
}
Sample:
Sample not available.
Sample:
Sample not available.