# FinCalc API Documentation ## Description This is version `2.0.0` of this API documentation. Last update on Dec 5, 2025. The FinCalc API offers a comprehensive suite of endpoints to support users with their financial planning requirements. All endpoints comply with the JSON data format for both input and output. To update existing data, it is recommended to use the PUT method. Therefore, a GET request should first be made to retrieve the relevant information, and the necessary changes can then be made before using the PUT method to update the data. Please note that the GET request may include formatted values that are not relevant to the PUT request. However, these irrelevant values will be ignored during the PUT request process. ## Servers - https://api.fincalc.co.uk: https://api.fincalc.co.uk () ## Authentication The API accepts 2 different authentication methods: - O auth2 (oauth2) - Bearer auth (http) ## Endpoints and operations ### [Clients](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-clients.md) - [Get clients household](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-parameter-household.md) - [Get clients](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients.md) - [Create a new client](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-clients.md) - [Get client options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-options.md) - [Get client](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-parameter.md) - [Update client](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-clients-parameter.md) - [Delete client](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-clients-parameter.md) - [Get clients reports](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-parameter-reports.md) - [Get client report](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-parameter-reports-parameter.md) - [Download client report](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-parameter-reports-parameter-download.md) - [Get client by back office ID](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-backoffice-parameter.md) - [Get clients tags](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-parameter-tags.md) - [Add client tag to client](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-clients-parameter-tags.md) - [Delete client tag for a specific client](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-clients-parameter-tags-parameter.md) ### [Company Client Tags](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-company-client-tags.md) - [Get company and system supplied client tags](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-companysettings-clienttags.md) - [Create client tag](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-companysettings-clienttags.md) - [Get client tag](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-companysettings-clienttags-parameter.md) - [Update client tag](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-companysettings-clienttags-parameter.md) - [Delete client tag](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-companysettings-clienttags-parameter.md) ### [Fact Find](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-fact-find.md) - [Get fact find templates](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-factfind-templates.md) - [Get Client's fact find request](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-backoffice-parameter-factfind.md) - [Create fact find request](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-clients-backoffice-parameter-factfind.md) - [Cancel fact find request](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-clients-backoffice-parameter-factfind.md) - [Create fact find session](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-clients-backoffice-parameter-factfind-session.md) ### [Household](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household.md) - [Get household options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-options.md) - [Get household](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter.md) - [Update household](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter.md) - [Create household](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household.md) ### [Household Assets](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-assets.md) - [Get assets](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-assets.md) - [Create asset](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-assets.md) - [Get asset options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-assets-options.md) - [Get asset](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-assets-parameter.md) - [Update asset](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-assets-parameter.md) - [Delete asset](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-assets-parameter.md) ### [Household Assets Improvements](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-assets-improvements.md) - [Get improvement options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-assets-improvements-options.md) - [Get improvement](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-assets-parameter-improvements-parameter.md) - [Update improvement](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-assets-parameter-improvements-parameter.md) - [Delete improvement](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-assets-parameter-improvements-parameter.md) - [Get improvements](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-assets-parameter-improvements.md) - [Create improvement](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-assets-parameter-improvements.md) ### [Household Expenditure](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-expenditure.md) - [Get expenditure](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-expenditure-parameter.md) - [Update expenditure](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-expenditure-parameter.md) - [Delete expenditure](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-expenditure-parameter.md) - [Get expenditure options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-expenditure-options.md) - [Get expenditures](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-expenditure.md) - [Create expenditure](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-expenditure.md) ### [Household Incomes](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-incomes.md) - [Get incomes](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-incomes.md) - [Create income](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-incomes.md) - [Get income](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-incomes-parameter.md) - [Update income](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-incomes-parameter.md) - [Delete income](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-incomes-parameter.md) - [Get income options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-incomes-options.md) ### [Household Liabilities](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-liabilities.md) - [Get liabilities](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-liabilities.md) - [Create liability](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-liabilities.md) - [Get liability](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-liabilities-parameter.md) - [Update liability](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-liabilities-parameter.md) - [Delete liability](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-liabilities-parameter.md) - [Get liability options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-liabilities-options.md) ### [Household Liabilities Repayments](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-liabilities-repayments.md) - [Get repayment options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-liabilities-repayments-options.md) - [Get repayments](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-liabilities-parameter-repayments.md) - [Create repayment](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-liabilities-parameter-repayments.md) - [Get repayment](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-liabilities-parameter-repayments-parameter.md) - [Update repayment](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-liabilities-parameter-repayments-parameter.md) - [Delete repayment](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-liabilities-parameter-repayments-parameter.md) ### [Household Pensions](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-pensions.md) - [Get pensions](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions.md) - [Create pension](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-pensions.md) - [Get pension](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-parameter.md) - [Update pension](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-pensions-parameter.md) - [Delete pension](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-pensions-parameter.md) - [Get pension options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-options.md) ### [Household Pension Contributions](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-pension-contributions.md) - [Get contributions](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-parameter-contributions.md) - [Create contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-pensions-parameter-contributions.md) - [Get contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-parameter-contributions-parameter.md) - [Update contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-pensions-parameter-contributions-parameter.md) - [Delete contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-pensions-parameter-contributions-parameter.md) - [Get contribution options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-contributions-options.md) ### [Household Pension Withdrawals](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-pension-withdrawals.md) - [Get withdrawals](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-parameter-withdrawals.md) - [Create withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-pensions-parameter-withdrawals.md) - [Get withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-parameter-withdrawals-parameter.md) - [Update withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-pensions-parameter-withdrawals-parameter.md) - [Delete withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-pensions-parameter-withdrawals-parameter.md) - [Get withdrawal options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-pensions-withdrawals-options.md) ### [Household Savings](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-savings.md) - [Get savings](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings.md) - [Create saving](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-savings.md) - [Get saving](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-parameter.md) - [Update saving](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-savings-parameter.md) - [Delete saving](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-savings-parameter.md) - [Get savings options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-options.md) ### [Household Savings Contributions](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-savings-contributions.md) - [Get contributions](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-parameter-contributions.md) - [Create contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-savings-parameter-contributions.md) - [Get contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-parameter-contributions-parameter.md) - [Update contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-savings-parameter-contributions-parameter.md) - [Delete contribution](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-savings-parameter-contributions-parameter.md) - [Get contribution options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-contributions-options.md) ### [Household Savings Withdrawals](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-savings-withdrawals.md) - [Get withdrawals](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-parameter-withdrawals.md) - [Create withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-savings-parameter-withdrawals.md) - [Get withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-parameter-withdrawals-parameter.md) - [Update withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-savings-parameter-withdrawals-parameter.md) - [Delete withdrawal](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-savings-parameter-withdrawals-parameter.md) - [Get withdrawal options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-savings-withdrawals-options.md) ### [Household Timeline & Goals](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-household-timeline-goals.md) - [Get event](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-events-parameter.md) - [Update event](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-household-parameter-events-parameter.md) - [Delete event](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-household-parameter-events-parameter.md) - [Get events](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-events.md) - [Create event](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-household-parameter-events.md) - [Get event options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-household-parameter-events-options.md) ### [Relationships](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-relationships.md) - [Get relationships](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-parameter-relationships.md) - [Update relationship](https://apidocs.fincalc.co.uk/upcoming/operation/operation-put-api-v2-clients-parameter-relationships.md) - [Create relationship](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-clients-parameter-relationships.md) - [Get relationship options](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-clients-relationships-options.md) ### [Status](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-status.md) - [Get the status of the server](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-status.md) ### [User](https://apidocs.fincalc.co.uk/upcoming/group/endpoint-user.md) - [Get Current User Information](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-user.md) - [Log out current user session](https://apidocs.fincalc.co.uk/upcoming/operation/operation-delete-api-v2-user.md) - [Get User Logins](https://apidocs.fincalc.co.uk/upcoming/operation/operation-get-api-v2-user-logins.md) - [Switch Current User Company](https://apidocs.fincalc.co.uk/upcoming/operation/operation-patch-api-v2-user-logins-parameter.md) - [Create FinCalc session](https://apidocs.fincalc.co.uk/upcoming/operation/operation-post-api-v2-user-session.md) [Powered by Bump.sh](https://bump.sh)