Edit Client Payments

Production

https://{{subdomain}}.daftra.com/api2

PUT

/client_payments/{id}{format}

Update an existing client payment.

This is a partial update — send only the fields you want to change, under a ClientPayment object. Fields not listed below (and any read-only fields) are ignored.

Editable fields (for payments recorded by staff/API): amount, date, payment_method, transaction_id, treasury_id, status, notes, receipt_notes, currency_code, staff_id, invoice_id, extra_details, attachment. If the payment was recorded by a client, only a narrower set is editable: treasury_id, receipt_notes, status, notes, invoice_id, attachment.

Notes: payment_method, if changed, must be one of the account's active configured methods (changing it clears stored gateway metadata). Changing the payment date requires the relevant permission; otherwise the original date is kept.

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

The client payment was updated.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request PUT 'https://.daftra.com/api2/client_payments/40.json' \
--header 'Accept: application/json' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data '{
    "ClientPayment": {
        "amount": 150,
        "date": "2027-05-16",
        "payment_method": "cash",
        "transaction_id": "payment",
        "treasury_id": 1,
        "status": 1,
        "notes": "Reconciled with bank statement",
        "receipt_notes": "elit commodo Ut Duis occaecat",
        "currency_code": "SAR",
        "staff_id": 1,
        "attachment": null
    }
}'

Response Example

200 - Example 1

{
    "result": "successful",
    "code": 200
}

Add New Client Payment

Delete Client Payments