Stand Worksheet Item

The Stand Worksheet Item API allows the user to access a list of stand worksheet items.

Security

apiKey	API Key
Name	Authorization
In	header

Endpoints

GET /stand-worksheet-item/schema

Summary

The schema of the stand worksheet item.

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	stand_work_sheet_item_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 /stand-worksheet-item

Summary

Get the stand worksheet 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	stand_work_sheet_item_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

Data Models

stand_work_sheet_item_get_response_1

Field Name	Type	Description
`stand_work_sheet_item_get_response_1`	object	The definition of stand worksheet item schema

stand_work_sheet_item_get_response_2

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

stand_work_sheet_item_get_response_2_items

Field Name	Type	Required	Description
`_id`	string	Yes	`objectId`, the stand worksheet item's identifier (ID)
`transaction_id`	string	Yes
`entity_id`	string	Yes	The stand worksheet item entity ID
`event_id`	string	Yes	`objectId`, the event's ID
`site_id`	string	Yes	`objectId`, the site's ID
`inventory_item_entity_id`	string	Yes	`objectId`, the inventory item venue's ID
`stand_work_sheet_entity_id`	string	Yes	`objectId`, the stand worksheet's ID
`status`	string	Yes	The stand worksheet status
`begin`	number	Yes	Begin count
`manager_begin`	number	Yes	Manager begin count
`pre_event_in`	number	Yes	The pre-event count of transfer in
`pre_event_out`	number	Yes	The pre-event count of transfer out
`during_event_in`	number	Yes	During event transfer in count
`during_event_out`	number	Yes	During event transfer out count
`gratis`	number	Yes	The gratis
`gratis_post_closure`	number	Yes	The gratis after the event
`ingredient_spoil`	number	Yes	The ingredient spoil
`ingredient_spoil_post_closure`	number	Yes	The ingredient spoil after the event
`voided_post_payment`	number	Yes	The voided post payment
`voided_post_payment_post_closure`	number	Yes	The voided post payment after the event
`price`	number	Yes	The terminal dollars from the item
`price_post_closure`	number	Yes	The terminal dollars after the event
`discount`	number	Yes
`discount_post_closure`	number	Yes	The discount after the event
`tax`	number	Yes
`tax_post_closure`	number	Yes	Tax after the event
`refund`	number	Yes
`refund_post_closure`	number	Yes	Refund after the event
`refund_discount`	number	Yes	Discount by refund order
`refund_discount_post_closure`	number	Yes	Discount by refund order after the event
`end_count_date`	date/time	Yes
`adjustment`	number	Yes	The adjustment
`end`	number	Yes	The manual end count
`sales_post_closure`	number	No	The sales post closure
`sales`	number	No	The sales count
`created_during`	string	Yes	Created during
`is_active`	boolean	Yes
`inventory_item_name`	string	No	The inventory item's name
`inventory_item_code`	string	No	The inventory item's code
`is_chargeable`	boolean	No	The inventory item is chargeable or non-chargeable
`product_name`	string	No	The parent product's name
`product_id`	string	No	`objectId`, the parent product's ID
`product_price`	number	No	The parent product price
`base_unit_price`	number	No	Equals `product_price`/ (parent product linked recipe measure's `factor_value` * quantity)
`system_count`	number	No	The system count