> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/store/get-till-status-details-by-token-information.md).

# Get till status details by token information

Get till status by using token information

Required permissions: SALES\_ORDER,RETURN\_ORDER,REPORTING

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Store","description":"Store"}],"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":{"TillCashReportResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillCashReportResponseSchema"}}},"description":"Example response"}},"schemas":{"TillCashReportResponseSchema":{"description":"Cash report for a till.\n\nzReport is the Z report this close made. Absent when none was made. Get the whole report with the get operation.","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"}},"zReport":{"$ref":"#/components/schemas/ZReportSummarySchema"}},"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"},"ZReportSummarySchema":{"title":"ZReportSummarySchema","type":"object","description":"One Z report in a list, or the Z report a close made. A GENERATED list row has only id, tillUid, source and date set; the figures on it (counts and amounts) are 0, which for GENERATED means not calculated here, not that nothing was sold. Open the report to see them. sequenceNumber, the times and producedBy are null for it.","required":["id","tillUid","source","sequenceNumber","date","periodFrom","periodTo","producedAt","producedBy","receiptCount","totalSales","returnCount","returnAmount","grandTotalSales","grandTotalReturn","grandTotalNet"],"properties":{"id":{"type":"string","description":"Pass this to the Z report get operation. The sequence number for STORED, the date (YYYY-MM-DD) for GENERATED. For LIVE it is `x`, which only names the response of the xreport operation and is not an id the Z report get operation accepts. Treat it as opaque."},"tillUid":{"type":"string","description":"The till this Z report belongs to. Sequence numbers are per till, so this identifies the report together with `id`."},"source":{"$ref":"#/components/schemas/ZReportSourceENUM"},"sequenceNumber":{"type":"integer","nullable":true,"description":"Per till, without gaps. Null for GENERATED."},"date":{"type":"string","format":"date","nullable":true,"description":"The date a GENERATED report covers. Null for STORED."},"periodFrom":{"type":"string","format":"date-time","nullable":true},"periodTo":{"type":"string","format":"date-time","nullable":true},"producedAt":{"type":"string","format":"date-time","nullable":true},"producedBy":{"type":"string","nullable":true,"enum":["TILL_CLOSE","STORE_CASH_RECONCILIATION",null]},"receiptCount":{"type":"integer"},"totalSales":{"type":"integer"},"returnCount":{"type":"integer"},"returnAmount":{"type":"integer"},"grandTotalSales":{"type":"integer"},"grandTotalReturn":{"type":"integer"},"grandTotalNet":{"type":"integer"}}},"ZReportSourceENUM":{"type":"string","enum":["STORED","GENERATED","LIVE"],"description":"STORED is a Z report made when a till was closed after stored Z reports were switched on.\nGENERATED is calculated on request for a date before that, or when stored Z reports are off.\nLIVE is an X report: everything the till has sold since its last stored Z report, calculated on request and never stored."}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/till/status":{"get":{"description":"Get till status by using token information\n\nRequired permissions: SALES_ORDER,RETURN_ORDER,REPORTING","operationId":"get-tenants-stores-till-status","responses":{"200":{"$ref":"#/components/responses/TillCashReportResponse"}},"summary":"Get till status details by token information","tags":["Store"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/store/get-till-status-details-by-token-information.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.