Create Settlement
Header Parameters
Api-Keystring Required
Body Parameters
client_idstring Required
A unique identifier of the client for which a new client settlement entry is being made.
debt_idstring Required
A unique identifier of the debt for which a settlement is being created.
settlement_amountstring Required
The dollar amount of the settlement.
settlement_feestring Required
The fees associated with this settlement.
notesstring Required
Notes associated with this new client settlement entry.
referencestring Required
Additional reference material related to this new client settlement entry.
paymentsarray Required
Show child attributes
creditorobject Required
Show child attributes
Response
200
Object
Settlement successfully created.
Response Attributes
client_idstring Required
debt_idstring Required
settlement_amountstring Required
settlement_feestring Required
notesstring Required
referencestring Required
paymentsarray
Show child attributes
creditorobject
An object containing details about the creditor associated with the settlement, such as their identifier and contact information.
Show child attributes
400
Object
Error
Response Attributes
statusobject Required
Show child attributes
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?