Stand Worksheet
The Stand Worksheet API pulls data from the Portal, Data Management, and Venue Inventory to show a list of existing of inventory items before an event, after an event, and after transferring items between kiosks. This data includes, but is not limited to Event, Site, Recipe, and Inventory information.
Security
jwt-bearer-token
apiKey | API Key |
|---|---|
Name | Authorization |
In | header |
Endpoints
GET /stand-worksheet/schema
Summary
Stand worksheet schema.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
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/event-status-change-ability
Summary
Check that the stand worksheet event status can be changed.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
query |
| string | Yes | The event ID |
query |
| string | Yes | The event status |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
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/{id}
Summary
Get the stand worksheet detail.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
path |
| string | Yes | Stand work sheet's document |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
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 /stand-worksheet/{id}
Summary
Update the stand worksheet.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
path |
| string | Yes |
|
body |
| 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 |
PATCH /stand-worksheet/bulk-update-phy-diff
Summary
Bulk update for the stand worksheet diff_physical_terminal.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
body |
| 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 /stand-worksheet
Summary
Get the stand worksheet list.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
query |
| string | No | A filter expression in OData v4 format |
query |
| integer | No | The maximum documents to return. For example, if |
query |
| integer | No | The documents to skip before returning. For example, if |
query |
| string | No | |
query |
| string | No | An order by expression in OData v4 format |
Responses
Code | Description | Schema |
|---|---|---|
200 | Success | |
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 /stand-worksheet
Summary
Create the stand worksheet for the sites.
Request Parameters
In | Field Name | Type | Required | Description |
|---|---|---|---|---|
header |
| string | Yes | The identifier (ID) of the company that owns the document |
body |
| Yes | The JSON formatted request |
Responses
Code | Description | Schema |
|---|---|---|
201 | Success | |
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_get_response_1
Field Name | Type | Description |
|---|---|---|
| object | The definition of the stand worksheet schema |
stand_work_sheet_post_response_2
Field Name | Type | Description |
|---|---|---|
| boolean | The flag which indicates if there is not an open pre event transfer |
| boolean | The flag which indicates if all stand worksheets are approved |
| boolean | The flag which indicates if there is not a pending pre event transfer |
stand_work_sheet_get_response_3
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes |
|
| string | Yes |
|
| string | No |
|
| string | Yes |
|
| string | Yes | The stand worksheet entity ID |
| string | No | The site's name |
| string | No | The site ID |
| string | No | The stand worksheet status |
| number | Yes | The cash count |
| number | Yes | Other fees |
| number | No | The other fees generated after the event |
| number | No | The unlinked recipe price |
| number | No | The unlinked recipe price after the event |
| number | No | The discount for unlinked recipe after closing the event |
| number | No | The discount for unlinked recipe |
| number | No | The tax for unlinked recipe |
| number | No | The tax for unlinked recipe after closing the event |
| No | ||
| boolean | Yes | The validity indicator field. When set to |
| string | Yes | The event name |
| date/time | Yes | |
| date/time | Yes | |
| string | No | The stand work sheet formula version |
| No | The status changed history |
stand_work_sheet_get_response_3_payments
Field Name | Type | Description |
|---|---|---|
| number | The amount of payment tips |
| number | The amount of payment tips after the event |
| number | The amount paid by credit card |
| number | The amount paid by credit card after the event |
| number | The amount paid by debit card |
| number | The amount paid by debit card after the event |
| number | The amount paid in cash |
| number | The amount paid in cash after the event |
| number | The amount paid by gift card |
| number | The amount paid by gift card after the event |
| number | The amount paid by custom approach |
| number | The amount paid by custom approach after the event |
| number | The tax amount |
| number | Tax after the event |
stand_work_sheet_get_response_3_status_history
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | The value of the status before this change |
| string | Yes | The status after this change |
| string | Yes | The comment about this status change |
| string | Yes | The user who updated the status |
| string | Yes | The time the status was updated |
stand_work_sheet_patch_body_4
Field Name | Type | Description |
|---|---|---|
| string | The stand worksheet status |
| number | The cash count |
|
stand_work_sheet_patch_body_4_item
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes |
|
| number | Yes | The |
| number | Yes | The |
stand_work_sheet_patch_body_4_items
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes |
|
| string | No |
|
| boolean | No | The inventory item is chargeable or non-chargeable |
| number | No | Manager begin count |
| number | No | The gratis |
| number | No | The ingredient spoil |
| number | No | The adjustment |
| number | No | The manual end count |
stand_work_sheet_get_response_5
Field Name | Type | Description |
|---|---|---|
| ||
| number | |
| number | |
| number | |
| number |
stand_work_sheet_get_response_5_items
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes |
|
| string | Yes |
|
| string | No |
|
| string | Yes |
|
| string | Yes | The stand worksheet entity ID |
| string | No | The site's name |
| string | No | The site ID |
| string | No | The stand worksheet status |
| number | Yes | The cash count |
| number | Yes | Other fees |
| number | No | The other fees generated after the event |
| number | No | The unlinked recipe price |
| number | No | The unlinked recipe price after the event |
| number | No | The discount for unlinked recipe after closing the event |
| number | No | The discount for unlinked recipe |
| number | No | The tax for unlinked recipe |
| number | No | The tax for unlinked recipe after closing the event |
| No | ||
| boolean | Yes | The validity indicator field. When set to |
| string | Yes | The event name |
| date/time | Yes | |
| date/time | Yes | |
| string | No | The stand work sheet formula version |
| No | The status changed history |
stand_work_sheet_get_response_5_items_payments
Field Name | Type | Description |
|---|---|---|
| number | The amount of payment tips |
| number | The amount of payment tips after the event |
| number | The amount paid by credit card |
| number | The amount paid by credit card after the event |
| number | The amount paid by debit card |
| number | The amount paid by debit card after the event |
| number | The amount paid in cash |
| number | The amount paid in cash after the event |
| number | The amount paid by gift card |
| number | The amount paid by gift card after the event |
| number | The amount paid by custom approach |
| number | The amount paid by custom approach after the event |
| number | The tax amount |
| number | Tax after the event |
stand_work_sheet_get_response_5_items_status_history
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | |
| string | Yes | |
| string | Yes | |
| string | Yes | |
| string | Yes |
stand_work_sheet_post_body_7
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | The event identifier (ID) |
| [string] | Yes | The site ID list |
stand_work_sheet_post_response_7_item
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes |
|
| string | Yes |
|
| string | No |
|
| string | Yes |
|
| string | Yes | The stand worksheet entity ID |
| string | No | The site's name |
| string | No | The site ID |
| string | No | The stand worksheet status |
| number | Yes | The cash count |
| number | Yes | Other fees |
| number | No | The other fees generated after the event |
| number | No | The unlinked recipe price |
| number | No | The unlinked recipe price after the event |
| number | No | The discount for unlinked recipe after closing the event |
| number | No | The discount for unlinked recipe |
| number | No | The tax for unlinked recipe |
| number | No | The tax for unlinked recipe after closing the event |
| No | ||
| boolean | Yes | The validity indicator field. When set to |
| string | Yes | The event name |
| date/time | Yes | |
| date/time | Yes | |
| string | No | The stand work sheet formula version |
| No |
stand_work_sheet_post_response_7_item_payments
Field Name | Type | Description |
|---|---|---|
| number | The amount of payment tips |
| number | The amount of payment tips after the event |
| number | The amount paid by credit card |
| number | The amount paid by credit card after the event |
| number | The amount paid by debit card |
| number | The amount paid by debit card after the event |
| number | The amount paid in cash |
| number | The amount paid in cash after the event |
| number | The amount paid by gift card |
| number | The amount paid by gift card after the event |
| number | The amount paid by custom approach |
| number | The amount paid by custom approach after the event |
| number | The tax amount |
| number | Tax after the event |
stand_work_sheet_post_response_7_item_status_history
Field Name | Type | Required | Description |
|---|---|---|---|
| string | Yes | |
| string | Yes | |
| string | Yes | |
| string | Yes | |
| string | Yes |