API Reference›LMS API›Charges›List charge definitions

List charge definitions

GEThttps://sandbox.api.lendeasy.ai/v1/charges Bearer token · READ_LMS_CHARGE

Returns loan charge definitions with their LendEasy classification. Definitions without a classification are reported as configurationStatus MISSING and cannot be attached to products or loans.

Request

curl https://sandbox.api.lendeasy.ai/v1/charges \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/charges`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/charges",
  headers={"Authorization": f"Bearer {token}"},
)

[
  {
    "id": 21,
    "name": "Late fee",
    "active": true,
    "penalty": true,
    "currency": {
      "code": "USD"
    },
    "amount": 18,
    "chargeTimeType": {
      "id": 9,
      "value": "Overdue Installment Fee"
    },
    "chargeCalculationType": {
      "id": 1,
      "value": "Flat"
    },
    "lmsConfig": {
      "financeChargeFlag": "EXCLUDED",
      "legalBasis": "CA Fin. Code §22307"
    },
    "configurationStatus": "CONFIGURED"
  }
]

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}

Path & query parameters

Field	Type	Description
LendEasy-Tenant required in header	string	Tenant selector: lowercase letters, digits, and hyphens, 1-64 characters. Exactly one instance; the only tenant selector honored.

Request

curl https://sandbox.api.lendeasy.ai/v1/charges \
  -H "Authorization: Bearer $TOKEN"

await fetch(`https://sandbox.api.lendeasy.ai/v1/charges`, {
  method: "GET",
  headers: { Authorization: `Bearer ${token}` },
});

requests.get(
  f"https://sandbox.api.lendeasy.ai/v1/charges",
  headers={"Authorization": f"Bearer {token}"},
)

[
  {
    "id": 21,
    "name": "Late fee",
    "active": true,
    "penalty": true,
    "currency": {
      "code": "USD"
    },
    "amount": 18,
    "chargeTimeType": {
      "id": 9,
      "value": "Overdue Installment Fee"
    },
    "chargeCalculationType": {
      "id": 1,
      "value": "Flat"
    },
    "lmsConfig": {
      "financeChargeFlag": "EXCLUDED",
      "legalBasis": "CA Fin. Code §22307"
    },
    "configurationStatus": "CONFIGURED"
  }
]

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "400",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "validation.msg.validation.errors.exist",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "401",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authenticated",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "403",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.not.authorized",
  "errors": []
}

{
  "developerMessage": "Request was understood but rejected; inspect errors for field-level causes.",
  "httpStatusCode": "404",
  "defaultUserMessage": "The request could not be applied.",
  "userMessageGlobalisationCode": "error.msg.resource.not.found",
  "errors": []
}