Search in payments

Retrieves a filtered list of invoice payments across the organization. One item per registered payment, not per invoice: an invoice paid in two instalments returns two items.

createdAt is when the payment was registered in Flow, paidAt is the value date supplied by the payer or bank file. Both ranges are applied as-is, so send local start-of-day and end-of-day.

Results are sorted by createdAt descending when no sorting parameter is specified. sortBy accepts payment fields only: createdAt, paidAt, amount, createdBy and externalReference. Customer name, invoice number and store name cannot be sorted server-side, and any other value is rejected.

Pending payment attempts (amount 0 with no paidAt) are never returned.

Required permissions: PAYMENT,SALES_ORDER

post

/tenants/{tenantUid}/organizations/{organizationUid}/payments/search

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

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:

Body

Filters for the payment search. Every field is optional, and an empty object returns every payment in the organization.

createdBystring[]Optional

Display names of the users who registered the payments, matched exactly. This is a snapshot taken when the payment was registered, so it does not follow a later rename of the user.

storeUidsstring[]Optional

The stores that issued the invoices, not the store where a payment was taken.

Responses

200

Example response

application/json

post/tenants/{tenantUid}/organizations/{organizationUid}/payments/search

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

{
  "createdAt": {
    "from": "2026-01-01T00:00:00.000Z",
    "to": "2026-01-01T00:00:00.000Z"
  },
  "paidAt": {
    "from": "2026-01-01T00:00:00.000Z",
    "to": "2026-01-01T00:00:00.000Z"
  },
  "createdBy": [
    "text"
  ],
  "storeUids": [
    "text"
  ]
}

200

Example response

{
  "items": [
    {
      "paymentUid": "text",
      "amount": 1,
      "paidAt": "2026-01-01T00:00:00.000Z",
      "externalReference": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "orderUid": "text",
      "settlementUid": "text",
      "invoiceNumber": "text",
      "settlementAmount": 1,
      "settlementPaidAmount": 1,
      "remainingAmount": 1,
      "storeUid": "text",
      "storeName": "text",
      "storeExternalId": "text",
      "customerUid": "text",
      "customerName": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}