Search
K
financials v1

Financial

v1OAS 3.0

This API product gives all the possible functionalities we can perform on financials like add, update, delete financial line items, funds authorization and set completion date.

API Base URL
  • Server 1:https://api.pexa.co.uk

    API Gateway URL

Security
oauth2 (oauth2)

Client Credentials OAuth Flow

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • x-api:authorise:funds - Permission to authorise funds for a workspace
  • x-api:approve:financial_settlement_schedules - Permission to approve financial settlement schedules
  • x-api:unapprove:financial_settlement_schedules - Permission to unapprove financial settlement schedules
  • add:fss_line_items - Permission to add financial settlement schedule line items
  • delete:fss_line_items - Permission to delete financial settlement schedule line items
  • view:financial_settlement_schedules - Permission to view financial settlement schedules
  • edit:financial_settlement_schedules - Permission to edit financial settlement schedules
  • edit:fss_line_items - Permission to edit financial settlement schedule line items

Funds Authorisation

This API is used to authorise/un-authorise the fss source line item for a workspace

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/funds-authorisation

Path Parameters

workspace_idstring(uuid)required

Workspace id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
completionDatestring(date)required

Example:1970-12-31

lineItemobjectrequired
Show Child Parameters

Response

application/json

OK

matchedboolean

Example:true

authorisedboolean

Authorisation status of the line item

Example:true

post/partner/api/platformconnect/v1/workspaces/{workspace_id}/funds-authorisation

Body

{ "completionDate": "1970-12-31", "lineItem": { "authorised": true, "category": "Mortgage Advance", "amount": 10 } }
 
application/json

Approve or Unapprove Financial Settlement Schedule

This endpoint is used by conveyancing law firms to approve the financial line items so the workspace can be prepared.

post
https://api.pexa.co.uk/partner/api/platformconnect/v1/workspaces/{workspace_id}/financial-approvals

Path Parameters

workspace_idstring(uuid)required

Workspace id

Headers

X-Request-Correlation-Idstring

The unique identifier for the request

Body

application/json
actionstringrequired

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

Match pattern:^(APPROVE|UNAPPROVE)$

Example:APPROVE

approvedBystringrequired

Email address of the user who performed 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

Example:approver@lawfirm.com

Response

application/json

OK

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
post/partner/api/platformconnect/v1/workspaces/{workspace_id}/financial-approvals

Body

{ "action": "APPROVE", "approvedBy": "approver@lawfirm.com" }
 
application/json