Skip to main content
GET
/
loans
/
{loan_id}
/
journal-entries
Paginated journal history for a loan
curl --request GET \
  --url https://ledger.clarivo.co/v1/loans/{loan_id}/journal-entries \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "effective_at": "2023-12-25",
      "posted_at": "2023-11-07T05:31:56Z",
      "lines": [
        {
          "sequence": 16384,
          "account_code": "<string>",
          "amount_minor": "<string>",
          "currency": "<string>",
          "layer": "SETTLED",
          "loan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "borrower_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_ref": "<string>"
        }
      ],
      "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reverses_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "actor": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

​
Authorization
string
header
required

OAuth2 JWT bearer tokens. Tokens are validated at API Gateway via a Lambda Authorizer that verifies signature against the issuer's JWKS, checks iss, aud, exp, nbf, and the tenant_id custom claim. Granular scopes are required per operation.

Path Parameters

​
loan_id
string<uuid>
required
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"11111111-1111-1111-1111-111111111111"

Query Parameters

​
from_date
string<date>
​
to_date
string<date>
​
event_type
enum<string>
Available options:
disbursement,
disbursement_settled,
accrual,
payment_received,
payment_allocated,
payment_returned,
fee_assessed,
fee_waived,
chargeoff,
recovery,
refinance,
restructure,
reversal,
manual_adjustment
​
page_size
integer
default:50
Required range: 1 <= x <= 500
​
page_token
string
Maximum string length: 512

Response

200 - application/json

Page of journal entries

​
items
object[]
required
​
next_page_token
string

Opaque cursor. Absent when no more pages.