---
title: "List receivable metrics"
method: GET
path: "/receivable-metrics"
tags: ["Receivables"]
---

# List receivable metrics

`GET /receivable-metrics`

## Request

- Base URL: `https://core.sivo.com`
- URL: `https://core.sivo.com/receivable-metrics`
- 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/receivable-metrics/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `limit` integer: Maximum number of results to return, from 1 to 100; defaults to 25
- `page` string: Opaque page token from a previous response's next_page or previous_page; pass it back unchanged, with the same sort and filters
- `expand` string[]: Extra fields to include in the page; total_count counts the matching results, exactly up to 10000
- `sort` 'created_at_desc': Result order; defaults to created_at_desc
- `debt_line_id` string: An object id with prefix

## Response `200`

Successful operation

- object: One page of a list
  - `data` object[], required
    - `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
  - `has_more` boolean, required: Whether more results follow this page in the list order
  - `next_page` string, nullable, required: Token for the page after this one, or null when this is the last page
  - `previous_page` string, nullable, required: Token for the page before this one, or null when this is the first page
  - `total_count` integer: Number of results matching the filters, exact up to 10000; 10001 means more than that. Only present when the request expands total_count

## Changes

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

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