---
title: "List debt schedule configs"
method: GET
path: "/debtscheduleconfigs/{companyId}"
tags: ["DebtScheduleConfigs"]
---

# List debt schedule configs

`GET /debtscheduleconfigs/{companyId}`

Returns the debt schedule configurations of a company. Results are ordered by last modification time, most recent first, and paginated: use `limit` to control page size and pass the returned `nextPageToken` to fetch the next page. `startUpdatedAt` (inclusive) and `endUpdatedAt` (exclusive) filter by last modification time, which is useful for incremental synchronization.

## Path parameters

- `companyId` string, required

## Query parameters

- `startUpdatedAt` string, date-time — Only return configurations last modified on or after this timestamp (inclusive).
- `endUpdatedAt` string, date-time — Only return configurations last modified before this timestamp (exclusive).
- `limit` integer — Maximum number of objects to return in the response. Default 10, maximum 50.
- `nextPageToken` string — Token to fetch the next page of results, taken from the `nextPageToken` returned by the previous request with the same filters. Omit it to fetch the first page. An invalid or malformed token is rejected with `404`.

## Response `200`

Successful Response

- ListDebtScheduleConfigsResponseSchema
  - `data` GetDebtScheduleConfigResponseSchema[], required — Debt schedule configurations matching the query.
    - `id` string, required — Embat debt schedule configuration ID.
    - `companyId` string, required — Embat company ID. You can get them from "companies" endpoints.
    - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTC' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNH' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EEK' | 'EGP' | 'ERN' | 'ETB' | 'ETH' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTC' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UYW' | 'UZS' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWG' | 'ZWL', required
    - `bankId` string, required — Embat ID of the bank relationship this debt is held with. You can get them from "banks" endpoints.
    - `debtProductId` string, required — Embat ID of the debt product this schedule is configured over. You can get them from "products" endpoints.
    - `settlementProductId` string, required — Embat ID of the product used to pay this debt schedule (returned as `settlementProductId`). You can get them from "products" endpoints.
    - `config` DebtScheduleConfigSchema, required
      - `amortisingFrequency` 'monthly' | 'quarterly' | 'semiannually' | 'yearly', required
      - `outstandingBalance` number, required — Balance still pending repayment, in the debt schedule `currency`.
      - `grantedBalance` number, required — Original balance granted for this debt, in the debt schedule `currency`.
      - `totalPeriods` integer, required — Total number of payment periods in the schedule.
      - `nextPaymentDate` string, date-time, required — Due date of the next scheduled payment.
      - `lastPaymentDate` string, date-time, required — Due date of the last scheduled payment (maturity date).
      - `taxRate` number, nullable — Tax rate applied to payments, if any. `null` when no tax applies.
      - `annualInterestRateOrSpread` number, required — Annual interest rate for `fixed` debt, or the spread applied over the reference rate for `variable` debt (see `interestType`).
      - `interestType` 'fixed' | 'variable', required
    - `debtSchedulePaymentsCalendar` DebtSchedulePaymentSchema[], required — Full calendar of scheduled payments for this debt, one entry per period, with the principal, interest and tax breakdown.
      - `period` integer, required — Period number in the amortization schedule, starting at 1.
      - `date` string, date-time, required — Due date of this scheduled payment.
      - `principalPayment` number, required — Principal portion of the payment, in the debt schedule `currency`.
      - `interestPayment` number, required — Interest portion of the payment, in the debt schedule `currency`.
      - `taxPayment` number, required — Tax portion of the payment, in the debt schedule `currency`. `0` when no tax applies.
      - `totalPayment` number, required — Total amount due for this period, in the debt schedule `currency` (`principalPayment` + `interestPayment` + `taxPayment`).
  - `nextPageToken` string, nullable — Token to fetch the next page of results. `null` when there are no more pages.

## Other responses

- `401` — Unauthorized. The bearer token is missing, invalid or expired.
- `404` — Company not found, or invalid `nextPageToken`.
- `422` — Validation Error

---

[API](https://skmtc.net/embat/apis/embat-api.md) · [All operations](https://skmtc.net/embat/apis/embat-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/embat/embat-api/revisions/36ca48bf4489/schema)