Request Information
Method returns price list item by its Id with extended entities.
Example URL:
v2.0/PriceListItems/{id}/Expand
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Price list item Id |
integer |
Required |
| id |
Price list item Id |
integer |
Required |
None.
Response Information
PriceListApiModelExpand
| Name | Description | Type | Additional information |
|---|---|---|---|
| Amount |
Sales amount |
decimal number |
None. |
| BarCode |
Price list item BarCode |
string |
Length: between 0 and 20 inclusive |
| Code |
Price list item code |
string |
Length: between 0 and 20 inclusive |
| Currency | CurrencyApiModel |
None. |
|
| CurrencyId |
Currency id |
integer |
None. |
| DateLastChange | date |
Readonly |
|
| HasStockMovement |
Determines whether the item has stock enabled, not whether it has stock movements |
boolean |
None. |
| Id |
Resource identifier |
integer |
Readonly |
| InitialDateStockBalance |
Date of the initial stock movement |
date |
None. |
| InitialStockBalance |
Initial stock balance |
decimal number |
None. |
| Name |
Item name |
string |
Required Length: between 0 and 200 inclusive |
| Note |
Note for stock movement |
string |
Length: between 0 and 100 inclusive |
| Price |
Unit price |
decimal number |
None. |
| PriceType |
Price type |
PriceType |
None. |
| StockBalance |
Current stock balance |
decimal number |
Readonly |
| Unit |
Unit of measure |
string |
Length: between 0 and 20 inclusive |
| VatCodeId |
Vat code id |
integer |
None. |
| VatRateType |
Vat rate type |
VatRateType |
None. |
Sample:
{
"Currency": {
"Code": "sample string 1",
"Country": "sample string 2",
"Name": "sample string 3",
"Priority": 4,
"Symbol": "sample string 5",
"Id": 6
},
"Amount": 1.0,
"BarCode": "sample string 1",
"Code": "sample string 2",
"CurrencyId": 1,
"DateLastChange": "2025-11-01T16:03:18.3436769+00:00",
"HasStockMovement": true,
"InitialDateStockBalance": "2025-11-01T16:03:18.3436769+00:00",
"InitialStockBalance": 5.0,
"Name": "sample string 6",
"Note": "sample string 7",
"Price": 1.0,
"PriceType": 0,
"StockBalance": 8.0,
"Unit": "sample string 9",
"VatCodeId": 1,
"VatRateType": 0,
"Id": 10
}
Sample:
<PriceListApiModelExpand 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">10</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>
<Amount>1</Amount>
<BarCode>sample string 1</BarCode>
<Code>sample string 2</Code>
<CurrencyId>1</CurrencyId>
<DateLastChange>2025-11-01T16:03:18.3436769+00:00</DateLastChange>
<HasStockMovement>true</HasStockMovement>
<InitialDateStockBalance>2025-11-01T16:03:18.3436769+00:00</InitialDateStockBalance>
<InitialStockBalance>5</InitialStockBalance>
<Name>sample string 6</Name>
<Note>sample string 7</Note>
<Price>1</Price>
<PriceType>0</PriceType>
<StockBalance>8</StockBalance>
<Unit>sample string 9</Unit>
<VatCodeId>1</VatCodeId>
<VatRateType>0</VatRateType>
<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>
</PriceListApiModelExpand>