payments

List /payments

Search payments. Matches client name, transaction ID, note, or related document number (optional query). Supports pagination and filters: date range, rel_type, client, invoice, pre_invoice, expense. Each item uses uuid only. Response: items and pagination.

GET

/payments

List /payments

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/payments?query=%3Cstring%3E&page=123&per_page=123&filter%5Bupdated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bcreated_since%5D=2023-11-07T05%3A31%3A56Z&filter%5Bdate%5D=%3Cstring%3E&filter%5Brel_type%5D=%3Cstring%3E&filter%5Bclient%5D=%3Cstring%3E&filter%5Binvoice%5D=%3Cstring%3E&filter%5Bpre_invoice%5D=%3Cstring%3E&filter%5Bexpense%5D=%3Cstring%3E&filter%5Buuid%5D=%3Cstring%3E&filter%5Bcreated_by%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bupdated_by%5D=3c90c3cc-0d44-4b50-8888-8dd25736052a&filter%5Bcreated_at%5D=%3Cstring%3E&filter%5Bupdated_at%5D=%3Cstring%3E&sort=%3Cstring%3E&fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "amount": "<string>",
      "cash_number": "<string>",
      "client": [
        {}
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "date": "<string>",
      "document": [
        {}
      ],
      "kpo": "<string>",
      "note": "<string>",
      "overpay_amount": "<string>",
      "payment_mode": [
        {}
      ],
      "rel_type": "<string>",
      "total_amount": "<string>",
      "transactionid": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": {
        "name": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "uuid": "<string>"
    }
  ],
  "pagination": {
    "from": 123,
    "last_page": 123,
    "page": 123,
    "per_page": 123,
    "to": 123,
    "total": 123
  },
  "query": "<string>"
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Query Parameters

querystringquery

Optional search phrase for client name, transaction ID, note, or related document number.

Minimum string length: 1

pageintegerquery

Page number (1-based).

Required range: 1 <= x

per_pageintegerquery

Number of results per page. limit is accepted as an alias.

Required range: 1 <= x <= 50

filter[updated_since]stringquery

Return only records whose updated_at is at or after this ISO 8601 timestamp (e.g. 2026-08-11T00:00:00Z). Intended for incremental polling.

filter[created_since]stringquery

Return only records whose created_at is at or after this ISO 8601 timestamp (e.g. 2026-08-11T00:00:00Z). Intended for polling new records.

filter[date]stringquery

Payment date range.

filter[rel_type]stringquery

Payment relation types: invoice, pre_invoice, expense, contract, overpay.

filter[client]stringquery

Client UUIDs.

filter[invoice]stringquery

Related invoice UUIDs (rel_type = invoice).

filter[pre_invoice]stringquery

Related pre-invoice (estimate) UUIDs (rel_type = pre_invoice).

filter[expense]stringquery

Related expense UUIDs (rel_type = expense).

filter[uuid]stringquery

Record UUIDs. Use it to fetch several known records in one call.

filter[created_by]string[]query

Staff UUID who created the record.

filter[updated_by]string[]query

Staff UUID who last changed the record. Empty until the record is saved once after 2026-09.

filter[created_at]stringquery

Created date range (YYYY-MM-DD - YYYY-MM-DD). Use created_since for one-sided incremental polling.

filter[updated_at]stringquery

Last change date range (YYYY-MM-DD - YYYY-MM-DD). Use updated_since for one-sided incremental polling.

sortstringquery

Optional sort order, comma-separated; prefix a field with - for descending (e.g. sort=-updated_at); empty values sort last. Sortable fields: amount, created_at, date, note, overpay_amount, rel_type, total_amount, transactionid, updated_at, uuid. Default when omitted: -date,-id.

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

Search results

itemsobject[]

Show child attributes

paginationobject

Show child attributes

querystring

Still need help? Ask the team