# Till

Till

## List tills

> Lists all tills.

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"}},"schemas":{"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"},"TillResponseSchema":{"title":"TillResponseSchema","type":"object","required":["cashDrawer","createdAt","lastModifiedAt","lastOrderUid","lastOrderNumber","name","paymentTerminal","settings","tillUid","tillNumber","device"],"properties":{"barcodePrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"cashDrawer":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"deviceIdentifier":{"type":"string","deprecated":true,"nullable":true},"lastModifiedAt":{"format":"date-time","type":"string"},"lastOrderUid":{"$ref":"#/components/schemas/UID"},"lastOrderNumber":{"type":"string"},"name":{"type":"string"},"paymentTerminal":{"$ref":"#/components/schemas/TillPaymentTerminalENUM"},"receiptPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"regularPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/TillSettingSchema"}},"tillUid":{"$ref":"#/components/schemas/UID"},"tillNumber":{"type":"integer"},"appSettings":{"$ref":"#/components/schemas/TillAppSettingsSchema"},"device":{"$ref":"#/components/schemas/TillDeviceResponseSchema"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillPaymentTerminalENUM":{"enum":["NONE","ADYEN","PAYEX","STRIPE","NETS","VERIFONE","SOFTPAY"],"title":"TillPaymentTerminalENUM","type":"string"},"TillSettingSchema":{"description":"Till specific settings","properties":{"key":{"$ref":"#/components/schemas/TillSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"TillSettingSchema","type":"object"},"TillSettingKeyENUM":{"enum":["STRIPE_TERMINAL_ID","ADYEN_POS_TERMINAL_ID","PAYEX_TERMINAL_IP","PAYEX_TERMINAL_PORT","PAYEX_COMMAND_QUEUE","NETS_TERMINAL_ID","VERIFONE_TERMINAL_POI_ID","SOFTPAY_APP_ID"],"title":"TillSettingKeyENUM","type":"string"},"TillAppSettingsSchema":{"title":"TillAppSettingsSchema","type":"object","description":"Application specific settings\nNOTE: This field is deprecated. Settings should be set on the device","deprecated":true,"required":["saleStopAtDelivery","autoLogout","touchMode"],"properties":{"saleStopAtDelivery":{"type":"boolean","description":"Stop in the delivery field for each product line during sale"},"autoLogout":{"type":"integer","description":"time in seconds, 0 = disabled, -1 = inherited from tenant"},"touchMode":{"$ref":"#/components/schemas/TillTouchModeENUM"}}},"TillTouchModeENUM":{"title":"TillTouchModeENUM","type":"string","enum":["UNAVAILABLE","ALWAYS","OPTIONAL_ON","OPTIONAL_OFF"]},"TillDeviceResponseSchema":{"title":"TillDeviceResponseSchema","type":"object","nullable":true,"required":["deviceUid","identifier","name"],"properties":{"deviceUid":{"$ref":"#/components/schemas/UID"},"identifier":{"type":"string"},"name":{"type":"string"}}},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"}},"responses":{"TillListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TillResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills":{"get":{"description":"Lists all tills.","operationId":"get-tenants-stores-tills","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/TillListResponse"}},"summary":"List tills","tags":["Till"]}}}}
```

## Create a new till

> Creates a new till.\
> \
> Required permissions: TILL

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"TillCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillCreateSchema"}}}}},"schemas":{"TillCreateSchema":{"description":"Create a new till","title":"TillCreateSchema","type":"object","required":["name","tillNumber"],"properties":{"barcodePrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"cashDrawer":{"type":"string"},"name":{"type":"string"},"paymentTerminal":{"$ref":"#/components/schemas/TillPaymentTerminalENUM"},"receiptPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"regularPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/TillSettingSchema"}},"tillNumber":{"type":"integer"},"tillUid":{"$ref":"#/components/schemas/UID"},"appSettings":{"$ref":"#/components/schemas/TillAppSettingsUpdateSchema"}}},"TillPaymentTerminalENUM":{"enum":["NONE","ADYEN","PAYEX","STRIPE","NETS","VERIFONE","SOFTPAY"],"title":"TillPaymentTerminalENUM","type":"string"},"TillSettingSchema":{"description":"Till specific settings","properties":{"key":{"$ref":"#/components/schemas/TillSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"TillSettingSchema","type":"object"},"TillSettingKeyENUM":{"enum":["STRIPE_TERMINAL_ID","ADYEN_POS_TERMINAL_ID","PAYEX_TERMINAL_IP","PAYEX_TERMINAL_PORT","PAYEX_COMMAND_QUEUE","NETS_TERMINAL_ID","VERIFONE_TERMINAL_POI_ID","SOFTPAY_APP_ID"],"title":"TillSettingKeyENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillAppSettingsUpdateSchema":{"title":"TillAppSettingsUpdateSchema","type":"object","description":"NOTE: This field is deprecated. Printers should be defined on the device","deprecated":true,"properties":{"saleStopAtDelivery":{"type":"boolean"},"autoLogout":{"type":"integer","description":"time in seconds, 0 = disabled, -1 = inherited from tenant"},"touchMode":{"$ref":"#/components/schemas/TillTouchModeENUM"}}},"TillTouchModeENUM":{"title":"TillTouchModeENUM","type":"string","enum":["UNAVAILABLE","ALWAYS","OPTIONAL_ON","OPTIONAL_OFF"]},"TillResponseSchema":{"title":"TillResponseSchema","type":"object","required":["cashDrawer","createdAt","lastModifiedAt","lastOrderUid","lastOrderNumber","name","paymentTerminal","settings","tillUid","tillNumber","device"],"properties":{"barcodePrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"cashDrawer":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"deviceIdentifier":{"type":"string","deprecated":true,"nullable":true},"lastModifiedAt":{"format":"date-time","type":"string"},"lastOrderUid":{"$ref":"#/components/schemas/UID"},"lastOrderNumber":{"type":"string"},"name":{"type":"string"},"paymentTerminal":{"$ref":"#/components/schemas/TillPaymentTerminalENUM"},"receiptPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"regularPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/TillSettingSchema"}},"tillUid":{"$ref":"#/components/schemas/UID"},"tillNumber":{"type":"integer"},"appSettings":{"$ref":"#/components/schemas/TillAppSettingsSchema"},"device":{"$ref":"#/components/schemas/TillDeviceResponseSchema"}}},"TillAppSettingsSchema":{"title":"TillAppSettingsSchema","type":"object","description":"Application specific settings\nNOTE: This field is deprecated. Settings should be set on the device","deprecated":true,"required":["saleStopAtDelivery","autoLogout","touchMode"],"properties":{"saleStopAtDelivery":{"type":"boolean","description":"Stop in the delivery field for each product line during sale"},"autoLogout":{"type":"integer","description":"time in seconds, 0 = disabled, -1 = inherited from tenant"},"touchMode":{"$ref":"#/components/schemas/TillTouchModeENUM"}}},"TillDeviceResponseSchema":{"title":"TillDeviceResponseSchema","type":"object","nullable":true,"required":["deviceUid","identifier","name"],"properties":{"deviceUid":{"$ref":"#/components/schemas/UID"},"identifier":{"type":"string"},"name":{"type":"string"}}}},"responses":{"TillResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills":{"post":{"description":"Creates a new till.\n\nRequired permissions: TILL","operationId":"post-tenants-stores-tills","requestBody":{"$ref":"#/components/requestBodies/TillCreateRequest"},"responses":{"200":{"$ref":"#/components/responses/TillResponse"}},"summary":"Create a new till","tags":["Till"]}}}}
```

## Get till details

> Get details for a till.

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"TillResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillResponseSchema"}}},"description":"Example response"}},"schemas":{"TillResponseSchema":{"title":"TillResponseSchema","type":"object","required":["cashDrawer","createdAt","lastModifiedAt","lastOrderUid","lastOrderNumber","name","paymentTerminal","settings","tillUid","tillNumber","device"],"properties":{"barcodePrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"cashDrawer":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"deviceIdentifier":{"type":"string","deprecated":true,"nullable":true},"lastModifiedAt":{"format":"date-time","type":"string"},"lastOrderUid":{"$ref":"#/components/schemas/UID"},"lastOrderNumber":{"type":"string"},"name":{"type":"string"},"paymentTerminal":{"$ref":"#/components/schemas/TillPaymentTerminalENUM"},"receiptPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"regularPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/TillSettingSchema"}},"tillUid":{"$ref":"#/components/schemas/UID"},"tillNumber":{"type":"integer"},"appSettings":{"$ref":"#/components/schemas/TillAppSettingsSchema"},"device":{"$ref":"#/components/schemas/TillDeviceResponseSchema"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillPaymentTerminalENUM":{"enum":["NONE","ADYEN","PAYEX","STRIPE","NETS","VERIFONE","SOFTPAY"],"title":"TillPaymentTerminalENUM","type":"string"},"TillSettingSchema":{"description":"Till specific settings","properties":{"key":{"$ref":"#/components/schemas/TillSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"TillSettingSchema","type":"object"},"TillSettingKeyENUM":{"enum":["STRIPE_TERMINAL_ID","ADYEN_POS_TERMINAL_ID","PAYEX_TERMINAL_IP","PAYEX_TERMINAL_PORT","PAYEX_COMMAND_QUEUE","NETS_TERMINAL_ID","VERIFONE_TERMINAL_POI_ID","SOFTPAY_APP_ID"],"title":"TillSettingKeyENUM","type":"string"},"TillAppSettingsSchema":{"title":"TillAppSettingsSchema","type":"object","description":"Application specific settings\nNOTE: This field is deprecated. Settings should be set on the device","deprecated":true,"required":["saleStopAtDelivery","autoLogout","touchMode"],"properties":{"saleStopAtDelivery":{"type":"boolean","description":"Stop in the delivery field for each product line during sale"},"autoLogout":{"type":"integer","description":"time in seconds, 0 = disabled, -1 = inherited from tenant"},"touchMode":{"$ref":"#/components/schemas/TillTouchModeENUM"}}},"TillTouchModeENUM":{"title":"TillTouchModeENUM","type":"string","enum":["UNAVAILABLE","ALWAYS","OPTIONAL_ON","OPTIONAL_OFF"]},"TillDeviceResponseSchema":{"title":"TillDeviceResponseSchema","type":"object","nullable":true,"required":["deviceUid","identifier","name"],"properties":{"deviceUid":{"$ref":"#/components/schemas/UID"},"identifier":{"type":"string"},"name":{"type":"string"}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}":{"get":{"description":"Get details for a till.","operationId":"get-tenants-stores-tills-details","responses":{"200":{"$ref":"#/components/responses/TillResponse"}},"summary":"Get till details","tags":["Till"]}}}}
```

## Update till details

> Updates details for a till.\
> \
> Required permissions: TILL

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"TillUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillUpdateSchema"}}}}},"schemas":{"TillUpdateSchema":{"description":"Update till","title":"TillUpdateSchema","type":"object","properties":{"barcodePrinter":{"type":"string","description":"NOTE: This field is deprecated. Printers should be defined on the device","deprecated":true},"cashDrawer":{"type":"string"},"name":{"type":"string"},"paymentTerminal":{"$ref":"#/components/schemas/TillPaymentTerminalENUM"},"receiptPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"regularPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/TillSettingSchema"}},"tillNumber":{"type":"integer"},"appSettings":{"$ref":"#/components/schemas/TillAppSettingsUpdateSchema"}}},"TillPaymentTerminalENUM":{"enum":["NONE","ADYEN","PAYEX","STRIPE","NETS","VERIFONE","SOFTPAY"],"title":"TillPaymentTerminalENUM","type":"string"},"TillSettingSchema":{"description":"Till specific settings","properties":{"key":{"$ref":"#/components/schemas/TillSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"TillSettingSchema","type":"object"},"TillSettingKeyENUM":{"enum":["STRIPE_TERMINAL_ID","ADYEN_POS_TERMINAL_ID","PAYEX_TERMINAL_IP","PAYEX_TERMINAL_PORT","PAYEX_COMMAND_QUEUE","NETS_TERMINAL_ID","VERIFONE_TERMINAL_POI_ID","SOFTPAY_APP_ID"],"title":"TillSettingKeyENUM","type":"string"},"TillAppSettingsUpdateSchema":{"title":"TillAppSettingsUpdateSchema","type":"object","description":"NOTE: This field is deprecated. Printers should be defined on the device","deprecated":true,"properties":{"saleStopAtDelivery":{"type":"boolean"},"autoLogout":{"type":"integer","description":"time in seconds, 0 = disabled, -1 = inherited from tenant"},"touchMode":{"$ref":"#/components/schemas/TillTouchModeENUM"}}},"TillTouchModeENUM":{"title":"TillTouchModeENUM","type":"string","enum":["UNAVAILABLE","ALWAYS","OPTIONAL_ON","OPTIONAL_OFF"]},"TillResponseSchema":{"title":"TillResponseSchema","type":"object","required":["cashDrawer","createdAt","lastModifiedAt","lastOrderUid","lastOrderNumber","name","paymentTerminal","settings","tillUid","tillNumber","device"],"properties":{"barcodePrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"cashDrawer":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"deviceIdentifier":{"type":"string","deprecated":true,"nullable":true},"lastModifiedAt":{"format":"date-time","type":"string"},"lastOrderUid":{"$ref":"#/components/schemas/UID"},"lastOrderNumber":{"type":"string"},"name":{"type":"string"},"paymentTerminal":{"$ref":"#/components/schemas/TillPaymentTerminalENUM"},"receiptPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"regularPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/TillSettingSchema"}},"tillUid":{"$ref":"#/components/schemas/UID"},"tillNumber":{"type":"integer"},"appSettings":{"$ref":"#/components/schemas/TillAppSettingsSchema"},"device":{"$ref":"#/components/schemas/TillDeviceResponseSchema"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillAppSettingsSchema":{"title":"TillAppSettingsSchema","type":"object","description":"Application specific settings\nNOTE: This field is deprecated. Settings should be set on the device","deprecated":true,"required":["saleStopAtDelivery","autoLogout","touchMode"],"properties":{"saleStopAtDelivery":{"type":"boolean","description":"Stop in the delivery field for each product line during sale"},"autoLogout":{"type":"integer","description":"time in seconds, 0 = disabled, -1 = inherited from tenant"},"touchMode":{"$ref":"#/components/schemas/TillTouchModeENUM"}}},"TillDeviceResponseSchema":{"title":"TillDeviceResponseSchema","type":"object","nullable":true,"required":["deviceUid","identifier","name"],"properties":{"deviceUid":{"$ref":"#/components/schemas/UID"},"identifier":{"type":"string"},"name":{"type":"string"}}}},"responses":{"TillResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}":{"put":{"description":"Updates details for a till.\n\nRequired permissions: TILL","operationId":"put-tenants-stores-tills-details","requestBody":{"$ref":"#/components/requestBodies/TillUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/TillResponse"}},"summary":"Update till details","tags":["Till"]}}}}
```

## Delete a till

> Deletes a till.\
> \
> Required permissions: TILL

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}":{"delete":{"description":"Deletes a till.\n\nRequired permissions: TILL","operationId":"delete-tenants-stores-tills-details","responses":{"204":{"description":"No Content"}},"summary":"Delete a till","tags":["Till"]}}}}
```

## Get cashdrawer status for a till

> Get cashdrawer status for the cashdrawer connect to the current till

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"responses":{"CashdrawerStatusSchemaResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashdrawerStatusSchema"}}},"description":"Example response"}},"schemas":{"CashdrawerStatusSchema":{"properties":{"status":{"enum":["OPEN","CLOSED"],"type":"string"}},"required":["status"],"title":"CashdrawerStatusSchema","type":"object"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer":{"get":{"description":"Get cashdrawer status for the cashdrawer connect to the current till","operationId":"get-tenants-stores-tills-cashdrawer","responses":{"200":{"$ref":"#/components/responses/CashdrawerStatusSchemaResponse"},"404":{"description":"Not Found"}},"summary":"Get cashdrawer status for a till","tags":["Till"]}}}}
```

## Open cashdrawer

> Open the cashdrawer for the current till\
> \
> Required permissions: SALES\_ORDER,RETURN\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashdrawer":{"post":{"description":"Open the cashdrawer for the current till\n\nRequired permissions: SALES_ORDER,RETURN_ORDER","operationId":"post-tenants-stores-tills-cashdrawer","responses":{"200":{"description":"OK"},"404":{"description":"Not Found"},"406":{"description":"Cashdrawer could not be opened"}},"summary":"Open cashdrawer","tags":["Till"]}}}}
```

## List all cash control reports

> Get a cash report

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"parameters":{"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","required":false,"schema":{"type":"integer"}},"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"sortDirectionQuery":{"description":"Reference to a sort direction","explode":false,"in":"query","name":"sortDirection","schema":{"$ref":"#/components/schemas/SortDirectionENUM"},"style":"form"},"sortByQuery":{"description":"Defines which field the resource list is sorted by.","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},"cashreportFromDateQuery":{"description":"Reference to a from-date.","in":"query","name":"cashreportFromDate","schema":{"format":"date","type":"string"},"style":"form"},"cashreportToDateQuery":{"description":"Reference to a to-date.","in":"query","name":"cashreportToDate","schema":{"format":"date","type":"string"},"style":"form"}},"schemas":{"SortDirectionENUM":{"description":"|ENUM      | Description |\n| ---------------- | ------------ |\n| ASC | Sort in ascending order|\n| DESC | Sort in descending order|\n","enum":["ASC","DESC"],"title":"SortDirectionENUM","type":"string"},"TillCashReportResponseSchema":{"description":" Cash report for a till","title":"TillCashReportResponseSchema","type":"object","properties":{"bankdepositAmount":{"type":"integer","nullable":true},"bankdepositReference":{"type":"string"},"cashDifferenceAmount":{"description":"The cash difference amount.  \nCalculation: (countedAmount + withdrawalAmount ) - (changeAmount + cashRevenueAmount)","type":"integer"},"cashRevenueAmount":{"description":"After the till is closed the cash revenue will be calculated in this field","type":"integer"},"cashreportUid":{"$ref":"#/components/schemas/UID"},"changeAmount":{"type":"integer"},"closedAt":{"format":"date-time","type":"string","nullable":true},"closedByDisplayName":{"type":"string"},"comment":{"type":"string"},"countedAmount":{"type":"integer","nullable":true},"openAt":{"format":"date-time","type":"string"},"openByDisplayName":{"type":"string"},"status":{"$ref":"#/components/schemas/TillStatusENUM"},"withdrawalAmount":{"type":"integer","nullable":true},"cashDetailsAtOpen":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"cashDetailsAtClose":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}},"required":["bankdepositAmount","bankdepositReference","cashDifferenceAmount","cashRevenueAmount","cashreportUid","changeAmount","closedAt","closedByDisplayName","comment","countedAmount","openAt","openByDisplayName","status","withdrawalAmount"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CashDetailSchema":{"title":"CashDetailSchema","type":"object","properties":{"currencyCode":{"type":"string"},"denomination":{"type":"integer"},"material":{"$ref":"#/components/schemas/CurrencyDenominationMaterialENUM"},"quantityCounted":{"type":"integer"},"amount":{"type":"integer"}},"required":["currencyCode","denomination","material","quantityCounted","amount"]},"CurrencyDenominationMaterialENUM":{"description":"","enum":["COIN","NOTE"],"title":"CurrencyDenominationMaterialENUM","type":"string"},"Paging":{"description":"totalCount The total number of items in the result set.\n\npageSize The number of items per page.\n\npageNumber The current page in the result set.","properties":{"pageNumber":{"type":"integer"},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"}},"required":["totalCount","pageSize","pageNumber"],"title":"Paging","type":"object"}},"responses":{"TillCashreportListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TillCashReportResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports":{"get":{"description":"Get a cash report","operationId":"get-tenants-stores-tills-cashreports","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/cashreportFromDateQuery"},{"$ref":"#/components/parameters/cashreportToDateQuery"}],"responses":{"200":{"$ref":"#/components/responses/TillCashreportListResponse"}},"summary":"List all cash control reports","tags":["Till"]}}}}
```

## Get a specific cash report

> Get cash control details

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"TillCashReportResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillCashReportResponseSchema"}}},"description":"Example response"},"GenericErrorResponse":{"content":{"application/json":{"schema":{"properties":{"code":{"type":"string"},"message":{"type":"string","description":"Error message in the locale you specify in the Accept-Language header or specified on the user"},"logId":{"type":"string","description":"Log identification. Can be used when reporting errors to Flow Solutions"}},"type":"object"}}},"description":"Linking failed. Ther error message will have information about what failed."}},"schemas":{"TillCashReportResponseSchema":{"description":" Cash report for a till","title":"TillCashReportResponseSchema","type":"object","properties":{"bankdepositAmount":{"type":"integer","nullable":true},"bankdepositReference":{"type":"string"},"cashDifferenceAmount":{"description":"The cash difference amount.  \nCalculation: (countedAmount + withdrawalAmount ) - (changeAmount + cashRevenueAmount)","type":"integer"},"cashRevenueAmount":{"description":"After the till is closed the cash revenue will be calculated in this field","type":"integer"},"cashreportUid":{"$ref":"#/components/schemas/UID"},"changeAmount":{"type":"integer"},"closedAt":{"format":"date-time","type":"string","nullable":true},"closedByDisplayName":{"type":"string"},"comment":{"type":"string"},"countedAmount":{"type":"integer","nullable":true},"openAt":{"format":"date-time","type":"string"},"openByDisplayName":{"type":"string"},"status":{"$ref":"#/components/schemas/TillStatusENUM"},"withdrawalAmount":{"type":"integer","nullable":true},"cashDetailsAtOpen":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"cashDetailsAtClose":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}},"required":["bankdepositAmount","bankdepositReference","cashDifferenceAmount","cashRevenueAmount","cashreportUid","changeAmount","closedAt","closedByDisplayName","comment","countedAmount","openAt","openByDisplayName","status","withdrawalAmount"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CashDetailSchema":{"title":"CashDetailSchema","type":"object","properties":{"currencyCode":{"type":"string"},"denomination":{"type":"integer"},"material":{"$ref":"#/components/schemas/CurrencyDenominationMaterialENUM"},"quantityCounted":{"type":"integer"},"amount":{"type":"integer"}},"required":["currencyCode","denomination","material","quantityCounted","amount"]},"CurrencyDenominationMaterialENUM":{"description":"","enum":["COIN","NOTE"],"title":"CurrencyDenominationMaterialENUM","type":"string"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}":{"get":{"operationId":"get-tenants-stores-tills-cashreports-details","description":"Get cash control details","responses":{"200":{"$ref":"#/components/responses/TillCashReportResponse"},"404":{"$ref":"#/components/responses/GenericErrorResponse"}},"summary":"Get a specific cash report","tags":["Till"]}}}}
```

## Update cash report

> The comment field can even be updated on a cashreport with status \`CLOSED\`.  \
> All other fields can only be set as long as status is \*not\* \`CLOSED\`. \
> \
> Required permissions: TILL\_OPERATION

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"CashReportUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashReportUpdateRequestSchema"}}},"description":""}},"schemas":{"CashReportUpdateRequestSchema":{"title":"CashReportUpdateRequestSchema","type":"object","properties":{"comment":{"type":"string"},"bankDepositAmount":{"type":"integer"},"bankDepositReference":{"type":"string"},"cashAmount":{"type":"integer","description":"When till is opened this is the change amount, when closed this is the counted amount."},"status":{"$ref":"#/components/schemas/TillStatusENUM"},"cashDetails":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}}},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CashDetailSchema":{"title":"CashDetailSchema","type":"object","properties":{"currencyCode":{"type":"string"},"denomination":{"type":"integer"},"material":{"$ref":"#/components/schemas/CurrencyDenominationMaterialENUM"},"quantityCounted":{"type":"integer"},"amount":{"type":"integer"}},"required":["currencyCode","denomination","material","quantityCounted","amount"]},"CurrencyDenominationMaterialENUM":{"description":"","enum":["COIN","NOTE"],"title":"CurrencyDenominationMaterialENUM","type":"string"},"TillCashReportResponseSchema":{"description":" Cash report for a till","title":"TillCashReportResponseSchema","type":"object","properties":{"bankdepositAmount":{"type":"integer","nullable":true},"bankdepositReference":{"type":"string"},"cashDifferenceAmount":{"description":"The cash difference amount.  \nCalculation: (countedAmount + withdrawalAmount ) - (changeAmount + cashRevenueAmount)","type":"integer"},"cashRevenueAmount":{"description":"After the till is closed the cash revenue will be calculated in this field","type":"integer"},"cashreportUid":{"$ref":"#/components/schemas/UID"},"changeAmount":{"type":"integer"},"closedAt":{"format":"date-time","type":"string","nullable":true},"closedByDisplayName":{"type":"string"},"comment":{"type":"string"},"countedAmount":{"type":"integer","nullable":true},"openAt":{"format":"date-time","type":"string"},"openByDisplayName":{"type":"string"},"status":{"$ref":"#/components/schemas/TillStatusENUM"},"withdrawalAmount":{"type":"integer","nullable":true},"cashDetailsAtOpen":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"cashDetailsAtClose":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}},"required":["bankdepositAmount","bankdepositReference","cashDifferenceAmount","cashRevenueAmount","cashreportUid","changeAmount","closedAt","closedByDisplayName","comment","countedAmount","openAt","openByDisplayName","status","withdrawalAmount"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}},"responses":{"TillCashReportResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillCashReportResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}":{"put":{"description":"The comment field can even be updated on a cashreport with status `CLOSED`.  \nAll other fields can only be set as long as status is *not* `CLOSED`. \n\nRequired permissions: TILL_OPERATION","operationId":"put-tenants-stores-tills-cashreports-details","requestBody":{"$ref":"#/components/requestBodies/CashReportUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/TillCashReportResponse"}},"summary":"Update cash report","tags":["Till"]}}}}
```

## Withdraw or deposit cash at cashdrawer

> Withdraw or deposit cash at cashdrawer \
> \
> Required permissions: TILL\_OPERATION

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"CashReportWithdrawalRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashReportWithdrawalRequestSchema"}}}}},"schemas":{"CashReportWithdrawalRequestSchema":{"title":"CashReportWithdrawalRequestSchema","type":"object","properties":{"amount":{"type":"integer"},"comment":{"type":"string"}},"required":["amount","comment"]}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/cashreports/{cashreportUid}/withdrawals":{"post":{"description":"Withdraw or deposit cash at cashdrawer \n\nRequired permissions: TILL_OPERATION","operationId":"post-tenants-stores-tills-cashreports-withdrawal","requestBody":{"$ref":"#/components/requestBodies/CashReportWithdrawalRequest"},"responses":{"200":{"description":"OK"}},"summary":"Withdraw or deposit cash at cashdrawer","tags":["Till"]}}}}
```

## Register a device on for a till

> Register a new device to a till.\
> \
> Required permissions: TILL

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"requestBodies":{"TillDeviceRegisterRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillDeviceRegisterSchema"}}}}},"schemas":{"TillDeviceRegisterSchema":{"description":"","properties":{"deviceIdentifier":{"type":"string"}},"required":["deviceIdentifier"],"title":"TillDeviceRegisterSchema","type":"object"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device":{"post":{"description":"Register a new device to a till.\n\nRequired permissions: TILL","operationId":"post-tenants-stores-tills-device","parameters":[],"requestBody":{"$ref":"#/components/requestBodies/TillDeviceRegisterRequest"},"responses":{"200":{"description":"OK"}},"summary":"Register a device on for a till","tags":["Till"]}}}}
```

## Remove a device from a till

> Remove a device from a till.\
> \
> Required permissions: TILL

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"TillResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillResponseSchema"}}},"description":"Example response"}},"schemas":{"TillResponseSchema":{"title":"TillResponseSchema","type":"object","required":["cashDrawer","createdAt","lastModifiedAt","lastOrderUid","lastOrderNumber","name","paymentTerminal","settings","tillUid","tillNumber","device"],"properties":{"barcodePrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"cashDrawer":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"deviceIdentifier":{"type":"string","deprecated":true,"nullable":true},"lastModifiedAt":{"format":"date-time","type":"string"},"lastOrderUid":{"$ref":"#/components/schemas/UID"},"lastOrderNumber":{"type":"string"},"name":{"type":"string"},"paymentTerminal":{"$ref":"#/components/schemas/TillPaymentTerminalENUM"},"receiptPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"regularPrinter":{"type":"string","deprecated":true,"description":"NOTE: This field is deprecated. Printers should be defined on the device"},"settings":{"type":"array","items":{"$ref":"#/components/schemas/TillSettingSchema"}},"tillUid":{"$ref":"#/components/schemas/UID"},"tillNumber":{"type":"integer"},"appSettings":{"$ref":"#/components/schemas/TillAppSettingsSchema"},"device":{"$ref":"#/components/schemas/TillDeviceResponseSchema"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillPaymentTerminalENUM":{"enum":["NONE","ADYEN","PAYEX","STRIPE","NETS","VERIFONE","SOFTPAY"],"title":"TillPaymentTerminalENUM","type":"string"},"TillSettingSchema":{"description":"Till specific settings","properties":{"key":{"$ref":"#/components/schemas/TillSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"TillSettingSchema","type":"object"},"TillSettingKeyENUM":{"enum":["STRIPE_TERMINAL_ID","ADYEN_POS_TERMINAL_ID","PAYEX_TERMINAL_IP","PAYEX_TERMINAL_PORT","PAYEX_COMMAND_QUEUE","NETS_TERMINAL_ID","VERIFONE_TERMINAL_POI_ID","SOFTPAY_APP_ID"],"title":"TillSettingKeyENUM","type":"string"},"TillAppSettingsSchema":{"title":"TillAppSettingsSchema","type":"object","description":"Application specific settings\nNOTE: This field is deprecated. Settings should be set on the device","deprecated":true,"required":["saleStopAtDelivery","autoLogout","touchMode"],"properties":{"saleStopAtDelivery":{"type":"boolean","description":"Stop in the delivery field for each product line during sale"},"autoLogout":{"type":"integer","description":"time in seconds, 0 = disabled, -1 = inherited from tenant"},"touchMode":{"$ref":"#/components/schemas/TillTouchModeENUM"}}},"TillTouchModeENUM":{"title":"TillTouchModeENUM","type":"string","enum":["UNAVAILABLE","ALWAYS","OPTIONAL_ON","OPTIONAL_OFF"]},"TillDeviceResponseSchema":{"title":"TillDeviceResponseSchema","type":"object","nullable":true,"required":["deviceUid","identifier","name"],"properties":{"deviceUid":{"$ref":"#/components/schemas/UID"},"identifier":{"type":"string"},"name":{"type":"string"}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/device":{"delete":{"description":"Remove a device from a till.\n\nRequired permissions: TILL","operationId":"delete-tenants-stores-tills-device","responses":{"200":{"$ref":"#/components/responses/TillResponse"}},"summary":"Remove a device from a till","tags":["Till"]}}}}
```

## Get till status details by tillUid

> Get till status by using token information and storeUid from url

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Till","description":"Till"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"authToken":[]},{"integrationToken":[]},{"accessToken":[]}],"components":{"securitySchemes":{"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"},"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"}},"responses":{"TillCashReportResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillCashReportResponseSchema"}}},"description":"Example response"}},"schemas":{"TillCashReportResponseSchema":{"description":" Cash report for a till","title":"TillCashReportResponseSchema","type":"object","properties":{"bankdepositAmount":{"type":"integer","nullable":true},"bankdepositReference":{"type":"string"},"cashDifferenceAmount":{"description":"The cash difference amount.  \nCalculation: (countedAmount + withdrawalAmount ) - (changeAmount + cashRevenueAmount)","type":"integer"},"cashRevenueAmount":{"description":"After the till is closed the cash revenue will be calculated in this field","type":"integer"},"cashreportUid":{"$ref":"#/components/schemas/UID"},"changeAmount":{"type":"integer"},"closedAt":{"format":"date-time","type":"string","nullable":true},"closedByDisplayName":{"type":"string"},"comment":{"type":"string"},"countedAmount":{"type":"integer","nullable":true},"openAt":{"format":"date-time","type":"string"},"openByDisplayName":{"type":"string"},"status":{"$ref":"#/components/schemas/TillStatusENUM"},"withdrawalAmount":{"type":"integer","nullable":true},"cashDetailsAtOpen":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"cashDetailsAtClose":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}},"required":["bankdepositAmount","bankdepositReference","cashDifferenceAmount","cashRevenueAmount","cashreportUid","changeAmount","closedAt","closedByDisplayName","comment","countedAmount","openAt","openByDisplayName","status","withdrawalAmount"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CashDetailSchema":{"title":"CashDetailSchema","type":"object","properties":{"currencyCode":{"type":"string"},"denomination":{"type":"integer"},"material":{"$ref":"#/components/schemas/CurrencyDenominationMaterialENUM"},"quantityCounted":{"type":"integer"},"amount":{"type":"integer"}},"required":["currencyCode","denomination","material","quantityCounted","amount"]},"CurrencyDenominationMaterialENUM":{"description":"","enum":["COIN","NOTE"],"title":"CurrencyDenominationMaterialENUM","type":"string"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/tills/{tillUid}/status":{"get":{"description":"Get till status by using token information and storeUid from url","operationId":"get-tenants-stores-storeid-tills-tillid-status","responses":{"200":{"$ref":"#/components/responses/TillCashReportResponse"}},"summary":"Get till status details by tillUid","tags":["Till"]}}}}
```