August Health · Schema

com.august.api.integrations.models.billing_callback.v1.RecordDepositRequest

CompanyHealthcareElectronic Health RecordsSenior LivingElder CareeMARBillingWebhook

Properties

Name Type Description
bankAccountId string Bank account ID (future use - currently logged and ignored)
cashAccountCode string Cash account code for accounting. Required if the facility has cash accounts configured; must not be sent if no cash accounts are configured.
depositDate string
externalDepositId string Partner's unique identifier for this deposit
payments array Individual payments in this batch (max 500)
totalAmountCents integer Total deposit amount in cents
View JSON Schema on GitHub

JSON Schema

august-health-com-august-api-integrations-models-billing-callback-v1-record-deposit-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/august-health/json-schema/august-health-com-august-api-integrations-models-billing-callback-v1-record-deposit-request-schema.json",
  "title": "com.august.api.integrations.models.billing_callback.v1.RecordDepositRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/august-health-billing-v1-api-openapi.yml#/components/schemas/com.august.api.integrations.models.billing_callback.v1.RecordDepositRequest",
  "properties": {
    "bankAccountId": {
      "description": "Bank account ID (future use - currently logged and ignored)",
      "type": "string"
    },
    "cashAccountCode": {
      "description": "Cash account code for accounting. Required if the facility has cash accounts configured; must not be sent if no cash accounts are configured.",
      "type": "string"
    },
    "depositDate": {
      "format": "date",
      "type": "string"
    },
    "externalDepositId": {
      "description": "Partner's unique identifier for this deposit",
      "type": "string"
    },
    "payments": {
      "description": "Individual payments in this batch (max 500)",
      "items": {
        "$ref": "#/$defs/com.august.api.integrations.models.billing_callback.v1.ExternalPaymentItem",
        "description": "Individual payments in this batch (max 500)"
      },
      "type": "array"
    },
    "totalAmountCents": {
      "description": "Total deposit amount in cents",
      "format": "int32",
      "type": "integer"
    }
  },
  "required": [
    "externalDepositId",
    "depositDate",
    "totalAmountCents",
    "payments"
  ],
  "$defs": {
    "com.august.api.integrations.models.billing_callback.v1.ExternalPaymentItem": {
      "properties": {
        "amountCents": {
          "description": "Payment amount in cents. Sign depends on paymentType: positive for PAYMENT, negative for PAYMENT_RETURN/REFUND.",
          "format": "int32",
          "type": "integer"
        },
        "externalTransactionId": {
          "description": "Partner's unique identifier for this payment",
          "type": "string"
        },
        "linkedExternalTransactionId": {
          "description": "For PAYMENT_RETURN or REFUND types, the externalTransactionId of the original PAYMENT being reversed.",
          "type": "string"
        },
        "notes": {
          "description": "Optional notes or reason for the payment (e.g., return reason for PAYMENT_RETURN).",
          "type": "string"
        },
        "paymentDate": {
          "format": "date",
          "type": "string"
        },
        "paymentMethod": {
          "$ref": "#/$defs/com.august.api.integrations.models.billing_callback.v1.ExternalPaymentMethod",
          "description": "Payment method used (ACH, CASH, CHECK, CREDIT_CARD, DEBIT_CARD, WIRE)"
        },
        "paymentType": {
          "default": "PAYMENT",
          "enum": [
            "PAYMENT",
            "PAYMENT_RETURN",
            "REFUND"
          ],
          "type": "string"
        },
        "personId": {
          "description": "August person (resident) ID",
          "type": "string"
        }
      },
      "required": [
        "externalTransactionId",
        "personId",
        "amountCents",
        "paymentMethod",
        "paymentDate",
        "paymentType"
      ]
    },
    "com.august.api.integrations.models.billing_callback.v1.ExternalPaymentMethod": {
      "enum": [
        "ACH",
        "CASH",
        "CHECK",
        "CREDIT_CARD",
        "DEBIT_CARD",
        "WIRE"
      ],
      "type": "string"
    }
  }
}

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/august-health-com-august-api-integrations-models-billing-callback-v1-record-deposit-request"
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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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