Receivables

Get the risk team review of a receivable

Changed on
get/receivables/{id}/review

Request

Path parameters

idstring required

An object ID assigned and owned by the originator

Example:acct-123

Response

Successful operation

status'approved' | 'declined' required

The risk team eligibility decision for the receivable

notesstring nullable

Notes explaining the review decision

fingerprintstring required

Hash of the receivable's reviewed terms, disbursements and document files when the decision was recorded

idstring required

The ID of the reviewed receivable, as assigned by the originator

created_atstring date-time required

Creation date and time

created_bystring required

ID of the user that created this object

updated_atstring date-time required

Last update date and time

updated_bystring required

ID of the user that last updated this object

staleboolean required

True when the receivable's terms, disbursements or document files changed after the decision was recorded; a stale decision no longer applies and the receivable is ineligible until reviewed again

Example response

{
  "id": "acct-123",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by": "user_0123456789ABCDEFGHIJKLMNOPq",
  "updated_at": "2024-01-15T10:30:00Z",
  "updated_by": "user_0123456789ABCDEFGHIJKLMNOPq"
}

Changes