Change Updates

Do not miss any PlannrCRM API changes, ever again

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

RSS

Changelog

Last update:
Compare
91 structure changes including:
27 Breaking changes
52 Additions
12 Modifications
27 Removals
Modified 12 Breaking
PUT /api/v1/plans/{uuid}
  • Body
  • content type Modified
    • adviser_split_uuid property Added
PUT /api/v1/introducer/{uuid}
  • Body
  • content type Modified
    • charge_split_schema_uuid property Added
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • keep_deleted_files_for, tax, month_end, statement_frequency properties Added
PUT /api/v1/employee/{uuid}
  • Body
  • content type Modified
    • charge_split_banding_uuid property Removed
    • adviser_split_uuid property Added
POST /api/v1/plans
  • Body
  • content type Modified
    • charge_split_banding_uuid property Removed
    • seller_uuid, adviser_split_uuid properties Added
POST /api/v1/introducer
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • content type Modified
    • keep_deleted_files_for, tax, month_end, lock_statements_after, adviser_split_uuid properties Added
  • Response
  • 200 response Modified
    • keep_deleted_files_for, tax, month_end, statement_frequency properties Added
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • keep_deleted_files_for, tax, month_end, statement_frequency properties Added
GET /api/v1/introducer/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/introducer
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
  • Query
  • per_page, sort, include query parameters Added
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • keep_deleted_files_for, tax, month_end, statement_frequency properties Added
DELETE /api/v1/introducer/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
Removed 27 Breaking
DELETE /api/v1/fee-schedule/{id}
DELETE /api/v1/fee-type/{feeType_uuid}
DELETE /api/v1/fee/{uuid}
DELETE /api/v1/payment-origin/{paymentOrigin_uuid}
DELETE /api/v1/payment/{uuid}
GET /api/v1/fee-schedule/{feeable_type}/{feeable_uuid}
GET /api/v1/fee-schedule/{id}
PUT /api/v1/payment/{uuid}
PUT /api/v1/payment-origin/{paymentOrigin_uuid}
PUT /api/v1/fee/{uuid}
PUT /api/v1/fee-type/{feeType_uuid}
PUT /api/v1/fee-schedule/{id}
POST /api/v1/payment/csv
POST /api/v1/payment-origin
POST /api/v1/payment
POST /api/v1/fee/{fee_uuid}/reconcile
POST /api/v1/fee-type
GET /api/v1/fee-type
GET /api/v1/fee-type/{feeType_uuid}
GET /api/v1/fee/{feeable_type}/{feeable_uuid}
GET /api/v1/fee/{uuid}
GET /api/v1/payment
GET /api/v1/payment-origin
GET /api/v1/payment-origin/{paymentOrigin_uuid}
GET /api/v1/payment/{uuid}
POST /api/v1/fee
POST /api/v1/fee-schedule
Added 52
PUT /api/v1/payment/{uuid}
PUT /api/v1/expected-payment/{expectedPayment_uuid}
PUT /api/v1/expected-charge/{expectedCharge_uuid}
PUT /api/v1/charge/{uuid}
PUT /api/v1/charge-split/{chargeSplit_uuid}
PUT /api/v1/charge-split-schema/{chargeSplitSchema_uuid}
GET /api/v1/expected-payment/{expectedPayment_uuid}/reconciliations
GET /api/v1/expected-payment/{expectedPayment_uuid}
GET /api/v1/expected-payment
GET /api/v1/expected-charge/{expectedCharge_uuid}/reconciliations
GET /api/v1/expected-charge/{expectedCharge_uuid}
GET /api/v1/expected-charge
GET /api/v1/client/{client_uuid}/expected-charges
GET /api/v1/client/{client_uuid}/charges
GET /api/v1/charge/{uuid}
GET /api/v1/charge-split/{splitableType}/{splitableUuid}
GET /api/v1/charge-split/{chargeSplit_uuid}
GET /api/v1/charge-split-schema/{chargeSplitSchema_uuid}
GET /api/v1/charge-split-schema
GET /api/v1/adviser-split/{adviserSplit_uuid}
GET /api/v1/adviser-split
DELETE /api/v1/reconciliation/{uuid}
DELETE /api/v1/payment/{uuid}
DELETE /api/v1/expected-payment/{expectedPayment_uuid}
DELETE /api/v1/expected-charge/{expectedCharge_uuid}
DELETE /api/v1/charge/{uuid}
DELETE /api/v1/charge-split/{chargeSplit_uuid}
DELETE /api/v1/charge-split-schema/{chargeSplitSchema_uuid}
DELETE /api/v1/adviser-split/{adviserSplit_uuid}
PUT /api/v1/adviser-split/{adviserSplit_uuid}
POST /api/v1/statement/{statement_uuid}/lock
POST /api/v1/payment/reconcile
POST /api/v1/payment/csv
POST /api/v1/payment
POST /api/v1/expected-payment/csv
POST /api/v1/expected-payment
POST /api/v1/expected-charge/reconcile
POST /api/v1/expected-charge/calculate
POST /api/v1/expected-charge/balance
POST /api/v1/charge-split-schema
POST /api/v1/charge-split
POST /api/v1/charge
POST /api/v1/adviser-split
GET /api/v1/statement/{uuid}
GET /api/v1/statement/{statement_uuid}/provider-statement/{providerStatement_uuid}
GET /api/v1/statement/{statement_uuid}/provider-statement
GET /api/v1/statement
GET /api/v1/plans/{plan_uuid}/expected-charges
GET /api/v1/plans/{plan_uuid}/charges
GET /api/v1/payment/{uuid}
GET /api/v1/payment/{payment_uuid}/reconciliations
GET /api/v1/payment
1 structure change including:
1 Modification
Modified 1
GET /api/v1/plans
  • Query
  • filter[status] query parameter Added
9 structure changes including:
9 Modifications
Modified 9
DELETE /api/v1/plans/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/client/{client_uuid}/plans
  • Query
  • filter[tags] query parameter Added
GET /api/v1/plans
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/inactivity-reasons
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{plan_uuid}/reporting/valuations/{subAccount}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
GET /api/v1/plans/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
POST /api/v1/plans
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
PUT /api/v1/introducer/{uuid}
  • Body
  • content type Modified
    • groups property Added
PUT /api/v1/plans/{uuid}
  • Header
  • X-PLANNR-ACCOUNT-UUID header Added
4 structure changes including:
4 Modifications
Modified 4
GET /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • billing property Added
POST /api/v1/firm/{firm_uuid}/branding
  • Response
  • 200 response Modified
    • billing property Added
POST /api/v1/firm/{firm_uuid}/settings
  • Response
  • 200 response Modified
    • billing property Added
PUT /api/v1/firm/{uuid}
  • Response
  • 200 response Modified
    • billing property Added
20 structure changes including:
10 Breaking changes
10 Additions
10 Removals
Removed 10 Breaking
PUT /api/v1/client/{client_uuid}/contact-detail/{id}
PUT /api/v1/client/{client_uuid}/address/{uuid}
POST /api/v1/client/{client_uuid}/contact-detail
POST /api/v1/client/{client_uuid}/address
GET /api/v1/client/{client_uuid}/contact-detail/{id}
GET /api/v1/client/{client_uuid}/contact-detail
GET /api/v1/client/{client_uuid}/address/{uuid}
GET /api/v1/client/{client_uuid}/address
DELETE /api/v1/client/{client_uuid}/contact-detail/{id}
DELETE /api/v1/client/{client_uuid}/address/{uuid}
Added 10
PUT /api/v1/account/{account_uuid}/contact-detail/{id}
PUT /api/v1/account/{account_uuid}/address/{uuid}
POST /api/v1/account/{account_uuid}/contact-detail
POST /api/v1/account/{account_uuid}/address
GET /api/v1/account/{account_uuid}/contact-detail/{id}
GET /api/v1/account/{account_uuid}/contact-detail
GET /api/v1/account/{account_uuid}/address/{uuid}
GET /api/v1/account/{account_uuid}/address
DELETE /api/v1/account/{account_uuid}/contact-detail/{id}
DELETE /api/v1/account/{account_uuid}/address/{uuid}
6 structure changes including:
6 Modifications
Modified 6 Breaking
DELETE /api/v1/client-status/{clientStatus_uuid}
  • Path
  • id path parameter Removed
  • clientStatus_uuid path parameter Added
GET /api/v1/client-status/{clientStatus_uuid}
  • Path
  • id path parameter Removed
  • clientStatus_uuid path parameter Added
GET /api/v1/client/{client_uuid}/employment/{uuid}
  • Response
  • 200 response Modified
    • last_salary_increase, business_name, business_year_end, business_value, directors, shareholding_in_business, profit, accountant_company_name, accountant_email, accountant_telephone_number, accountant_address, turnover_history properties Added
POST /api/v1/client/{client_uuid}/employment
  • Body
  • content type Modified
    • last_salary_increase, business_name, business_year_end, business_value, directors, shareholding_in_business, profit, turnover_history, accountant_company_name, accountant_email, accountant_telephone_number, accountant_address properties Added
  • Response
  • 201 response Modified
    • last_salary_increase, business_name, business_year_end, business_value, directors, shareholding_in_business, profit, accountant_company_name, accountant_email, accountant_telephone_number, accountant_address, turnover_history properties Added
PUT /api/v1/client-status/{clientStatus_uuid}
  • Path
  • id path parameter Removed
  • clientStatus_uuid path parameter Added
PUT /api/v1/client/{client_uuid}/employment/{uuid}
  • Body
  • content type Modified
    • last_salary_increase, business_name, business_year_end, business_value, directors, shareholding_in_business, profit, turnover_history, accountant_company_name, accountant_email, accountant_telephone_number, accountant_address properties Added
  • Response
  • 200 response Modified
    • last_salary_increase, business_name, business_year_end, business_value, directors, shareholding_in_business, profit, accountant_company_name, accountant_email, accountant_telephone_number, accountant_address, turnover_history properties Added