Skip to main content
PATCH
Update selected Receivable fields

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 Receivable identifier supplied by the Integration; capitalization must match.

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

Body

application/merge-patch+json

One uncompressed resource representation, limited to 256 KiB.

sourceRevision
integer
required
Required range: x <= 9007199254740991
balanceBreakdown
object | null

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

creditUnion
object
propertyManagement
object
financialType
enum<string>
Available options:
loan_instalment,
accelerated_balance,
loan_balance,
service_charge_demand
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
recoverableAmount
object
responsibleCustomers
object[]

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

Required array length: 1 - 8 elements
sourceReference
string
Required string length: 1 - 200

Response

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

Each financial type requires exactly its industry context. The balance breakdown must sum exactly to recoverableAmount.

creditUnion
object
required
financialType
enum<string>
required
Available options:
loan_instalment,
accelerated_balance,
loan_balance
sourceRevision
integer
required
Required range: x <= 9007199254740991
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
responsibleCustomers
object[]
required

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

Required array length: 1 - 8 elements
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.

propertyManagement
any
receivableSafetyAssertions
object[]

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

Maximum array length: 3
financialPosition
object

Present on reads. sourceAmount is the declared accounting authority's position, workingAmount is the safe collection balance after confirmed allocated Payments, and confirmedUnreconciledAmount is the allocated confirmed amount the Source has not yet acknowledged. Unapplied funds appear in none of them.