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

12 days ago

upcoming
2.0.0
Compare

API structure has changed

Next Change
34 structure changes including:
2 Breaking changes
2 Additions
30 Modifications
2 Removals
Modified 30 Breaking
PUT /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}
  • Body
  • application/json content type Modified
    • ATRSlot, FutureRiskLevel properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ATRGUID, FutureRiskATRGUID properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}
  • Body
  • application/json content type Modified
    • DeathBasis property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • DeathBasis property Added
PUT /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}
  • Body
  • application/json content type Modified
    • ATRSlot, FutureRiskLevel properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ATRGUID, FutureRiskATRGUID properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
PUT /api/v2/companysettings/clienttags/{TagGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • CompanyGUID property Added
PUT /api/v2/clients/{ClientGUID}
  • Body
  • application/json content type Modified
    • AdviserID, AttitudeToRiskLevel, ClientTier properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • AdviserUserGUID, ATRGUID, ClientTierGUID properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • AdviserID, AttitudeToRiskLevel, ClientTier properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • AdviserUserGUID, ATRGUID, ClientTierGUID properties Added
POST /api/v2/household/{HouseholdGUID}/savings
  • Body
  • application/json content type Modified
    • ATRSlot, FutureRiskLevel properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ATRGUID, FutureRiskATRGUID properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
POST /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals
  • Body
  • application/json content type Modified
    • DeathBasis property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • TakeNaturalIncome, DeathBasis properties Added
POST /api/v2/household/{HouseholdGUID}/pensions
  • Body
  • application/json content type Modified
    • ATRSlot, FutureRiskLevel properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • ATRGUID, FutureRiskATRGUID properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
POST /api/v2/companysettings/clienttags
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • CompanyGUID property Added
POST /api/v2/clients/{ClientGUID}/tags
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • CompanyGUID property Added
POST /api/v2/clients/backoffice/{BackOfficeID}/factfind
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • WhoRequestedID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • WhoRequestedGUID property Added
POST /api/v2/clients
  • Body
  • application/json content type Modified
    • AdviserID, AttitudeToRiskLevel, ClientTier properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • AdviserUserGUID, ATRGUID, ClientTierGUID properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • AdviserID, AttitudeToRiskLevel, ClientTier properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • AdviserUserGUID, ATRGUID, ClientTierGUID properties Added
GET /api/v2/user
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ID, Name, CompanyID, PrimaryCompanyID, SecurityProfileID, TeamID properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • UserGUID, PersonGUID, CompanyGUID, SecurityProfileGUID, TeamGUID, FirstName, LastName properties Added
GET /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
GET /api/v2/household/{HouseholdGUID}/savings/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
GET /api/v2/household/{HouseholdGUID}/savings
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals/{PensionWithdrawalGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • DeathBasis property Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}/withdrawals
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • DeathBasis property Added
GET /api/v2/household/{HouseholdGUID}/pensions/{PensionGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
GET /api/v2/household/{HouseholdGUID}/pensions/withdrawals/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • DeathBasis property Added
GET /api/v2/household/{HouseholdGUID}/pensions/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
GET /api/v2/household/{HouseholdGUID}/pensions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • ATRSlot, FutureRiskLevel properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • ATRGUID, FutureRiskATRGUID properties Added
GET /api/v2/companysettings/clienttags/{TagGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • CompanyGUID property Added
GET /api/v2/companysettings/clienttags
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyClientTags property Modified
GET /api/v2/clients/{ClientGUID}/tags
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • CompanyID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • CompanyGUID property Added
GET /api/v2/clients/{ClientGUID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • AdviserID, AttitudeToRiskLevel, ClientTier properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • AdviserUserGUID, ATRGUID, ClientTierGUID properties Added
GET /api/v2/clients/options
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • AdviserID, AttitudeToRiskLevel, ClientTier properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • AdviserUserGUID, ATRGUID, ClientTierGUID properties Added
GET /api/v2/clients/backoffice/{BackOfficeID}/factfind
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • WhoRequestedID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • WhoRequestedGUID property Added
GET /api/v2/clients/backoffice/{BackOfficeID}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • AdviserID, AttitudeToRiskLevel, ClientTier properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • AdviserUserGUID, ATRGUID, ClientTierGUID properties Added
GET /api/v2/clients
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • AdviserID property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • AdviserUserGUID property Added
Removed 2 Breaking
GET /api/v2/user/companies
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PATCH /api/v2/user/companies/{NewCompanyID}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 2
PATCH /api/v2/user/logins/{UserGUID}
GET /api/v2/user/logins