Request Information
Returns payment with related entities by Id.
Example URL:
v2.0/ReceivedDocumentPayments/{id}/Expand
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Payment Id |
integer |
Required |
| id |
Payment Id |
integer |
Required |
None.
Response Information
ReceivedDocumentPaymentApiModelExpand
| Name | Description | Type | Additional information |
|---|---|---|---|
| Currency |
Currency details |
CurrencyApiModel |
None. |
| CurrencyId |
Currency Id |
integer |
None. |
| DateCreated |
Date created |
date |
None. |
| DateLastChange |
Date last change |
date |
None. |
| DateOfPayment |
Date of payment |
date |
None. |
| DateOfVatApplication | date |
Used in Sk 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. |
| Id |
Resource identifier |
integer |
Readonly |
| InvoiceDocumentNumber |
Invoice document number |
string |
None. |
| InvoiceId |
Document Id |
integer |
Required |
| Partner |
Partner |
string |
None. |
| PartnerId |
Partner id |
integer |
None. |
| PaymentAmount |
Payment ammount |
decimal number |
None. |
| PaymentAmountHc |
Payment ammount in home currency |
decimal number |
None. |
| PaymentOption |
Payment option details |
PaymentOptionApiModel |
None. |
| PaymentOptionId |
Payment option id |
integer |
None. |
| ReceivedInvoice |
Document details |
ReceivedInvoiceApiModel |
None. |
Sample:
{
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"PaymentOption": {
"Code": "sample string 1",
"DateLastChange": "2025-11-05T05:54:44.1088283+00:00",
"IsDefault": true,
"IsRounded": true,
"Name": "sample string 5",
"IsAutoPayment": true,
"Id": 7
},
"ReceivedInvoice": {
"AttachmentFileName": "sample string 1",
"CurrencyId": 2,
"DateCreated": "2025-11-05T05:54:44.1088283+00:00",
"DateLastChange": "2025-11-05T05:54:44.1088283+00:00",
"DateOfAccountingEvent": "2025-11-05T05:54:44.1088283+00:00",
"DateOfIssue": "2025-11-05T05:54:44.1088283+00:00",
"DateOfMaturity": "2025-11-05T05:54:44.1088283+00:00",
"DateOfPayment": "2025-11-05T05:54:44.1088283+00:00",
"DateOfReceiving": "2025-11-05T05:54:44.1088283+00:00",
"DateOfTaxing": "2025-11-05T05:54:44.1088283+00:00",
"DateOfVatApplication": "2025-11-05T05:54:44.1088283+00:00",
"Description": "sample string 12",
"DocumentNumber": "sample string 13",
"DocumentSerialNumber": 14,
"ExchangeRate": 15.0,
"ExchangeRateAmount": 16.0,
"Exported": 0,
"IsSentToAccountant": true,
"Items": [
{
"DateCreated": "2025-11-05T05:54:44.1088283+00:00",
"DateLastChange": "2025-11-05T05:54:44.1088283+00:00",
"IsCustomVat": true,
"ItemType": 0,
"Price": 4.0,
"PriceTotalWithoutVat": 5.0,
"PriceTotalWithoutVatHc": 6.0,
"PriceTotalWithVat": 7.0,
"PriceTotalWithVatHc": 8.0,
"PriceUnitHc": 9.0,
"VatRate": 10.0,
"VatTotal": 11.0,
"VatTotalHc": 12.0,
"Amount": 1.0,
"CustomVatRate": 1.0,
"Name": "sample string 13",
"PriceListItemId": 1,
"PriceType": 0,
"Unit": "sample string 14",
"UnitPrice": 1.0,
"VatCodeId": 1,
"VatRateType": 0,
"Id": 15
}
],
"MyCompanyDocumentAddressId": 18,
"Note": "sample string 19",
"OrderNumber": "sample string 20",
"PaymentOptionId": 1,
"PaymentStatus": 0,
"ReceivedDocumentNumber": "sample string 21",
"SupplierDocumentAddressId": 22,
"SupplierId": 23,
"TotalPaid": 24.0,
"TotalPaidHc": 25.0,
"TotalVat": 26.0,
"TotalVatHc": 27.0,
"TotalWithoutVat": 28.0,
"TotalWithoutVatHc": 29.0,
"TotalWithVat": 30.0,
"TotalWithVatHc": 31.0,
"VariableSymbol": "sample string 32",
"VatOnPayStatus": 0,
"VatReverseChargeCodeId": 1,
"IsIncomeTax": true,
"RecountVersion": 0,
"VatRegime": 0,
"Id": 34
},
"CurrencyId": 1,
"DateCreated": "2025-11-05T05:54:44.1088283+00:00",
"DateLastChange": "2025-11-05T05:54:44.1088283+00:00",
"DateOfPayment": "2025-11-05T05:54:44.1088283+00:00",
"DateOfVatApplication": "2025-11-05T05:54:44.1088283+00:00",
"ExchangeRate": 6.0,
"ExchangeRateAmount": 7.0,
"Exported": 0,
"InvoiceId": 8,
"InvoiceDocumentNumber": "sample string 9",
"Partner": "sample string 10",
"PartnerId": 11,
"PaymentAmount": 12.0,
"PaymentAmountHc": 13.0,
"PaymentOptionId": 14,
"Id": 15
}
Sample:
<ReceivedDocumentPaymentApiModelExpand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels">
<Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">15</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>
<DateCreated>2025-11-05T05:54:44.1088283+00:00</DateCreated>
<DateLastChange>2025-11-05T05:54:44.1088283+00:00</DateLastChange>
<DateOfPayment>2025-11-05T05:54:44.1088283+00:00</DateOfPayment>
<DateOfVatApplication>2025-11-05T05:54:44.1088283+00:00</DateOfVatApplication>
<ExchangeRate>6</ExchangeRate>
<ExchangeRateAmount>7</ExchangeRateAmount>
<Exported>0</Exported>
<InvoiceDocumentNumber>sample string 9</InvoiceDocumentNumber>
<InvoiceId>8</InvoiceId>
<Partner>sample string 10</Partner>
<PartnerId>11</PartnerId>
<PaymentAmount>12</PaymentAmount>
<PaymentAmountHc>13</PaymentAmountHc>
<PaymentOptionId>14</PaymentOptionId>
<Currency xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReadOnlyEntites">
<Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">6</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:Code>sample string 1</d2p1:Code>
<d2p1:Country>sample string 2</d2p1:Country>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:Priority>4</d2p1:Priority>
<d2p1:Symbol>sample string 5</d2p1:Symbol>
</Currency>
<PaymentOption xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReadOnlyEntites">
<Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">7</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:Code>sample string 1</d2p1:Code>
<d2p1:DateLastChange>2025-11-05T05:54:44.1088283+00:00</d2p1:DateLastChange>
<d2p1:IsAutoPayment>true</d2p1:IsAutoPayment>
<d2p1:IsDefault>true</d2p1:IsDefault>
<d2p1:IsRounded>true</d2p1:IsRounded>
<d2p1:Name>sample string 5</d2p1:Name>
</PaymentOption>
<ReceivedInvoice xmlns:d2p1="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.ReceivedInvoice">
<Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">34</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:AttachmentFileName>sample string 1</d2p1:AttachmentFileName>
<d2p1:CurrencyId>2</d2p1:CurrencyId>
<d2p1:DateCreated>2025-11-05T05:54:44.1088283+00:00</d2p1:DateCreated>
<d2p1:DateLastChange>2025-11-05T05:54:44.1088283+00:00</d2p1:DateLastChange>
<d2p1:DateOfAccountingEvent>2025-11-05T05:54:44.1088283+00:00</d2p1:DateOfAccountingEvent>
<d2p1:DateOfIssue>2025-11-05T05:54:44.1088283+00:00</d2p1:DateOfIssue>
<d2p1:DateOfMaturity>2025-11-05T05:54:44.1088283+00:00</d2p1:DateOfMaturity>
<d2p1:DateOfPayment>2025-11-05T05:54:44.1088283+00:00</d2p1:DateOfPayment>
<d2p1:DateOfReceiving>2025-11-05T05:54:44.1088283+00:00</d2p1:DateOfReceiving>
<d2p1:DateOfTaxing>2025-11-05T05:54:44.1088283+00:00</d2p1:DateOfTaxing>
<d2p1:DateOfVatApplication>2025-11-05T05:54:44.1088283+00:00</d2p1:DateOfVatApplication>
<d2p1:Description>sample string 12</d2p1:Description>
<d2p1:DocumentNumber>sample string 13</d2p1:DocumentNumber>
<d2p1:DocumentSerialNumber>14</d2p1:DocumentSerialNumber>
<d2p1:ExchangeRate>15</d2p1:ExchangeRate>
<d2p1:ExchangeRateAmount>16</d2p1:ExchangeRateAmount>
<d2p1:Exported>0</d2p1:Exported>
<d2p1:IsIncomeTax>true</d2p1:IsIncomeTax>
<d2p1:IsSentToAccountant>true</d2p1:IsSentToAccountant>
<d2p1:Items>
<d2p1:ReceivedInvoiceItemApiModel>
<Id xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">15</Id>
<Links xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Doklad.Api.ApiModels.BaseModels">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>sample string 1</d5p1:Key>
<d5p1:Value>sample string 2</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Links>
<d2p1:Amount>1</d2p1:Amount>
<d2p1:CustomVatRate>1</d2p1:CustomVatRate>
<d2p1:Name>sample string 13</d2p1:Name>
<d2p1:PriceListItemId>1</d2p1:PriceListItemId>
<d2p1:PriceType>0</d2p1:PriceType>
<d2p1:Unit>sample string 14</d2p1:Unit>
<d2p1:UnitPrice>1</d2p1:UnitPrice>
<d2p1:VatCodeId>1</d2p1:VatCodeId>
<d2p1:VatRateType>0</d2p1:VatRateType>
<d2p1:DateCreated>2025-11-05T05:54:44.1088283+00:00</d2p1:DateCreated>
<d2p1:DateLastChange>2025-11-05T05:54:44.1088283+00:00</d2p1:DateLastChange>
<d2p1:IsCustomVat>true</d2p1:IsCustomVat>
<d2p1:ItemType>0</d2p1:ItemType>
<d2p1:Price>4</d2p1:Price>
<d2p1:PriceTotalWithVat>7</d2p1:PriceTotalWithVat>
<d2p1:PriceTotalWithVatHc>8</d2p1:PriceTotalWithVatHc>
<d2p1:PriceTotalWithoutVat>5</d2p1:PriceTotalWithoutVat>
<d2p1:PriceTotalWithoutVatHc>6</d2p1:PriceTotalWithoutVatHc>
<d2p1:PriceUnitHc>9</d2p1:PriceUnitHc>
<d2p1:VatRate>10</d2p1:VatRate>
<d2p1:VatTotal>11</d2p1:VatTotal>
<d2p1:VatTotalHc>12</d2p1:VatTotalHc>
</d2p1:ReceivedInvoiceItemApiModel>
</d2p1:Items>
<d2p1:MyCompanyDocumentAddressId>18</d2p1:MyCompanyDocumentAddressId>
<d2p1:Note>sample string 19</d2p1:Note>
<d2p1:OrderNumber>sample string 20</d2p1:OrderNumber>
<d2p1:PaymentOptionId>1</d2p1:PaymentOptionId>
<d2p1:PaymentStatus>0</d2p1:PaymentStatus>
<d2p1:ReceivedDocumentNumber>sample string 21</d2p1:ReceivedDocumentNumber>
<d2p1:RecountVersion>None</d2p1:RecountVersion>
<d2p1:SupplierDocumentAddressId>22</d2p1:SupplierDocumentAddressId>
<d2p1:SupplierId>23</d2p1:SupplierId>
<d2p1:TotalPaid>24</d2p1:TotalPaid>
<d2p1:TotalPaidHc>25</d2p1:TotalPaidHc>
<d2p1:TotalVat>26</d2p1:TotalVat>
<d2p1:TotalVatHc>27</d2p1:TotalVatHc>
<d2p1:TotalWithVat>30</d2p1:TotalWithVat>
<d2p1:TotalWithVatHc>31</d2p1:TotalWithVatHc>
<d2p1:TotalWithoutVat>28</d2p1:TotalWithoutVat>
<d2p1:TotalWithoutVatHc>29</d2p1:TotalWithoutVatHc>
<d2p1:VariableSymbol>sample string 32</d2p1:VariableSymbol>
<d2p1:VatOnPayStatus>0</d2p1:VatOnPayStatus>
<d2p1:VatRegime>NonVatRegime</d2p1:VatRegime>
<d2p1:VatReverseChargeCodeId>1</d2p1:VatReverseChargeCodeId>
</ReceivedInvoice>
</ReceivedDocumentPaymentApiModelExpand>