---
title: "Get the metrics for a receivable"
method: GET
path: "/receivables/{id}/metric"
tags: ["Receivables"]
---

# Get the metrics for a receivable

`GET /receivables/{id}/metric`

## Request

- Base URL: `https://core.sivo.com`
- URL: `https://core.sivo.com/receivables/{id}/metric`
- 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: <https://skmtc.dev/sivo/apis/sivo-advance-api/docs/receivables/:id/metric/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `id` string, required: An object ID assigned and owned by the originator

## Response `200`

Successful operation

- object
  - `id` string, required: Receivable ID
  - `created_at` string, date-time, required: When the metric row was created
  - `updated_at` string, date-time, required: When the metric row was last updated
  - `outdated_at` string, date-time, required: When the metric row was last marked as needing recalculation
  - `debt_line_id` string, nullable: The most recent active debt line for the originator
  - `loan_apr` number, nullable: APR calculated from the receivable properties (fees, interest rate, and term)
  - `xirr_apr` number, nullable: APR calculated from the full receivable cash flows using XIRR
  - `simple_apr` number, nullable: APR calculated from the net receivable cash flows without compounding
  - `apr` number, nullable: Effective APR chosen between xirr_apr and simple_apr, capped by loan_apr
  - `is_eligible` object, nullable: Map of eligibility criteria to whether the receivable satisfies each one
    - `obligor_type` boolean
    - `country` boolean
    - `currency` boolean
    - `product_type` boolean
    - `term_length` boolean
    - `credit_limit` boolean
    - `max_balance` boolean
    - `apr` boolean
    - `review` boolean
  - `balance` integer, nullable: Latest reported balance of the receivable, floored at 0 (a negative balance holds no value) and 0 once it defaults
  - `default_balance` integer, nullable: Balance at the time the receivable went into default
  - `disbursed` integer, nullable: Total amount disbursed to the obligor
  - `closed_on` string, date, nullable: Date on which the receivable was reported closed
  - `status` 'active' | 'closed' | 'null', nullable: Latest reported status of the receivable
  - `repayment_days` integer, nullable: Days from the first disbursement (or origination) to collection in full; empty while the receivable is outstanding

## Changes

- **2026-11-03** `4bbab9699612`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sivo/apis/sivo-advance-api/changes/receivables/:id/metric/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)