--- title: "Get a debt line's principal against its limit, what it can still draw, its next payment and any overdue fees" method: GET path: "/debt-lines/{id}/position" tags: ["Debt Lines"] --- # Get a debt line's principal against its limit, what it can still draw, its next payment and any overdue fees `GET /debt-lines/{id}/position` ## Request - Base URL: `https://core.sivo.com` - URL: `https://core.sivo.com/debt-lines/{id}/position` - Auth: one of: - API key in header `Authorization` - OAuth 2 - Authorization code: `https://dashboard.sivo.com/oauth/authorize` - Client credentials - Token URL: `https://core.sivo.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `id` string, required: An object id with prefix ## Query parameters - `date` string, date: UTC date to compute the position for, the caller's today: it sets the next payment's due date and the days of interest projected until then; today by default ## Response `200` Successful operation - object: Money position of a debt line - `date` string, date, required: UTC date the position is computed for - `currency` string, required: currency of the debt line - `principal` integer, required: outstanding principal: settled plus the draws in flight, which count from the day they are made since they are expected to settle that day - `limit` object: what caps the principal; omitted when the terms have no current step - `amount` integer, required: the limit: the lower of max_principal and the greater of borrowing_base and collateral - `binding` 'max_principal' | 'borrowing_base' | 'collateral', required: which cap sets the limit: the facility size; the borrowing base when it is lower and at least the collateral; or the collateral when it is lower than the facility size and above the borrowing base - `max_principal` integer, required: facility size of the current terms step - `advance_rate` number: advance rate of the current terms step; omitted when the step has none, and so has no borrowing base - `eligible_balance` integer: outstanding balance of the eligible receivables pledged to Sivo, from the latest debt line metric (0 without one); omitted without an advance rate - `collateral` integer: settled collateral posted, which sets the limit instead of the borrowing base when it is greater; omitted without an advance rate - `borrowing_base` integer: eligible_balance × advance_rate; omitted without an advance rate - `metric_month` string: test month of the debt line metric eligible_balance comes from; omitted when there is none - `available_to_draw` integer, required: limit amount minus principal, floored at 0; whether a draw is allowed at all also depends on the terms status and the checks in /status - `deficit` integer, required: principal above the limit amount; 0 while within the limit - `interest_rate` number: effective annual interest rate of the current step: its margin, plus today's SOFR unless the rate is fixed; omitted without a current step - `daily_interest` integer: interest one day accrues on the principal (draws in flight included, as if settled) at interest_rate, rounded; a draw still in flight when the nightly accrual runs accrues nothing that day; omitted without a current step - `next_payment` object: omitted when the 1st will charge nothing: the line is not active and carries no principal or accrued interest - `due_on` string, date, required: date the payment is debited: the 1st of the following month - `amount` integer, required: what the 1st will debit: projected_interest + min_payment_top_up + past_due - credit_applied - `projected_interest` integer, required: this month's interest: accrued plus daily_interest for each day left to accrue, rounded - `min_payment_top_up` integer, required: what the step's minimum payment adds above projected_interest, charged on the 1st with the interest; 0 when the interest reaches the minimum - `past_due` integer, required: fees already owed from earlier charges, net of the debits in flight; 0 when nothing is owed - `credit_applied` integer, required: the part of the position's credit that pays this payment, up to the month's charge; any rest stays on the debt line for later payments; 0 when there is no credit - `accrued` integer, required: interest accrued so far this month, settled plus the accruals in flight, rounded - `accrued_through` string, date, required: the last day accrued covers - `overdue` object: omitted unless fees above the grace amount are past due - `amount` integer, required: fees owed net of the debits in flight: what is still to be paid - `due_on` string, date, required: date the overdue balance fell due: the day after the charge that took it above the grace amount - `days_late` integer, required: whole days from due_on to date - `credit` integer: credit the fees ledger holds (deposits above the fees charged, the debits in flight counted as paid), which pays the next payments down; next_payment's credit_applied is the part the 1st uses and the rest carries over; omitted when there is none ## Changes - **2026-11-03** `4bbab9699612`: 1 info - endpoint added [Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/debt-lines/:id/position/get.md) --- [API](https://skmtc.dev/sivo/apis/sivo-advance-api.md) - [All operations](https://skmtc.dev/sivo/apis/sivo-advance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sivo/apis/sivo-advance-api/revisions/4bbab9699612?raw)