> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/api/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/api/store.md).

# Store

Store

## Get all numberseries

> List all numberseries for a tenant.

```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":[]},{"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":{"numberSeriesTypeQuery":{"description":"The number series type","in":"query","name":"numberSeriesType","required":false,"schema":{"type":"string"}},"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"},"NumberSeriesResponseSchema":{"properties":{"currentValue":{"type":"integer"},"end":{"type":"integer"},"name":{"type":"string"},"numberSeriesUid":{"$ref":"#/components/schemas/UID"},"start":{"type":"integer"},"type":{"$ref":"#/components/schemas/NumberSeriesTypeENUM"}},"required":["numberSeriesUid","name","type","currentValue","end","start"],"title":"NumberSeriesResponseSchema","type":"object"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"NumberSeriesTypeENUM":{"enum":["PURCHASE","VOUCHER","SERVICE","INTERNAL_PURCHASE","RMA_ORDER","CUSTOMER_LEDGER"],"title":"NumberSeriesTypeENUM","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":{"NumberSeriesListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/NumberSeriesResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/number-series":{"get":{"description":"List all numberseries for a tenant.","operationId":"get-tenants-number-series","parameters":[{"$ref":"#/components/parameters/numberSeriesTypeQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}],"responses":{"200":{"$ref":"#/components/responses/NumberSeriesListResponse"}},"summary":"Get all numberseries","tags":["Store"]}}}}
```

## Add new numberseries

> Add a new numberseries to a tenant.\
> \
> Required permissions: NUMBER\_SERIE<br>

```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":[]},{"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":{"NumberSeriesCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberSeriesCreateSchema"}}}}},"schemas":{"NumberSeriesCreateSchema":{"title":"NumberSeriesCreateSchema","type":"object","properties":{"end":{"type":"integer"},"name":{"type":"string"},"start":{"type":"integer"},"type":{"$ref":"#/components/schemas/NumberSeriesTypeENUM"},"numberSeriesUid":{"$ref":"#/components/schemas/UID"}},"required":["end","name","start","type"]},"NumberSeriesTypeENUM":{"enum":["PURCHASE","VOUCHER","SERVICE","INTERNAL_PURCHASE","RMA_ORDER","CUSTOMER_LEDGER"],"title":"NumberSeriesTypeENUM","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"NumberSeriesResponseSchema":{"properties":{"currentValue":{"type":"integer"},"end":{"type":"integer"},"name":{"type":"string"},"numberSeriesUid":{"$ref":"#/components/schemas/UID"},"start":{"type":"integer"},"type":{"$ref":"#/components/schemas/NumberSeriesTypeENUM"}},"required":["numberSeriesUid","name","type","currentValue","end","start"],"title":"NumberSeriesResponseSchema","type":"object"}},"responses":{"NumberSeriesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberSeriesResponseSchema"}}},"description":"Number series response"}}},"paths":{"/tenants/{tenantUid}/number-series":{"post":{"description":"Add a new numberseries to a tenant.\n\nRequired permissions: NUMBER_SERIE\n","operationId":"post-tenants-number-series","requestBody":{"$ref":"#/components/requestBodies/NumberSeriesCreateRequest"},"responses":{"200":{"$ref":"#/components/responses/NumberSeriesResponse"}},"summary":"Add new numberseries","tags":["Store"]}}}}
```

## Get a number serie

> Get a specific numberseries for a tenant.

```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":[]},{"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":{"NumberSeriesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberSeriesResponseSchema"}}},"description":"Number series response"}},"schemas":{"NumberSeriesResponseSchema":{"properties":{"currentValue":{"type":"integer"},"end":{"type":"integer"},"name":{"type":"string"},"numberSeriesUid":{"$ref":"#/components/schemas/UID"},"start":{"type":"integer"},"type":{"$ref":"#/components/schemas/NumberSeriesTypeENUM"}},"required":["numberSeriesUid","name","type","currentValue","end","start"],"title":"NumberSeriesResponseSchema","type":"object"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"NumberSeriesTypeENUM":{"enum":["PURCHASE","VOUCHER","SERVICE","INTERNAL_PURCHASE","RMA_ORDER","CUSTOMER_LEDGER"],"title":"NumberSeriesTypeENUM","type":"string"}}},"paths":{"/tenants/{tenantUid}/number-series/{numberSeriesUid}":{"get":{"description":"Get a specific numberseries for a tenant.","operationId":"get-tenants-number-series-by-id","responses":{"200":{"$ref":"#/components/responses/NumberSeriesResponse"}},"summary":"Get a number serie","tags":["Store"]}}}}
```

## Update a number series record

> Update numberseries record.\
> \
> Required permissions: NUMBER\_SERIE<br>

```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":[]},{"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":{"NumberSeriesUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberSeriesUpdateSchema"}}}}},"schemas":{"NumberSeriesUpdateSchema":{"properties":{"end":{"type":"integer"},"name":{"type":"string"},"start":{"type":"integer"}},"required":["name"],"title":"NumberSeriesUpdateSchema","type":"object"},"NumberSeriesResponseSchema":{"properties":{"currentValue":{"type":"integer"},"end":{"type":"integer"},"name":{"type":"string"},"numberSeriesUid":{"$ref":"#/components/schemas/UID"},"start":{"type":"integer"},"type":{"$ref":"#/components/schemas/NumberSeriesTypeENUM"}},"required":["numberSeriesUid","name","type","currentValue","end","start"],"title":"NumberSeriesResponseSchema","type":"object"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"NumberSeriesTypeENUM":{"enum":["PURCHASE","VOUCHER","SERVICE","INTERNAL_PURCHASE","RMA_ORDER","CUSTOMER_LEDGER"],"title":"NumberSeriesTypeENUM","type":"string"}},"responses":{"NumberSeriesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NumberSeriesResponseSchema"}}},"description":"Number series response"}}},"paths":{"/tenants/{tenantUid}/number-series/{numberSeriesUid}":{"put":{"description":"Update numberseries record.\n\nRequired permissions: NUMBER_SERIE\n","operationId":"put-tenants-number-series-by-id","requestBody":{"$ref":"#/components/requestBodies/NumberSeriesUpdateRequest"},"responses":{"200":{"$ref":"#/components/responses/NumberSeriesResponse"}},"summary":"Update a number series record","tags":["Store"]}}}}
```

## List stores

> List all stores.

```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":[]},{"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":{"storeExternalIdQuery":{"description":"External reference to a store.","in":"query","name":"storeExternalId","required":false,"schema":{"type":"string"}},"storeNameQuery":{"description":"Reference to the name of a store.","in":"query","name":"storeName","required":false,"schema":{"type":"string"}},"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"},"storeOrganizationUidQuery":{"description":"Reference to an organization uid.","in":"query","name":"storeOrganizationUid","required":false,"schema":{"type":"string"}}},"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"},"StoreResponseSchema":{"title":"StoreResponseSchema","type":"object","required":["address","city","countryCode","createdAt","defaultWarehouseUid","defaultReturnWarehouseUid","defaultDeliveryWarehouseUid","email","externalId","isActive","lastModifiedAt","latitude","longitude","name","postalCode","phone","purchaseNumberSeriesUid","internalPurchaseNumberSeriesUid","rmaOrderNumberSeriesUid","customerLedgerNumberSeriesUid","quicksaleCategoryUid","receiptMessage","emailReceiptMessage","exchangenoteMessage","exchangenoteValidDays","salesPriceUid","purchasePriceListUid","appSettings","storeUid","vatNumber","voucherNumberSeriesUid","serviceNumberSeriesUid","hasWorkShop","organizationUid","availableExtensions","openingHours","bankInfo","websiteUrl","invoiceFooterText","labelComparisonPricelistUid","addresses","enableStoreCashReconciliation","cashReconciliationCutOffTime","logoAssetUid"],"properties":{"address":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"defaultWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultReturnWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultDeliveryWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"email":{"$ref":"#/components/schemas/EmailTYPE"},"externalId":{"type":"string"},"isActive":{"type":"boolean"},"lastModifiedAt":{"format":"date-time","type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"postalCode":{"type":"string"},"phone":{"type":"string"},"purchaseNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"internalPurchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"rmaOrderNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"customerLedgerNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"quicksaleCategoryUid":{"$ref":"#/components/schemas/OptionalUID"},"receiptMessage":{"type":"string"},"emailReceiptMessage":{"type":"string"},"exchangenoteMessage":{"type":"string"},"exchangenoteValidDays":{"type":"integer","description":"Number of days an exchangenote is valid."},"salesPriceUid":{"$ref":"#/components/schemas/OptionalUID"},"purchasePriceListUid":{"$ref":"#/components/schemas/OptionalUID"},"settings":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/StoreSettingSchema"}},"appSettings":{"$ref":"#/components/schemas/StoreAppSettingResponseSchema"},"storeUid":{"$ref":"#/components/schemas/UID"},"vatNumber":{"$ref":"#/components/schemas/VatNumberTYPE"},"voucherNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"serviceNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"hasWorkShop":{"type":"boolean"},"organizationUid":{"$ref":"#/components/schemas/UID"},"availableExtensions":{"type":"array","items":{"$ref":"#/components/schemas/AvailableExtensionSchema"}},"openingHours":{"$ref":"#/components/schemas/OpeningHoursResponseSchema"},"bankInfo":{"$ref":"#/components/schemas/BankInfoResponseSchema"},"websiteUrl":{"type":"string"},"invoiceFooterText":{"type":"string"},"labelComparisonPricelistUid":{"$ref":"#/components/schemas/OptionalUID"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}},"enableStoreCashReconciliation":{"type":"boolean"},"cashReconciliationCutOffTime":{"type":"string","format":"time","description":"Daily cut-off time (e.g. 4 AM). After this time, tills cannot open until the previous settlement is complete."},"logoAssetUid":{"$ref":"#/components/schemas/OptionalUID"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"EmailTYPE":{"title":"Email","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreSettingSchema":{"description":"","properties":{"key":{"$ref":"#/components/schemas/StoreSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"StoreSettingSchema","type":"object"},"StoreSettingKeyENUM":{"enum":["VIPPS_MSN","ADYEN_API_KEY"],"title":"StoreSettingKey","type":"string"},"StoreAppSettingResponseSchema":{"title":"StoreAppSettingResponseSchema","type":"object","required":["hidePurchase","hideReceivement","enableUnlinkedPayments"],"properties":{"hidePurchase":{"type":"boolean"},"hideReceivement":{"type":"boolean"},"enableUnlinkedPayments":{"type":"boolean"}}},"VatNumberTYPE":{"description":"VAT identification number for value added tax reporting purposes.","title":"VatNumber","type":"string"},"AvailableExtensionSchema":{"title":"AvailableExtensionSchema","type":"object","required":["extensionCode","name"],"properties":{"extensionCode":{"$ref":"#/components/schemas/ExtensionCodeENUM"},"name":{"type":"string"}}},"ExtensionCodeENUM":{"enum":["FLOWGIFTCARD","PAYEX_GIFTCARD","ADYEN_POS","PAYEX_POS","VIPPS","EXTERNAL_CUSTOMER_SEARCH","STORE_CREDIT","SMS","STRIPE","NETS","VERIFONE","SERVICE_WORKSHOP","TWO_INVOICE","OMNIUM","DILLER","ARTS","CAMPAIGN","B2B","PEOPLE_COUNTER_KUNDETELLING","COMPENSATION","SWISH","DINTERO","KID","EHF","MYPOWER","BRITANNIA","SOFTPAY","CENTRAL_WAREHOUSE","PROFRAKT","LOYALTY_POINTS","SUBSCRIPTION","POWER_DIRECT","POSTER","PAYMENT_GATEWAY","KLAVIYO","COMPANY_REGISTRY","DIGITAL_PRODUCT"],"title":"ExtensionCodeENUM","type":"string"},"OpeningHoursResponseSchema":{"title":"OpeningHoursResponseSchema","type":"object","properties":{"monday":{"type":"string"},"tuesday":{"type":"string"},"wednesday":{"type":"string"},"thursday":{"type":"string"},"friday":{"type":"string"},"saturday":{"type":"string"},"sunday":{"type":"string"},"note":{"type":"string"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday","note"]},"BankInfoResponseSchema":{"title":"BankInfoResponseSchema","type":"object","required":["accountNumber","bankName","iban","swift"],"properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"iban":{"type":"string"},"swift":{"type":"string"}}},"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"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":{"StoreListResponse":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/StoreResponseSchema"},"type":"array"},"paging":{"$ref":"#/components/schemas/Paging"}},"required":["items","paging"],"type":"object"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores":{"get":{"description":"List all stores.","operationId":"get-tenants-stores","parameters":[{"$ref":"#/components/parameters/storeExternalIdQuery"},{"$ref":"#/components/parameters/storeNameQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/storeOrganizationUidQuery"}],"responses":{"200":{"$ref":"#/components/responses/StoreListResponse"}},"summary":"List stores","tags":["Store"]}}}}
```

## Create a new store

> Creates a new store.\
> \
> Required permissions: STORE

```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":[]},{"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":{"StoreCreateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCreateRequestSchema"}}}}},"schemas":{"StoreCreateRequestSchema":{"allOf":[{"$ref":"#/components/schemas/StoreUpdateRequestSchema"},{"properties":{"storeUid":{"$ref":"#/components/schemas/UID"},"organizationUid":{"$ref":"#/components/schemas/UID"},"name":{"type":"string"},"voucherNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"purchaseNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"internalPurchaseNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"rmaOrderNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"customerLedgerNumberSeriesUid":{"$ref":"#/components/schemas/UID"}},"required":["organizationUid","name","voucherNumberSeriesUid","purchaseNumberSeriesUid"]}],"title":"StoreCreateRequestSchema","type":"object"},"StoreUpdateRequestSchema":{"title":"StoreUpdateRequestSchema","type":"object","properties":{"address":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"defaultReturnWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultDeliveryWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"email":{"$ref":"#/components/schemas/EmailTYPE"},"externalId":{"type":"string"},"isActive":{"type":"boolean"},"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"phone":{"type":"string"},"postalCode":{"type":"string"},"purchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"internalPurchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"rmaOrderNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"customerLedgerNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"quicksaleCategoryUid":{"$ref":"#/components/schemas/OptionalUID"},"receiptMessage":{"type":"string"},"emailReceiptMessage":{"type":"string"},"exchangenoteMessage":{"type":"string"},"exchangenoteValidDays":{"type":"integer","description":"Number of days an exchangenote is valid."},"salesPriceUid":{"$ref":"#/components/schemas/OptionalUID"},"purchasePriceListUid":{"$ref":"#/components/schemas/OptionalUID"},"appSettings":{"$ref":"#/components/schemas/StoreAppSettingRequestSchema"},"vatNumber":{"$ref":"#/components/schemas/VatNumberTYPE"},"voucherNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"hasWorkshop":{"type":"boolean"},"organizationUid":{"$ref":"#/components/schemas/OptionalUID"},"serviceNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"openingHours":{"$ref":"#/components/schemas/OpeningHoursRequestSchema"},"bankInfo":{"$ref":"#/components/schemas/BankInfoRequestSchema"},"websiteUrl":{"type":"string"},"invoiceFooterText":{"type":"string"},"labelComparisonPricelistUid":{"$ref":"#/components/schemas/OptionalUID"},"enableStoreCashReconciliation":{"type":"boolean"},"cashReconciliationCutOffTime":{"type":"string","format":"time","description":"Daily cut-off time (e.g. 4 AM). After this time, tills cannot open until the previous settlement is complete."},"logoAssetUid":{"$ref":"#/components/schemas/OptionalUID"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"EmailTYPE":{"title":"Email","type":"string"},"StoreAppSettingRequestSchema":{"title":"StoreAppSettingRequestSchema","type":"object","properties":{"hidePurchase":{"type":"boolean"},"hideReceivement":{"type":"boolean"},"enableUnlinkedPayments":{"type":"boolean"}}},"VatNumberTYPE":{"description":"VAT identification number for value added tax reporting purposes.","title":"VatNumber","type":"string"},"OpeningHoursRequestSchema":{"title":"OpeningHoursRequestSchema","type":"object","properties":{"monday":{"type":"string"},"tuesday":{"type":"string"},"wednesday":{"type":"string"},"thursday":{"type":"string"},"friday":{"type":"string"},"saturday":{"type":"string"},"sunday":{"type":"string"},"note":{"type":"string"}}},"BankInfoRequestSchema":{"title":"BankInfoSchema","type":"object","properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"iban":{"type":"string"},"swift":{"type":"string"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreResponseSchema":{"title":"StoreResponseSchema","type":"object","required":["address","city","countryCode","createdAt","defaultWarehouseUid","defaultReturnWarehouseUid","defaultDeliveryWarehouseUid","email","externalId","isActive","lastModifiedAt","latitude","longitude","name","postalCode","phone","purchaseNumberSeriesUid","internalPurchaseNumberSeriesUid","rmaOrderNumberSeriesUid","customerLedgerNumberSeriesUid","quicksaleCategoryUid","receiptMessage","emailReceiptMessage","exchangenoteMessage","exchangenoteValidDays","salesPriceUid","purchasePriceListUid","appSettings","storeUid","vatNumber","voucherNumberSeriesUid","serviceNumberSeriesUid","hasWorkShop","organizationUid","availableExtensions","openingHours","bankInfo","websiteUrl","invoiceFooterText","labelComparisonPricelistUid","addresses","enableStoreCashReconciliation","cashReconciliationCutOffTime","logoAssetUid"],"properties":{"address":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"defaultWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultReturnWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultDeliveryWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"email":{"$ref":"#/components/schemas/EmailTYPE"},"externalId":{"type":"string"},"isActive":{"type":"boolean"},"lastModifiedAt":{"format":"date-time","type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"postalCode":{"type":"string"},"phone":{"type":"string"},"purchaseNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"internalPurchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"rmaOrderNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"customerLedgerNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"quicksaleCategoryUid":{"$ref":"#/components/schemas/OptionalUID"},"receiptMessage":{"type":"string"},"emailReceiptMessage":{"type":"string"},"exchangenoteMessage":{"type":"string"},"exchangenoteValidDays":{"type":"integer","description":"Number of days an exchangenote is valid."},"salesPriceUid":{"$ref":"#/components/schemas/OptionalUID"},"purchasePriceListUid":{"$ref":"#/components/schemas/OptionalUID"},"settings":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/StoreSettingSchema"}},"appSettings":{"$ref":"#/components/schemas/StoreAppSettingResponseSchema"},"storeUid":{"$ref":"#/components/schemas/UID"},"vatNumber":{"$ref":"#/components/schemas/VatNumberTYPE"},"voucherNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"serviceNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"hasWorkShop":{"type":"boolean"},"organizationUid":{"$ref":"#/components/schemas/UID"},"availableExtensions":{"type":"array","items":{"$ref":"#/components/schemas/AvailableExtensionSchema"}},"openingHours":{"$ref":"#/components/schemas/OpeningHoursResponseSchema"},"bankInfo":{"$ref":"#/components/schemas/BankInfoResponseSchema"},"websiteUrl":{"type":"string"},"invoiceFooterText":{"type":"string"},"labelComparisonPricelistUid":{"$ref":"#/components/schemas/OptionalUID"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}},"enableStoreCashReconciliation":{"type":"boolean"},"cashReconciliationCutOffTime":{"type":"string","format":"time","description":"Daily cut-off time (e.g. 4 AM). After this time, tills cannot open until the previous settlement is complete."},"logoAssetUid":{"$ref":"#/components/schemas/OptionalUID"}}},"StoreSettingSchema":{"description":"","properties":{"key":{"$ref":"#/components/schemas/StoreSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"StoreSettingSchema","type":"object"},"StoreSettingKeyENUM":{"enum":["VIPPS_MSN","ADYEN_API_KEY"],"title":"StoreSettingKey","type":"string"},"StoreAppSettingResponseSchema":{"title":"StoreAppSettingResponseSchema","type":"object","required":["hidePurchase","hideReceivement","enableUnlinkedPayments"],"properties":{"hidePurchase":{"type":"boolean"},"hideReceivement":{"type":"boolean"},"enableUnlinkedPayments":{"type":"boolean"}}},"AvailableExtensionSchema":{"title":"AvailableExtensionSchema","type":"object","required":["extensionCode","name"],"properties":{"extensionCode":{"$ref":"#/components/schemas/ExtensionCodeENUM"},"name":{"type":"string"}}},"ExtensionCodeENUM":{"enum":["FLOWGIFTCARD","PAYEX_GIFTCARD","ADYEN_POS","PAYEX_POS","VIPPS","EXTERNAL_CUSTOMER_SEARCH","STORE_CREDIT","SMS","STRIPE","NETS","VERIFONE","SERVICE_WORKSHOP","TWO_INVOICE","OMNIUM","DILLER","ARTS","CAMPAIGN","B2B","PEOPLE_COUNTER_KUNDETELLING","COMPENSATION","SWISH","DINTERO","KID","EHF","MYPOWER","BRITANNIA","SOFTPAY","CENTRAL_WAREHOUSE","PROFRAKT","LOYALTY_POINTS","SUBSCRIPTION","POWER_DIRECT","POSTER","PAYMENT_GATEWAY","KLAVIYO","COMPANY_REGISTRY","DIGITAL_PRODUCT"],"title":"ExtensionCodeENUM","type":"string"},"OpeningHoursResponseSchema":{"title":"OpeningHoursResponseSchema","type":"object","properties":{"monday":{"type":"string"},"tuesday":{"type":"string"},"wednesday":{"type":"string"},"thursday":{"type":"string"},"friday":{"type":"string"},"saturday":{"type":"string"},"sunday":{"type":"string"},"note":{"type":"string"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday","note"]},"BankInfoResponseSchema":{"title":"BankInfoResponseSchema","type":"object","required":["accountNumber","bankName","iban","swift"],"properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"iban":{"type":"string"},"swift":{"type":"string"}}},"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}},"responses":{"StoreResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores":{"post":{"description":"Creates a new store.\n\nRequired permissions: STORE","operationId":"post-tenants-stores","requestBody":{"$ref":"#/components/requestBodies/StoreCreateRequest"},"responses":{"200":{"$ref":"#/components/responses/StoreResponse"}},"summary":"Create a new store","tags":["Store"]}}}}
```

## Get store details

> Get details for a store.

```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":[]},{"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":{"StoreResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreResponseSchema"}}},"description":"Example response"}},"schemas":{"StoreResponseSchema":{"title":"StoreResponseSchema","type":"object","required":["address","city","countryCode","createdAt","defaultWarehouseUid","defaultReturnWarehouseUid","defaultDeliveryWarehouseUid","email","externalId","isActive","lastModifiedAt","latitude","longitude","name","postalCode","phone","purchaseNumberSeriesUid","internalPurchaseNumberSeriesUid","rmaOrderNumberSeriesUid","customerLedgerNumberSeriesUid","quicksaleCategoryUid","receiptMessage","emailReceiptMessage","exchangenoteMessage","exchangenoteValidDays","salesPriceUid","purchasePriceListUid","appSettings","storeUid","vatNumber","voucherNumberSeriesUid","serviceNumberSeriesUid","hasWorkShop","organizationUid","availableExtensions","openingHours","bankInfo","websiteUrl","invoiceFooterText","labelComparisonPricelistUid","addresses","enableStoreCashReconciliation","cashReconciliationCutOffTime","logoAssetUid"],"properties":{"address":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"defaultWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultReturnWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultDeliveryWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"email":{"$ref":"#/components/schemas/EmailTYPE"},"externalId":{"type":"string"},"isActive":{"type":"boolean"},"lastModifiedAt":{"format":"date-time","type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"postalCode":{"type":"string"},"phone":{"type":"string"},"purchaseNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"internalPurchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"rmaOrderNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"customerLedgerNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"quicksaleCategoryUid":{"$ref":"#/components/schemas/OptionalUID"},"receiptMessage":{"type":"string"},"emailReceiptMessage":{"type":"string"},"exchangenoteMessage":{"type":"string"},"exchangenoteValidDays":{"type":"integer","description":"Number of days an exchangenote is valid."},"salesPriceUid":{"$ref":"#/components/schemas/OptionalUID"},"purchasePriceListUid":{"$ref":"#/components/schemas/OptionalUID"},"settings":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/StoreSettingSchema"}},"appSettings":{"$ref":"#/components/schemas/StoreAppSettingResponseSchema"},"storeUid":{"$ref":"#/components/schemas/UID"},"vatNumber":{"$ref":"#/components/schemas/VatNumberTYPE"},"voucherNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"serviceNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"hasWorkShop":{"type":"boolean"},"organizationUid":{"$ref":"#/components/schemas/UID"},"availableExtensions":{"type":"array","items":{"$ref":"#/components/schemas/AvailableExtensionSchema"}},"openingHours":{"$ref":"#/components/schemas/OpeningHoursResponseSchema"},"bankInfo":{"$ref":"#/components/schemas/BankInfoResponseSchema"},"websiteUrl":{"type":"string"},"invoiceFooterText":{"type":"string"},"labelComparisonPricelistUid":{"$ref":"#/components/schemas/OptionalUID"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}},"enableStoreCashReconciliation":{"type":"boolean"},"cashReconciliationCutOffTime":{"type":"string","format":"time","description":"Daily cut-off time (e.g. 4 AM). After this time, tills cannot open until the previous settlement is complete."},"logoAssetUid":{"$ref":"#/components/schemas/OptionalUID"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"EmailTYPE":{"title":"Email","type":"string"},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreSettingSchema":{"description":"","properties":{"key":{"$ref":"#/components/schemas/StoreSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"StoreSettingSchema","type":"object"},"StoreSettingKeyENUM":{"enum":["VIPPS_MSN","ADYEN_API_KEY"],"title":"StoreSettingKey","type":"string"},"StoreAppSettingResponseSchema":{"title":"StoreAppSettingResponseSchema","type":"object","required":["hidePurchase","hideReceivement","enableUnlinkedPayments"],"properties":{"hidePurchase":{"type":"boolean"},"hideReceivement":{"type":"boolean"},"enableUnlinkedPayments":{"type":"boolean"}}},"VatNumberTYPE":{"description":"VAT identification number for value added tax reporting purposes.","title":"VatNumber","type":"string"},"AvailableExtensionSchema":{"title":"AvailableExtensionSchema","type":"object","required":["extensionCode","name"],"properties":{"extensionCode":{"$ref":"#/components/schemas/ExtensionCodeENUM"},"name":{"type":"string"}}},"ExtensionCodeENUM":{"enum":["FLOWGIFTCARD","PAYEX_GIFTCARD","ADYEN_POS","PAYEX_POS","VIPPS","EXTERNAL_CUSTOMER_SEARCH","STORE_CREDIT","SMS","STRIPE","NETS","VERIFONE","SERVICE_WORKSHOP","TWO_INVOICE","OMNIUM","DILLER","ARTS","CAMPAIGN","B2B","PEOPLE_COUNTER_KUNDETELLING","COMPENSATION","SWISH","DINTERO","KID","EHF","MYPOWER","BRITANNIA","SOFTPAY","CENTRAL_WAREHOUSE","PROFRAKT","LOYALTY_POINTS","SUBSCRIPTION","POWER_DIRECT","POSTER","PAYMENT_GATEWAY","KLAVIYO","COMPANY_REGISTRY","DIGITAL_PRODUCT"],"title":"ExtensionCodeENUM","type":"string"},"OpeningHoursResponseSchema":{"title":"OpeningHoursResponseSchema","type":"object","properties":{"monday":{"type":"string"},"tuesday":{"type":"string"},"wednesday":{"type":"string"},"thursday":{"type":"string"},"friday":{"type":"string"},"saturday":{"type":"string"},"sunday":{"type":"string"},"note":{"type":"string"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday","note"]},"BankInfoResponseSchema":{"title":"BankInfoResponseSchema","type":"object","required":["accountNumber","bankName","iban","swift"],"properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"iban":{"type":"string"},"swift":{"type":"string"}}},"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}":{"get":{"description":"Get details for a store.","operationId":"get-tenants-stores-details","responses":{"200":{"$ref":"#/components/responses/StoreResponse"}},"summary":"Get store details","tags":["Store"]}}}}
```

## Update store details

> Update details for a store. Partial updates are allowed.\
> \
> Required permissions: STORE

```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":[]},{"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":{"StoreUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreUpdateRequestSchema"}}}}},"schemas":{"StoreUpdateRequestSchema":{"title":"StoreUpdateRequestSchema","type":"object","properties":{"address":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"defaultReturnWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultDeliveryWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"email":{"$ref":"#/components/schemas/EmailTYPE"},"externalId":{"type":"string"},"isActive":{"type":"boolean"},"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"phone":{"type":"string"},"postalCode":{"type":"string"},"purchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"internalPurchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"rmaOrderNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"customerLedgerNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"quicksaleCategoryUid":{"$ref":"#/components/schemas/OptionalUID"},"receiptMessage":{"type":"string"},"emailReceiptMessage":{"type":"string"},"exchangenoteMessage":{"type":"string"},"exchangenoteValidDays":{"type":"integer","description":"Number of days an exchangenote is valid."},"salesPriceUid":{"$ref":"#/components/schemas/OptionalUID"},"purchasePriceListUid":{"$ref":"#/components/schemas/OptionalUID"},"appSettings":{"$ref":"#/components/schemas/StoreAppSettingRequestSchema"},"vatNumber":{"$ref":"#/components/schemas/VatNumberTYPE"},"voucherNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"hasWorkshop":{"type":"boolean"},"organizationUid":{"$ref":"#/components/schemas/OptionalUID"},"serviceNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"openingHours":{"$ref":"#/components/schemas/OpeningHoursRequestSchema"},"bankInfo":{"$ref":"#/components/schemas/BankInfoRequestSchema"},"websiteUrl":{"type":"string"},"invoiceFooterText":{"type":"string"},"labelComparisonPricelistUid":{"$ref":"#/components/schemas/OptionalUID"},"enableStoreCashReconciliation":{"type":"boolean"},"cashReconciliationCutOffTime":{"type":"string","format":"time","description":"Daily cut-off time (e.g. 4 AM). After this time, tills cannot open until the previous settlement is complete."},"logoAssetUid":{"$ref":"#/components/schemas/OptionalUID"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"EmailTYPE":{"title":"Email","type":"string"},"StoreAppSettingRequestSchema":{"title":"StoreAppSettingRequestSchema","type":"object","properties":{"hidePurchase":{"type":"boolean"},"hideReceivement":{"type":"boolean"},"enableUnlinkedPayments":{"type":"boolean"}}},"VatNumberTYPE":{"description":"VAT identification number for value added tax reporting purposes.","title":"VatNumber","type":"string"},"OpeningHoursRequestSchema":{"title":"OpeningHoursRequestSchema","type":"object","properties":{"monday":{"type":"string"},"tuesday":{"type":"string"},"wednesday":{"type":"string"},"thursday":{"type":"string"},"friday":{"type":"string"},"saturday":{"type":"string"},"sunday":{"type":"string"},"note":{"type":"string"}}},"BankInfoRequestSchema":{"title":"BankInfoSchema","type":"object","properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"iban":{"type":"string"},"swift":{"type":"string"}}},"StoreResponseSchema":{"title":"StoreResponseSchema","type":"object","required":["address","city","countryCode","createdAt","defaultWarehouseUid","defaultReturnWarehouseUid","defaultDeliveryWarehouseUid","email","externalId","isActive","lastModifiedAt","latitude","longitude","name","postalCode","phone","purchaseNumberSeriesUid","internalPurchaseNumberSeriesUid","rmaOrderNumberSeriesUid","customerLedgerNumberSeriesUid","quicksaleCategoryUid","receiptMessage","emailReceiptMessage","exchangenoteMessage","exchangenoteValidDays","salesPriceUid","purchasePriceListUid","appSettings","storeUid","vatNumber","voucherNumberSeriesUid","serviceNumberSeriesUid","hasWorkShop","organizationUid","availableExtensions","openingHours","bankInfo","websiteUrl","invoiceFooterText","labelComparisonPricelistUid","addresses","enableStoreCashReconciliation","cashReconciliationCutOffTime","logoAssetUid"],"properties":{"address":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"createdAt":{"format":"date-time","type":"string"},"defaultWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultReturnWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"defaultDeliveryWarehouseUid":{"$ref":"#/components/schemas/OptionalUID"},"email":{"$ref":"#/components/schemas/EmailTYPE"},"externalId":{"type":"string"},"isActive":{"type":"boolean"},"lastModifiedAt":{"format":"date-time","type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"postalCode":{"type":"string"},"phone":{"type":"string"},"purchaseNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"internalPurchaseNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"rmaOrderNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"customerLedgerNumberSeriesUid":{"$ref":"#/components/schemas/OptionalUID"},"quicksaleCategoryUid":{"$ref":"#/components/schemas/OptionalUID"},"receiptMessage":{"type":"string"},"emailReceiptMessage":{"type":"string"},"exchangenoteMessage":{"type":"string"},"exchangenoteValidDays":{"type":"integer","description":"Number of days an exchangenote is valid."},"salesPriceUid":{"$ref":"#/components/schemas/OptionalUID"},"purchasePriceListUid":{"$ref":"#/components/schemas/OptionalUID"},"settings":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/StoreSettingSchema"}},"appSettings":{"$ref":"#/components/schemas/StoreAppSettingResponseSchema"},"storeUid":{"$ref":"#/components/schemas/UID"},"vatNumber":{"$ref":"#/components/schemas/VatNumberTYPE"},"voucherNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"serviceNumberSeriesUid":{"$ref":"#/components/schemas/UID"},"hasWorkShop":{"type":"boolean"},"organizationUid":{"$ref":"#/components/schemas/UID"},"availableExtensions":{"type":"array","items":{"$ref":"#/components/schemas/AvailableExtensionSchema"}},"openingHours":{"$ref":"#/components/schemas/OpeningHoursResponseSchema"},"bankInfo":{"$ref":"#/components/schemas/BankInfoResponseSchema"},"websiteUrl":{"type":"string"},"invoiceFooterText":{"type":"string"},"labelComparisonPricelistUid":{"$ref":"#/components/schemas/OptionalUID"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}},"enableStoreCashReconciliation":{"type":"boolean"},"cashReconciliationCutOffTime":{"type":"string","format":"time","description":"Daily cut-off time (e.g. 4 AM). After this time, tills cannot open until the previous settlement is complete."},"logoAssetUid":{"$ref":"#/components/schemas/OptionalUID"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreSettingSchema":{"description":"","properties":{"key":{"$ref":"#/components/schemas/StoreSettingKeyENUM"},"value":{"type":"string"}},"required":["key","value"],"title":"StoreSettingSchema","type":"object"},"StoreSettingKeyENUM":{"enum":["VIPPS_MSN","ADYEN_API_KEY"],"title":"StoreSettingKey","type":"string"},"StoreAppSettingResponseSchema":{"title":"StoreAppSettingResponseSchema","type":"object","required":["hidePurchase","hideReceivement","enableUnlinkedPayments"],"properties":{"hidePurchase":{"type":"boolean"},"hideReceivement":{"type":"boolean"},"enableUnlinkedPayments":{"type":"boolean"}}},"AvailableExtensionSchema":{"title":"AvailableExtensionSchema","type":"object","required":["extensionCode","name"],"properties":{"extensionCode":{"$ref":"#/components/schemas/ExtensionCodeENUM"},"name":{"type":"string"}}},"ExtensionCodeENUM":{"enum":["FLOWGIFTCARD","PAYEX_GIFTCARD","ADYEN_POS","PAYEX_POS","VIPPS","EXTERNAL_CUSTOMER_SEARCH","STORE_CREDIT","SMS","STRIPE","NETS","VERIFONE","SERVICE_WORKSHOP","TWO_INVOICE","OMNIUM","DILLER","ARTS","CAMPAIGN","B2B","PEOPLE_COUNTER_KUNDETELLING","COMPENSATION","SWISH","DINTERO","KID","EHF","MYPOWER","BRITANNIA","SOFTPAY","CENTRAL_WAREHOUSE","PROFRAKT","LOYALTY_POINTS","SUBSCRIPTION","POWER_DIRECT","POSTER","PAYMENT_GATEWAY","KLAVIYO","COMPANY_REGISTRY","DIGITAL_PRODUCT"],"title":"ExtensionCodeENUM","type":"string"},"OpeningHoursResponseSchema":{"title":"OpeningHoursResponseSchema","type":"object","properties":{"monday":{"type":"string"},"tuesday":{"type":"string"},"wednesday":{"type":"string"},"thursday":{"type":"string"},"friday":{"type":"string"},"saturday":{"type":"string"},"sunday":{"type":"string"},"note":{"type":"string"}},"required":["monday","tuesday","wednesday","thursday","friday","saturday","sunday","note"]},"BankInfoResponseSchema":{"title":"BankInfoResponseSchema","type":"object","required":["accountNumber","bankName","iban","swift"],"properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"iban":{"type":"string"},"swift":{"type":"string"}}},"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}},"responses":{"StoreResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreResponseSchema"}}},"description":"Example response"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}":{"put":{"operationId":"put-tenants-stores-details","description":"Update details for a store. Partial updates are allowed.\n\nRequired permissions: STORE","requestBody":{"$ref":"#/components/requestBodies/StoreUpdateRequest"},"responses":{"201":{"$ref":"#/components/responses/StoreResponse"}},"summary":"Update store details","tags":["Store"]}}}}
```

## Delete a store

> Deletes a store.\
> \
> Required permissions: STORE

```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":[]},{"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}":{"delete":{"operationId":"delete-tenants-stores-details","description":"Deletes a store.\n\nRequired permissions: STORE","responses":{"204":{"description":"No Content"}},"summary":"Delete a store","tags":["Store"]}}}}
```

## Get Till by token information

> Get till information by token information

```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":{"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}/till":{"get":{"description":"Get till information by token information","operationId":"get-tenants-stores-till","parameters":[],"responses":{"200":{"$ref":"#/components/responses/TillResponse"},"404":{"description":"Not Found"}},"summary":"Get Till by token information","tags":["Store"]}}}}
```

## 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","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}/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"]}}}}
```

## Set a new till status by token information

> Set a new till status by token information\
> \
> Required permissions: SALES\_ORDER,RETURN\_ORDER

```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"}},"requestBodies":{"TillStatusRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TillStatusRequestSchema"}}}}},"schemas":{"TillStatusRequestSchema":{"title":"TillStatusRequestSchema","type":"object","properties":{"bankdepositAmount":{"description":"The amount that should be withdrawed from the till and deposited to night safe when the till is closed.","type":"integer"},"bankdepositReference":{"description":"An optional reference to the bank deposit","type":"string"},"cashAmount":{"description":"When the till is opened this is the change amount.\nWhen the till is closed this is the counted amount","type":"integer"},"status":{"$ref":"#/components/schemas/TillStatusENUM"},"cashDetails":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}},"required":["status"]},"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}/till/status":{"post":{"description":"Set a new till status by token information\n\nRequired permissions: SALES_ORDER,RETURN_ORDER","operationId":"post-tenants-stores-till-status","requestBody":{"$ref":"#/components/requestBodies/TillStatusRequest"},"responses":{"200":{"$ref":"#/components/responses/TillCashReportResponse"}},"summary":"Set a new till status by token information","tags":["Store"]}}}}
```

## List all cash control reports for a store

> List all cashreports for a store

```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":[]},{"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"},"ExtendedTillCashReportSchema":{"title":"ExtendedTillCashReportSchema","allOf":[{"type":"object","required":["tillUid","tillName","tillNumber"],"properties":{"tillUid":{"$ref":"#/components/schemas/UID"},"tillName":{"type":"string"},"tillNumber":{"type":"integer"}}},{"$ref":"#/components/schemas/TillCashReportResponseSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"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"]},"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":{"StoreCashreportListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedTillCashReportSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/cashreports":{"get":{"description":"List all cashreports for a store","operationId":"get-tenants-stores-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/StoreCashreportListResponse"}},"summary":"List all cash control reports for a store","tags":["Store"]}}}}
```

## List all visitor records for a list of stores

> List all visitor records for a list of stores

```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":[]},{"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":{"StoreVisitorListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StoreVisitorResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"StoreVisitorResponseSchema":{"title":"StoreVisitorResponseSchema","type":"object","required":["storeVisitorUid","storeUid","dateTime","visitorCount"],"properties":{"storeVisitorUid":{"$ref":"#/components/schemas/UID"},"storeUid":{"$ref":"#/components/schemas/UID"},"dateTime":{"type":"string","format":"date-time"},"visitorCount":{"type":"integer"}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"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"},"StoreVisitorRequestSchema":{"title":"StoreVisitorRequestSchema","type":"object","required":["fromDateTime","toDateTime","storeUids"],"properties":{"fromDateTime":{"type":"string","format":"date-time"},"toDateTime":{"type":"string","format":"date-time"},"storeUids":{"type":"array","items":{"$ref":"#/components/schemas/UID"}}}},"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"}},"requestBodies":{"StoreVisitorRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreVisitorRequestSchema"}}}}},"parameters":{"pageSizeQuery":{"description":"The number of items per page in a result set.","in":"query","name":"pageSize","required":false,"schema":{"type":"integer"}},"pageNumberQuery":{"description":"Reference to a specific page in a result set.","in":"query","name":"pageNumber","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"}}},"paths":{"/tenants/{tenantUid}/stores/visitors":{"post":{"summary":"List all visitor records for a list of stores","description":"List all visitor records for a list of stores","responses":{"200":{"$ref":"#/components/responses/StoreVisitorListResponse"}},"operationId":"get-tenant-store-visitors","requestBody":{"$ref":"#/components/requestBodies/StoreVisitorRequest"},"tags":["Store"],"parameters":[{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"}]}}}}
```

## List store addresses

> List store additional addresses.

```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":[]},{"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":{"StoreAddressListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"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"},"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"}},"parameters":{"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"},"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"}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/addresses":{"get":{"summary":"List store addresses","tags":["Store"],"responses":{"200":{"$ref":"#/components/responses/StoreAddressListResponse"}},"operationId":"get-stores-addresses","description":"List store additional addresses.","parameters":[{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"}]}}}}
```

## Create new store address

> Create new store address\
> \
> Required permissions: STORE

```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":[]},{"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":{"StoreAddressResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}}}}},"schemas":{"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"}},"requestBodies":{"StoreAddressCreateRequest":{"content":{"application/json":{"schema":{"type":"object","required":["type","companyName","address","postalCode","city","countryCode"],"properties":{"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"companyName":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"vatNumber":{"type":"string"},"storeAddressUid":{"$ref":"#/components/schemas/OptionalUID"},"default":{"type":"boolean"}}}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/addresses":{"post":{"summary":"Create new store address","tags":["Store"],"responses":{"201":{"$ref":"#/components/responses/StoreAddressResponse"}},"operationId":"post-stores-addresses","description":"Create new store address\n\nRequired permissions: STORE","requestBody":{"$ref":"#/components/requestBodies/StoreAddressCreateRequest"}}}}}
```

## Get store address

> Get a store address\
> \
> Required permissions: STORE

```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":[]},{"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":{"StoreAddressResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}}}}},"schemas":{"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/addresses/{storeAddressUid}":{"get":{"summary":"Get store address","tags":["Store"],"responses":{"200":{"$ref":"#/components/responses/StoreAddressResponse"}},"operationId":"get-stores-addresses-storeAddressUid","description":"Get a store address\n\nRequired permissions: STORE"}}}}
```

## Update store address

> Update a store address\
> \
> Required permissions: STORE

```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":[]},{"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":{"StoreAddressResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreAddressResponseSchema"}}}}},"schemas":{"StoreAddressResponseSchema":{"title":"StoreAddressResponseSchema","allOf":[{"type":"object","required":["storeAddressUid","companyName","vatNumber","address","postalCode","city","countryCode","email","phone","type","default"],"properties":{"storeAddressUid":{"$ref":"#/components/schemas/UID"},"companyName":{"type":"string"},"vatNumber":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"type":{"$ref":"#/components/schemas/StoreAddressTypeENUM"},"default":{"type":"boolean"}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"StoreAddressTypeENUM":{"title":"StoreAddressTypeENUM","enum":["PURCHASE_INVOICE_ADDRESS","DELIVERY_ADDRESS"],"type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}},"requestBodies":{"StoreAddressUpdateRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"companyName":{"type":"string"},"address":{"type":"string"},"postalCode":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"vatNumber":{"type":"string"},"default":{"type":"boolean"}}}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/addresses/{storeAddressUid}":{"put":{"summary":"Update store address","tags":["Store"],"responses":{"200":{"$ref":"#/components/responses/StoreAddressResponse"}},"operationId":"put-stores-addresses","description":"Update a store address\n\nRequired permissions: STORE","requestBody":{"$ref":"#/components/requestBodies/StoreAddressUpdateRequest"}}}}}
```

## Delete store address

> Delete a store address\
> \
> Required permissions: STORE

```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":[]},{"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}/addresses/{storeAddressUid}":{"delete":{"summary":"Delete store address","tags":["Store"],"responses":{"204":{"description":"No Content"}},"operationId":"delete-stores-addresses","description":"Delete a store address\n\nRequired permissions: STORE"}}}}
```

## List store cash reconciliations

> List store cash reconciliations\
> \
> Required permissions: TILL\_OPERATION

```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":[]},{"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":{"StoreCashReconciliationListResponse":{"description":"Example response","content":{"application/json":{"schema":{"type":"object","required":["items","paging"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/StoreCashReconciliationSchema"}},"paging":{"$ref":"#/components/schemas/Paging"}}}}}}},"schemas":{"StoreCashReconciliationSchema":{"title":"StoreCashReconciliationSchema","allOf":[{"type":"object","required":["storeCashReconciliationUid","reconciliationDate","balance","depositAmount","deposits","status","note","tenantUserUid","tenantUserDisplayName","review","cashReports"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"balance":{"type":"integer"},"depositAmount":{"type":"integer"},"deposits":{"type":"array","items":{"$ref":"#/components/schemas/CashDepositSchema"}},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"},"review":{"$ref":"#/components/schemas/StoreCashReconciliationReviewSchema"},"cashReports":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedTillCashReportSchema"}}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"CashDepositSchema":{"title":"CashDepositSchema","type":"object","required":["cashDepositUid","depositNumber","amount","depositedAt","denominations","reconciliations"],"properties":{"cashDepositUid":{"$ref":"#/components/schemas/UID"},"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"reconciliations":{"type":"array","items":{"$ref":"#/components/schemas/StoreCashReconciliationSummary"}}}},"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"},"StoreCashReconciliationSummary":{"title":"StoreCashReconciliationSummary","type":"object","required":["storeCashReconciliationUid","reconciliationDate","depositAmount","status"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"}}},"StoreCashReconciliationStatusENUM":{"type":"string","title":"StoreCashReconciliationStatusENUM","enum":["IN_PROGRESS","COMPLETE","NOT_STARTED"]},"StoreCashReconciliationReviewSchema":{"title":"StoreCashReconciliationReviewSchema","type":"object","nullable":true,"required":["reviewedAt","approved","note","tenantUserUid","tenantUserDisplayName"],"properties":{"reviewedAt":{"type":"string","format":"date-time"},"approved":{"type":"boolean"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"}}},"ExtendedTillCashReportSchema":{"title":"ExtendedTillCashReportSchema","allOf":[{"type":"object","required":["tillUid","tillName","tillNumber"],"properties":{"tillUid":{"$ref":"#/components/schemas/UID"},"tillName":{"type":"string"},"tillNumber":{"type":"integer"}}},{"$ref":"#/components/schemas/TillCashReportResponseSchema"}]},"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"]},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"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"},"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"}},"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"},"reconciliationDateFromQuery":{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Reconcilation date GTE"},"reconciliationDateToQuery":{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Reconciliation date LTE"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/cash-reconciliations":{"get":{"summary":"List store cash reconciliations","tags":["Store"],"responses":{"200":{"$ref":"#/components/responses/StoreCashReconciliationListResponse"}},"operationId":"get-stores-cash-reconciliations","description":"List store cash reconciliations\n\nRequired permissions: TILL_OPERATION","parameters":[{"$ref":"#/components/parameters/pageNumberQuery"},{"$ref":"#/components/parameters/pageSizeQuery"},{"$ref":"#/components/parameters/sortByQuery"},{"$ref":"#/components/parameters/sortDirectionQuery"},{"$ref":"#/components/parameters/reconciliationDateFromQuery"},{"$ref":"#/components/parameters/reconciliationDateToQuery"}]}}}}
```

## Create store cash reconciliation

> Create new cash reconciliation for store\
> \
> Required permissions: TILL\_OPERATION

```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":[]},{"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":{"StoreCashReconciliationResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCashReconciliationSchema"}}},"headers":{}}},"schemas":{"StoreCashReconciliationSchema":{"title":"StoreCashReconciliationSchema","allOf":[{"type":"object","required":["storeCashReconciliationUid","reconciliationDate","balance","depositAmount","deposits","status","note","tenantUserUid","tenantUserDisplayName","review","cashReports"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"balance":{"type":"integer"},"depositAmount":{"type":"integer"},"deposits":{"type":"array","items":{"$ref":"#/components/schemas/CashDepositSchema"}},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"},"review":{"$ref":"#/components/schemas/StoreCashReconciliationReviewSchema"},"cashReports":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedTillCashReportSchema"}}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"CashDepositSchema":{"title":"CashDepositSchema","type":"object","required":["cashDepositUid","depositNumber","amount","depositedAt","denominations","reconciliations"],"properties":{"cashDepositUid":{"$ref":"#/components/schemas/UID"},"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"reconciliations":{"type":"array","items":{"$ref":"#/components/schemas/StoreCashReconciliationSummary"}}}},"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"},"StoreCashReconciliationSummary":{"title":"StoreCashReconciliationSummary","type":"object","required":["storeCashReconciliationUid","reconciliationDate","depositAmount","status"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"}}},"StoreCashReconciliationStatusENUM":{"type":"string","title":"StoreCashReconciliationStatusENUM","enum":["IN_PROGRESS","COMPLETE","NOT_STARTED"]},"StoreCashReconciliationReviewSchema":{"title":"StoreCashReconciliationReviewSchema","type":"object","nullable":true,"required":["reviewedAt","approved","note","tenantUserUid","tenantUserDisplayName"],"properties":{"reviewedAt":{"type":"string","format":"date-time"},"approved":{"type":"boolean"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"}}},"ExtendedTillCashReportSchema":{"title":"ExtendedTillCashReportSchema","allOf":[{"type":"object","required":["tillUid","tillName","tillNumber"],"properties":{"tillUid":{"$ref":"#/components/schemas/UID"},"tillName":{"type":"string"},"tillNumber":{"type":"integer"}}},{"$ref":"#/components/schemas/TillCashReportResponseSchema"}]},"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"]},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"TillCashReportKey":{"title":"TillCashRegisterStatusKey","type":"object","required":["tillUid","cashReportUid"],"properties":{"tillUid":{"$ref":"#/components/schemas/UID"},"cashReportUid":{"$ref":"#/components/schemas/UID"}}},"StoreCashReconciliationReviewRequestSchema":{"title":"StoreCashReconciliationReviewRequestSchema","type":"object","required":["tenantUserUid","reviewedAt","approved","pin"],"properties":{"tenantUserUid":{"$ref":"#/components/schemas/UID"},"reviewedAt":{"type":"string","format":"date-time"},"approved":{"type":"boolean"},"note":{"type":"string"},"pin":{"type":"string"}}}},"requestBodies":{"StoreCashReconciliationCreateRequest":{"content":{"application/json":{"schema":{"type":"object","required":["reconciliationDate","tenantUserUid"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/OptionalUID"},"reconciliationDate":{"type":"string","format":"date"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"},"note":{"type":"string"},"cashReports":{"type":"array","items":{"$ref":"#/components/schemas/TillCashReportKey"}},"review":{"$ref":"#/components/schemas/StoreCashReconciliationReviewRequestSchema"}}}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/cash-reconciliations":{"post":{"summary":"Create store cash reconciliation","tags":["Store"],"responses":{"201":{"$ref":"#/components/responses/StoreCashReconciliationResponse"}},"operationId":"post-stores-cash-reconciliations","description":"Create new cash reconciliation for store\n\nRequired permissions: TILL_OPERATION","requestBody":{"$ref":"#/components/requestBodies/StoreCashReconciliationCreateRequest"}}}}}
```

## Get store cash reconciliation

> Get a store cash reconciliation by its UID.\
> \
> Required permissions: TILL\_OPERATION

```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":[]},{"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":{"StoreCashReconciliationResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCashReconciliationSchema"}}},"headers":{}}},"schemas":{"StoreCashReconciliationSchema":{"title":"StoreCashReconciliationSchema","allOf":[{"type":"object","required":["storeCashReconciliationUid","reconciliationDate","balance","depositAmount","deposits","status","note","tenantUserUid","tenantUserDisplayName","review","cashReports"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"balance":{"type":"integer"},"depositAmount":{"type":"integer"},"deposits":{"type":"array","items":{"$ref":"#/components/schemas/CashDepositSchema"}},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"},"review":{"$ref":"#/components/schemas/StoreCashReconciliationReviewSchema"},"cashReports":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedTillCashReportSchema"}}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"CashDepositSchema":{"title":"CashDepositSchema","type":"object","required":["cashDepositUid","depositNumber","amount","depositedAt","denominations","reconciliations"],"properties":{"cashDepositUid":{"$ref":"#/components/schemas/UID"},"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"reconciliations":{"type":"array","items":{"$ref":"#/components/schemas/StoreCashReconciliationSummary"}}}},"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"},"StoreCashReconciliationSummary":{"title":"StoreCashReconciliationSummary","type":"object","required":["storeCashReconciliationUid","reconciliationDate","depositAmount","status"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"}}},"StoreCashReconciliationStatusENUM":{"type":"string","title":"StoreCashReconciliationStatusENUM","enum":["IN_PROGRESS","COMPLETE","NOT_STARTED"]},"StoreCashReconciliationReviewSchema":{"title":"StoreCashReconciliationReviewSchema","type":"object","nullable":true,"required":["reviewedAt","approved","note","tenantUserUid","tenantUserDisplayName"],"properties":{"reviewedAt":{"type":"string","format":"date-time"},"approved":{"type":"boolean"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"}}},"ExtendedTillCashReportSchema":{"title":"ExtendedTillCashReportSchema","allOf":[{"type":"object","required":["tillUid","tillName","tillNumber"],"properties":{"tillUid":{"$ref":"#/components/schemas/UID"},"tillName":{"type":"string"},"tillNumber":{"type":"integer"}}},{"$ref":"#/components/schemas/TillCashReportResponseSchema"}]},"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"]},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/cash-reconciliations/{storeCashReconciliationUid}":{"get":{"summary":"Get store cash reconciliation","tags":["Store"],"responses":{"200":{"$ref":"#/components/responses/StoreCashReconciliationResponse"}},"operationId":"get-stores-cash-reconciliations-storeCashReconciliationUid","description":"Get a store cash reconciliation by its UID.\n\nRequired permissions: TILL_OPERATION"}}}}
```

## Update store cash reconciliation

> Update a store cash reconciliation\
> \
> Required permissions: TILL\_OPERATION

```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":[]},{"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":{"StoreCashReconciliationResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StoreCashReconciliationSchema"}}},"headers":{}}},"schemas":{"StoreCashReconciliationSchema":{"title":"StoreCashReconciliationSchema","allOf":[{"type":"object","required":["storeCashReconciliationUid","reconciliationDate","balance","depositAmount","deposits","status","note","tenantUserUid","tenantUserDisplayName","review","cashReports"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"balance":{"type":"integer"},"depositAmount":{"type":"integer"},"deposits":{"type":"array","items":{"$ref":"#/components/schemas/CashDepositSchema"}},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"},"review":{"$ref":"#/components/schemas/StoreCashReconciliationReviewSchema"},"cashReports":{"type":"array","items":{"$ref":"#/components/schemas/ExtendedTillCashReportSchema"}}}},{"$ref":"#/components/schemas/CreatedModifiedSchema"}]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"CashDepositSchema":{"title":"CashDepositSchema","type":"object","required":["cashDepositUid","depositNumber","amount","depositedAt","denominations","reconciliations"],"properties":{"cashDepositUid":{"$ref":"#/components/schemas/UID"},"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"reconciliations":{"type":"array","items":{"$ref":"#/components/schemas/StoreCashReconciliationSummary"}}}},"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"},"StoreCashReconciliationSummary":{"title":"StoreCashReconciliationSummary","type":"object","required":["storeCashReconciliationUid","reconciliationDate","depositAmount","status"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"}}},"StoreCashReconciliationStatusENUM":{"type":"string","title":"StoreCashReconciliationStatusENUM","enum":["IN_PROGRESS","COMPLETE","NOT_STARTED"]},"StoreCashReconciliationReviewSchema":{"title":"StoreCashReconciliationReviewSchema","type":"object","nullable":true,"required":["reviewedAt","approved","note","tenantUserUid","tenantUserDisplayName"],"properties":{"reviewedAt":{"type":"string","format":"date-time"},"approved":{"type":"boolean"},"note":{"type":"string"},"tenantUserUid":{"$ref":"#/components/schemas/UID"},"tenantUserDisplayName":{"type":"string"}}},"ExtendedTillCashReportSchema":{"title":"ExtendedTillCashReportSchema","allOf":[{"type":"object","required":["tillUid","tillName","tillNumber"],"properties":{"tillUid":{"$ref":"#/components/schemas/UID"},"tillName":{"type":"string"},"tillNumber":{"type":"integer"}}},{"$ref":"#/components/schemas/TillCashReportResponseSchema"}]},"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"]},"TillStatusENUM":{"enum":["OPEN","CLOSED","CLOSED_NOT_COUNTED"],"title":"TillStatus","type":"string"},"CreatedModifiedSchema":{"title":"CreatedModifiedSchema","type":"object","required":["createdBy","createdAt","lastModifiedBy","lastModifiedAt"],"properties":{"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"TillCashReportKey":{"title":"TillCashRegisterStatusKey","type":"object","required":["tillUid","cashReportUid"],"properties":{"tillUid":{"$ref":"#/components/schemas/UID"},"cashReportUid":{"$ref":"#/components/schemas/UID"}}},"StoreCashReconciliationReviewRequestSchema":{"title":"StoreCashReconciliationReviewRequestSchema","type":"object","required":["tenantUserUid","reviewedAt","approved","pin"],"properties":{"tenantUserUid":{"$ref":"#/components/schemas/UID"},"reviewedAt":{"type":"string","format":"date-time"},"approved":{"type":"boolean"},"note":{"type":"string"},"pin":{"type":"string"}}}},"requestBodies":{"StoreCashReconciliationUpdateRequest":{"content":{"application/json":{"schema":{"type":"object","properties":{"reconciliationDate":{"type":"string","format":"date"},"tenantUserUid":{"$ref":"#/components/schemas/OptionalUID"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"},"note":{"type":"string"},"cashReports":{"type":"array","items":{"$ref":"#/components/schemas/TillCashReportKey"}},"review":{"$ref":"#/components/schemas/StoreCashReconciliationReviewRequestSchema"}}}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/cash-reconciliations/{storeCashReconciliationUid}":{"put":{"summary":"Update store cash reconciliation","tags":["Store"],"responses":{"200":{"$ref":"#/components/responses/StoreCashReconciliationResponse"}},"operationId":"put-stores-cash-reconciliations-storeCashReconciliationUid","description":"Update a store cash reconciliation\n\nRequired permissions: TILL_OPERATION","requestBody":{"$ref":"#/components/requestBodies/StoreCashReconciliationUpdateRequest"}}}}}
```

## Delete store cash reconciliation

> Delete a store cash reconciliation record.\
> \
> Required permissions: TILL\_OPERATION

```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":[]},{"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}/cash-reconciliations/{storeCashReconciliationUid}":{"delete":{"summary":"Delete store cash reconciliation","tags":["Store"],"responses":{"204":{"description":"No Content"}},"operationId":"delete-stores-cash-reconciliations-storeCashReconciliationUid","description":"Delete a store cash reconciliation record.\n\nRequired permissions: TILL_OPERATION"}}}}
```

## Create cash deposit

> Create cash deposit.\
> \
> Required permissions: TILL\_OPERATION

```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":[]},{"authToken":[]},{"accessToken":[]}],"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"}},"responses":{"CashDepositResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDepositSchema"}}}}},"schemas":{"CashDepositSchema":{"title":"CashDepositSchema","type":"object","required":["cashDepositUid","depositNumber","amount","depositedAt","denominations","reconciliations"],"properties":{"cashDepositUid":{"$ref":"#/components/schemas/UID"},"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"reconciliations":{"type":"array","items":{"$ref":"#/components/schemas/StoreCashReconciliationSummary"}}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"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"},"StoreCashReconciliationSummary":{"title":"StoreCashReconciliationSummary","type":"object","required":["storeCashReconciliationUid","reconciliationDate","depositAmount","status"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"}}},"StoreCashReconciliationStatusENUM":{"type":"string","title":"StoreCashReconciliationStatusENUM","enum":["IN_PROGRESS","COMPLETE","NOT_STARTED"]},"CashDepositRequestSchema":{"title":"CashDepositRequestSchema","type":"object","properties":{"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}}},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"}},"requestBodies":{"CashDepositCreateRequest":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/CashDepositRequestSchema"},{"type":"object","properties":{"cashDepositUid":{"$ref":"#/components/schemas/OptionalUID"}}}]}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/cash-reconciliations/{storeCashReconciliationUid}/cashdeposits":{"post":{"summary":"Create cash deposit","tags":["Store"],"responses":{"201":{"$ref":"#/components/responses/CashDepositResponse"}},"operationId":"post-stores-cash-reconciliations-cashdeposits","description":"Create cash deposit.\n\nRequired permissions: TILL_OPERATION","requestBody":{"$ref":"#/components/requestBodies/CashDepositCreateRequest"}}}}}
```

## Update cash deposit

> Update cash deposit.\
> \
> Required permissions: TILL\_OPERATION

```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":[]},{"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":{"CashDepositResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDepositSchema"}}}}},"schemas":{"CashDepositSchema":{"title":"CashDepositSchema","type":"object","required":["cashDepositUid","depositNumber","amount","depositedAt","denominations","reconciliations"],"properties":{"cashDepositUid":{"$ref":"#/components/schemas/UID"},"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}},"reconciliations":{"type":"array","items":{"$ref":"#/components/schemas/StoreCashReconciliationSummary"}}}},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"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"},"StoreCashReconciliationSummary":{"title":"StoreCashReconciliationSummary","type":"object","required":["storeCashReconciliationUid","reconciliationDate","depositAmount","status"],"properties":{"storeCashReconciliationUid":{"$ref":"#/components/schemas/UID"},"reconciliationDate":{"type":"string","format":"date"},"depositAmount":{"type":"integer"},"status":{"$ref":"#/components/schemas/StoreCashReconciliationStatusENUM"}}},"StoreCashReconciliationStatusENUM":{"type":"string","title":"StoreCashReconciliationStatusENUM","enum":["IN_PROGRESS","COMPLETE","NOT_STARTED"]},"CashDepositRequestSchema":{"title":"CashDepositRequestSchema","type":"object","properties":{"depositNumber":{"type":"string"},"amount":{"type":"integer"},"depositedAt":{"type":"string","format":"date-time"},"denominations":{"type":"array","items":{"$ref":"#/components/schemas/CashDetailSchema"}}}}},"requestBodies":{"CashDepositUpdateRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CashDepositRequestSchema"}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/cash-reconciliations/{storeCashReconciliationUid}/cashdeposits/{cashDepositUid}":{"put":{"summary":"Update cash deposit","tags":["Store"],"responses":{"200":{"$ref":"#/components/responses/CashDepositResponse"}},"operationId":"put-stores-cash-reconciliations-cashdeposits-cashDepositUid","description":"Update cash deposit.\n\nRequired permissions: TILL_OPERATION","requestBody":{"$ref":"#/components/requestBodies/CashDepositUpdateRequest"}}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flowretail.com/api/store.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.