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

2 days ago

main
2.0.0
Compare

API structure has changed

Next change
31 structure changes including:
1 Addition
30 Modifications
Modified 30 Breaking
PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals/{WithdrawalGUID}
  • Body
  • application/json content type Modified
    • WithdrawalStyle, NumberOfSegments, StartValueAbsolute properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • NumberOfSegments, WithdrawalStyle, StartValueAbsolute properties Added
PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions/{ContributionGUID}
  • Body
  • application/json content type Modified
    • StartValueAbsolute property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}
  • Body
  • application/json content type Modified
    • OriginalInvestmentPercentageWithdrawn property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • NumberOfSegments, DateOfAssignment, HistoricTransactions properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • OriginalInvestmentPercentageWithdrawn property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • NumberOfSegments, DateOfAssignment, HistoricTransactions properties Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}
  • Body
  • application/json content type Modified
    • StartValueAbsolute property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions/{PensionContributionGUID}
  • Body
  • application/json content type Modified
    • StartValueAbsolute property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}
  • Body
  • application/json content type Modified
    • FullyCrystallised property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • FullyCrystallised property Added
POST /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals
  • Body
  • application/json content type Modified
    • WithdrawalStyle, NumberOfSegments, StartValueAbsolute properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • NumberOfSegments, WithdrawalStyle, StartValueAbsolute properties Added
POST /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions
  • Body
  • application/json content type Modified
    • StartValueAbsolute property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
POST /api/v2/household/{HouseholdGUID}/savings
  • Body
  • application/json content type Modified
    • OriginalInvestmentPercentageWithdrawn property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • NumberOfSegments, DateOfAssignment, HistoricTransactions properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • OriginalInvestmentPercentageWithdrawn property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • NumberOfSegments, DateOfAssignment, HistoricTransactions properties Added
POST /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals
  • Body
  • application/json content type Modified
    • StartValueAbsolute property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
POST /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions
  • Body
  • application/json content type Modified
    • StartValueAbsolute property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
POST /api/v2/household/{HouseholdGUID}/pensions
  • Body
  • application/json content type Modified
    • FullyCrystallised property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • FullyCrystallised property Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals/{WithdrawalGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • NumberOfSegments, WithdrawalStyle, StartValueAbsolute properties Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/withdrawals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • NumberOfSegments, WithdrawalStyle, StartValueAbsolute properties Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions/{ContributionGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • OriginalInvestmentPercentageWithdrawn property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • NumberOfSegments, DateOfAssignment, HistoricTransactions properties Added
GET /api/v2/household/{HouseholdGUID}/savings/withdrawals/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • WithdrawalStyle, StartValueAbsolute properties Added
GET /api/v2/household/{HouseholdGUID}/savings/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • HistoricTransactions property Added
GET /api/v2/household/{HouseholdGUID}/savings/contributions/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/savings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • OriginalInvestmentPercentageWithdrawn property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • NumberOfSegments, DateOfAssignment, HistoricTransactions properties Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions/{PensionContributionGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/contributions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • FullyCrystallised property Added
GET /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/pensions/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • FullyCrystallised property Added
GET /api/v2/household/{HouseholdGUID}/pensions/contributions/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • StartValueAbsolute property Added
GET /api/v2/household/{HouseholdGUID}/pensions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • FullyCrystallised property Added
Added 1
DELETE /api/v2/user