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

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

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

## Request

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

## Path parameters

- `tenantLocator` string, uuid, required

## Query parameters

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

## Response `200`

OK

- ShortfallCreditListResponse
  - `listCompleted` boolean, required
  - `items` ShortfallCreditResponse[], required
    - `locator` string, ulid, required
    - `creditType` 'creditDistribution' | 'disbursement' | 'payment' | 'subpayment' | 'shortfallWriteOff' | 'writeOff', required
    - `shortfallCreditState` 'draft' | 'distributed' | 'reversed', required
    - `currency` string, required
    - `amount` number, required
    - `createdAt` string, date-time, required
    - `createdBy` string, uuid, required
    - `accountLocator` string, ulid, required
    - `targets` CreditItem[], required
      - `containerLocator` string, ulid, required
      - `containerType` 'invoice' | 'account' | 'subpayment' | 'invoiceItem', required
      - `amount` number
    - `parentCreditLocator` string, ulid, required
    - `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)