Search
K
financials v1

Set Completion Date

This API is used in conjunction with ‘Fetch financial settlement schedules’ API to set or update the completion date

patch
https://api.pexa.co.uk/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}

Path Parameters

financialSettlementScheduleIdstring(uuid)required

Unique identifier for Financial Settlement Schedule id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
completionDatestring(date)required

Example:1970-12-31

Response

application/json

OK

dataobject
Show Child Parameters
errorsarray[object]

Default:[]

Show Child Parameters
patch/partner/api/platformconnect/v1/financial-settlement-schedules/{financialSettlementScheduleId}

Body

{ "completionDate": "1970-12-31" }
 
application/json

FinancialSettlementScheduleApprovalRequest

object
actionstringrequired

Action to perform on financial settlement schedule
Allowed values: [APPROVE, UNAPPROVE]

Match pattern:^(APPROVE|UNAPPROVE)$

Example:APPROVE

workspaceIdstring(uuid)required

The workspace ID for which to approve/unapprove financial settlement schedule line items

Example:4gb85f64-5717-4562-b3fc-2c963f66afa6

financialSettlementScheduleIdstring(uuid)required

The financial settlement schedule ID for which to approve/unapprove line items

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

approvedBystringrequired

Email address of the user performing the approval action

Match pattern:^$|(?:[A-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[A-z0-9!#$%&'*+/=?^_`{|}~-]+)*|"(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21\x23-\x5b\x5d-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])*")@(?:(?:[A-z0-9](?:[A-z0-9-]*[A-z0-9])?\.)+[A-z0-9](?:[A-z0-9-]*[A-z0-9])?|\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[A-z0-9-]*[A-z0-9]:(?:[\x01-\x08\x0b\x0c\x0e-\x1f\x21-\x5A\x53-\x7f]|\\[\x01-\x09\x0b\x0c\x0e-\x7f])+)\])

>= 1 characters<= 50 characters

Example:approver@lawfirm.com

Example

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