Search
K
financials v1

LineItemDto

object
lineItemIdstring(uuid)

UUID of the corresponding line item

Example:c7c0ee40-25c1-11ec-9621-0242ac130002

typestring

Allowed values:
[SOURCE, DESTINATION]

Match pattern:^(SOURCE|DESTINATION)$

Example:SOURCE

amountnumber

Amount to be credited / debited

>= 1<= 999999999999.99

Example:10

authorisedboolean

Authorisation status of the line item

Example:true

referencestring

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

>= 1 characters<= 18 characters

Example:Nation wide

categorystring

Allowed values for source line item:
[Mortgage Advance]

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

lineItemReferencestring

Example:PEXA220000003D01

bankAccountobject

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

Show Child Parameters
verificationDetailobject
Show Child Parameters
hasLinkedAccountboolean

Flag to indicate whether account is a linked account

Example

LineItemResponse

object
dataobject
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
Example

FinancialSettlementScheduleParticipant

object
subscriberIdstring(uuid)

Example:59a02f78-79c2-49ff-b27f-5606b4cda762

rolestring

Example:INCOMING_LENDER

Example