Receipt

Receipt

Search for order receipts in all stores on tenant

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/receipts/search

Optionally narrow down the search to order in given stores and organizatons.

The field orderStatuses can not be used in combination with the fields orderStates, settleStates or deliveryStates.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Body

application/json

Search for order receipts in all stores on tenant.

An empty string will be ignored, and handled as if the key did not exist in the payload.

Fuzzy search means that it will try to find words that contains the query string that is supplied. The search is case-insensitive. Example: If you search for "Ol" you will get "Olsen", "Olstad", "Bolset", "Ormebol", [e-mail], etc ..

storeUidsstring[]Optional

organizationUidsstring[]Optional

customerQuerystringOptional

Search for orders containting this customer. The customer can be specific by firstname, lastname, phonenumber or email. This is a fuzzy search.

customerUidsstring[]Optional

settledAtFromstring · date-timeOptional

orderNumberstringOptional

Search for an order receipt on an order with a specific ordernumber. This is an exact lookup

voucherNumberstringOptionalDeprecated

Deprecated: Use voucherNumbers instead.

voucherNumbersstring[]Optional

Search for multiple order receipts by voucher numbers. This is an exact lookup

productSkusstring[]Optional

Search for order receipts containing the products. These must be SKUs and is an exact lookup.

tenantPaymentMethodUidsstring[]Optional

Search for order receipts containing one of the specified payment methods.

settledAtTostring · date-timeOptional

tenantUserUidsstring[]Optional

querystringOptional

General fuzzy search.

productUidsstring[]Optional

hasUnpaidInvoicesbooleanOptional

When this is set to true, only unpaid receipts/invoices will be in the response.

settlementExternalPaymentReferencesstring[]Optional

Search for receipts with settlement with the specified external payment reference.

Responses

200

Example response

application/json

post/tenants/{tenantUid}/receipts/search

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/receipts/search HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 487

{
  "storeUids": [
    "text"
  ],
  "organizationUids": [
    "text"
  ],
  "customerQuery": "text",
  "customerUids": [
    "text"
  ],
  "settledAtFrom": "2026-07-20T03:49:45.204Z",
  "orderNumber": "text",
  "voucherNumbers": [
    "text"
  ],
  "productSkus": [
    "text"
  ],
  "tenantPaymentMethodUids": [
    "text"
  ],
  "settledAtTo": "2026-07-20T03:49:45.204Z",
  "tenantUserUids": [
    "text"
  ],
  "deliveryStates": [
    "NOT_STARTED"
  ],
  "query": "text",
  "productUids": [
    "text"
  ],
  "amountRange": {
    "from": 1,
    "to": 1
  },
  "hasUnpaidInvoices": true,
  "settlementExternalPaymentReferences": [
    "text"
  ]
}

200

Example response

{
  "items": [
    {
      "storeUid": "text",
      "orderUid": "text",
      "orderReceiptUid": "text",
      "settleState": "NOT_STARTED",
      "voucherNumber": "text",
      "externalVoucherNumber": "text",
      "sellerDisplayName": "text",
      "settledAt": "2026-07-20T03:49:45.204Z",
      "deliveryState": "NOT_STARTED",
      "grandTotal": 1,
      "settlementTotals": {
        "change": 1,
        "remaining": 1,
        "remainingRounded": 1,
        "totals": 1,
        "remainingPrePayment": 1,
        "remainingAuthorizedAmount": 1
      },
      "settlements": [
        {
          "amount": 1,
          "createdAt": "2026-07-20T03:49:45.204Z",
          "displayMessages": [
            {
              "key": "text",
              "message": "text",
              "timestamp": "2026-07-20T03:49:45.204Z"
            }
          ],
          "externalId": "text",
          "externalPaymentReference": "text",
          "idMethod": "NO_CVM_RULE_PERFORMED",
          "lastModifiedAt": "2026-07-20T03:49:45.204Z",
          "ledgerNumber": "text",
          "ledgerType": "LEDGER",
          "parameters": [
            {
              "key": "text",
              "value": "text",
              "name": "text",
              "type": "TEXT"
            }
          ],
          "settledAt": "2026-07-20T03:49:45.204Z",
          "settlementCode": "text",
          "settlementUid": "text",
          "settlementName": "text",
          "state": "NOT_STARTED",
          "status": "NEW",
          "storeSettlementIssuer": {
            "storeSettlementIssuerUid": "text",
            "name": "text",
            "code": "text"
          },
          "tenantUserDisplayName": "text",
          "tenantUserUid": "text",
          "storePaymentMethodUid": "text",
          "currency": {
            "amount": 1,
            "code": "text",
            "exchangeRate": 1
          },
          "additionalDetails": [
            {
              "key": "text",
              "value": "text"
            }
          ],
          "creditCount": 1,
          "creditAmount": 1,
          "paymentCount": 1,
          "paymentAmount": 1,
          "tillUid": "text",
          "tillName": "text",
          "tillNumber": 1,
          "storeUid": "text",
          "storeName": "text",
          "orderReceiptUid": "text",
          "authorizedAmount": 1,
          "capturedAmount": 1,
          "refundedAmount": 1,
          "receiptText": "text",
          "transactions": [
            {
              "transactionType": "text",
              "pspTransactionId": "text",
              "transactionAmount": 1,
              "orderReceiptUid": "text"
            }
          ]
        }
      ],
      "items": [
        {
          "actions": [
            {
              "comment": "text",
              "createdAt": "2026-07-20T03:49:45.204Z",
              "createdBy": "text",
              "handlingActionUid": "text",
              "handlingActionName": "text",
              "handlingDescription": "text",
              "handlingUid": "text",
              "handlingName": "text",
              "lastModifiedAt": "2026-07-20T03:49:45.204Z",
              "lastModifiedBy": "text",
              "orderHandlingActionUid": "text"
            }
          ],
          "allowedActions": [
            "QUANTITY_SOLD"
          ],
          "createdAt": "2026-07-20T03:49:45.204Z",
          "discountReasonCode": "text",
          "externalId": "text",
          "itemCost": 1,
          "itemDiscountAmount": 1,
          "itemDiscountPercentage": 1,
          "itemGrossProfitAmount": 1,
          "itemGrossProfitPercentage": 1,
          "itemPrice": 1,
          "itemVatAmount": 1,
          "lastModifiedAt": "2026-07-20T03:49:45.204Z",
          "ledgerNumber": "text",
          "name": "text",
          "note": "text",
          "orderItemUid": "text",
          "orderLinks": [
            {
              "orderUid": "text",
              "orderItemUid": "text",
              "orderNumber": "text",
              "storeUid": "text",
              "type": "CREDIT"
            }
          ],
          "originalItemPrice": 1,
          "productUid": "text",
          "productType": "STOCK",
          "properties": [
            {
              "uid": "text",
              "key": "text",
              "value": "text"
            }
          ],
          "quantityCredited": 1,
          "quantityDelivered": 1,
          "quantityOrdered": 1,
          "quantityReserved": 1,
          "returnReasonCode": "text",
          "serialnumber": "text",
          "sku": "text",
          "sortOrder": 1,
          "tenantUserDisplayName": "text",
          "tenantUserUid": "text",
          "totalCost": 1,
          "totalDiscountAmount": 1,
          "totalGrossProfitAmount": 1,
          "totalPrice": 1,
          "totalVatAmount": 1,
          "vatCodeUid": "text",
          "warehouseUid": "text",
          "warehouseName": "text",
          "internalInfo": "text",
          "productProperties": [
            {
              "productPropertyUid": "text",
              "propertyName": "text",
              "propertyOptionName": "text",
              "propertyType": "TEXT",
              "propertyText": "text",
              "propertyUid": "text",
              "propertyOptionUid": "text",
              "required": true
            }
          ],
          "coverImage": {
            "productMediaUid": "text",
            "mainUrl": "text",
            "thumbnailUrl": "text"
          },
          "deliveryUid": "text",
          "compensationReasonCode": "text",
          "orderReceiptUid": "text",
          "allowDelivery": "YES",
          "allowDeliveryFromDate": "2026-07-20T03:49:45.204Z",
          "reservationType": "NONE",
          "reservationDetails": {
            "warehouse": {
              "warehouseName": "text"
            },
            "purchaseOrder": {
              "purchaseOrderUid": "text",
              "purchaseOrderItemUid": "text",
              "expectedDeliveryDate": "2026-07-20T03:49:45.204Z",
              "purchaseOrderNumber": "text",
              "quantityOrdered": 1,
              "externalId": "text"
            },
            "receivement": {
              "receivementUid": "text",
              "receivementItemUid": "text",
              "expectedArrival": "2026-07-20T03:49:45.204Z",
              "expectedDispatch": "2026-07-20T03:49:45.204Z",
              "quantity": 1,
              "supplierOrderReference": "text",
              "receivedAt": "2026-07-20T03:49:45.204Z"
            }
          },
          "gtins": [
            {
              "gtin": "text",
              "primary": true,
              "type": "text"
            }
          ]
        }
      ],
      "address": {
        "address": "text",
        "city": "text",
        "companyName": "text",
        "countryCode": "text",
        "email": "text",
        "firstname": "text",
        "lastname": "text",
        "mobile": "text",
        "postalCode": "text",
        "vatNumber": "text",
        "displayName": "text"
      },
      "customerUid": "text",
      "note": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new receipt on order

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts

Create new receipt on order

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

orderItemUidsstring[]Optional

settlementUidsstring[]Optional

orderReceiptUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

201

Example response

application/json

storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderReceiptUidstringRequiredPattern: ^[A-Za-z0-9-_]+

settleStatestring · enumRequired

ENUM	Description
NOT_STARTED	Receipt not started. No complete settlements exists.
IN_PROGRESS	Receipt is in progress. At least one settlement has been started.
COMPLETE	Receipt is complete. Sum of settlements = sum of orderlines.
CANCELED	Receipt is canceled. Can only be done if receiptState = NOT_STARTED.

Possible values:

voucherNumberstringRequired

externalVoucherNumberstringRequired

sellerDisplayNamestringRequired

settledAtstring · date-timeRequired

deliveryStatestring · enumRequired

ENUM	Description
NOT_STARTED	Delivery not started
IN_PROGRESS	Delivery is in progress. Some order lines are still reserved
COMPLETE	Delivery is complete. All order lines are delivered

Possible values:

grandTotalintegerRequired

customerUidstringRequiredPattern: ^[A-Za-z0-9-_]*

notestringRequired

post/tenants/{tenantUid}/stores/{storeUid}/receipts

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/receipts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "orderItemUids": [
    "text"
  ],
  "settlementUids": [
    "text"
  ],
  "orderReceiptUid": "text"
}

201

Example response

{
  "storeUid": "text",
  "orderUid": "text",
  "orderReceiptUid": "text",
  "settleState": "NOT_STARTED",
  "voucherNumber": "text",
  "externalVoucherNumber": "text",
  "sellerDisplayName": "text",
  "settledAt": "2026-07-20T03:49:45.204Z",
  "deliveryState": "NOT_STARTED",
  "grandTotal": 1,
  "settlementTotals": {
    "change": 1,
    "remaining": 1,
    "remainingRounded": 1,
    "totals": 1,
    "remainingPrePayment": 1,
    "remainingAuthorizedAmount": 1
  },
  "settlements": [
    {
      "amount": 1,
      "createdAt": "2026-07-20T03:49:45.204Z",
      "displayMessages": [
        {
          "key": "text",
          "message": "text",
          "timestamp": "2026-07-20T03:49:45.204Z"
        }
      ],
      "externalId": "text",
      "externalPaymentReference": "text",
      "idMethod": "NO_CVM_RULE_PERFORMED",
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "parameters": [
        {
          "key": "text",
          "value": "text",
          "name": "text",
          "type": "TEXT"
        }
      ],
      "settledAt": "2026-07-20T03:49:45.204Z",
      "settlementCode": "text",
      "settlementUid": "text",
      "settlementName": "text",
      "state": "NOT_STARTED",
      "status": "NEW",
      "storeSettlementIssuer": {
        "storeSettlementIssuerUid": "text",
        "name": "text",
        "code": "text"
      },
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "storePaymentMethodUid": "text",
      "currency": {
        "amount": 1,
        "code": "text",
        "exchangeRate": 1
      },
      "additionalDetails": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "creditCount": 1,
      "creditAmount": 1,
      "paymentCount": 1,
      "paymentAmount": 1,
      "tillUid": "text",
      "tillName": "text",
      "tillNumber": 1,
      "storeUid": "text",
      "storeName": "text",
      "orderReceiptUid": "text",
      "authorizedAmount": 1,
      "capturedAmount": 1,
      "refundedAmount": 1,
      "receiptText": "text",
      "transactions": [
        {
          "transactionType": "text",
          "pspTransactionId": "text",
          "transactionAmount": 1,
          "orderReceiptUid": "text"
        }
      ]
    }
  ],
  "items": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2026-07-20T03:49:45.204Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2026-07-20T03:49:45.204Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2026-07-20T03:49:45.204Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2026-07-20T03:49:45.204Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2026-07-20T03:49:45.204Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2026-07-20T03:49:45.204Z",
          "expectedDispatch": "2026-07-20T03:49:45.204Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2026-07-20T03:49:45.204Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "address": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "mobile": "text",
    "postalCode": "text",
    "vatNumber": "text",
    "displayName": "text"
  },
  "customerUid": "text",
  "note": "text"
}

Get Receipt Details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}

Get Receipt Details

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderReceiptUidstringRequiredPattern: ^[A-Za-z0-9-_]+

settleStatestring · enumRequired

ENUM	Description
NOT_STARTED	Receipt not started. No complete settlements exists.
IN_PROGRESS	Receipt is in progress. At least one settlement has been started.
COMPLETE	Receipt is complete. Sum of settlements = sum of orderlines.
CANCELED	Receipt is canceled. Can only be done if receiptState = NOT_STARTED.

Possible values:

voucherNumberstringRequired

externalVoucherNumberstringRequired

sellerDisplayNamestringRequired

settledAtstring · date-timeRequired

deliveryStatestring · enumRequired

ENUM	Description
NOT_STARTED	Delivery not started
IN_PROGRESS	Delivery is in progress. Some order lines are still reserved
COMPLETE	Delivery is complete. All order lines are delivered

Possible values:

grandTotalintegerRequired

customerUidstringRequiredPattern: ^[A-Za-z0-9-_]*

notestringRequired

get/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "storeUid": "text",
  "orderUid": "text",
  "orderReceiptUid": "text",
  "settleState": "NOT_STARTED",
  "voucherNumber": "text",
  "externalVoucherNumber": "text",
  "sellerDisplayName": "text",
  "settledAt": "2026-07-20T03:49:45.204Z",
  "deliveryState": "NOT_STARTED",
  "grandTotal": 1,
  "settlementTotals": {
    "change": 1,
    "remaining": 1,
    "remainingRounded": 1,
    "totals": 1,
    "remainingPrePayment": 1,
    "remainingAuthorizedAmount": 1
  },
  "settlements": [
    {
      "amount": 1,
      "createdAt": "2026-07-20T03:49:45.204Z",
      "displayMessages": [
        {
          "key": "text",
          "message": "text",
          "timestamp": "2026-07-20T03:49:45.204Z"
        }
      ],
      "externalId": "text",
      "externalPaymentReference": "text",
      "idMethod": "NO_CVM_RULE_PERFORMED",
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "parameters": [
        {
          "key": "text",
          "value": "text",
          "name": "text",
          "type": "TEXT"
        }
      ],
      "settledAt": "2026-07-20T03:49:45.204Z",
      "settlementCode": "text",
      "settlementUid": "text",
      "settlementName": "text",
      "state": "NOT_STARTED",
      "status": "NEW",
      "storeSettlementIssuer": {
        "storeSettlementIssuerUid": "text",
        "name": "text",
        "code": "text"
      },
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "storePaymentMethodUid": "text",
      "currency": {
        "amount": 1,
        "code": "text",
        "exchangeRate": 1
      },
      "additionalDetails": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "creditCount": 1,
      "creditAmount": 1,
      "paymentCount": 1,
      "paymentAmount": 1,
      "tillUid": "text",
      "tillName": "text",
      "tillNumber": 1,
      "storeUid": "text",
      "storeName": "text",
      "orderReceiptUid": "text",
      "authorizedAmount": 1,
      "capturedAmount": 1,
      "refundedAmount": 1,
      "receiptText": "text",
      "transactions": [
        {
          "transactionType": "text",
          "pspTransactionId": "text",
          "transactionAmount": 1,
          "orderReceiptUid": "text"
        }
      ]
    }
  ],
  "items": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2026-07-20T03:49:45.204Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2026-07-20T03:49:45.204Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2026-07-20T03:49:45.204Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2026-07-20T03:49:45.204Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2026-07-20T03:49:45.204Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2026-07-20T03:49:45.204Z",
          "expectedDispatch": "2026-07-20T03:49:45.204Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2026-07-20T03:49:45.204Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "address": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "mobile": "text",
    "postalCode": "text",
    "vatNumber": "text",
    "displayName": "text"
  },
  "customerUid": "text",
  "note": "text"
}

Update a receipt

put

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}

Update a receipt

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

externalVoucherNumberstringOptional

Responses

201

Example response

application/json

storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderReceiptUidstringRequiredPattern: ^[A-Za-z0-9-_]+

settleStatestring · enumRequired

ENUM	Description
NOT_STARTED	Receipt not started. No complete settlements exists.
IN_PROGRESS	Receipt is in progress. At least one settlement has been started.
COMPLETE	Receipt is complete. Sum of settlements = sum of orderlines.
CANCELED	Receipt is canceled. Can only be done if receiptState = NOT_STARTED.

Possible values:

voucherNumberstringRequired

externalVoucherNumberstringRequired

sellerDisplayNamestringRequired

settledAtstring · date-timeRequired

deliveryStatestring · enumRequired

ENUM	Description
NOT_STARTED	Delivery not started
IN_PROGRESS	Delivery is in progress. Some order lines are still reserved
COMPLETE	Delivery is complete. All order lines are delivered

Possible values:

grandTotalintegerRequired

customerUidstringRequiredPattern: ^[A-Za-z0-9-_]*

notestringRequired

put/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}

HTTPcURLJavaScriptPython

PUT /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "externalVoucherNumber": "text"
}

201

Example response

{
  "storeUid": "text",
  "orderUid": "text",
  "orderReceiptUid": "text",
  "settleState": "NOT_STARTED",
  "voucherNumber": "text",
  "externalVoucherNumber": "text",
  "sellerDisplayName": "text",
  "settledAt": "2026-07-20T03:49:45.204Z",
  "deliveryState": "NOT_STARTED",
  "grandTotal": 1,
  "settlementTotals": {
    "change": 1,
    "remaining": 1,
    "remainingRounded": 1,
    "totals": 1,
    "remainingPrePayment": 1,
    "remainingAuthorizedAmount": 1
  },
  "settlements": [
    {
      "amount": 1,
      "createdAt": "2026-07-20T03:49:45.204Z",
      "displayMessages": [
        {
          "key": "text",
          "message": "text",
          "timestamp": "2026-07-20T03:49:45.204Z"
        }
      ],
      "externalId": "text",
      "externalPaymentReference": "text",
      "idMethod": "NO_CVM_RULE_PERFORMED",
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "parameters": [
        {
          "key": "text",
          "value": "text",
          "name": "text",
          "type": "TEXT"
        }
      ],
      "settledAt": "2026-07-20T03:49:45.204Z",
      "settlementCode": "text",
      "settlementUid": "text",
      "settlementName": "text",
      "state": "NOT_STARTED",
      "status": "NEW",
      "storeSettlementIssuer": {
        "storeSettlementIssuerUid": "text",
        "name": "text",
        "code": "text"
      },
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "storePaymentMethodUid": "text",
      "currency": {
        "amount": 1,
        "code": "text",
        "exchangeRate": 1
      },
      "additionalDetails": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "creditCount": 1,
      "creditAmount": 1,
      "paymentCount": 1,
      "paymentAmount": 1,
      "tillUid": "text",
      "tillName": "text",
      "tillNumber": 1,
      "storeUid": "text",
      "storeName": "text",
      "orderReceiptUid": "text",
      "authorizedAmount": 1,
      "capturedAmount": 1,
      "refundedAmount": 1,
      "receiptText": "text",
      "transactions": [
        {
          "transactionType": "text",
          "pspTransactionId": "text",
          "transactionAmount": 1,
          "orderReceiptUid": "text"
        }
      ]
    }
  ],
  "items": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2026-07-20T03:49:45.204Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2026-07-20T03:49:45.204Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2026-07-20T03:49:45.204Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2026-07-20T03:49:45.204Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2026-07-20T03:49:45.204Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2026-07-20T03:49:45.204Z",
          "expectedDispatch": "2026-07-20T03:49:45.204Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2026-07-20T03:49:45.204Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "address": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "mobile": "text",
    "postalCode": "text",
    "vatNumber": "text",
    "displayName": "text"
  },
  "customerUid": "text",
  "note": "text"
}

Delete a receipt

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}

Delete a receipt

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

List settlements for a receipt

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements

List settlements for a receipt

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

Responses

200

Example response

application/jsonapplication/vnd.openxmlformats-officedocument.spreadsheetml.sheet

get/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "amount": 1,
      "createdAt": "2026-07-20T03:49:45.204Z",
      "displayMessages": [
        {
          "key": "text",
          "message": "text",
          "timestamp": "2026-07-20T03:49:45.204Z"
        }
      ],
      "externalId": "text",
      "externalPaymentReference": "text",
      "idMethod": "NO_CVM_RULE_PERFORMED",
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "parameters": [
        {
          "key": "text",
          "value": "text",
          "name": "text",
          "type": "TEXT"
        }
      ],
      "settledAt": "2026-07-20T03:49:45.204Z",
      "settlementCode": "text",
      "settlementUid": "text",
      "settlementName": "text",
      "state": "NOT_STARTED",
      "status": "NEW",
      "storeSettlementIssuer": {
        "storeSettlementIssuerUid": "text",
        "name": "text",
        "code": "text"
      },
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "storePaymentMethodUid": "text",
      "currency": {
        "amount": 1,
        "code": "text",
        "exchangeRate": 1
      },
      "additionalDetails": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "creditCount": 1,
      "creditAmount": 1,
      "paymentCount": 1,
      "paymentAmount": 1,
      "tillUid": "text",
      "tillName": "text",
      "tillNumber": 1,
      "storeUid": "text",
      "storeName": "text",
      "orderReceiptUid": "text",
      "authorizedAmount": 1,
      "capturedAmount": 1,
      "refundedAmount": 1,
      "receiptText": "text",
      "transactions": [
        {
          "transactionType": "text",
          "pspTransactionId": "text",
          "transactionAmount": 1,
          "orderReceiptUid": "text"
        }
      ]
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create new settlement

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements

Create new settlement

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

Create a new settlement

amountintegerRequired

in cents, e.g. 1,50 as 150

externalIdstringOptional

External reference for the settlement

settlementCodestringRequired

settlementUidstringOptionalPattern: ^[A-Za-z0-9-_]+

Responses

201

Example response

application/json

amountintegerRequired

createdAtstring · date-timeRequired

externalIdstringRequired

externalPaymentReferencestringRequired

The external payment reference for this settlement. For invoices, this could contain the KID

idMethodstring · enumRequiredPossible values:

lastModifiedAtstring · date-timeRequired

ledgerNumberstringOptional

Ledger number must be a valid number with possible leading zeros

ledgerTypestring · enumOptional

ENUM	Description
LEDGER	Ledger
GENERAL_LEDGER	General ledger
CUSTOMER_LEDGER	Customer ledger

Possible values:

settledAtstring · date-timeOptional

settlementCodestringRequired

settlementUidstringRequiredPattern: ^[A-Za-z0-9-_]+

settlementNamestringRequired

statestring · enumRequiredPossible values:

statusstring · enumRequiredPossible values:

tenantUserDisplayNamestringRequired

tenantUserUidstringRequiredPattern: ^[A-Za-z0-9-_]+

storePaymentMethodUidstringRequiredPattern: ^[A-Za-z0-9-_]+

creditCountintegerRequired

Number of credits on this settlement. Only applicable for invoice

creditAmountintegerRequired

The total amount credited. Only applicable for invoice

paymentCountintegerRequired

Number of payments on this settlement. Only applicable for invoice

paymentAmountintegerRequired

The total amount of payments. Only applicable for invoice

tillUidstringOptionalPattern: ^[A-Za-z0-9-_]*

tillNamestringOptional

Display name of the till where the payment was registered.

tillNumberintegerOptional

Till register number where the payment was registered.

storeUidstringRequiredPattern: ^[A-Za-z0-9-_]*

storeNamestringRequired

Display name of the store where the payment was registered.

orderReceiptUidstringRequiredPattern: ^[A-Za-z0-9-_]*

authorizedAmountintegerOptional

The total authorized amount on this settlement, calculated from authorize transactions.

capturedAmountintegerOptional

The total captured amount on this settlement, calculated from capture transactions.

refundedAmountintegerOptional

The total refunded amount on this settlement, calculated from refund transactions.

receiptTextstring · max: 500Required

Text printed on the receipt for this payment method when configured on the tenant payment method. Empty when not set, when suppressed for this settlement type (e.g. store credit, gift cards), or when cleared.

post/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "amount": 1,
  "externalId": "text",
  "settlementCode": "text",
  "parameters": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "settlementUid": "text"
}

201

Example response

{
  "amount": 1,
  "createdAt": "2026-07-20T03:49:45.204Z",
  "displayMessages": [
    {
      "key": "text",
      "message": "text",
      "timestamp": "2026-07-20T03:49:45.204Z"
    }
  ],
  "externalId": "text",
  "externalPaymentReference": "text",
  "idMethod": "NO_CVM_RULE_PERFORMED",
  "lastModifiedAt": "2026-07-20T03:49:45.204Z",
  "ledgerNumber": "text",
  "ledgerType": "LEDGER",
  "parameters": [
    {
      "key": "text",
      "value": "text",
      "name": "text",
      "type": "TEXT"
    }
  ],
  "settledAt": "2026-07-20T03:49:45.204Z",
  "settlementCode": "text",
  "settlementUid": "text",
  "settlementName": "text",
  "state": "NOT_STARTED",
  "status": "NEW",
  "storeSettlementIssuer": {
    "storeSettlementIssuerUid": "text",
    "name": "text",
    "code": "text"
  },
  "tenantUserDisplayName": "text",
  "tenantUserUid": "text",
  "storePaymentMethodUid": "text",
  "currency": {
    "amount": 1,
    "code": "text",
    "exchangeRate": 1
  },
  "additionalDetails": [
    {
      "key": "text",
      "value": "text"
    }
  ],
  "creditCount": 1,
  "creditAmount": 1,
  "paymentCount": 1,
  "paymentAmount": 1,
  "tillUid": "text",
  "tillName": "text",
  "tillNumber": 1,
  "storeUid": "text",
  "storeName": "text",
  "orderReceiptUid": "text",
  "authorizedAmount": 1,
  "capturedAmount": 1,
  "refundedAmount": 1,
  "receiptText": "text",
  "transactions": [
    {
      "transactionType": "text",
      "pspTransactionId": "text",
      "transactionAmount": 1,
      "orderReceiptUid": "text"
    }
  ]
}

Print receipt

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/print

Print receipt

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

typestring · enum · min: 1Required

ENUM	Description
RECEIPT	Print sales receipt
EXCHANGENOTE	Print exchange note
GIFTCARD	Print giftcard barcode
PICKUP	Print a pickup label/note

Possible values:

printerUidstringOptional

The printer to send the print to

Pattern: ^[A-Za-z0-9-_]+

orderItemUidsstring[]Optional

exchangenoteValidUntilstring · dateOptional

Only valid for type EXCHANGENOTE. Sets a date that the exchange note is valid until. If not set, exchangeNoteValidUntil is calculated from the store's exchangeNoteValidDays setting. Stored on all orderItemUids in request, usually only one item.

Responses

204

No Content

No content

post/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/print

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/print HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "type": "RECEIPT",
  "printerUid": "text",
  "orderItemUids": [
    "text"
  ],
  "exchangenoteValidUntil": "2026-07-20"
}

204

No Content

No content

Get settlement details

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements/{settlementUid}

Get settlement details

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

settlementUidstringRequired

Reference to a settlement on an order.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

checkStatusbooleanOptional

Check external payment gateways and fetch status

includeDisplayMessagesbooleanOptional

Include display messages in the response

Responses

200

Example response

application/json

storeUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderReceiptUidstringRequiredPattern: ^[A-Za-z0-9-_]+

settleStatestring · enumRequired

ENUM	Description
NOT_STARTED	Receipt not started. No complete settlements exists.
IN_PROGRESS	Receipt is in progress. At least one settlement has been started.
COMPLETE	Receipt is complete. Sum of settlements = sum of orderlines.
CANCELED	Receipt is canceled. Can only be done if receiptState = NOT_STARTED.

Possible values:

voucherNumberstringRequired

externalVoucherNumberstringRequired

sellerDisplayNamestringRequired

settledAtstring · date-timeRequired

deliveryStatestring · enumRequired

ENUM	Description
NOT_STARTED	Delivery not started
IN_PROGRESS	Delivery is in progress. Some order lines are still reserved
COMPLETE	Delivery is complete. All order lines are delivered

Possible values:

grandTotalintegerRequired

customerUidstringRequiredPattern: ^[A-Za-z0-9-_]*

notestringRequired

get/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements/{settlementUid}

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements/{settlementUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "storeUid": "text",
  "orderUid": "text",
  "orderReceiptUid": "text",
  "settleState": "NOT_STARTED",
  "voucherNumber": "text",
  "externalVoucherNumber": "text",
  "sellerDisplayName": "text",
  "settledAt": "2026-07-20T03:49:45.204Z",
  "deliveryState": "NOT_STARTED",
  "grandTotal": 1,
  "settlementTotals": {
    "change": 1,
    "remaining": 1,
    "remainingRounded": 1,
    "totals": 1,
    "remainingPrePayment": 1,
    "remainingAuthorizedAmount": 1
  },
  "settlements": [
    {
      "amount": 1,
      "createdAt": "2026-07-20T03:49:45.204Z",
      "displayMessages": [
        {
          "key": "text",
          "message": "text",
          "timestamp": "2026-07-20T03:49:45.204Z"
        }
      ],
      "externalId": "text",
      "externalPaymentReference": "text",
      "idMethod": "NO_CVM_RULE_PERFORMED",
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "ledgerType": "LEDGER",
      "parameters": [
        {
          "key": "text",
          "value": "text",
          "name": "text",
          "type": "TEXT"
        }
      ],
      "settledAt": "2026-07-20T03:49:45.204Z",
      "settlementCode": "text",
      "settlementUid": "text",
      "settlementName": "text",
      "state": "NOT_STARTED",
      "status": "NEW",
      "storeSettlementIssuer": {
        "storeSettlementIssuerUid": "text",
        "name": "text",
        "code": "text"
      },
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "storePaymentMethodUid": "text",
      "currency": {
        "amount": 1,
        "code": "text",
        "exchangeRate": 1
      },
      "additionalDetails": [
        {
          "key": "text",
          "value": "text"
        }
      ],
      "creditCount": 1,
      "creditAmount": 1,
      "paymentCount": 1,
      "paymentAmount": 1,
      "tillUid": "text",
      "tillName": "text",
      "tillNumber": 1,
      "storeUid": "text",
      "storeName": "text",
      "orderReceiptUid": "text",
      "authorizedAmount": 1,
      "capturedAmount": 1,
      "refundedAmount": 1,
      "receiptText": "text",
      "transactions": [
        {
          "transactionType": "text",
          "pspTransactionId": "text",
          "transactionAmount": 1,
          "orderReceiptUid": "text"
        }
      ]
    }
  ],
  "items": [
    {
      "actions": [
        {
          "comment": "text",
          "createdAt": "2026-07-20T03:49:45.204Z",
          "createdBy": "text",
          "handlingActionUid": "text",
          "handlingActionName": "text",
          "handlingDescription": "text",
          "handlingUid": "text",
          "handlingName": "text",
          "lastModifiedAt": "2026-07-20T03:49:45.204Z",
          "lastModifiedBy": "text",
          "orderHandlingActionUid": "text"
        }
      ],
      "allowedActions": [
        "QUANTITY_SOLD"
      ],
      "createdAt": "2026-07-20T03:49:45.204Z",
      "discountReasonCode": "text",
      "externalId": "text",
      "itemCost": 1,
      "itemDiscountAmount": 1,
      "itemDiscountPercentage": 1,
      "itemGrossProfitAmount": 1,
      "itemGrossProfitPercentage": 1,
      "itemPrice": 1,
      "itemVatAmount": 1,
      "lastModifiedAt": "2026-07-20T03:49:45.204Z",
      "ledgerNumber": "text",
      "name": "text",
      "note": "text",
      "orderItemUid": "text",
      "orderLinks": [
        {
          "orderUid": "text",
          "orderItemUid": "text",
          "orderNumber": "text",
          "storeUid": "text",
          "type": "CREDIT"
        }
      ],
      "originalItemPrice": 1,
      "productUid": "text",
      "productType": "STOCK",
      "properties": [
        {
          "uid": "text",
          "key": "text",
          "value": "text"
        }
      ],
      "quantityCredited": 1,
      "quantityDelivered": 1,
      "quantityOrdered": 1,
      "quantityReserved": 1,
      "returnReasonCode": "text",
      "serialnumber": "text",
      "sku": "text",
      "sortOrder": 1,
      "tenantUserDisplayName": "text",
      "tenantUserUid": "text",
      "totalCost": 1,
      "totalDiscountAmount": 1,
      "totalGrossProfitAmount": 1,
      "totalPrice": 1,
      "totalVatAmount": 1,
      "vatCodeUid": "text",
      "warehouseUid": "text",
      "warehouseName": "text",
      "internalInfo": "text",
      "productProperties": [
        {
          "productPropertyUid": "text",
          "propertyName": "text",
          "propertyOptionName": "text",
          "propertyType": "TEXT",
          "propertyText": "text",
          "propertyUid": "text",
          "propertyOptionUid": "text",
          "required": true
        }
      ],
      "coverImage": {
        "productMediaUid": "text",
        "mainUrl": "text",
        "thumbnailUrl": "text"
      },
      "deliveryUid": "text",
      "compensationReasonCode": "text",
      "orderReceiptUid": "text",
      "allowDelivery": "YES",
      "allowDeliveryFromDate": "2026-07-20T03:49:45.204Z",
      "reservationType": "NONE",
      "reservationDetails": {
        "warehouse": {
          "warehouseName": "text"
        },
        "purchaseOrder": {
          "purchaseOrderUid": "text",
          "purchaseOrderItemUid": "text",
          "expectedDeliveryDate": "2026-07-20T03:49:45.204Z",
          "purchaseOrderNumber": "text",
          "quantityOrdered": 1,
          "externalId": "text"
        },
        "receivement": {
          "receivementUid": "text",
          "receivementItemUid": "text",
          "expectedArrival": "2026-07-20T03:49:45.204Z",
          "expectedDispatch": "2026-07-20T03:49:45.204Z",
          "quantity": 1,
          "supplierOrderReference": "text",
          "receivedAt": "2026-07-20T03:49:45.204Z"
        }
      },
      "gtins": [
        {
          "gtin": "text",
          "primary": true,
          "type": "text"
        }
      ]
    }
  ],
  "address": {
    "address": "text",
    "city": "text",
    "companyName": "text",
    "countryCode": "text",
    "email": "text",
    "firstname": "text",
    "lastname": "text",
    "mobile": "text",
    "postalCode": "text",
    "vatNumber": "text",
    "displayName": "text"
  },
  "customerUid": "text",
  "note": "text"
}

Delete a settlement

delete

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements/{settlementUid}

Delete a settlement

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

settlementUidstringRequired

Reference to a settlement on an order.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

forceDeletebooleanOptional

Force Delete on a settlement

Responses

204

No Content

No content

delete/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements/{settlementUid}

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/settlements/{settlementUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Get EHF invoice status

get

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/ehf

Check the status for an EHF invoice.

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

Example response

application/json

voucherNumberstringRequired

orderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderNumberstringRequired

orderSettlementUidstringRequiredPattern: ^[A-Za-z0-9-_]+

statusOkbooleanRequired

statusAtstring · date-timeRequired

statusMessagestringRequired

get/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/ehf

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/ehf HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "voucherNumber": "text",
  "orderUid": "text",
  "orderNumber": "text",
  "orderSettlementUid": "text",
  "statusOk": true,
  "statusAt": "2026-07-20T03:49:45.204Z",
  "statusMessage": "text"
}

Send EHF invoice

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/ehf

An EHF invoice is normally sent automatically upon order settlement completion, but here you can try an send it again if it failed the first time. If sending succeeds, the status is also checked.

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Responses

201

Example response

application/json

voucherNumberstringRequired

orderUidstringRequiredPattern: ^[A-Za-z0-9-_]+

orderNumberstringRequired

orderSettlementUidstringRequiredPattern: ^[A-Za-z0-9-_]+

statusOkbooleanRequired

statusAtstring · date-timeRequired

statusMessagestringRequired

post/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/ehf

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/ehf HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

201

Example response

{
  "voucherNumber": "text",
  "orderUid": "text",
  "orderNumber": "text",
  "orderSettlementUid": "text",
  "statusOk": true,
  "statusAt": "2026-07-20T03:49:45.204Z",
  "statusMessage": "text"
}

Send receipt by email

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/email

Send receipt by email

Required permissions: SALES_ORDER,RETURN_ORDER

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Body

application/json

ReceiptEmailSchema

typestring · enum · min: 1Required

ENUM	Description
RECEIPT	Send sales receipt as email

Possible values:

emailstringRequired

Responses

204

No Content

No content

post/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/email

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/email HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "type": "RECEIPT",
  "email": "text"
}

204

No Content

No content

Get receipt PDF

post

https://api.flowretail.com/v2https://api.stage.flowretail.com/v2

/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/pdf

Get receipt PDF as direct download.

Authorizations

accessTokenauthTokenintegrationToken

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

receiptUidstringRequired

Reference to a Receipt.

Pattern: ^[A-Za-z0-9-_]+

Responses

200

OK

application/pdf

string · binaryOptional

post/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/pdf

HTTPcURLJavaScriptPython

POST /v2/tenants/{tenantUid}/stores/{storeUid}/receipts/{receiptUid}/pdf HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

binary