Update selected Receivable fields

curl --request PATCH \ --url https://api.sandbox.paypathiq.com/v1/clients/{clientCode}/receivables/{externalReceivableId} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/merge-patch+json' \ --data '{}'

{ "balanceBreakdown": { "costs": { "amount": "0.00", "currency": "EUR" }, "fees": { "amount": "50.00", "currency": "EUR" }, "interest": { "amount": "200.00", "currency": "EUR" }, "principal": { "amount": "1000.00", "currency": "EUR" } }, "creditUnion": { "arrearsAmount": { "amount": "1250.00", "currency": "EUR" }, "contractualInstalment": { "amount": { "amount": "125.00", "currency": "EUR" }, "frequency": "monthly" }, "defaultDate": "2026-07-01", "loanAccountReference": "loan-ref-example", "loanType": "personal_loan", "totalOutstandingAmount": { "amount": "4000.00", "currency": "EUR" } }, "dueDate": "2026-08-01", "recoverableAmount": { "amount": "1250.00", "currency": "EUR" }, "responsibleParties": [ { "externalPartyId": "PTY_123", "role": "primary" } ], "sourceReference": "receivable-ref-example", "externalReceivableId": "REC_123", "status": "active", "updatedAt": "2026-08-29T12:00:00Z" }

Authorizations

Authorization

string

header

required

Integration-owned environment-specific API key. Never paste a production key into documentation tools.

Path Parameters

clientCode

string

required

Stable non-sensitive Client code authorized by the Integration grant.

Pattern: ^[A-Za-z0-9_-]{1,128}$

externalReceivableId

string

required

Opaque case-sensitive Receivable identifier supplied by the Integration.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/merge-patch+json

Maximum uncompressed request body size: 256 KiB.

balanceBreakdown

object | null

All four amounts are required when a breakdown is supplied; use 0.00 where needed.

Show child attributes

creditUnion

object

Show child attributes

dueDate

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

receivableSafetyAssertions

object[]

At most one assertion per type; ordering is semantically irrelevant.

Maximum array length: 3

Show child attributes

recoverableAmount

object

Show child attributes

responsibleParties

object[]

Party identifiers must be unique and exactly one role must be primary.

Required array length: 1 - 8 elements

Show child attributes

sourceReference

string

Required string length: 1 - 200

Response

Receivable updated, or patch was a safe no-op.

The balance breakdown must sum exactly to recoverableAmount.

creditUnion

object

required

Show child attributes

dueDate

string<date>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

recoverableAmount

object

required

Show child attributes

responsibleParties

object[]

required

Party identifiers must be unique and exactly one role must be primary.

Required array length: 1 - 8 elements

Show child attributes

sourceReference

string

required

Required string length: 1 - 200

externalReceivableId

string

required

Pattern: ^[A-Za-z0-9_-]{1,128}$

status

enum<string>

required

Available options:

active,

paused,

closed

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

balanceBreakdown

object

All four amounts are required when a breakdown is supplied; use 0.00 where needed.

Show child attributes

receivableSafetyAssertions

object[]

At most one assertion per type; ordering is semantically irrelevant.

Maximum array length: 3

Show child attributes

Parties

Payment observations

Receivables

Receivable lifecycle

Update selected Receivable fields

Authorizations

Path Parameters

Body

Response