Search
K
financials v1

AccountType

string

Allowed Values: [BUSINESS, PERSONAL]

Match pattern:^(BUSINESS|PERSONAL)$

Example

DisplayName

string

Match pattern:^[0-9a-zA-Z/\-\?:\(\)\.,'\+ !#$%&\*=^_`\{\|\}~";<>@\[\\\]]+$

<= 35 characters

Example

BankAccountDto

object

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

accountNamestringrequired

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

>= 1 characters<= 35 characters

Example:Bob Smith

accountNumberstringrequired

Match pattern:^\d{8}$

Example:12345678

bankCodestringrequired

Match pattern:^\d{6}$

Example:123456

accountTypestring

Allowed Values: [BUSINESS, PERSONAL]

Match pattern:^(BUSINESS|PERSONAL)$

Example:BUSINESS

displayNamestring

Match pattern:^[0-9a-zA-Z/\-\?:\(\)\.,'\+ !#$%&\*=^_`\{\|\}~";<>@\[\\\]]+$

<= 35 characters

Example:Mortgage account

Example

LineItemAttributesDto

object

Additional line item attributes. Omitted when neither subCategory nor notes is set.

subCategorystring

Sub-category. Only populated when category is Third Party Payment.

Match pattern:^(LANDLORD_FEE|MANAGEMENT_COMPANY_FEE|INDEMNITY_INSURANCE|ESTATE_AGENTS_FEE|OTHER)$

Example:INDEMNITY_INSURANCE

notesstring

Optional free-text notes for the line item.

>= 0 characters<= 128 characters

Example:Insurance Fee

Example

schemas-Authorised

boolean

Authorisation status of the line item

Example:true