payments

Detail /payments/{uuid}

Get one payment by UUID (/payments/{uuid}). Returns record with amounts, payment mode, related document, client, dates, and notes. Reference entities use UUIDs only (payment modes use id + name).

GET

/payments/{uuid}

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/payments/{uuid}?fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "record": {
    "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>",
    "daterecorded": "2023-11-07T05:31:56Z",
    "document": [
      {}
    ],
    "kpo": "<string>",
    "note": "<string>",
    "overpay_amount": "<string>",
    "payment_basis": "<string>",
    "payment_mode": [
      {}
    ],
    "paymentmethod": "<string>",
    "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>"
  }
}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

uuidstringrequired

Record identifier (uuid)

Query Parameters

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

Single record

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team