payments

Update /payments/{uuid}

Update a payment by UUID (PATCH). Only sent fields are updated (total_amount, payment_mode, date, note). Related document and rel_type cannot be changed. Returns record with the detail projection.

PATCH

/payments/{uuid}

curl --request PATCH \
  --url https://default.hannacrm.app/api/v4/payments/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "<string>",
  "note": "<string>",
  "payment_mode": "<string>",
  "total_amount": "<string>"
}
'

{
  "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>"
  }
}

Autorizacijos

Authorizationstringheaderprivaloma

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

Kelio parametrai

uuidstringprivaloma

Turinys

datestring

Payment date (Y-m-d). Defaults to today on create when omitted.

notestring

Payment note.

payment_modestring

Payment mode ID from tenant payment modes.

total_amountstring

Total paid amount.

Atsakymas

Success

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.

Rodyti: child attributes

Vis dar reikia pagalbos? Klausti komandos