Change Updates

Do not miss any lms API changes, ever again

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

RSS

Mar 13, 2024

main
0.3.0
Compare

API structure has changed

23 structure changes including:
2 Additions
21 Modifications
Modified 21 Breaking
POST /v1/borrowers/{borrower_id}/simulate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • loans property Modified
      • positive_balance property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • summary property Added
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/create
  • Response
  • 404, 500 responses Added
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/cancel
  • Response
  • 404, 500 responses Added
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/allocate
  • Response
  • 404, 500 responses Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create
  • Response
  • 200 response Modified
    • application/json content type Modified
      • loan_id property Added
  • 404, 500 responses Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/cancel
  • Response
  • 404 response Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/undo_cancellation
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • effective_date, loan_id properties Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/transfer_ownership
  • Response
  • 404, 500 responses Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/create
  • Response
  • 404, 500 responses Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/cancel
  • Response
  • 404 response Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/create
  • Body
  • application/json content type Modified
    • loan property Modified
      • config_id, due_dates properties Modified
        • Properties are now required
          Breaking
      • daily_fee_charge, installment_fee_charge properties Modified
        • Full types went from number to null | number
  • Response
  • 200 response Modified
    • application/json content type Modified
      • config_id, due_dates properties Modified
        • Properties are now required
          Breaking
      • daily_fee_charge, installment_fee_charge properties Modified
        • Full types went from number to null | number
  • 404, 500 responses Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/cancel
  • Body
  • application/json content type Modified
    • loan_cancellation property Modified
      • loan_id property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • id property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Full types went from string to null | string
      • effective_date, loan_id properties Added
  • 404, 500 responses Added
POST /v1/borrowers/payments/create
  • Response
  • 404, 500 responses Added
POST /v1/borrowers/loans/waivers/create
  • Response
  • 207 response Modified
    • application/json content type Modified
      • succeeded property Modified
  • 404, 500 responses Added
POST /v1/borrowers/loans/simulate
  • Body
  • application/json content type Modified
    • loan property Modified
  • Response
  • 404 response Added
POST /v1/borrowers/loans/restructurings/create
  • Response
  • 404 response Added
POST /v1/borrowers/loans/restructurings/cancel
  • Response
  • 404 response Added
POST /v1/borrowers/loans/create
  • Body
  • application/json content type Modified
    • loan property Modified
  • Response
  • 207 response Modified
    • application/json content type Modified
      • succeeded property Modified
  • 404, 500 responses Added
POST /v1/borrowers/loans/cancel
  • Body
  • application/json content type Modified
    • loan_cancellation property Modified
  • Response
  • 207 response Modified
    • application/json content type Modified
      • succeeded property Modified
  • 404, 500 responses Added
GET /v1/borrowers/{borrower_id}/get_status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • loans property Modified
      • positive_balance property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • summary property Added
GET /v1/borrowers/loans/get_summary
  • Response
  • 404, 500 responses Added
Added 2
POST /v1/borrowers/payments/cancel
POST /v1/borrowers/loans/transfer_ownership