LEleantech
Liabilities

Get Credit Obligations

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.

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

Query parameters

entity_idstring uuid required

The entity_id you're querying for.

start_datestring date required

The start date in UTC (in the format YYYY-MM-DD) you want to query credit obligations for.

asyncboolean

When true the API will return a results_id which can be fetched from the /data/v2/results endpoint when ready. Note: it''s recommended to use the sync flow (async=false) for all requests by adapting the data workflow for connected entities.

Response

OK

status'OK' | 'PENDING' | 'FAILED' | 'CONSENT_EXPIRED' | 'RECONNECT_REQUIRED' | 'PROCESSING_STARTED' required

The status of the request

results_idstring uuid required

The unique identifier for the request

messagestring required

A message describing the status of the request

metaobject nullable

Meta information about the request

timestampstring date-time required

The datetime of when the request was made

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

Example response

{
  "insights": {
    "current_credit_cards_balance": {
      "amount": {
        "currency": "AED"
      }
    },
    "total": {
      "loan_repayments": {
        "amount": {
          "currency": "AED"
        }
      },
      "minimum_loan_repayment": {
        "currency": "AED"
      },
      "maximum_loan_repayment": {
        "currency": "AED"
      },
      "average_loan_repayment": {
        "currency": "AED"
      },
      "loan_received": {
        "amount": {
          "currency": "AED"
        }
      },
      "minimum_loan_received": {
        "currency": "AED"
      },
      "maximum_loan_received": {
        "currency": "AED"
      },
      "average_loan_received": {
        "currency": "AED"
      },
      "credit_cards_repayments": {
        "amount": {
          "currency": "AED"
        }
      },
      "credit_cards_spending": {
        "amount": {
          "currency": "AED"
        }
      },
      "credit_cards_balance": {
        "average_balance": {
          "currency": "AED"
        },
        "initial_balance": {
          "currency": "AED"
        },
        "current_balance": {
          "currency": "AED"
        },
        "available_balance": {
          "currency": "AED"
        }
      }
    },
    "monthly_totals": [
      {
        "loan_repayments": {
          "amount": {
            "currency": "AED"
          }
        },
        "loan_received": {
          "amount": {
            "currency": "AED"
          }
        },
        "credit_cards_repayments": {
          "amount": {
            "currency": "AED"
          }
        },
        "credit_cards_spending": {
          "amount": {
            "currency": "AED"
          }
        },
        "credit_cards_balance": {
          "average_balance": {
            "currency": "AED"
          },
          "initial_balance": {
            "currency": "AED"
          },
          "current_balance": {
            "currency": "AED"
          },
          "available_balance": {
            "currency": "AED"
          }
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.