---
title: "Retrieve paginated general ledger data"
method: GET
path: "/v1/general-ledger-data"
tags: ["General Ledger"]
---

# Retrieve paginated general ledger data

`GET /v1/general-ledger-data`

## Request

- Base URL: `http://<host-url>`
- URL: `http://<host-url>/v1/general-ledger-data`
- Auth: HTTP bearer

The event_type filter accepts AUTHORIZATION, SETTLEMENT, REVERSAL, CANCELLATION, FORCE_CAPTURE, or REFUND. Sort by transaction_id, event_id, transaction_reference, event_type, transaction_type_id, or occurred_at.

## Query parameters

- `transaction_id` integer
- `event_id` string, uuid
- `schema_version` integer
- `transaction_reference` string
- `transaction_identifier` string
- `parent_transaction_id` integer
- `event_type` 'AUTHORIZATION' | 'SETTLEMENT' | 'REVERSAL' | 'CANCELLATION' | 'FORCE_CAPTURE' | 'REFUND'
- `transaction_type_id` integer
- `amount` number
- `currency` string
- `transaction_date_time_from` string, date-time
- `transaction_date_time_to` string, date-time
- `occurred_at_from` string, date-time: Inclusive ISO-8601 start instant converted to tenant-local time before filtering
- `occurred_at_to` string, date-time: Inclusive ISO-8601 end instant converted to tenant-local time before filtering
- `page_number` integer, required
- `page_size` integer, required
- `sort_by` 'transaction_id' | 'event_id' | 'transaction_reference' | 'event_type' | 'transaction_type_id' | 'occurred_at', required
- `sort_direction` 'ASC' | 'DESC', required

## Headers

- `unique-request-id` string

## Response `200`

General ledger data retrieved successfully

- GeneralLedgerDataPageResponse
  - `general_ledger_data` GeneralLedgerDataItem[]
    - `amount` number
    - `currency` string
    - `event_id` string, uuid
    - `event_type` string
    - `id` integer
    - `occurred_at` string, date-time
    - `parent_transaction_id` integer
    - `schema_version` integer
    - `transaction_date_time` string, date-time
    - `transaction_id` integer
    - `transaction_identifier` string
    - `transaction_reference` string
    - `transaction_type_id` integer
  - `page_number` integer
  - `response_status` StatusDto
    - `status_code` string
    - `status_message` string
    - `error_message` string: Details of the error, when applicable.
  - `total_pages` integer
  - `total_results` integer

## Other responses

- `400`: Invalid query parameters
- `500`: Server Error

---

[API](https://skmtc.dev/paymentology/apis/paycredit-api.md) - [All operations](https://skmtc.dev/paymentology/apis/paycredit-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/paycredit-api/revisions/cc56df9c933b?raw)