Show Menu
Search…
Ctrl+K
ESC
Example searches: “ClientGUID”, “Title”, “Clients”, “403”, “NextPage”
API Changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
upcoming
main
default
upcoming
Topics
Introduction
Authentication
Endpoints
Clients
Get clients household
GET
Get clients
GET
Create a new client
POST
Get client options
GET
Get client
GET
Update client
PUT
Delete client
DELETE
Get clients reports
GET
Get client report
GET
Download client report
GET
Get client by back office ID
GET
Get clients tags
GET
Add client tag to client
POST
Delete client tag for a specific client
DELETE
Company Client Tags
Get company and system supplied client tags
GET
Create client tag
POST
Get client tag
GET
Update client tag
PUT
Delete client tag
DELETE
Fact Find
Get fact find templates
GET
Get Client's fact find request
GET
Create fact find request
POST
Cancel fact find request
DELETE
Create fact find session
POST
Household
Get household options
GET
Get household
GET
Update household
PUT
Create household
POST
Household Assets
Get assets
GET
Create asset
POST
Get asset options
GET
Get asset
GET
Update asset
PUT
Delete asset
DELETE
Household Assets Improvements
Get improvement options
GET
Get improvement
GET
Update improvement
PUT
Delete improvement
DELETE
Get improvements
GET
Create improvement
POST
Household Expenditure
Get expenditure
GET
Update expenditure
PUT
Delete expenditure
DELETE
Get expenditure options
GET
Get expenditures
GET
Create expenditure
POST
Household Incomes
Get incomes
GET
Create income
POST
Get income
GET
Update income
PUT
Delete income
DELETE
Get income options
GET
Household Liabilities
Get liabilities
GET
Create liability
POST
Get liability
GET
Update liability
PUT
Delete liability
DELETE
Get liability options
GET
Household Liabilities Repayments
Get repayment options
GET
Get repayments
GET
Create repayment
POST
Get repayment
GET
Update repayment
PUT
Delete repayment
DELETE
Household Pensions
Get pensions
GET
Create pension
POST
Get pension
GET
Update pension
PUT
Delete pension
DELETE
Get pension options
GET
Household Pension Contributions
Get contributions
GET
Create contribution
POST
Get contribution
GET
Update contribution
PUT
Delete contribution
DELETE
Get contribution options
GET
Household Pension Withdrawals
Get withdrawals
GET
Create withdrawal
POST
Get withdrawal
GET
Update withdrawal
PUT
Delete withdrawal
DELETE
Get withdrawal options
GET
Household Savings
Get savings
GET
Create saving
POST
Get saving
GET
Update saving
PUT
Delete saving
DELETE
Get savings options
GET
Household Savings Contributions
Get contributions
GET
Create contribution
POST
Get contribution
GET
Update contribution
PUT
Delete contribution
DELETE
Get contribution options
GET
Household Savings Withdrawals
Get withdrawals
GET
Create withdrawal
POST
Get withdrawal
GET
Update withdrawal
PUT
Delete withdrawal
DELETE
Get withdrawal options
GET
Household Timeline & Goals
Get event
GET
Update event
PUT
Delete event
DELETE
Get events
GET
Create event
POST
Get event options
GET
Relationships
Get relationships
GET
Update relationship
PUT
Create relationship
POST
Get relationship options
GET
Status
Get the status of the server
GET
User
Get Current User Information
GET
Get linked companies for Current User
GET
Switch Current User Company
PATCH
Create FinCalc session
POST
Dismiss highlight
Show more
Clients
Operations related to clients