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

Changelog

Last update:
Compare
2 structure changes including:
2 Additions
Added 2
POST /v1/borrowers/{borrower_id}/loans/consolidations/{consolidation_id}/cancel
POST /v1/borrowers/{borrower_id}/loans/consolidations/{consolidation_id}/create
5 structure changes including:
5 Modifications
Modified 5
GET /v1/borrowers/{borrower_id}/get_status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • loans, summary properties Modified
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
POST /v1/borrowers/loans/simulate
  • Body
  • application/json content type Modified
    • loan property Modified
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/create
  • Body
  • application/json content type Modified
    • loan property Modified
      • initial_fee_charge property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • initial_fee_charge property Added
POST /v1/borrowers/{borrower_id}/simulate
  • Response
  • 200 response Modified
    • application/json content type Modified
      • loans, summary properties Modified
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
1 structure change including:
1 Addition
Added 1
GET /v1/borrowers/{borrower_id}/get_history
0.3.0
49 structure changes including:
26 Breaking changes
21 Additions
28 Removals
Removed 28 Breaking
POST /v1/borrowers/loans/amount_modifications/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/amount_modifications/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/reschedulings/create
POST /v1/borrowers/loans/restructurings/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/restructurings/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/simulate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/transfer_ownership
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/loans/waivers/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/payments/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/amount_modifications/{amount_modification_id}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/amount_modifications/{amount_modification_id}/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/reschedulings/{rescheduling_id}/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/transfer_ownership
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/undo_cancellation
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/allocate
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/cancel
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/create
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/loan_configurations/{loan_configuration_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/borrowers/{borrower_id}/get_status
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/borrowers/loans/get_summary
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 21
GET /v1/borrowers/loans/get_summary
GET /v1/borrowers/{borrower_id}/get_status
POST /v1/borrowers/loans/cancel
POST /v1/borrowers/loans/create
POST /v1/borrowers/loans/restructurings/cancel
POST /v1/borrowers/loans/restructurings/create
POST /v1/borrowers/loans/simulate
POST /v1/borrowers/loans/waivers/create
POST /v1/borrowers/payments/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/cancel
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/cancel
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/transfer_ownership
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/undo_cancellation
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/cancel
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/allocate
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/cancel
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/create
POST /v1/borrowers/{borrower_id}/simulate
1 structure change including:
1 Modification
Modified 1
GET /v1/borrowers/{borrower_id}/get_status
  • Response
  • 200 response Modified
    • application/json content type Modified
      • payments property Added
2 structure changes including:
2 Modifications
Modified 2
POST /v1/borrowers/loans/transfer_ownership
  • Response
  • 207 response Modified
    • succeeded property Modified
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/transfer_ownership
  • Response
  • 200 response Modified
    • kordev_id property Added
10 structure changes including:
8 Additions
2 Modifications
Modified 2
POST /v1/borrowers/loans/reschedulings/create
  • Operation is now deprecated
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/reschedulings/{rescheduling_id}/create
  • Operation is now deprecated
Added 8
POST /v1/borrowers/loans/amount_modifications/cancel
POST /v1/borrowers/loans/amount_modifications/create
POST /v1/borrowers/loans/restructurings/cancel
POST /v1/borrowers/loans/restructurings/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/amount_modifications/{amount_modification_id}/cancel
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/amount_modifications/{amount_modification_id}/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/cancel
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/restructurings/{restructuring_id}/create
17 structure changes including:
2 Additions
15 Modifications
Modified 15 Breaking
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/cancel
  • Body
  • content type Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/allocate
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/cancel
  • Body
  • content type Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/undo_cancellation
  • Body
  • content type Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/reschedulings/{rescheduling_id}/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/cancel
  • Body
  • content type Modified
    • loan_cancellation property Modified
    • request_id property Added
  • Response
  • 200 response Modified
    • borrower_id, request_id properties Added
POST /v1/borrowers/payments/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Removed
  • 207 response Added
POST /v1/borrowers/loans/waivers/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Removed
  • 207 response Added
POST /v1/borrowers/loans/simulate
  • Response
  • 200 response Modified
    • failed property Modified
POST /v1/borrowers/loans/reschedulings/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Removed
  • 207 response Added
POST /v1/borrowers/loans/create
  • Body
  • content type Modified
    • occurred_on property Modified
    • request_id property Added
  • Response
  • 200 response Removed
  • 207 response Added
POST /v1/borrowers/loans/cancel
  • Body
  • content type Modified
    • occurred_on, loan_cancellation properties Modified
    • request_id property Added
  • Response
  • 200 response Removed
  • 207 response Added
Added 2
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/transfer_ownership
POST /v1/borrowers/loans/transfer_ownership
1 structure change including:
1 Modification
Modified 1
GET /v1/borrowers/loans/get_summary
  • Response
  • 200 response Modified
    • items property Modified
  • Query
  • paid_off_before, paid_off_after query parameters Added
2 structure changes including:
2 Additions
Added 2
POST /v1/borrowers/loans/reschedulings/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/reschedulings/{rescheduling_id}/create
1 structure change including:
1 Modification
Modified 1
GET /v1/borrowers/loans/get_summary
  • Query
  • min_immediate_payment_amount, max_immediate_payment_amount, max_next_payment_amount, max_imputed_late_payment query parameters Added
1 structure change including:
1 Addition
Added 1
POST /v1/borrowers/loans/waivers/create
1 structure change including:
1 Addition
Added 1
POST /v1/borrowers/loans/cancel
2 structure changes including:
1 Addition
1 Modification
Modified 1 Breaking
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/undo_cancellation
  • Response
  • 200 response Modified
    • undone_cancellation_id property Modified
Added 1
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/cancel
1 structure change including:
1 Addition
Added 1
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/cancel
2 structure changes including:
1 Addition
1 Modification
Modified 1
GET /v1/borrowers/loans/get_summary
  • Query
  • min_days_until_due_date query parameter Added
Added 1
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/undo_cancellation
1 structure change including:
1 Modification
Modified 1
GET /v1/borrowers/{borrower_id}/get_status
  • Response
  • 200 response Modified
    • loans property Modified
8 structure changes including:
8 Modifications
Modified 8 Breaking
GET /v1/borrowers/loans/get_summary
  • Response
  • 200 response Modified
    • items property Modified
GET /v1/borrowers/{borrower_id}/get_status
  • Response
  • 200 response Modified
    • loans property Modified
POST /v1/borrowers/loans/create
  • Response
  • 200 response Modified
    • succeeded property Modified
POST /v1/borrowers/payments/create
  • Response
  • 200 response Modified
    • succeeded property Modified
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/cancel
  • Response
  • 200 response Modified
    • kordev_id property Modified
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/create
  • Response
  • 200 response Modified
    • kordev_id property Modified
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create
  • Response
  • 200 response Modified
    • kordev_id property Modified
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/create
  • Response
  • 200 response Modified
    • kordev_id property Modified
11 structure changes including:
11 Additions
Added 11
GET /v1/borrowers/loans/get_summary
GET /v1/borrowers/{borrower_id}/get_status
GET /v1/loan_configurations/{loan_configuration_id}
POST /v1/borrowers/loans/create
POST /v1/borrowers/loans/simulate
POST /v1/borrowers/payments/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/cancel
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/create
POST /v1/borrowers/{borrower_id}/loans/{loan_id}/waivers/{waiver_id}/create
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/allocate
POST /v1/borrowers/{borrower_id}/payments/{payment_id}/create