Sign in
loans

Get Loan By Id

Changed on
get/api/loans/{loan_id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

loan_idinteger required

Headers

authorizationstring nullable

Cookies

session_idstring nullable

Response

Successful Response

idinteger required
status'scheduled' | 'active' | 'returned' required

Represents the status of a loan.

start_datestring date-time required
end_datestring date-time required
total_deposit_centsinteger required
actual_start_datestring date-time nullable
actual_return_datestring date-time nullable
retained_deposit_centsinteger nullable
request_idinteger nullable
commentsstring nullable

Changes

  • 866bb7869de2Revision changes
    • info

      removed the unauthenticated enum value from the / response property for the response status

    • info

      removed the unauthenticated enum value from the / response property for the response status

    • info

      added the required property to the response with the status

  • a76b64885b38Revision changes
    • warning

      for the path request parameter loan_id, the min was set to 1.00

    • info

      added the new optional header request parameter authorization

    • info

      added the optional property // to the response with the status