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
3 structure changes including:
1 Breaking change
2 Additions
1 Removal
Removed 1 Breaking
GET /api/v1/static/charge-categories/{feeType}
Added 2
GET /api/v1/static/charge-categories
POST /api/v1/notifications/unread/{notification_id}
2 structure changes including:
2 Modifications
Modified 2 Breaking
POST /api/v1/plans
  • Body
  • content type Modified
    • value_released property Removed
  • Response
  • 200 (2) response Modified
    • fields property Modified
  • 200 (6) response Modified
    • fields property Modified
  • 200 (10) response Removed
PUT /api/v1/plans/{uuid}
  • Body
  • content type Modified
    • value_released property Removed
3 structure changes including:
1 Addition
2 Modifications
Modified 2
GET /api/v1/notifications
  • Query
  • filter[read], per_page query parameters Added
PUT /api/v1/plans/{uuid}
  • Body
  • content type Modified
    • client_uuid property Added
Added 1
DELETE /api/v1/notifications/{id}
5 structure changes including:
2 Additions
3 Modifications
Modified 3 Breaking
GET /api/v1/plans/{uuid}
  • Response
  • 200 response Modified
    • plan_type property Removed
    • sub_type property Added
POST /api/v1/plans
  • Body
  • content type Modified
    • plan_type property Removed
    • sub_type, equity_released properties Added
  • Response
  • 200 response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (1) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (2) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (3) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (4) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (5) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (6) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (7) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (8) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (9) response Modified
    • plan_type property Removed
    • sub_type property Added
  • 200 (10) response Modified
    • plan_type property Removed
    • sub_type property Added
PUT /api/v1/plans/{uuid}
  • Body
  • content type Modified
    • plan_type property Removed
    • sub_type, equity_released properties Added
  • Response
  • 200 response Modified
    • plan_type property Removed
    • sub_type property Added
Added 2
GET /api/v1/static/plan-sub-types/{type}
GET /api/v1/static/plan-types
1 structure change including:
1 Addition
Added 1
GET /api/v1/static/charge-categories/{feeType}
1 structure change including:
1 Modification
Modified 1
POST /api/v1/account/{account_uuid}/address
  • Body
  • content type Modified
    • town_city, postcode, country properties Modified
10 structure changes including:
10 Modifications
Modified 10 Breaking
GET /api/v1/client/{client_uuid}/charges
  • Query
  • include, sort query parameters Added
GET /api/v1/expected-charge/{expectedCharge_uuid}
  • Response
  • 200 response Modified
    • tax_exempt, tax, recurring, gross_amount, net_amount, amount, percentage, exclude_from_rmar, rmar_type, advice_type, service_type, advice_area, seller properties Added
GET /api/v1/plans/{plan_uuid}/charges
  • Query
  • include, sort query parameters Added
POST /api/v1/charge
  • Body
  • content type Modified
    • seller_uuid, exclude_from_rmar, advice_type, service_type, advice_area properties Added
POST /api/v1/employee
  • Body
  • content type Modified
    • advice_type property Added
POST /api/v1/expected-charge/reconcile
  • Response
  • 200 response Modified
    • tax_exempt, tax, recurring, gross_amount, net_amount, amount, percentage, exclude_from_rmar, rmar_type, advice_type, service_type, advice_area, seller properties Added
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • content type Modified
    • advice_type property Added
PUT /api/v1/charge/{uuid}
  • Body
  • content type Modified
    • seller_uuid, exclude_from_rmar, advice_type, service_type, advice_area properties Added
PUT /api/v1/employee/{uuid}
  • Body
  • content type Modified
    • advice_type property Added
PUT /api/v1/expected-charge/{expectedCharge_uuid}
  • Body
  • content type Modified
    • seller_uuid, exclude_from_rmar, rmar_type, advice_type, service_type properties Added
  • Response
  • 200 response Modified
    • tax_exempt, tax, recurring, gross_amount, net_amount, amount, percentage, exclude_from_rmar, rmar_type, advice_type, service_type, advice_area, seller properties Added
2 structure changes including:
2 Modifications
Modified 2
POST /api/v1/client
  • Body
  • content type Modified
    • date_of_marriage, is_deceased, deceased_at, is_married_to_partner, checked_sanctions_at, lead_source, write_to_whom, passport_number, do_not_contact_via_fax, do_not_contact_via_mail, do_not_contact_via_sms, do_not_contact_via_email, do_not_contact_via_telephone, do_not_visit, do_not_market properties Added
PUT /api/v1/client/{uuid}
  • Body
  • content type Modified
    • is_deceased, deceased_at, is_married_to_partner, checked_sanctions_at, lead_source, write_to_whom, passport_number, do_not_contact_via_fax, do_not_contact_via_mail, do_not_contact_via_sms, do_not_contact_via_email, do_not_contact_via_telephone, do_not_visit, do_not_market properties Added
9 structure changes including:
2 Additions
7 Modifications
Modified 7
GET /api/v1/plans/{plan_uuid}/transaction
  • Query
  • filter[sub_type] query parameter Added
GET /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Response
  • 200 response Modified
    • sub_type property Added
GET /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Response
  • 200 response Modified
    • sub_type property Added
POST /api/v1/plans/{plan_uuid}/transaction
  • Body
  • content type Modified
    • sub_type property Added
  • Response
  • 201 response Modified
    • sub_type property Added
POST /api/v1/plans/{plan_uuid}/transaction-schedule
  • Body
  • content type Modified
    • sub_type property Added
  • Response
  • 201 response Modified
    • sub_type property Added
PUT /api/v1/plans/{plan_uuid}/transaction-schedule/{transactionSchedule_uuid}
  • Body
  • content type Modified
    • sub_type property Added
  • Response
  • 200 response Modified
    • sub_type property Added
PUT /api/v1/plans/{plan_uuid}/transaction/{uuid}
  • Body
  • content type Modified
    • sub_type property Added
  • Response
  • 200 response Modified
    • sub_type property Added
Added 2
GET /api/v1/static/transaction-sub-types/{transactionType}
GET /api/v1/static/transaction-types
5 structure changes including:
5 Modifications
Modified 5 Breaking
GET /api/v1/payment
  • Query
  • filter[payment_origin] query parameter Removed
GET /api/v1/payment/{uuid}
  • Response
  • 200 response Modified
    • payment_origin property Removed
POST /api/v1/payment
  • Response
  • 201 response Modified
    • payment_origin property Removed
POST /api/v1/payment/csv
  • Response
  • 201 response Modified
    • payment_origin property Removed
PUT /api/v1/payment/{uuid}
  • Body
  • content type Modified
    • payment_origin property Removed
  • Response
  • 200 response Modified
    • payment_origin property Removed