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

Jan 27, 2023

main
1.0.0
Compare

API structure has changed

62 structure changes including:
25 Breaking changes
30 Additions
7 Modifications
25 Removals
Modified 7 Breaking
GET /api/v1/statement/{uuid}
  • Response
  • 200 response Modified
    • total_charges, total_payments, total_expected_payments, expected_charges_count, expected_payments_count, expected_payments properties Removed
    • total_expectations, total_statement_transactions, total_bank_transactions, total_expectation_amount_reconciled_to_bank, total_expectation_percentage_reconciled_to_bank, expectations_count, statement_transactions_count, statement_transactions properties Added
GET /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • expected_payments_count, expected_payments, reconciled_payments_amount properties Removed
    • statement_transactions_count, statement_transactions, reconciled_expectations_percentage, reconciled_bank_transactions_amount, reconciled_bank_transactions_percentage properties Added
POST /api/v1/provider-statement
  • Response
  • 201 response Modified
    • expected_payments_count, expected_payments, reconciled_payments_amount properties Removed
    • statement_transactions_count, statement_transactions, reconciled_expectations_percentage, reconciled_bank_transactions_amount, reconciled_bank_transactions_percentage properties Added
POST /api/v1/provider-statement/upload
  • Body
  • content type Modified
    • expected_payments property Removed
    • statement_transactions property Added
  • Response
  • 200 response Modified
    • expected_charge, payments properties Removed
    • expectation, bank_transactions properties Added
POST /api/v1/statement/{statement_uuid}/lock
  • Response
  • 200 response Modified
    • total_charges, total_payments, total_expected_payments, expected_charges_count, expected_payments_count, expected_payments properties Removed
    • total_expectations, total_statement_transactions, total_bank_transactions, total_expectation_amount_reconciled_to_bank, total_expectation_percentage_reconciled_to_bank, expectations_count, statement_transactions_count, statement_transactions properties Added
POST /api/v1/statement/{statement_uuid}/unlock
  • Response
  • 200 response Modified
    • total_charges, total_payments, total_expected_payments, expected_charges_count, expected_payments_count, expected_payments properties Removed
    • total_expectations, total_statement_transactions, total_bank_transactions, total_expectation_amount_reconciled_to_bank, total_expectation_percentage_reconciled_to_bank, expectations_count, statement_transactions_count, statement_transactions properties Added
PUT /api/v1/provider-statement/{providerStatement_uuid}
  • Response
  • 200 response Modified
    • expected_payments_count, expected_payments, reconciled_payments_amount properties Removed
    • statement_transactions_count, statement_transactions, reconciled_expectations_percentage, reconciled_bank_transactions_amount, reconciled_bank_transactions_percentage properties Added
Removed 25 Breaking
DELETE /api/v1/expected-charge/{expectedCharge_uuid}
DELETE /api/v1/expected-payment/{expectedPayment_uuid}
DELETE /api/v1/payment/{uuid}
GET /api/v1/client/{client_uuid}/expected-charges
GET /api/v1/expected-charge
GET /api/v1/expected-charge/{expectedCharge_uuid}
GET /api/v1/expected-payment
GET /api/v1/expected-payment/{expectedPayment_uuid}
GET /api/v1/expected-payment/{expectedPayment_uuid}/reconciliations
GET /api/v1/payment
GET /api/v1/payment/{payment_uuid}/reconciliations
GET /api/v1/payment/{uuid}
GET /api/v1/plans/{plan_uuid}/expected-charges
POST /api/v1/expected-charge/balance
POST /api/v1/expected-charge/calculate
POST /api/v1/expected-charge/reconcile
POST /api/v1/expected-payment
POST /api/v1/expected-payment/create-expected-charges
POST /api/v1/expected-payment/{expectedPayment_uuid}/unreconcile-expectation
POST /api/v1/payment
POST /api/v1/payment/csv
POST /api/v1/payment/reconcile
PUT /api/v1/expected-charge/{expectedCharge_uuid}
PUT /api/v1/expected-payment/{expectedPayment_uuid}
PUT /api/v1/payment/{uuid}
Added 30
DELETE /api/v1/bank-statement/{bankStatement_uuid}
DELETE /api/v1/bank-transaction/{bankTransaction_uuid}
DELETE /api/v1/expectation/{uuid}
DELETE /api/v1/statement-transaction/{statementTransaction_uuid}
GET /api/v1/bank-statement
GET /api/v1/bank-statement/{bankStatement_uuid}
GET /api/v1/bank-transaction
GET /api/v1/bank-transaction/{bankTransaction_uuid}
GET /api/v1/bank-transaction/{bankTransaction_uuid}/reconciliations
GET /api/v1/client/{client_uuid}/expectations
GET /api/v1/expectation
GET /api/v1/expectation/{uuid}
GET /api/v1/plans/{plan_uuid}/expectations
GET /api/v1/statement-transaction
GET /api/v1/statement-transaction/{statementTransaction_uuid}
GET /api/v1/statement-transaction/{statementTransaction_uuid}/reconciliations
POST /api/v1/bank-statement
POST /api/v1/bank-statement/upload
POST /api/v1/bank-transaction
POST /api/v1/bank-transaction/reconcile
POST /api/v1/expectation/balance
POST /api/v1/expectation/calculate
POST /api/v1/expectation/reconcile
POST /api/v1/statement-transaction
POST /api/v1/statement-transaction/create-expectations
POST /api/v1/statement-transaction/{statementTransaction_uuid}/unreconcile-expectation
PUT /api/v1/bank-statement/{bankStatement_uuid}
PUT /api/v1/bank-transaction/{bankTransaction_uuid}
PUT /api/v1/expectation/{uuid}
PUT /api/v1/statement-transaction/{statementTransaction_uuid}