Skip to main content

Inventory Count Item

The Inventory Count Item API allows the user to request lists of inventory count items.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoint

GET /inventory-count-item

Summary

Get the inventory count item list.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
query	`$filter`	string	No	A filter expression in OData v4 format
query	`$top`	integer	No	The maximum documents to return. For example, if `top` is 100, and `skip` is 0, the system returns documents 1 to 100.
query	`$skip`	integer	No	The documents to skip before returning. For example, if `top` is 100, and `skip` is 100, the system returns documents 101 to 200.
query	`$select`	string	No
query	`$orderby`	string	No	An order by expression in OData v4 format

Responses

Code	Description	Schema
200	Success	inventory_count_item_get_response
400	Bad request, for more information look at body error
401	Unauthorized error
403	Forbidden error
404	Not Found
422	Unprocessable error
500	Internal Server Error

Data Models

inventory_count_item_get_response

Field Name	Type	Description
`items`	inventory_count_item_get_response_items
`total`	number
`page_count`	number
`current_page`	number
`page_size`	number

inventory_count_item_get_response_items

Field Name	Type	Description
`_id`	string
`entity_id`	string	The inventory count entity identifier (ID)
`site_id`	string	The inventory count site ID
`inventory_count_entity_id`	string
`inventory_item_entity_id`	string
`name`	string	The inventory count site name
`description`	string	The inventory item description
`count`	number	The total count
`system_count`	number	A quantity on hand (QOH) snapshot of the inventory item at the inventory count site
`variance_count`	number	The difference between the number of the total count and the QOH
`variance_cost`	number	The difference between the total cost of the total count and the QOH
`counts`	inventory_count_item_get_response_items_counts
`reporting_category_major`	inventory_count_item_get_response_items_reporting_category_major
`reporting_category_minor`	inventory_count_item_get_response_items_reporting_category_minor

inventory_count_item_get_response_items_counts

Field Name	Type	Description
`measure_description`	string	The measure description
`measure_entity_id`	string	The measure entity identifier (ID)
`count`	number	The quantity filled by the user on user interface (UI) page. The default is null.
`factor_value`	number	The factor value of this measure

inventory_count_item_get_response_items_reporting_category_major

Field Name	Type	Description
`name`	string	The reporting major category name
`external_category_id`	string
`entity_id`	string

inventory_count_item_get_response_items_reporting_category_minor

Field Name	Type	Description
`name`	string	The reporting minor category name
`external_category_id`	string
`entity_id`	string

See also: