August Health Billing (v1) API

The Billing (v1) API from August Health — 7 operation(s) for billing (v1).

Operations 7

POST /v1/organizations/{orgId}/facilities/{facilityId}/billing/charges Record one-time charges #
POST /v1/organizations/{orgId}/facilities/{facilityId}/billing/deposits Record deposit #
GET /v1/organizations/{orgId}/facilities/{facilityId}/billing/summaries List facility billing summaries #
GET /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/statements Search statements #
GET /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/statements/{statementId}.pdf Get statement PDF #
GET /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/summary Get resident billing summary #
GET /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/transactions List resident billing transactions #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API
curl "https://apis.io/api/v1/apis/august-health:august-health-billing-v1-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

OpenAPI Specification

august-health-billing-v1-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: August Health Integrations Billing (v1) API
  version: '1.0'
servers:
- url: https://integrations.staging.augusthealth.com
security:
- BearerAuth: []
tags:
- name: Billing (v1)
paths:
  /v1/organizations/{orgId}/facilities/{facilityId}/billing/charges:
    post:
      description: 'Submit a batch of one-time charges/credits for residents in a facility.


        Each charge lands as a pending ledger entry on the resident''s transaction log.'
      operationId: recordChargesV1
      parameters:
      - description: August organization ID
        in: path
        name: orgId
        required: true
        schema:
          type: string
      - description: August facility ID
        in: path
        name: facilityId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.august.api.integrations.models.billing_charges.v1.RecordChargesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.billing_charges.v1.RecordChargesResponse'
                type: object
          description: All charges already existed (idempotent response)
        '201':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.billing_charges.v1.RecordChargesResponse'
                type: object
          description: At least one charge was created
        '400':
          description: Invalid request data
        '401':
          description: Invalid or missing credentials
        '403':
          description: Insufficient permissions
      summary: Record one-time charges
      tags:
      - Billing (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/billing/deposits:
    post:
      description: 'Integration partners submit collected payments as a consolidated deposit.


        **Authentication**: Bearer token (JWT) required with `BILLING_PAYMENTS_CREATE` permission.


        **Idempotency**: If the same `externalDepositId` is resubmitted,

        returns the existing deposit without creating duplicates.

        The retry must contain the exact same set of payments (by `externalTransactionId`);

        mismatched payments return a `400` error.


        **Atomicity**: All payments in the batch succeed or none do.

        If any `personId` is invalid, the entire batch is rejected.


        **Payment Types**:

        - `PAYMENT`: Standard payment (amount must be positive)

        - `PAYMENT_RETURN`: Returned payment, e.g., NSF (amount must be negative)

        - `REFUND`: Refunded payment (amount must be negative)


        If `paymentType` is omitted, it defaults to `PAYMENT`.


        **Cash Account Code**:

        The `cashAccountCode` field controls which GL cash account is assigned to the deposit

        for accounting export purposes.

        - If the facility has GL cash accounts configured: `cashAccountCode` is **required** and must match a configured code.

        - If no GL cash accounts are configured: `cashAccountCode` **must not** be sent.'
      operationId: recordDepositV1
      parameters:
      - description: August organization ID
        in: path
        name: orgId
        required: true
        schema:
          format: int64
          type: integer
      - description: August facility ID
        in: path
        name: facilityId
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/com.august.api.integrations.models.billing_callback.v1.RecordDepositRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.billing_callback.v1.RecordDepositResponse'
                type: object
          description: Deposit already exists (idempotent response)
        '201':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.billing_callback.v1.RecordDepositResponse'
                type: object
          description: Deposit created successfully
        '400':
          description: Invalid request data (invalid personId, batch too large, invalid amount sign, etc.)
        '401':
          description: Invalid or missing credentials
        '403':
          description: Insufficient permissions
      summary: Record deposit
      tags:
      - Billing (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/billing/summaries:
    get:
      description: 'Retrieve paginated billing summaries for all residents in a facility including:

        - Resident identification and status

        - Physical and financial move-in/move-out dates

        - Latest issued statement details

        - Current balance

        - Payer contacts (contacts marked as "Payment of Care")


        Results can be filtered by resident status using the `residentStatus` query parameter.'
      operationId: listFacilityBillingSummariesV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - description: Maximum number of results to return
        in: query
        name: limit
        required: false
        schema:
          default: 100
          format: int32
          type: integer
      - description: Number of results to skip
        in: query
        name: offset
        required: false
        schema:
          default: 0
          format: int32
          type: integer
      - description: Filter by resident status. Defaults to RESIDENT_STATUS_CURRENT_RESIDENT.
        in: query
        name: residentStatus
        required: true
        schema:
          $ref: '#/components/schemas/com.august.protos.person.ResidentStatus'
          default: RESIDENT_STATUS_CURRENT_RESIDENT
          enum:
          - RESIDENT_STATUS_CURRENT_RESIDENT
          - RESIDENT_STATUS_PROSPECT
          - RESIDENT_STATUS_DISCHARGED
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.billing_summary.v1.ExternalBillingSummary'
                    type: array
                  meta:
                    $ref: '#/components/schemas/com.august.api.integrations.models.common.ApiResponseMetadata'
                type: object
          description: Billing summaries retrieved successfully
        '401':
          description: No credentials provided
        '403':
          description: Not Authorized for this resource
      summary: List facility billing summaries
      tags:
      - Billing (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/statements:
    get:
      description: 'Search for issued private pay statements by billing period.

        Provide either `billingPeriod` (YYYY-MM) or both `startDate` and `endDate`, but not both.'
      operationId: searchStatementsV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: path
        name: personId
        required: true
        schema:
          type: string
      - description: Start of the date range (inclusive) to filter by billing period (YYYY-MM-DD). Required if `billingPeriod` is not provided.
        in: query
        name: startDate
        required: false
        schema:
          example: '2020-01-01'
          format: date
          type: string
      - description: End of the date range (inclusive) to filter by billing period (YYYY-MM-DD). Required if `billingPeriod` is not provided.
        in: query
        name: endDate
        required: false
        schema:
          example: '2020-01-01'
          format: date
          type: string
      - description: Monthly billing period in YYYY-MM format (e.g. 2025-01). Alternative to startDate/endDate.
        in: query
        name: billingPeriod
        required: false
        schema:
          example: 2025-01
          pattern: ^\d{4}-\d{2}$
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.statements.v1.StatementSearchResult'
                    type: array
                type: object
          description: List of statements within the date range
        '400':
          description: Invalid parameters (e.g. startDate is after endDate, both billingPeriod and date range provided, or neither provided)
        '403':
          description: Not Authorized for this resource
      summary: Search statements
      tags:
      - Billing (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/statements/{statementId}.pdf:
    get:
      description: Retrieve an issued statement PDF for a resident.
      operationId: getStatementPdfV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: path
        name: personId
        required: true
        schema:
          type: string
      - description: The statement ID (e.g., 123)
        in: path
        name: statementId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/pdf:
              schema:
                format: binary
                type: string
          description: Statement PDF
        '403':
          description: Not Authorized for this resource
        '404':
          description: Statement not found or doesn't belong to personId
      summary: Get statement PDF
      tags:
      - Billing (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/summary:
    get:
      description: 'Retrieve billing summary for a single resident including:

        - Resident identification and status

        - Physical and financial move-in/move-out dates

        - Latest issued statement details

        - Current balance

        - Payer contacts (contacts marked as "Payment of Care")'
      operationId: getBillingSummaryV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: path
        name: personId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/com.august.api.integrations.models.billing_summary.v1.ExternalBillingSummary'
                  meta:
                    $ref: '#/components/schemas/com.august.api.integrations.models.common.ApiResponseMetadata'
                type: object
          description: Billing summary retrieved successfully
        '401':
          description: No credentials provided
        '403':
          description: Not Authorized for this resource
        '404':
          description: Resource not found
      summary: Get resident billing summary
      tags:
      - Billing (v1)
  /v1/organizations/{orgId}/facilities/{facilityId}/people/{personId}/billing/transactions:
    get:
      description: 'Retrieve paginated billing transactions (payments and charges) for a resident.

        Includes both active and deleted transactions.


        Use the `updatedAfter` parameter to pull only transactions that have been

        created or modified since your last query.


        Each transaction has an `idType` of either `PAYMENT` or `BILLING_CHARGE`.

        Payment-specific fields (`paymentMethod`, `paymentSource`, `merchantFeeCents`)

        are null for charges. Charge-specific fields (`invoiceId`, `feeName`, `rateCents`,

        `quantity`, `taxCents`, `medicaidProgramShortName`) are null for payments.'
      operationId: listResidentBillingTransactionsV1
      parameters:
      - in: path
        name: orgId
        required: true
        schema:
          type: string
      - in: path
        name: facilityId
        required: true
        schema:
          type: string
      - in: path
        name: personId
        required: true
        schema:
          type: string
      - description: Maximum number of results to return (default 100, max 5000)
        in: query
        name: limit
        required: false
        schema:
          default: 100
          format: int32
          maximum: 5000
          minimum: 1
          type: integer
      - description: Number of results to skip
        in: query
        name: offset
        required: false
        schema:
          default: 0
          format: int32
          minimum: 0
          type: integer
      - description: Only return transactions updated after this timestamp (ISO 8601)
        in: query
        name: updatedAfter
        required: false
        schema:
          format: date-time
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/com.august.api.integrations.models.billing_transactions.v1.ExternalBillingTransaction'
                    type: array
                  meta:
                    $ref: '#/components/schemas/com.august.api.integrations.models.common.ApiResponseMetadata'
                type: object
          description: Billing transactions retrieved successfully
        '401':
          description: No credentials provided
        '403':
          description: Not Authorized for this resource
        '404':
          description: Resource not found
      summary: List resident billing transactions
      tags:
      - Billing (v1)
components:
  schemas:
    com.august.api.integrations.models.common.ApiResponseMetadata:
      properties:
        limit:
          description: The limit used for a paginated request for the query
          format: int32
          type: integer
        offset:
          description: The offset used for a paginated request for the query
          format: int32
          type: integer
        total:
          description: The total number of available items for the query
          format: int32
          type: integer
      required:
      - total
      - limit
      - offset
    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:
          example: '2020-01-01'
          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: '#/components/schemas/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
    com.august.api.integrations.models.billing_summary.v1.ExternalBillingSummary:
      properties:
        contacts:
          description: Contacts who are payers or responsible parties
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.billing_summary.v1.ExternalContact'
            description: Contacts who are payers or responsible parties
          type: array
        currentBalanceCents:
          description: Total current balance in cents
          format: int32
          type: integer
        financialMoveInDate:
          example: '2020-01-01'
          format: date
          type: string
        financialMoveOutDate:
          example: '2020-01-01'
          format: date
          type: string
        firstName:
          description: Resident's first name (first given name)
          type: string
        lastName:
          description: Resident's last name (family name)
          type: string
        latestStatement:
          $ref: '#/components/schemas/com.august.api.integrations.models.billing_summary.v1.LatestStatement'
          description: Most recent issued statement details (null if no statements)
        physicalMoveInDate:
          example: '2020-01-01'
          format: date
          type: string
        physicalMoveOutDate:
          example: '2020-01-01'
          format: date
          type: string
        residentId:
          type: string
        residentStatus:
          $ref: '#/components/schemas/com.august.protos.person.ResidentStatus'
          description: Current resident status
      required:
      - residentId
      - residentStatus
      - currentBalanceCents
      - contacts
    com.august.api.integrations.models.billing_transactions.v1.TransactionIdType:
      enum:
      - PAYMENT
      - BILLING_CHARGE
      type: string
    com.august.api.integrations.models.billing_charges.v1.RecordChargesResponse:
      properties:
        charges:
          description: The resulting ledger entries, one per submitted charge, in request order.
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.billing_charges.v1.RecordChargeResult'
            description: The resulting ledger entries, one per submitted charge, in request order.
          type: array
      required:
      - charges
    com.august.api.integrations.models.billing_transactions.v1.ExternalBillingTransaction:
      properties:
        accountCode:
          type: string
        amountCents:
          format: int32
          type: integer
        chargeSource:
          description: The integration partner the charge is attributed to, when one is recorded.
          type: string
        createdAt:
          format: date-time
          type: string
        deleted:
          type: boolean
        effectiveTime:
          format: date-time
          type: string
        externalTransactionId:
          type: string
        feeName:
          type: string
        id:
          type: string
        idType:
          $ref: '#/components/schemas/com.august.api.integrations.models.billing_transactions.v1.TransactionIdType'
        invoiceId:
          type: string
        medicaidProgramShortName:
          type: string
        merchantFeeCents:
          format: int32
          type: integer
        note:
          type: string
        paymentMethod:
          $ref: '#/components/schemas/com.august.api.integrations.models.billing_transactions.v1.TransactionPaymentMethod'
        paymentSource:
          description: How the payment was made.
          type: string
        pending:
          type: boolean
        postMonth:
          example: '2020-01-01'
          format: date
          type: string
        quantity:
          format: int32
          type: integer
        rateCents:
          format: int32
          type: integer
        serviceEndDate:
          example: '2020-01-01'
          format: date
          type: string
        serviceStartDate:
          example: '2020-01-01'
          format: date
          type: string
        surchargeCents:
          format: int32
          type: integer
        taxCents:
          format: int32
          type: integer
        transactionType:
          $ref: '#/components/schemas/com.august.api.integrations.models.billing_transactions.v1.TransactionType'
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - idType
      - pending
      - deleted
      - effectiveTime
      - serviceStartDate
      - postMonth
      - createdAt
      - updatedAt
      - amountCents
      - transactionType
    com.august.api.integrations.models.billing_charges.v1.RecordChargeResult:
      properties:
        amountCents:
          description: The extended, tax-inclusive total in cents (rateCents times quantity, plus tax). Negative for a credit.
          format: int32
          type: integer
        chargeSource:
          description: The integration partner the charge is attributed to, when one is recorded.
          type: string
        createdAt:
          description: When the ledger entry was created.
          format: date-time
          type: string
        externalTransactionId:
          description: Echo of the externalChargeId you submitted.
          type: string
        feeName:
          description: The one-time fee the charge was posted against.
          type: string
        id:
          description: August's identifier for the ledger entry.
          type: string
        isNew:
          description: True when this request created the charge; false when a charge with the same externalChargeId already existed and was returned instead of being recreated.
          type: boolean
        personId:
          description: The resident the charge was recorded on, so you can confirm it landed on the person you submitted (including when an existing charge is returned).
          type: string
        quantity:
          description: The number of units charged.
          format: int32
          type: integer
        rateCents:
          description: The per-unit rate in cents. Negative for a credit.
          format: int32
          type: integer
        serviceStartDate:
          example: '2020-01-01'
          format: date
          type: string
        taxCents:
          description: The total tax in cents computed server-side across all units.
          format: int32
          type: integer
        updatedAt:
          description: When the ledger entry was last modified.
          format: date-time
          type: string
      required:
      - id
      - externalTransactionId
      - personId
      - serviceStartDate
      - createdAt
      - updatedAt
      - amountCents
      - feeName
      - rateCents
      - quantity
      - taxCents
      - isNew
    com.august.api.integrations.models.statements.v1.StatementStatus:
      enum:
      - DUE
      - PAID
      type: string
    com.august.api.integrations.models.billing_callback.v1.ExternalPaymentMethod:
      enum:
      - ACH
      - CASH
      - CHECK
      - CREDIT_CARD
      - DEBIT_CARD
      - WIRE
      type: string
    com.august.api.integrations.models.billing_transactions.v1.TransactionPaymentMethod:
      enum:
      - CASH
      - CHECK
      - ACH
      - CREDIT_CARD
      - WIRE
      - DEBIT_CARD
      - PREPAID_CARD
      type: string
    com.august.api.integrations.models.billing_callback.v1.RecordPaymentResult:
      properties:
        externalTransactionId:
          description: Echo of partner's payment reference
          type: string
        paymentId:
          description: August's internal payment ID
          type: string
      required:
      - paymentId
      - externalTransactionId
    com.august.api.integrations.models.billing_summary.v1.LatestStatement:
      properties:
        balanceCents:
          description: Remaining balance on this statement in cents (after payments)
          format: int32
          type: integer
        dueDate:
          example: '2020-01-01'
          format: date
          type: string
        id:
          type: string
        issueDate:
          example: '2020-01-01'
          format: date
          type: string
      required:
      - id
      - issueDate
      - dueDate
      - balanceCents
    com.august.protos.person.ResidentStatus:
      enum:
      - RESIDENT_STATUS_PROSPECT
      - RESIDENT_STATUS_CURRENT_RESIDENT
      - RESIDENT_STATUS_CLOSED
      - RESIDENT_STATUS_DISCHARGED
      - RESIDENT_STATUS_ENTERED_IN_ERROR
      type: string
    com.august.api.integrations.models.billing_charges.v1.ExternalChargeItem:
      properties:
        description:
          description: Optional free-text note stored on the charge.
          type: string
        externalChargeId:
          description: Partner's unique identifier for this charge, used as the idempotency key.
          type: string
        feeName:
          description: Name of the one-time fee to charge, matched by name against the fees available to the facility (its own fees plus inherited organization fees); a facility-level fee overrides an organization fee of the same name.
          type: string
        personId:
          description: August person (resident) ID the charge applies to.
          type: string
        quantity:
          description: Number of units.
          format: int32
          type: integer
        rateCents:
          description: Per-unit rate in cents. A negative value records a credit.
          format: int32
          type: integer
        transactionDate:
          example: '2020-01-01'
          format: date
          type: string
      required:
      - externalChargeId
      - personId
      - feeName
      - transactionDate
      - rateCents
      - quantity
    com.august.api.integrations.models.billing_callback.v1.RecordDepositResponse:
      properties:
        depositId:
          description: August's internal deposit ID
          type: string
        externalDepositId:
          description: Echo of partner's deposit reference
          type: string
        payments:
          description: Mapping of created payments
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.billing_callback.v1.RecordPaymentResult'
            description: Mapping of created payments
          type: array
      required:
      - depositId
      - externalDepositId
      - payments
    com.august.api.integrations.models.billing_transactions.v1.TransactionType:
      enum:
      - PAYMENT
      - PAYMENT_RETURN
      - PAYMENT_CANCELED
      - PAYMENT_FAILED
      - REFUND
      - REFUND_RETURN
      - REFUND_CANCELED
      - REFUND_FAILED
      - PAYMENT_ENTERED_IN_ERROR
      - CHARGEBACK_DISPUTE_STARTED
      - CHARGEBACK_WON
      - CHARGEBACK_INQUIRY_STARTED
      - CHARGEBACK_LOST
      - MEDICAID_TAKEBACK
      - CREDIT
      - RECURRING
      - ONE_TIME
      type: string
    com.august.api.integrations.models.billing_charges.v1.RecordChargesRequest:
      properties:
        charges:
          description: Individual charges in this batch.
          items:
            $ref: '#/components/schemas/com.august.api.integrations.models.billing_charges.v1.ExternalChargeItem'
            description: Individual charges in this batch.
          type: array
      required:
      - charges
    com.august.api.integrations.models.statements.v1.StatementSearchResult:
      properties:
        billingPeriod:
          description: Statement billing period in YYYY-MM format (derived from endDate)
          type: string
        dueDate:
          example: '2020-01-01'
          format: date
          type: string
        endDate:
          example: '2020-01-01'
          format: date
          type: string
        id:
          type: string
        issueDate:
          example: '2020-01-01'
          format: date
          type: string
        startDate:
          example: '2020-01-01'
          format: date
          type: string
        status:
          $ref: '#/components/schemas/com.august.api.integrations.models.statements.v1.StatementStatus'
          description: Statement status (DUE or PAID)
        totalAmountCents:
          description: Total amount billed on the statement in cents
          format: int32
          type: integer
      required:
      - id
      - issueDate
      - dueDate
      - startDate
      - endDate
      - billingPeriod
      - status
      - totalAmountCents
    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:
          example: '2020-01-01'
          format: date
          type: string
        paymentMethod:
          $ref: '#/components/schemas/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_summary.v1.ExternalContact:
      properties:
        email:
          description: Primary email address
          type: string
        firstName:
          description: Contact's first name (first given name)
          type: string
        id:
          type: string
        isPayer:
          description: True if contact is marked as "Payment of Care"
          type: boolean
        isResponsibleParty:
          description: True if contact is marked as "Responsible Person"
          type: boolean
        isSelf:
          description: True if contact represents the resident themselves
          type: boolean
        lastName:
          description: Contact's last name (family name)
          type: string
        phone:
          description: Primary phone number
          type: string
      required:
      - id
      - isPayer
      - isResponsibleParty
      - isSelf
  securitySchemes:
    BearerAuth:
      scheme: bearer
      type: http
x-provenance:
  method: searched
  source: https://developer.augusthealth.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.augusthealth.com/reference/bulkchartroutineadministrationsv1.md
  - https://developer.augusthealth.com/reference/createcontactv1-1.md
  - https://developer.augusthealth.com/reference/createincidentv1.md
  - https://developer.augusthealth.com/reference/createpersonv1-1.md
  - https://developer.augusthealth.com/reference/createresidentbiographyv1.md
  - https://developer.augusthealth.com/reference/createtokenv1.md


# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/august-health/refs/heads/main/openapi/august-health-billing-v1-api-openapi.yml