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
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
1 structure change including:
1 Addition
Added 1
GET /api/v1/release-notes
6 structure changes including:
3 Breaking changes
2 Additions
1 Modification
3 Removals
Modified 1
GET /api/v1/import/{uuid}
  • Response
  • 200 response Modified
    • mode, error_report properties Added
Removed 3 Breaking
POST /api/v1/import/client
POST /api/v1/import/plans
POST /api/v1/import/valuations
Added 2
GET /api/v1/import/modes/{importer}
POST /api/v1/import
8 structure changes including:
6 Additions
2 Modifications
Modified 2 Breaking
GET /api/v1/expected-payment
  • Query
  • filter[status] query parameter Removed
  • filter[agency_number], filter[product_reference], filter[adviser], filter[reconciliation] query parameters Added
GET /api/v1/provider-statement
  • Query
  • filter[uuid], filter[reference], filter[provider], filter[date_from], filter[date_to], filter[amount_from] query parameters Added
Added 6
DELETE /api/v1/custom-default-folder/{customDefaultFolder_uuid}
GET /api/v1/custom-default-folder
GET /api/v1/custom-default-folder/{customDefaultFolder_uuid}
POST /api/v1/custom-default-folder
POST /api/v1/provider-statement/upload
PUT /api/v1/custom-default-folder/{customDefaultFolder_uuid}
15 structure changes including:
1 Breaking change
1 Addition
13 Modifications
1 Removal
Modified 13 Breaking
GET /api/v1/expected-charge/{expectedCharge_uuid}
  • Response
  • 200 response Modified
    • reconciliations property Removed
GET /api/v1/expected-payment
  • Response
  • 200 response Modified
    • expected_charges, expected_charge_reconciliations properties Removed
    • expected_charge property Added
GET /api/v1/expected-payment/{expectedPayment_uuid}
  • Response
  • 200 response Modified
    • expected_charges, expected_charge_reconciliations properties Removed
    • expected_charge property Added
GET /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • reconciled_charges_amount property Removed
    • reconciled_expectations_amount property Added
GET /api/v1/statement/{uuid}
  • Response
  • 200 response Modified
    • payment_reconciled_amount, expected_charge_reconciled_amount, provider_statements properties Removed
POST /api/v1/expected-charge/reconcile
  • Body
  • content type Modified
    • provider_statement_uuid, expected_charges properties Removed
    • expected_charge_uuid property Added
  • Response
  • 200 response Added
POST /api/v1/expected-payment
  • Response
  • 200 response Modified
    • expected_charges, expected_charge_reconciliations properties Removed
    • expected_charge property Added
POST /api/v1/provider-statement
  • Response
  • 201 response Modified
    • reconciled_charges_amount property Removed
    • reconciled_expectations_amount property Added
POST /api/v1/statement/{statement_uuid}/lock
  • Response
  • 200 response Modified
    • payment_reconciled_amount, expected_charge_reconciled_amount, provider_statements properties Removed
POST /api/v1/statement/{statement_uuid}/unlock
  • Response
  • 200 response Modified
    • payment_reconciled_amount, expected_charge_reconciled_amount, provider_statements properties Removed
PUT /api/v1/expected-charge/{expectedCharge_uuid}
  • Response
  • 200 response Modified
    • reconciliations property Removed
PUT /api/v1/expected-payment/{expectedPayment_uuid}
  • Response
  • 200 response Modified
    • expected_charges, expected_charge_reconciliations properties Removed
    • expected_charge property Added
PUT /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • reconciled_charges_amount property Removed
    • reconciled_expectations_amount property Added
Removed 1 Breaking
GET /api/v1/expected-charge/{expectedCharge_uuid}/reconciliations
Added 1
POST /api/v1/expected-payment/{expectedPayment_uuid}/unreconcile-expectation
1 structure change including:
1 Modification
Modified 1
POST /api/v1/firm/{firm_uuid}/settings
  • Body
  • content type Modified
    • rmar_start_date property Added
12 structure changes including:
3 Breaking changes
5 Additions
4 Modifications
3 Removals
Modified 4 Breaking
GET /api/v1/expected-payment
  • Response
  • 200 response Modified
    • name, payment_reference, payment_date, amount properties Removed
    • client_name, transaction_reference, date, gross_amount properties Added
  • Query
  • filter[provider_statement] query parameter Added
GET /api/v1/expected-payment/{expectedPayment_uuid}
  • Response
  • 200 response Modified
    • name, payment_reference, payment_date, amount properties Removed
    • client_name, transaction_reference, date, gross_amount properties Added
POST /api/v1/expected-payment
  • Body
  • content type Modified
    • statement_uuid property Modified
    • provider_uuid, payment_origin properties Removed
    • provider_statement_uuid property Added
  • Response
  • 200 response Modified
    • name, payment_reference, payment_date, amount properties Removed
    • client_name, transaction_reference, date, gross_amount properties Added
PUT /api/v1/expected-payment/{expectedPayment_uuid}
  • Body
  • content type Modified
    • policy_number property Modified
    • name, payment_reference, payment_date, amount properties Removed
    • client_name, transaction_reference, agency_number, product_reference, date, gross_amount, net_amount, adviser_name properties Added
  • Response
  • 200 response Modified
    • name, payment_reference, payment_date, amount properties Removed
    • client_name, transaction_reference, date, gross_amount properties Added
Removed 3 Breaking
GET /api/v1/statement/{statement_uuid}/provider-statement
GET /api/v1/statement/{statement_uuid}/provider-statement/{providerStatement_uuid}
POST /api/v1/expected-payment/csv
Added 5
DELETE /api/v1/provider-statement/{providerStatement_uuid}
GET /api/v1/provider-statement
GET /api/v1/provider-statement/{providerStatement_uuid}
POST /api/v1/provider-statement
PUT /api/v1/provider-statement/{providerStatement_uuid}