---
title: "Get Credit Obligations"
method: GET
path: "/insights/v2/liabilities/credit-obligations"
tags: ["Liabilities"]
---

# Get Credit Obligations

`GET /insights/v2/liabilities/credit-obligations`

## Request

- Base URL: `https://sandbox.leantech.me`
- URL: `https://sandbox.leantech.me/insights/v2/liabilities/credit-obligations`
- Auth: HTTP bearer

The Credit Obligations API allows you to fetch a businesses debt obligations, including loan repayments, credit card usage, and balances. You can use this to understand a company's credit exposure, repayment behaviour, and overall financial health.

## Query parameters

- `entity_id` string, uuid, required
- `start_date` string, date, required
- `async` boolean

## Response `200`

OK

- object
  - `status` 'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED', required: The status of the request
  - `results_id` string, uuid, required: The unique identifier for the request
  - `message` string, required: A message describing the status of the request
  - `meta` object, nullable: Meta information about the request
  - `timestamp` string, date-time, required: The datetime of when the request was made
  - `status_detail` StatusDetail, nullable
    - `granular_status_code` string, nullable: Granular status code
    - `status_additional_info` string, nullable: Additional information about the status
  - `insights` CreditObligations
    - `current_credit_cards_balance` CurrentCreditCardsBalance, required
      - `amount` CurrencyAmount
        - `currency` string, required: The ISO 3 letter currency code
        - `amount` number, required: The amount of money in the currency specified.
    - `number_of_credit_cards` integer, nullable, required: Total number of credit cards
    - `total` CreditObligationsTotal, required
      - `loan_repayments` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `minimum_loan_repayment` CurrencyAmount
        - `currency` string, required: The ISO 3 letter currency code
        - `amount` number, required: The amount of money in the currency specified.
      - `maximum_loan_repayment` CurrencyAmount
        - `currency` string, required: The ISO 3 letter currency code
        - `amount` number, required: The amount of money in the currency specified.
      - `average_loan_repayment` CurrencyAmount
        - `currency` string, required: The ISO 3 letter currency code
        - `amount` number, required: The amount of money in the currency specified.
      - `last_loan_repayment_date_time` string, date-time, nullable: Date and time of the last loan repayment transaction
      - `loan_received` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `minimum_loan_received` CurrencyAmount
        - `currency` string, required: The ISO 3 letter currency code
        - `amount` number, required: The amount of money in the currency specified.
      - `maximum_loan_received` CurrencyAmount
        - `currency` string, required: The ISO 3 letter currency code
        - `amount` number, required: The amount of money in the currency specified.
      - `average_loan_received` CurrencyAmount
        - `currency` string, required: The ISO 3 letter currency code
        - `amount` number, required: The amount of money in the currency specified.
      - `last_loan_received_date_time` string, date-time, nullable: Date and time of the last loan received transaction
      - `credit_cards_repayments` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `credit_cards_spending` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `credit_cards_balance` BalanceInsights
        - `average_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `initial_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `current_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `available_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `frequency_of_contributions` 'MONTHLY' | 'WEEKLY' | 'DAILY': Frequency of contributions
    - `monthly_totals` CreditObligationsMonthlyTotal[], nullable, required
      - `month` integer: The month number (1-12)
      - `year` integer: The year
      - `is_month_complete` boolean: Indicates if the month has complete data
      - `loan_repayments` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `loan_received` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `credit_cards_repayments` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `credit_cards_spending` AmountCount
        - `amount` CurrencyAmount, required
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `count` integer, nullable: The total number of transactions
      - `credit_cards_balance` BalanceInsights
        - `average_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `initial_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `current_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `available_balance` CurrencyAmount
          - `currency` string, required: The ISO 3 letter currency code
          - `amount` number, required: The amount of money in the currency specified.
        - `frequency_of_contributions` 'MONTHLY' | 'WEEKLY' | 'DAILY': Frequency of contributions
  - `type` 'income' | 'employment' | 'cashflow' | 'credits-obligations' | 'non-credits-obligations' | 'expenses' | 'cash-balances' | 'freelancer-cashflow' | 'cashflow-patterns' | 'credit-assessments' | 'account-controls' | 'credit-obligations' | 'spending': type of insight

## Other responses

- `202`: Accepted
- `501`: Not Implemented

---

[API](https://skmtc.dev/leantech/apis/insights-api-account-controls.md) - [All operations](https://skmtc.dev/leantech/apis/insights-api-account-controls/llms.txt) - [OpenAPI document](https://skmtc.dev/leantech/apis/insights-api-account-controls/revisions/6a904c24f1e4?raw)