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

Sep 14, 2022

main
1.0.0
Compare

API structure has changed

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