Search
K
financials v1

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

Authorised

boolean

Authorisation status of the line item

Example:true

CreateLineItemRequest

object
typestringrequired

Allowed values:
[SOURCE, DESTINATION]

Match pattern:^(SOURCE|DESTINATION)$

Example:SOURCE

categorystringrequired

Allowed values for source line item:
[Mortgage Advance]

Allowed values for destination line item:
[Redemption, Conveyancing Fees, Surplus, Onward Funds]

amountnumberrequired

Amount to be credited / debited

>= 1<= 999999999999.99

Example:10

referencestringrequired

Match pattern:^[a-zA-Z0-9\/\-\\?:().,'#=!"%&*<>;@{+\s]*$

>= 1 characters<= 18 characters

Example:Nation wide

bankAccountobject

This field is required and can be updated only for type DESTINATION.

Show Child Parameters
hasLinkedAccountboolean

Flag to indicate whether account is linked to a financial account

Example

FinancialSettlementScheduleListResponse

object
recordsarray[object]
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
Example

FinancialSettlementScheduleResponse

object
dataobject
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
Example