---
title: "GET /billing/{tenantLocator}/credits/list"
method: GET
path: "/billing/{tenantLocator}/credits/list"
---

# GET /billing/{tenantLocator}/credits/list

`GET /billing/{tenantLocator}/credits/list`

## Request

- Base URL: `https://docs.socotra.com`
- URL: `https://docs.socotra.com/billing/{tenantLocator}/credits/list`
- Auth: none declared
- TypeScript: <https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/docs/billing/:tenantLocator/credits/list/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

- `accountLocator` string, ulid
- `offset` integer
- `count` integer

## Response `200`

OK

- CreditListResponse
  - `listCompleted` boolean, required
  - `items` CreditResponse[], required
    - `locator` string, ulid, required
    - `creditState` 'discarded' | 'draft' | 'posted' | 'reversed' | 'validated' | 'executed' | 'distributed' | 'approved' | 'rejected' | 'requested' | 'executing' | 'failed' | 'cancelled', required
    - `creditType` 'creditDistribution' | 'disbursement' | 'payment' | 'subpayment' | 'shortfallWriteOff' | 'writeOff', required
    - `currency` string, required
    - `amount` number, required
    - `createdAt` string, date-time, required
    - `accountLocator` string, ulid
    - `realizedAt` string, date-time
    - `reversedAt` string, date-time
    - `reversalReason` string

---

[API](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi.md) - [All operations](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/llms.txt) - [OpenAPI document](https://skmtc.dev/socotra/apis/socotra-insurance-suite-openapi/revisions/6537d24b3693?raw)
