GET api/Inventory/Head/{headId}
Get a single inventory basis head
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| headId |
The ID of the wanted inventory basis head |
globally unique identifier |
Required |
Body Parameters
None.
Remarks
None.
Example
None.
Response Information
Resource Description
The data of the relevant inventory basis head
InventoryBasisHead| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Unique ID for a given inventory basis |
globally unique identifier |
Required |
| BranchId |
ID of associated branch |
integer |
Required |
| BranchName |
Name of associated branch |
string |
Required Max length: 80 |
| StartDate |
Optional start date of the inventory basis |
date |
None. |
| Description |
Description of the associated inventory basis head |
string |
Max length: 80 |
| StockId |
The stock ID of the inventory |
globally unique identifier |
None. |
| StockName |
The name of the associated stock |
string |
Max length: 50 |
| ArticleNoFrom | integer |
None. |
|
| ArticleNoTo | integer |
None. |
|
| MainGroupIdFrom | integer |
None. |
|
| MainGroupIdTo | integer |
None. |
|
| SubGroupIdFrom | integer |
None. |
|
| SubGroupIdTo | integer |
None. |
|
| LeaveArticlesInventoriedFromDate | date |
None. |
|
| LeaveArticlesInventoriedToDate | date |
None. |
|
| SortOrder | integer |
None. |
|
| SortOrderName | string |
Max length: 50 |
|
| GroupByMainGroup | boolean |
Required |
|
| GroupBySubGroup | boolean |
Required |
|
| UseOnlyArticlesInStock | boolean |
Required |
|
| InventoryNumber | integer |
Required |
|
| ShowReservations | boolean |
Required |
|
| ShowQuantity | boolean |
Required |
|
| ShowPalletPlace | boolean |
Required |
|
| LineCount |
Number of inventory basis lines associated with the given head |
integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "d646133e-bc5f-4385-b5c9-cb8a5a9bea9e",
"BranchId": 2,
"BranchName": "sample string 3",
"StartDate": "12/21/2025 1:08:58 PM",
"Description": "sample string 4",
"StockId": "d2264956-1028-43d3-9484-b3be7b312878",
"StockName": "sample string 5",
"ArticleNoFrom": 1,
"ArticleNoTo": 1,
"MainGroupIdFrom": 1,
"MainGroupIdTo": 1,
"SubGroupIdFrom": 1,
"SubGroupIdTo": 1,
"LeaveArticlesInventoriedFromDate": "12/21/2025 1:08:58 PM",
"LeaveArticlesInventoriedToDate": "12/21/2025 1:08:58 PM",
"SortOrder": 1,
"SortOrderName": "sample string 6",
"GroupByMainGroup": true,
"GroupBySubGroup": true,
"UseOnlyArticlesInStock": true,
"InventoryNumber": 10,
"ShowReservations": true,
"ShowQuantity": true,
"ShowPalletPlace": true,
"LineCount": 14
}
application/xml, text/xml
Sample:
<InventoryBasisHead xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Stock"> <ArticleNoFrom>1</ArticleNoFrom> <ArticleNoTo>1</ArticleNoTo> <BranchId>2</BranchId> <BranchName>sample string 3</BranchName> <Description>sample string 4</Description> <GroupByMainGroup>true</GroupByMainGroup> <GroupBySubGroup>true</GroupBySubGroup> <Id>d646133e-bc5f-4385-b5c9-cb8a5a9bea9e</Id> <InventoryNumber>10</InventoryNumber> <LeaveArticlesInventoriedFromDate>2025-12-21T13:08:58.0939648+00:00</LeaveArticlesInventoriedFromDate> <LeaveArticlesInventoriedToDate>2025-12-21T13:08:58.0939648+00:00</LeaveArticlesInventoriedToDate> <LineCount>14</LineCount> <MainGroupIdFrom>1</MainGroupIdFrom> <MainGroupIdTo>1</MainGroupIdTo> <ShowPalletPlace>true</ShowPalletPlace> <ShowQuantity>true</ShowQuantity> <ShowReservations>true</ShowReservations> <SortOrder>1</SortOrder> <SortOrderName>sample string 6</SortOrderName> <StartDate>2025-12-21T13:08:58.0939648+00:00</StartDate> <StockId>d2264956-1028-43d3-9484-b3be7b312878</StockId> <StockName>sample string 5</StockName> <SubGroupIdFrom>1</SubGroupIdFrom> <SubGroupIdTo>1</SubGroupIdTo> <UseOnlyArticlesInStock>true</UseOnlyArticlesInStock> </InventoryBasisHead>
