Daftra API

Edit Client Payments

Production

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

PUT

/client_payments/{id}{format}

Client Payments

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https://.daftra.com/api2/client_payments/' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'apikey: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ClientPayment": {
        "client_id": 0,
        "status": 0,
        "payment_method": "string",
        "amount": 0,
        "currency_code": "USD",
        "transaction_id": "string",
        "treasury_id": 0,
        "date": "2025-03-24 21:22:32",
        "staff_id": 0,
        "notes": "string",
        "receipt_notes": "string"
    }
}'

Response Example

200 - Example 1

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

Request

Path Params

string

required

format

string

required

Header Params

string

optional

Default:

application/json

Content-Type

string

optional

Default:

application/json

Authorization

string

optional

You can generate the bearer token using the the authorization endpoint then use it here to be able to operate over your account's data

Default:

Bearer {{access_token}}

apikey

string

deprecated

You can find/generate your apikey(s) from inside your Daftra Account

Default:

Body Params application/json

ClientPayment

object

optional

client_id

integer <int32>

optional

Client REF#, you can get it through the Clients API

status

integer <int32>

optional

Status of payment

payment_method

string

optional

Method of payment

<= 100 characters

amount

number <double>

optional

Amount paid

currency_code

string

optional

Currency Code

<= 10 characters

Example:

USD

transaction_id

string

optional

Visual identifier for the process

<= 100 characters

treasury_id

integer

optional

Treasury Ref get it from GET Treasuries

date

string <date-time>

optional

Date of the payment

Example:

2025-03-24 21:22:32

staff_id

integer <int32>

optional

Staff user submitting the request get it from GET STAFF API if it's 0 that means the site owner is the staff that created it

notes

string

optional

Notes for payment

receipt_notes

string

optional

Notes for receipt

Examples

Responses

🟢200OK

application/json

Body

code

integer

optional

Example:

200

result

string

optional

Example:

successful

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

GET Single Client Payment

Delete Client Payments