Collectly · Schema

Payment

CompanyHealth TechRevenue Cycle ManagementPatient PaymentsMedical BillingPaymentsHealthcareInsurance Eligibility

Properties

Name Type Description
allocations array
amount numbernull
collectly_id string Unique Collectly resource ID
collectly_payment_plan_id string Collectly payment plan ID. It is NOT null in case the payment was charged as a part of the payment plan
collectly_source_payment_id string Collectly source payment ID. Used only for refunds.
copay_amount number
created_at object
id string Unique resource ID from your integration
modified_at object
patient_id string Patient ID from your integration who owns the resource
payment_type string
post_date stringnull
status string
transaction_id stringnull
View JSON Schema on GitHub

JSON Schema

collectly-payment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/collectly/json-schema/collectly-payment-schema.json",
  "title": "Payment",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/collectly-payments-api-openapi.yml#/components/schemas/Payment",
  "properties": {
    "allocations": {
      "items": {
        "$ref": "#/$defs/Allocation"
      },
      "type": "array"
    },
    "amount": {
      "type": [
        "number",
        "null"
      ]
    },
    "collectly_id": {
      "description": "Unique Collectly resource ID",
      "readOnly": true,
      "type": "string"
    },
    "collectly_payment_plan_id": {
      "description": "Collectly payment plan ID. It is NOT null in case the payment was charged as a part of the payment plan",
      "type": "string"
    },
    "collectly_source_payment_id": {
      "description": "Collectly source payment ID. Used only for refunds.",
      "type": "string"
    },
    "copay_amount": {
      "type": "number"
    },
    "created_at": {
      "readOnly": true
    },
    "id": {
      "description": "Unique resource ID from your integration",
      "type": "string"
    },
    "modified_at": {
      "readOnly": true
    },
    "patient_id": {
      "description": "Patient ID from your integration who owns the resource",
      "type": "string"
    },
    "payment_type": {
      "enum": [
        "payment",
        "copay",
        "refund",
        "part_ref",
        "autodeb",
        "collect"
      ],
      "type": "string"
    },
    "post_date": {
      "format": "date",
      "type": [
        "string",
        "null"
      ]
    },
    "status": {
      "readOnly": true,
      "type": "string"
    },
    "transaction_id": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "id",
    "patient_id"
  ],
  "type": "object",
  "$defs": {
    "Allocation": {
      "properties": {
        "amount": {
          "type": "number"
        },
        "charge_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "readOnly": true,
          "type": "string"
        },
        "visit_id": {}
      },
      "required": [
        "amount"
      ],
      "type": "object"
    }
  }
}

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/collectly-payment"
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.