LEleantech
Liabilities

Get Non-Credit Obligations

The Non Credit Obligations API allows you to fetch a recurring personal obligations, including labor wage, monthly external and domestic remittances.

get/insights/v2/liabilities/non-credit-obligations

Request

  • Base URL
    https://sandbox.leantech.me
  • URL
    https://sandbox.leantech.me/insights/v2/liabilities/non-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 non-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

Changes

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