Search
K
financials v1

FinancialSettlementScheduleApprovalResponse

object
statusstring

Current status of the financial settlement schedule
values: [APPROVED, PREPARED]

Example:APPROVED

approvedBystring(email)

Email address of the user who performed the approval action

Example:approver@lawfirm.com

lineItemsarray[object]

List of line items in the financial settlement schedule

Default:[]

Show Child Parameters
Example

ApprovedLineItem

object
lineItemIdstring(uuid)

Unique identifier for the line item

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

amountnumber

Amount for the line item

Example:100

typestring

Type of line item
values: [SOURCE, DESTINATION]

Example:SOURCE

authorisedboolean

Authorization status of the line item

Example:true

referencestring

Reference for the line item

Example:ref

categorystring

Category of the line item

Example:Mortgage Advance

Example

FundsAuthorisationRequest

object
completionDatestring(date)required

Example:1970-12-31

lineItemobjectrequired
Show Child Parameters
Example

FundsAuthorisationResponse

object
matchedboolean

Example:true

authorisedboolean

Authorisation status of the line item

Example:true

Example

LineItem

object
authorisedbooleanrequired

Authorisation status of the line item

Example:true

categorystringrequired

Allowed values:
[Mortgage Advance]

Match pattern:^(Mortgage Advance)$

Example:Mortgage Advance

amountnumberrequired

Amount to be credited / debited

>= 1<= 999999999999.99

Example:10

Example