Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.

Reports

PreviousReceivement NextReportsExternal

Was this helpful?

List all reports

get

List all reports for an organization

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

List of available reports

application/json

get

GET /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List of available reports

{
  "items": [
    {
      "reportUid": "text",
      "request": {
        "fromDate": "2025-06-15",
        "toDate": "2025-06-15",
        "storeUids": [
          "text"
        ],
        "reportUid": "text"
      },
      "state": "ABORTED",
      "type": "SAFT",
      "createdAt": "2025-06-15T01:21:20.232Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-06-15T01:21:20.232Z",
      "lastModifiedBy": "text",
      "sendNotificationTo": "text",
      "notificationSentAt": "2025-06-15T01:21:20.232Z",
      "progress": "text",
      "filename": "text",
      "filesize": 1
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Get report details

get

Get report details

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

reportUidstringRequired

Reference to a report.

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

Responses

200

Report details

application/json

get

GET /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Report details

{
  "reportUid": "text",
  "request": {
    "fromDate": "2025-06-15",
    "toDate": "2025-06-15",
    "storeUids": [
      "text"
    ],
    "reportUid": "text"
  },
  "state": "ABORTED",
  "type": "SAFT",
  "createdAt": "2025-06-15T01:21:20.232Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-15T01:21:20.232Z",
  "lastModifiedBy": "text",
  "sendNotificationTo": "text",
  "notificationSentAt": "2025-06-15T01:21:20.232Z",
  "progress": "text",
  "filename": "text",
  "filesize": 1
}

Delete a generated report

delete

Deletes a generated report

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

reportUidstringRequired

Reference to a report.

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

Responses

204

No Content

403

Forbidden

404

Not Found

delete

DELETE /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Download report content

get

Download report content

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

reportUidstringRequired

Reference to a report.

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

Responses

200

Based on the Accept header the response will be base64 json encoded or a raw file. application/octet-stream will return a binary file application/json will return a json with the file content base64 encoded.

404

Not Found

409

Conflict

get

GET /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid}/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": "text",
  "contentType": "text",
  "filename": "text"
}

Abort report generation

post

Abort report generation

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

reportUidstringRequired

Reference to a report.

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

Body

actionstring · enumRequired

ENUM	Description
ABORT	Abort running job

Possible values:

Responses

200

Report details

application/json

post

POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/{reportUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "action": "ABORT"
}

200

Report details

{
  "reportUid": "text",
  "request": {
    "fromDate": "2025-06-15",
    "toDate": "2025-06-15",
    "storeUids": [
      "text"
    ],
    "reportUid": "text"
  },
  "state": "ABORTED",
  "type": "SAFT",
  "createdAt": "2025-06-15T01:21:20.232Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-15T01:21:20.232Z",
  "lastModifiedBy": "text",
  "sendNotificationTo": "text",
  "notificationSentAt": "2025-06-15T01:21:20.232Z",
  "progress": "text",
  "filename": "text",
  "filesize": 1
}

Start WarehouseStockDetails report

post

Start report generation of WarehouseStockDetails

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

Body

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

brandUidsstring[]Optional

productGroupUidsstring[]Optional

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

Responses

201

Report details

application/json

post

POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/warehouse-stock-details HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "warehouseUid": "text",
  "brandUids": [
    "text"
  ],
  "productGroupUids": [
    "text"
  ],
  "reportUid": "text"
}

201

Report details

{
  "reportUid": "text",
  "request": {
    "fromDate": "2025-06-15",
    "toDate": "2025-06-15",
    "storeUids": [
      "text"
    ],
    "reportUid": "text"
  },
  "state": "ABORTED",
  "type": "SAFT",
  "createdAt": "2025-06-15T01:21:20.232Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-15T01:21:20.232Z",
  "lastModifiedBy": "text",
  "sendNotificationTo": "text",
  "notificationSentAt": "2025-06-15T01:21:20.232Z",
  "progress": "text",
  "filename": "text",
  "filesize": 1
}

Start SAF-T report generation

post

Start SAF-T report generation for a set period. It is also possible to only run it for a specific set of stores.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

Body

fromDatestring · dateRequired

toDatestring · dateRequired

storeUidsstring[]Optional

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

Responses

201

Report details

application/json

post

POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/saf-t HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "fromDate": "2025-06-15",
  "toDate": "2025-06-15",
  "storeUids": [
    "text"
  ],
  "reportUid": "text"
}

201

Report details

{
  "reportUid": "text",
  "request": {
    "fromDate": "2025-06-15",
    "toDate": "2025-06-15",
    "storeUids": [
      "text"
    ],
    "reportUid": "text"
  },
  "state": "ABORTED",
  "type": "SAFT",
  "createdAt": "2025-06-15T01:21:20.232Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-15T01:21:20.232Z",
  "lastModifiedBy": "text",
  "sendNotificationTo": "text",
  "notificationSentAt": "2025-06-15T01:21:20.232Z",
  "progress": "text",
  "filename": "text",
  "filesize": 1
}

Accounting report for stores, json format

post

Get accounting report for a storeUid and a period. Response is a json structured data of accounting

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

fromDatestring · date · min: 10Required

toDatestring · date · min: 10Required

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

storeUidsstring[]Optional

List of storeUids to include in report.

Responses

200

Response for Accounting report.

application/json

post

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

{
  "fromDate": "2025-06-15",
  "toDate": "2025-06-15",
  "organizationUid": "text",
  "storeUids": [
    "text"
  ]
}

200

Response for Accounting report.

{
  "asset": [
    {
      "account": "text",
      "creditAmount": 1,
      "date": "text",
      "debetAmount": 1,
      "text": "text",
      "vatCode": "text"
    }
  ],
  "credit": [
    {
      "account": "text",
      "creditAmount": 1,
      "date": "text",
      "debetAmount": 1,
      "text": "text",
      "vatCode": "text"
    }
  ],
  "debet": [
    {
      "account": "text",
      "creditAmount": 1,
      "date": "text",
      "debetAmount": 1,
      "text": "text",
      "vatCode": "text"
    }
  ],
  "header": {
    "fromDate": "text",
    "storeUid": "text",
    "toDate": "text"
  },
  "ledger": [
    {
      "account": "text",
      "creditAmount": 1,
      "date": "text",
      "debetAmount": 1,
      "text": "text",
      "vatCode": "text"
    }
  ],
  "printDate": "text",
  "tenantName": "text",
  "organizationName": "text",
  "storeNames": [
    "text"
  ],
  "totals": {
    "totalAsset": 1,
    "totalCredit": 1,
    "totalCreditAndAsset": 1,
    "totalDebet": 1,
    "totalLedger": 1
  }
}

Accounting report file for stores

post

Get an accounting report for a store UID and a time period. Depending on the header you set, the response is either a json containing a base 64 encoded pdf or a direct download. The file is base64 encoded. You can set choose among the supported file types, default is PDF.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

all ofOptional

Responses

200

post

POST /v2/tenants/{tenantUid}/reports/accounting/download HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "fromDate": "2025-06-15",
  "toDate": "2025-06-15",
  "organizationUid": "text",
  "storeUids": [
    "text"
  ],
  "reportFormat": "PDF"
}

200

{
  "content": "text",
  "contentType": "text",
  "filename": "text"
}

Turnover report for products

post

Get products turnover report for a time period, optionally filtered on a list of product group and UIDs. The report generates sums of sold products and total values.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

brandUidsstring[]Optional

Array of brandUids

fromDateTimestring · date-time · min: 10Required

productGroupUidsstring[]Optional

Array of productGroup ids

storeUidsstring[]Required

Array of storeUids

toDateTimestring · date-time · min: 10Required

Responses

200

Response for Product turnover report.

post

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

{
  "brandUids": [
    "text"
  ],
  "fromDateTime": "2025-06-15T01:21:20.232Z",
  "productGroupUids": [
    "text"
  ],
  "storeUids": [
    "text"
  ],
  "toDateTime": "2025-06-15T01:21:20.232Z"
}

200

Response for Product turnover report.

{
  "items": [
    {
      "costAmount": 1,
      "count": 1,
      "discountAmount": 1,
      "name": "text",
      "revenueAmount": 1,
      "revenuePercent": 1,
      "storeUid": "text",
      "turnoverAmount": 1,
      "brandUid": "text",
      "brandName": "text",
      "productGroupUid": "text",
      "productGroupName": "text",
      "productUid": "text",
      "sku": "text",
      "lastSettledAt": "2025-06-15T01:21:20.232Z"
    }
  ]
}

Turnover report for stores

post

Get turnover data grouped by store.

If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

Body

Turnover Request Body

fromDateTimestring · date-time · min: 20Required

toDateTimestring · date-time · min: 20Required

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

Responses

200

Turnover response

application/json

post

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

{
  "fromDateTime": "2025-06-15T01:21:20.232Z",
  "toDateTime": "2025-06-15T01:21:20.232Z",
  "tenantUserUid": "text"
}

200

Turnover response

{
  "dates": [
    {
      "costAmount": 1,
      "count": 1,
      "date": "text",
      "discountAmount": 1,
      "revenueAmount": 1,
      "revenuePercent": 1,
      "turnoverAmount": 1
    }
  ],
  "stores": [
    {
      "costAmount": 1,
      "count": 1,
      "discountAmount": 1,
      "name": "text",
      "revenueAmount": 1,
      "revenuePercent": 1,
      "storeUid": "text",
      "turnoverAmount": 1
    }
  ],
  "total": {
    "costAmount": 1,
    "count": 1,
    "discountAmount": 1,
    "revenueAmount": 1,
    "turnoverAmount": 1,
    "orderCount": 1
  }
}

Turnover report for root product groups

post

Get turnover data for a store grouped by product-group.

If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

Turnover Request Body

fromDateTimestring · date-time · min: 20Required

toDateTimestring · date-time · min: 20Required

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

Responses

200

Turnover response for ProductGroup

application/json

post

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

{
  "fromDateTime": "2025-06-15T01:21:20.232Z",
  "toDateTime": "2025-06-15T01:21:20.232Z",
  "tenantUserUid": "text"
}

200

Turnover response for ProductGroup

{
  "items": [
    {
      "costAmount": 1,
      "count": 1,
      "discountAmount": 1,
      "hasChildren": true,
      "productGroupUid": "text",
      "revenueAmount": 1,
      "revenuePercent": 1,
      "text": "text",
      "turnoverAmount": 1
    }
  ],
  "total": {
    "costAmount": 1,
    "count": 1,
    "discountAmount": 1,
    "revenueAmount": 1,
    "turnoverAmount": 1,
    "orderCount": 1
  }
}

Turnover report for sellers on a store

post

Get turnover data for all sellers in a store.

Ordered by turnover descending.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

Turnover Request Body

fromDateTimestring · date-time · min: 20Required

toDateTimestring · date-time · min: 20Required

Responses

200

Example response

application/json

post

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

{
  "fromDateTime": "2025-06-15T01:21:20.232Z",
  "toDateTime": "2025-06-15T01:21:20.232Z"
}

200

Example response

{
  "items": [
    {
      "position": 1,
      "costAmount": 1,
      "orderCount": 1,
      "discountAmount": 1,
      "revenueAmount": 1,
      "revenuePercent": 1,
      "turnoverAmount": 1,
      "vatAmount": 1,
      "firstName": "text",
      "lastName": "text",
      "displayName": "text",
      "tenantUserUid": "text"
    }
  ]
}

Turnover report for one product group

post

Get turnover data for a store and product group.

If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

productGroupUidstringRequired

Reference to a ProductGroup.

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

Body

Turnover Request Body

fromDateTimestring · date-time · min: 20Required

toDateTimestring · date-time · min: 20Required

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

Responses

200

Turnover response for ProductGroup

application/json

post

POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/product-groups/{productGroupUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "fromDateTime": "2025-06-15T01:21:20.232Z",
  "toDateTime": "2025-06-15T01:21:20.232Z",
  "tenantUserUid": "text"
}

200

Turnover response for ProductGroup

{
  "items": [
    {
      "costAmount": 1,
      "count": 1,
      "discountAmount": 1,
      "hasChildren": true,
      "productGroupUid": "text",
      "revenueAmount": 1,
      "revenuePercent": 1,
      "text": "text",
      "turnoverAmount": 1
    }
  ],
  "total": {
    "costAmount": 1,
    "count": 1,
    "discountAmount": 1,
    "revenueAmount": 1,
    "turnoverAmount": 1,
    "orderCount": 1
  }
}

Turnover report for products

post

Get turnover data for a product group grouped by product

If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

productGroupUidstringRequired

Reference to a ProductGroup.

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

Body

Turnover Request Body

fromDateTimestring · date-time · min: 20Required

toDateTimestring · date-time · min: 20Required

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

Responses

200

Turnover response

application/json

post

POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/product-groups/{productGroupUid}/products HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "fromDateTime": "2025-06-15T01:21:20.232Z",
  "toDateTime": "2025-06-15T01:21:20.232Z",
  "tenantUserUid": "text"
}

200

Turnover response

{
  "items": [
    {
      "costAmount": 1,
      "count": 1,
      "discountAmount": 1,
      "id": "text",
      "revenueAmount": 1,
      "revenuePercent": 1,
      "text": "text",
      "turnoverAmount": 1
    }
  ],
  "total": {
    "costAmount": 1,
    "count": 1,
    "discountAmount": 1,
    "revenueAmount": 1,
    "turnoverAmount": 1,
    "orderCount": 1
  }
}

Turnover report for orders

post

Get turnover data for a product grouped by orders.

If tenant user UID is specified, the turnover data will only contain the numbers for that specific user.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

productGroupUidstringRequired

Reference to a ProductGroup.

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

productUidstringRequired

Reference to a Product.

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

Body

Turnover Request Body

fromDateTimestring · date-time · min: 20Required

toDateTimestring · date-time · min: 20Required

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

Responses

200

Turnover response

application/json

post

POST /v2/tenants/{tenantUid}/reports/turnover/stores/{storeUid}/product-groups/{productGroupUid}/products/{productUid}/orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "fromDateTime": "2025-06-15T01:21:20.232Z",
  "toDateTime": "2025-06-15T01:21:20.232Z",
  "tenantUserUid": "text"
}

200

Turnover response

{
  "items": [
    {
      "costAmount": 1,
      "count": 1,
      "discountAmount": 1,
      "id": "text",
      "revenueAmount": 1,
      "revenuePercent": 1,
      "text": "text",
      "turnoverAmount": 1
    }
  ],
  "total": {
    "costAmount": 1,
    "count": 1,
    "discountAmount": 1,
    "revenueAmount": 1,
    "turnoverAmount": 1,
    "orderCount": 1
  }
}

Start Art Fee report

post

Start Art Fee report generation for a set time period and optionally for given stores.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

organizationUidstringRequired

Reference to an organization.

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

Body

fromDatestring · dateRequired

toDatestring · dateRequired

storeUidsstring[]Optional

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

Responses

201

Report details

application/json

post

POST /v2/tenants/{tenantUid}/organizations/{organizationUid}/reports/art-fee HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 87

{
  "fromDate": "2025-06-15",
  "toDate": "2025-06-15",
  "storeUids": [
    "text"
  ],
  "reportUid": "text"
}

201

Report details

{
  "reportUid": "text",
  "request": {
    "fromDate": "2025-06-15",
    "toDate": "2025-06-15",
    "storeUids": [
      "text"
    ],
    "reportUid": "text"
  },
  "state": "ABORTED",
  "type": "SAFT",
  "createdAt": "2025-06-15T01:21:20.232Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-06-15T01:21:20.232Z",
  "lastModifiedBy": "text",
  "sendNotificationTo": "text",
  "notificationSentAt": "2025-06-15T01:21:20.232Z",
  "progress": "text",
  "filename": "text",
  "filesize": 1
}

Start Art Provision report

post

The Art Provision report gives overview over each artist's sales and stock for the requested time period. Optionally filter on artist.

Artists with no sales and no stock are included.

sendEmailToSupplier = true will send email to each artist.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

fromDatestring · dateRequired

toDatestring · dateRequired

supplierUidsstring[]Required

sendEmailToSupplierbooleanRequired

productGroupUidsstring[]Required

showDiffbooleanOptional

Responses

200

ZipFileResponse

application/zip

Responsestring · binary

204

No Content

post

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

{
  "fromDate": "2025-06-15",
  "toDate": "2025-06-15",
  "supplierUids": [
    "text"
  ],
  "sendEmailToSupplier": true,
  "productGroupUids": [
    "text"
  ],
  "showDiff": true
}

binary

List suppliers' commission sales payouts

post

List suppliers' payouts for commission sales in a time period. Optionally filter on commission sales that are paid/not paid.

Authorizations

Path parameters

tenantUidstringRequired

Reference to a tenant.

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

storeUidstringRequired

Reference to a Store.

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

Body

fromDatestring · dateRequired

GTE

toDatestring · dateRequired

LTE

paidbooleanOptional

filter on paid/not paid

supplierUidsstring[]Optional

productGroupUidsstring[]Optional

scopestring · enumOptionalPossible values:

Responses

200

Example response

application/json

post

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

{
  "fromDate": "2025-06-15",
  "toDate": "2025-06-15",
  "paid": true,
  "supplierUids": [
    "text"
  ],
  "productGroupUids": [
    "text"
  ],
  "scope": "STOCK_ONLY"
}

200

Example response

{
  "items": [
    {
      "supplier": {
        "address": "text",
        "city": "text",
        "contactEmail": "text",
        "contactName": "text",
        "countryCode": "text",
        "createdAt": "2025-06-15T01:21:20.232Z",
        "email": "text",
        "externalId": "text",
        "lastModifiedAt": "2025-06-15T01:21:20.232Z",
        "name": "text",
        "phone": "text",
        "postalCode": "text",
        "supplierUid": "text",
        "vatNumber": "text",
        "active": true,
        "bankInfo": {
          "accountNumber": "text",
          "bankName": "text",
          "iban": "text",
          "swift": "text"
        },
        "fixedDiscountRate": 1,
        "currency": "text"
      },
      "commissionSales": [
        {
          "payoutAmount": 1,
          "paidAt": "2025-06-15T01:21:20.232Z",
          "paid": true,
          "commissionPercentage": 1,
          "commissionAmount": 1,
          "salesPrice": 1,
          "productSku": "text",
          "productName": "text",
          "orderNumber": "text",
          "orderSettledAt": "2025-06-15T01:21:20.232Z",
          "commissionUid": "text",
          "orderProductLineUid": "text",
          "orderUid": "text"
        }
      ],
      "payoutsTotal": 1,
      "payoutsCount": 1
    }
  ]
}