Inventory Count

The Inventory Count API allows the user to count the inventory items for each site. It pulls and shares data with our other cloud services such as Data Management and the Portal.

Security

jwt-bearer-token

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /inventory-count/schema

Summary

Inventory count schema.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document

Responses

Code	Description	Schema
200	Success	inventory_count_get_response_1
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

GET /inventory-count/{id}

Summary

Get the inventory count document identifier from the database.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
path	`id`	string	Yes	`objectId`, the inventory count group's ID
query	`$include_calculated_values`	string	No
query	`$include_items`	string	No

Responses

Code	Description	Schema
200	Success	inventory_count_get_response_2
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

PATCH /inventory-count/{id}

Summary

Update the inventory count document identifier.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
path	`id`	string	Yes	`objectId`, the inventory count group's ID
body	`body`	inventory_count_patch_body_7	Yes	The JSON formatted request

Responses

Code	Description	Schema
204	No content
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

GET /inventory-count

Summary

Get an inventory count 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
query	`$include_calculated_values`	string	No
query	`$include_items`	string	No

Responses

Code	Description	Schema
200	Success	inventory_count_get_response_3
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

POST /inventory-count

Summary

Create the inventory count.

Request Parameters

In	Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
body	`body`	inventory_count_post_body_4	Yes	The JSON formatted request

Responses

Code	Description	Schema
201	Success	inventory_count_post_response_4
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

PATCH /inventory-count/bulk-change-status

Summary

Update a bulk change to the status of the given inventory count.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
body	`body`	inventory_count_patch_body_5	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	inventory_count_patch_response_5
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

PATCH /inventory-count/dm-sync

Summary

Check inventory items for changes.

Request Parameters

In	Field Name	Type	Required	Description
header	`X-COMPANY-ID`	string	Yes	The identifier (ID) of the company that owns the document
body	`body`	inventory_count_patch_body_6	Yes	The JSON formatted request

Responses

Code	Description	Schema
200	Success	inventory_count_patch_response_6
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_get_response_1

Field Name	Type	Description
`inventory_count_get_response_1`	object	The inventory count schema definition

inventory_count_get_response_2

Field Name	Type	Description
`_id`	string
`name`	string
`date`	string
`start_date`	string
`status`	string
`entity_id`	string
`inventory_count_group_entity_id`	string
`site_id`	string
`is_active`	boolean
`counted_value`	number
`variance_total`	number
`inventory_count_items`	[string]
`company_id`	string
`created_at`	date/time
`created_by`	string
`updated_at`	date/time
`updated_by`	string

inventory_count_get_response_3

Field Name	Type	Description
`items`	[ inventory_count_get_response_3_items ]
`total`	number
`page_count`	number
`current_page`	number
`page_size`	number

inventory_count_get_response_3_items

Field Name	Type	Description
`_id`	string
`name`	string
`date`	string
`start_date`	string
`status`	string
`entity_id`	string
`site_id`	string
`is_active`	boolean
`counted_value`	number
`variance_total`	number
`inventory_count_group_entity_id`	string
`inventory_count_items`	[string]
`company_id`	string
`created_at`	date/time
`created_by`	string
`updated_at`	date/time
`updated_by`	string

inventory_count_post_body_4

Field Name	Type	Required
`name`	string	Yes
`date`	date/time	Yes
`start_date`	date/time	Yes
`status`	string	Yes
`entity_id`	string	Yes
`inventory_count_group_entity_id`	string	Yes
`site_id`	string	Yes
`counted_value`	number	Yes
`variance_total`	number	Yes
`inventory_count_items`	[ inventory_count_post_body_4_inventory_count_items ]	No

inventory_count_post_body_4_inventory_count_items

Field Name	Type	Required
`entity_id`	string	Yes
`site_id`	string	Yes
`inventory_count_entity_id`	string	Yes
`inventory_item_entity_id`	string	Yes
`name`	string	Yes
`description`	string	No
`count`	number	Yes
`system_count`	number	Yes
`variance_count`	number	Yes
`cost`	number	Yes
`variance_cost`	number	Yes
`counts`	[inventory_count_post_body_4_inventory_count_items_counts]	No
`reporting_category_major`	inventory_count_patch_body_4_inventory_count_items_reporting_major	Yes
`reporting_category_minor`	inventory_count_patch_body_4_inventory_count_items_reporting_minor	Yes

inventory_count_post_body_4_inventory_count_items_counts

Field Name	Type	Required
`measure_description`	string	Yes
`measure_entity_id`	string	Yes
`count`	number	Yes
`factor_value`	number	Yes

inventory_count_post_body_4_inventory_count_items_reporting_category_major

Field Name	Type	Required
`name`	string	No
`external_category_id`	string	No
`entity_id`	string	Yes

inventory_count_post_body_4_inventory_count_items_reporting_category_minor

Field Name	Type	Required
`name`	string	No
`external_category_id`	string	No
`entity_id`	string	Yes

inventory_count_post_response_4

Field Name	Type	Description
`_id`	string
`acknowledged`	boolean

inventory_count_patch_body_5

Field Name	Type	Required	Description
`inventory_count_ids`	[string]	Yes	A list of the inventory count identifiers (IDs)
`to_status`	string	Yes	The `to_status` to change. Enum: `closed`
`is_sync`	boolean	Yes	The flag that indicates whether to return results synchronously

Field Name

Type

Required

Description

inventory_count_ids

[string]

Yes

A list of the inventory count identifiers (IDs)

to_status

string

Yes

The to_status to change.

Enum: closed

is_sync

boolean

Yes

The flag that indicates whether to return results synchronously

inventory_count_patch_response_5

Field Name	Type	Required	Description
`_id`	string	Yes	`objectId`, the task's identifier (ID)
`company_id`	string	Yes	`objectId`, the company's ID
`type`	string	Yes	The task type of inventory-count-bulk-change-status
`status`	string	Yes	The task status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	No	The error message if the task fails
`sub_tasks`	inventory_count_patch_response_5_sub_tasks	No
`created_at`	date/time	No
`updated_at`	date/time	No

inventory_count_patch_response_5_sub_tasks

Field Name	Type	Required	Description
`_id`	string	Yes	`objectId`, the task's identifier (ID)
`company_id`	string	Yes	`objectId`, the company's ID
`type`	string	Yes	The task type
`status`	string	Yes	The task status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	No	The error message if the task fails
`value`	inventory_count_patch_response_5_sub_tasks_value	No
`created_at`	date/time	Yes
`updated_at`	date/time	Yes

inventory_count_patch_response_5_sub_tasks_value

Field Name	Type	Description
`inventory_count_id`	string	The transfer document identifier (ID)
`inventory_count_status`	string	The transfer status after task execution

inventory_count_patch_body_6

Field Name	Type	Required	Description
`inventory_count_ids`	[string]	Yes	A list of transfer identifiers (IDs)
`is_sync`	boolean	Yes	The flag that indicates whether to return results synchronously

inventory_count_patch_response_6

Field Name	Type	Required	Description
`_id`	string	Yes	`objectId`, the task's identifier (ID)
`company_id`	string	Yes	`objectId`, the company's ID
`type`	string	Yes	The inventory-count-dm task type
`status`	string	Yes	The status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	No	The error message if the task fails
`sub_tasks`	inventory_count_patch_response_6_sub_tasks	No
`created_at`	date/time	No
`updated_at`	date/time	No

inventory_count_patch_response_6_sub_tasks

Field Name	Type	Required	Description
`_id`	string	Yes	`objectId`, the task's identifier (ID)
`company_id`	string	Yes	`objectId`, the company's ID
`type`	string	Yes	The task type
`status`	string	Yes	The task status including `pending`, `running`, `failed`, and `completed`
`error_message`	string	No	The error message if the task fails
`value`	inventory_count_patch_response_6_sub_tasks_value	Yes
`created_at`	date/time	Yes
`updated_at`	date/time	Yes

inventory_count_patch_response_6_sub_tasks_value

Field Name	Type	Required	Description
`inventory_count_id`	string	Yes	The transfer document identifier (ID)
`inventory_count_status`	string	Yes	The inventory count status after task execution

inventory_count_patch_body_7

Field Name	Type	Description
`name`	string
`date`	string
`start_date`	string
`status`	string
`entity_id`	string
`inventory_count_group_entity_id`	string
`site_id`	string
`counted_value`	number
`variance_total`	number
`inventory_count_items`	[inventory_count_patch_body_7_inventory_count_items]

inventory_count_patch_body_7_inventory_count_items

Field Name	Type	Description
`entity_id`	string
`site_id`	string
`inventory_count_entity_id`	string
`inventory_item_entity_id`	string
`name`	string
`description`	string
`count`	number
`system_count`	number
`variance_count`	number
`cost`	number
`variance_cost`	number
`counts`	[inventory_count_patch_body_7_inventory_count_items_counts]
`reporting_category_major`	inventory_count_patch_body_7_inventory_count_items_reporting_category_major
`reporting_category_minor`	inventory_count_patch_body_7_inventory_count_items_reporting_category_minor

inventory_count_patch_body_7_inventory_count_items_counts

Field Name	Type	Description
`measure_description`	string
`measure_entity_id`	string
`count`	number
`factor_value`	number

inventory_count_patch_body_7_inventory_count_items_reporting_category_major

Field Name	Type	Description
`name`	string
`external_category_id`	string
`entity_id`	string

inventory_count_patch_body_7_inventory_count_items_reporting_category_minor

Field Name	Type	Description
`name`	string
`external_category_id`	string
`entity_id`	string

Inventory Count

Security

Endpoints

GET /inventory-count/schema

GET /inventory-count/{id}

PATCH /inventory-count/{id}

GET /inventory-count

POST /inventory-count

PATCH /inventory-count/bulk-change-status

PATCH /inventory-count/dm-sync

Data Models

inventory_count_get_response_1

inventory_count_get_response_2

inventory_count_get_response_3

inventory_count_get_response_3_items

inventory_count_post_body_4

inventory_count_post_body_4_inventory_count_items

inventory_count_post_body_4_inventory_count_items_counts

inventory_count_post_body_4_inventory_count_items_reporting_category_major

inventory_count_post_body_4_inventory_count_items_reporting_category_minor

inventory_count_post_response_4

inventory_count_patch_body_5

inventory_count_patch_response_5

inventory_count_patch_response_5_sub_tasks

inventory_count_patch_response_5_sub_tasks_value

inventory_count_patch_body_6

inventory_count_patch_response_6

inventory_count_patch_response_6_sub_tasks

inventory_count_patch_response_6_sub_tasks_value

inventory_count_patch_body_7

inventory_count_patch_body_7_inventory_count_items

inventory_count_patch_body_7_inventory_count_items_counts

inventory_count_patch_body_7_inventory_count_items_reporting_category_major

inventory_count_patch_body_7_inventory_count_items_reporting_category_minor

Search results