Canopy · Schema

GetAdvanceResponse

Response schema for a single advance.

CompanyB2BLoan ManagementFintechAPI Platform

Properties

Name Type Description
account_id string The unique identifier of the account.
advance_id string The unique identifier of the advance.
effective_at string The date at which the advance became effective.
balances object The breakdown of balances on the advance.
currency string The currency of the advance.
repayment_pace number The pace of repayment for the advance.
status object The status of the advance.
term object Term information for the advance.
maturity_at string The maturity date (last payment due date) of the advance.
factor_rate number Ratio of the total repayment amount to the advance amount.
View JSON Schema on GitHub

JSON Schema

canopyservicing-com-get-advance-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/canopyservicing-com/json-schema/canopyservicing-com-get-advance-response-schema.json",
  "title": "GetAdvanceResponse",
  "description": "Response schema for a single advance.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/canopyservicing-com-advances-api-openapi.yml#/components/schemas/GetAdvanceResponse",
  "properties": {
    "account_id": {
      "type": "string",
      "title": "Account Id",
      "description": "The unique identifier of the account.",
      "hidden": false
    },
    "advance_id": {
      "type": "string",
      "title": "Advance Id",
      "description": "The unique identifier of the advance.",
      "hidden": false
    },
    "effective_at": {
      "type": "string",
      "title": "Effective At",
      "description": "The date at which the advance became effective.",
      "hidden": false
    },
    "balances": {
      "$ref": "#/$defs/AdvanceBalanceBreakdown",
      "description": "The breakdown of balances on the advance.",
      "hidden": false
    },
    "currency": {
      "type": "string",
      "title": "Currency",
      "description": "The currency of the advance.",
      "hidden": false
    },
    "repayment_pace": {
      "type": "number",
      "title": "Repayment Pace",
      "description": "The pace of repayment for the advance.",
      "hidden": false
    },
    "status": {
      "$ref": "#/$defs/AdvanceStatusType",
      "description": "The status of the advance.",
      "hidden": false
    },
    "term": {
      "$ref": "#/$defs/AdvanceTerm",
      "description": "Term information for the advance.",
      "hidden": false
    },
    "maturity_at": {
      "type": "string",
      "title": "Maturity At",
      "description": "The maturity date (last payment due date) of the advance.",
      "hidden": false
    },
    "factor_rate": {
      "type": "number",
      "title": "Factor Rate",
      "description": "Ratio of the total repayment amount to the advance amount.",
      "hidden": false
    }
  },
  "type": "object",
  "required": [
    "account_id",
    "advance_id",
    "effective_at",
    "balances",
    "currency",
    "repayment_pace",
    "status",
    "term",
    "maturity_at",
    "factor_rate"
  ],
  "$defs": {
    "AdvanceBalance": {
      "properties": {
        "original_amount_cents": {
          "type": "integer",
          "title": "Original Amount Cents",
          "description": "Original amount in cents.",
          "hidden": false
        },
        "balance_cents": {
          "type": "integer",
          "title": "Balance Cents",
          "description": "Current balance in cents.",
          "hidden": false
        },
        "due_to_date_cents": {
          "type": "integer",
          "title": "Due To Date Cents",
          "description": "Amount due to date in cents.",
          "hidden": false
        }
      },
      "type": "object",
      "required": [
        "original_amount_cents",
        "balance_cents",
        "due_to_date_cents"
      ],
      "title": "AdvanceBalance"
    },
    "AdvanceBalanceBreakdown": {
      "properties": {
        "repayment": {
          "$ref": "#/$defs/AdvanceBalance",
          "description": "Original and remaining repayment balances.",
          "hidden": false
        },
        "advance": {
          "$ref": "#/$defs/AdvanceBalance",
          "description": "Original and remaining advance balances.",
          "hidden": false
        },
        "fee": {
          "$ref": "#/$defs/AdvanceBalance",
          "description": "Original and remaining fee balances.",
          "hidden": false
        }
      },
      "type": "object",
      "required": [
        "repayment",
        "advance",
        "fee"
      ],
      "title": "AdvanceBalanceBreakdown",
      "description": "Breakdown of the advance balance."
    },
    "AdvanceStatusType": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "PAID_OFF"
      ],
      "title": "AdvanceStatusType"
    },
    "AdvanceTerm": {
      "properties": {
        "cycles": {
          "type": "integer",
          "title": "Cycles",
          "description": "The number of payment cycles for the advance.",
          "hidden": false
        },
        "cycle_length": {
          "type": "string",
          "title": "Cycle Length",
          "description": "The length of each cycle.",
          "hidden": false
        }
      },
      "type": "object",
      "required": [
        "cycles",
        "cycle_length"
      ],
      "title": "AdvanceTerm",
      "description": "Term information for an advance."
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/canopyservicing-com-get-advance-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.