Change Updates

Do not miss any FinCalc API changes, ever again

Subscribe to the FinCalc API changelog to be up to date on recent changes.

RSS

28 days ago

main
2.0.0
Compare

API structure has changed

Next Change
82 structure changes including:
3 Additions
79 Modifications
Modified 79 Breaking
PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals/{WithdrawalGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, TakeNaturalIncome properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
POST /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/pensions
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, CalculatedRepayment properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • CalculatedRepayment property Added
POST /api/v2/household/{HouseholdGUID}/liabilities
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/incomes
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/expenditure
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/events
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/assets/{AssetGUID}/improvements
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/assets
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/companysettings/clienttags
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/clients/{ClientGUID}/tags
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/clients/{ClientGUID}/relationships
  • Body
  • application/json content type Modified
    • ClientGUID property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ExcludeFormattedValues property Added
POST /api/v2/clients/backoffice/{BackOfficeID}/factfind
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/clients
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
GET /api/v2/user
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals/{WithdrawalGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions/{ContributionGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions
  • Query
  • ExcludeFormattedValues query parameter Added
PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions/{ContributionGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, NeverTouch properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • NeverTouch property Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, TakeNaturalIncome properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions/{PensionContributionGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, CalculatedRepayment properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CalculatedRepayment property Added
PUT /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/incomes/{IncomeGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/expenditure/{ExpenditureGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/events/{EventGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/assets/{AssetGUID}/improvements/{ImprovementGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}/assets/{AssetGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/household/{HouseholdGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/companysettings/clienttags/{TagGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/clients/{ClientGUID}/relationships
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
PUT /api/v2/clients/{ClientGUID}
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, TakeNaturalIncome properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
POST /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues property Added
POST /api/v2/household/{HouseholdGUID}/savings
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, NeverTouch properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • NeverTouch property Added
POST /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals
  • Body
  • application/json content type Modified
    • ExcludeFormattedValues, TakeNaturalIncome properties Added
GET /api/v2/household/{HouseholdGUID}/expenditure/{ExpenditureGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/expenditure
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/events/{EventGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/events
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/assets/{AssetGUID}/improvements/{ImprovementGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/assets/{AssetGUID}/improvements
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/assets/{AssetGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/assets
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/factfind/templates
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/companysettings/clienttags/{TagGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/companysettings/clienttags
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/clients/{ClientGUID}/tags
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/clients/{ClientGUID}/relationships
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/clients/{ClientGUID}/household
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/clients/{ClientGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/clients/backoffice/{BackOfficeID}/factfind
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/clients/backoffice/{BackOfficeID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/clients
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • NeverTouch property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/savings/withdrawals/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
GET /api/v2/household/{HouseholdGUID}/savings/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • NeverTouch property Added
GET /api/v2/household/{HouseholdGUID}/savings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • NeverTouch property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions/{PensionContributionGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome property Added
GET /api/v2/household/{HouseholdGUID}/pensions
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CalculatedRepayment property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CalculatedRepayment property Added
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CalculatedRepayment property Added
GET /api/v2/household/{HouseholdGUID}/liabilities/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CalculatedRepayment property Added
GET /api/v2/household/{HouseholdGUID}/liabilities
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/incomes/{IncomeGUID}
  • Query
  • ExcludeFormattedValues query parameter Added
GET /api/v2/household/{HouseholdGUID}/incomes
  • Query
  • ExcludeFormattedValues query parameter Added
Added 3
GET /api/v2/clients/{ClientGUID}/reports/{ReportRequestGUID}/download
GET /api/v2/clients/{ClientGUID}/reports/{ReportRequestGUID}
GET /api/v2/clients/{ClientGUID}/reports