Patient AR

List patient AR accounts

Lists patient accounts receivable accounts owned by the organization selected by the bearer API key.

GETPublic reference baselineRead-onlyPatient ARoperationId: listPatientArAccountshttps://dev-api.quickintell.com/api/v1/patient-ar/accounts

Public reference baselineRead-onlyPatient financials

Route status

Public reference baseline

Generated endpoint contract may be shown with caveats, but external publication still needs route registry and release evidence.

Publication status

Baseline reference only

Requires E6 route registry and E9 release evidence before external publication.

Authentication

Bearer API key declared

OpenAPI declares bearer API-key security for this operation.

Tenant context

API-key organization

API-key organization context is authoritative; request organizationId is not a public tenant selector.

Side-effect summary

Read-only

Reads tenant-scoped data only unless the endpoint description explicitly states an external lookup.

Source artifact

docs/openapi/openapi.json

OpenAPI 3.1.0; API 1.0.0.

When to use this endpoint

Use this page as an internal baseline for the patient financials contract generated for GET /api/v1/patient-ar/accounts. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated GET /api/v1/patient-ar/accounts contract as a read-only baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Read behavior still needs release evidence before broad external publication.

Not public from this page

Live external side effects, file contents, credentials, webhooks, SDK promises, and production recipes are still gated.

Headers and tenancy

Current headers and tenant authority. Target headers stay labeled as future until OpenAPI and release evidence declare them.

Header	Required	Current status	Notes
Authorization	Yes	Current	Bearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-Key	No	Target/future	Do not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-Id	No	Target/future	Use for support correlation only after approved; not declared as a standard OpenAPI header today.

Required scopes

Unclassified until E6 route metadata exists; do not infer scopes from route names.

Wrong-org behavior

Tenant-safe 404, empty list, or 403 is endpoint-specific and remains an evidence gap until E1 is closed.

Actor and audit

No public actor, audit, or correlation contract is published from OpenAPI alone.

Idempotency and retries

Retry behavior is documented conservatively because universal idempotency headers are not declared.

Topic	Status	Guidance
Current idempotency	Read request; no mutation idempotency contract needed.	Use ordinary safe-read retry behavior with rate-limit backoff.
Universal header	Not declared	Do not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behavior	Unresolved	Same-key changed-payload, in-flight retry, fingerprint scope, and TTL behavior remain endpoint-specific evidence gaps.

Async jobs and polling

Queued work is accepted work, not proof of completed workflow execution.

Topic	Status	Guidance
Immediate response	No 202 response declared	OpenAPI does not declare HTTP 202 for this operation.
Polling and terminal states	Not indicated by OpenAPI	No generic polling contract is published from this page.
Later side effects	Not proven	Do not infer background execution beyond the documented response.

Files and artifacts

File-like routes need content-class, ownership, scanning, retention, and URL policy evidence before public recipes.

Topic	Status	Guidance
Content class	No file/artifact class inferred	OpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keys	Not applicable unless a file field is present	Tenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retention	Unresolved unless endpoint-specific evidence exists	Short-lived URLs, MIME limits, checksums, scanner status, retention, expiration, and legal hold behavior are not implied by OpenAPI examples.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Public reference baseline from documentation classification overlay.	E6 route registry evidence is still required before external publication.
Example validation	Generated examples are internal baseline aids.	No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewed	Implementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.	Refresh this evidence for release workspaces.
Release evidence	E9 required.	No SDK readiness, production readiness, or expanded external docs claim from this endpoint page.

Patient AR public API.

Patient AR public APIs expose organization-scoped patient accounts receivable account lookup, local account maintenance, patient-responsibility charge posting, local payment application, payment-plan setup, statement draft creation, deposit-batch reconciliation, and collection-task activity logging. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector; all account, patient, guarantor, facility, claim, charge, payment, plan, statement, deposit-batch, collection-task, activity, and assignee identifiers must resolve inside the authenticated organization. Read endpoints accept `patient-ar:read` or `patient-ar:write`; write endpoints require `patient-ar:write` plus Patient AR RBAC through the existing authorization helper. This public surface is intentionally conservative around money movement and outbound contact. Cash, check, wire, and other non-card payment records can be created locally, then applied to local charges. Card, debit, and ACH payment requests must use validation, dry-run, or queue-only controls and do not call Stripe directly from the public handler. Refund and void endpoints validate or return queue-only acknowledgements; they do not settle refunds, void external payments, or mutate payment rows inline. Statement creation creates a local draft only, and collection endpoints record local task/activity state without sending email, SMS, letters, calls, legal notices, or agency placements. Use synthetic examples only. Account numbers, MRNs, patient or guarantor references, contact details, notes, payment references, check numbers, and collection activity can be PHI or sensitive financial data. Do not include raw EDI, payer portal credentials, tokens, S3 keys, vendor payloads, transcripts, or real payment method identifiers in public examples.

What this endpoint does

Use case

Use this to build patient-balance worklists, find an account before posting a charge or payment, monitor collection status, or reconcile local Patient AR account counts.

Before calling

Authenticate with `patient-ar:read` or `patient-ar:write`. Choose bounded pagination and the narrowest available filters for status, collection status, patient, facility, balance range, or search text.

Request and response behavior

Request guidance

`page` is one-based and defaults to 1. `pageSize` defaults to 25 and is capped at 100. The `search` filter is capped at 120 characters and searches account number, patient MRN, and patient name, so clients should avoid logging raw search terms.

Do not send `organizationId`; tenant context comes from the API key.
`status` accepts ACTIVE, ON_HOLD, IN_COLLECTIONS, CLOSED, or WRITTEN_OFF.
`collectionStatus` accepts CURRENT, PAST_DUE, PRE_COLLECT, IN_COLLECT, AGENCY, LEGAL, PAYMENT_PLAN, or HARDSHIP.
`minBalance` and `maxBalance` are numeric lower and upper bounds for current balance.

Response semantics

HTTP 200 returns local account summaries in `data.accounts`, total counts, page metadata, and `meta.organizationId`. Account rows include patient and guarantor references, facility reference, balance strings, collection/status fields, timestamps, and counts of related charges, payments, statements, payment plans, and collection tasks.

`currentBalance`, `charityAmount`, and `lastPaymentAmount` are decimal monetary values serialized as strings.
`patient` and `guarantor` include identifiers, MRN, first name, and last name; examples must be synthetic.
`counts` are local relationship counts, not external collection or payment processing evidence.
`status` is the local account lifecycle status, not an HTTP or operation-result status.

Errors and retries

Treat 400 as invalid filters or pagination, 401 as authentication failure, 403 as scope or RBAC failure, and 429 as a backoff signal. Retrying the same read with the same filters is safe after transient failures.

403 can mean the API key is valid but lacks Patient AR access.
429 means the public API rate limit was exceeded.
Avoid broad polling loops over account lists that can contain PHI-adjacent context.

Template boundary before examples

The route class, authentication state, tenancy rule, side-effect mode, idempotency status, async behavior, file policy, warnings, links, and evidence above are part of the endpoint contract. Treat generated examples below as internal baseline aids until release evidence closes.

Path parameters

This endpoint does not define path parameters.

Query parameters

Name	Location	Required	Type	Description	Validation and safety notes
page	query	No	integer	One-based result page. Defaults to 1.	Minimum value: 1. Default: 1.
pageSize	query	No	integer	Number of accounts per page. Defaults to 25 and is capped at 100.	Minimum value: 1. Maximum value: 100. Default: 25.
status	query	No	ACTIVE \| ON_HOLD \| IN_COLLECTIONS \| CLOSED \| WRITTEN_OFF	Optional Patient AR account lifecycle status filter.	Enum values are declared in the Type column. Potential PHI; use synthetic examples and avoid logging raw values.
collectionStatus	query	No	CURRENT \| PAST_DUE \| PRE_COLLECT \| IN_COLLECT \| AGENCY \| LEGAL \| PAYMENT_PLAN \| HARDSHIP	Optional collection workflow status filter.	Enum values are declared in the Type column.
patientId	query	No	string	Optional QuickRCM patient identifier scoped to the authenticated organization.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
facilityId	query	No	string	Optional QuickRCM facility identifier scoped to the authenticated organization.	Minimum length: 1.
minBalance	query	No	number	Optional minimum current balance filter.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
maxBalance	query	No	number	Optional maximum current balance filter.	Minimum value: 0. Financial value; preserve decimal precision and avoid real account details.
search	query	No	string	Optional text filter over account number, patient MRN, and patient name. Treat raw search terms as sensitive.	Minimum length: 1. Maximum length: 120. Potential PHI; use synthetic examples and avoid logging raw values.

OpenAPI-declared header parameters

Standard platform header guidance appears in the governance panel. This table only lists operation-specific headers declared in OpenAPI.

This endpoint does not define operation-specific header parameters.

Request body

JSON fields from the generated OpenAPI schema with pilot enrichment applied where available. Nested object fields are shown with dotted paths.

This endpoint does not define a JSON request body.

Generated request example

Generated examples are baseline contract aids only. They are not external publication evidence and must not include real PHI, credentials, raw vendor payloads, raw EDI, transcripts, storage keys, or signed URLs.

No request example is declared.

Successful responses

Generated response examples show the baseline OpenAPI contract. Tenant identifier echo, PHI redaction, pagination, money, date/time, and enum semantics remain endpoint-specific publication checks.

200

Patient AR accounts for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "accounts": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "patientId": "00000000-0000-4000-8000-000000000001",
        "guarantorId": "00000000-0000-4000-8000-000000000001",
        "facilityId": "00000000-0000-4000-8000-000000000001",
        "accountNumber": "example-accountnumber",
        "currentBalance": "example-currentbalance",
        "collectionStatus": "CURRENT",
        "collectionScore": 1.25,
        "status": "ACTIVE",
        "financialClass": "example-financialclass",
        "badDebtDate": "2026-06-08T10:15:30Z",
        "charityAmount": "example-charityamount",
        "hardshipApproved": true,
        "hardshipDate": "2026-06-08T10:15:30Z",
        "lastActivityDate": "2026-06-08T10:15:30Z",
        "lastPaymentDate": "2026-06-08T10:15:30Z",
        "lastPaymentAmount": "example-lastpaymentamount",
        "lastStatementDate": "2026-06-08T10:15:30Z",
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "2026-06-08T10:15:30Z",
        "patient": {
          "id": "00000000-0000-4000-8000-000000000001",
          "mrn": "example-mrn",
          "firstName": "John",
          "lastName": "Smith"
        },
        "guarantor": {
          "id": "00000000-0000-4000-8000-000000000001",
          "mrn": "example-mrn",
          "firstName": "John",
          "lastName": "Smith"
        },
        "facility": {
          "id": "00000000-0000-4000-8000-000000000001",
          "name": "Example patient_ar_account"
        },
        "counts": {
          "charges": 125.5,
          "payments": 1,
          "statements": 1,
          "paymentPlans": 1,
          "collectionTasks": 1
        }
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 1,
    "totalPages": 1
  },
  "meta": {
    "organizationId": "00000000-0000-4000-8000-000000000001"
  }
}

Error responses

Errors must remain sanitized. Do not include raw payer, EHR, SFTP, SMTP, Stripe, LLM/OCR, browser automation, file, transcript, EDI, worker, or vendor payloads.

400

Invalid request parameters.