AR Management

Create patient AR payment plan

Creates a local patient Accounts Receivable payment plan after account ownership and active-plan checks.

POSTPublic reference baselinePayment or creditAR ManagementoperationId: createArPaymentPlanhttps://dev-api.quickintell.com/api/v1/ar-management/patient-accounts/{accountId}/payment-plans

Public reference baselinePayment or creditRevenue and follow-up

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. Also requires E2 side-effect policy before production recipes, SDK inclusion, or try-out access.

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

Payment or credit

May affect payments, credits, refunds, voids, or financial posting. Requires explicit product approval before publication.

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 revenue and follow-up contract generated for POST /api/v1/ar-management/patient-accounts/{accountId}/payment-plans. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated POST /api/v1/ar-management/patient-accounts/{accountId}/payment-plans contract as a payment or credit baseline endpoint.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Mutating behavior still needs side-effect and retry evidence.

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	No idempotency mechanism is declared.	Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
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.

Publication warnings

Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes Idempotency

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.

Accounts Receivable Management.

AR Management APIs coordinate payer follow-up, work queues, correspondence, collection-stage movement, patient payment-plan tracking, financial-assistance review, and appeal tracking. These endpoints help teams organize revenue recovery work after claims, denials, patient balances, and payer responses already exist in QuickRCM.

What this endpoint does

Use case

Use this when a patient or guarantor agrees to pay an outstanding balance over scheduled installments.

Before calling

Verify the patient account, total balance, first payment date, installment count, and autopay expectations outside this endpoint.

Request and response behavior

Request guidance

Send payment-plan schedule metadata only. Do not send card numbers, bank accounts, or processor tokens.

installmentAmount and totalInstallments define the schedule.
autoPayEnabled is metadata and not payment credential storage.

Response semantics

A successful response creates local plan tracking. It does not charge a card or guarantee payment collection.

Creates local plan tracking.
Payment processing remains separate.

Errors and retries

Do not retry after a timeout until checking for an active plan on the account; duplicate payment plans can confuse billing workflows.

400 means invalid schedule values.
409 can indicate an active plan already exists when exposed.

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

Name	Location	Required	Type	Description	Validation and safety notes
accountId	path	Yes	string	QuickRCM patient accounts receivable account identifier. It must belong to the organization selected by the bearer API key.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.

Query parameters

This endpoint does not define query parameters.

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.

Name	Location	Required	Type	Description	Validation and safety notes
installmentAmount	body	Yes	number	Payment amount for each patient payment-plan installment. Use a decimal number and do not include card data.	Potential PHI; use synthetic examples and avoid logging raw values.
frequency	body	No	WEEKLY \| BI_WEEKLY \| MONTHLY \| QUARTERLY \| ONE_TIME	Payment-plan cadence such as monthly, biweekly, weekly, or another supported billing interval.	Enum values are declared in the Type column. Default: MONTHLY. Financial value; preserve decimal precision and avoid real account details.
startDate	body	Yes	string (date-time)	Start date for a payment plan, service period, or workflow schedule. Use an ISO date string.	Format: date-time. Financial value; preserve decimal precision and avoid real account details.
totalInstallments	body	Yes	integer	Total number of scheduled installments in a patient payment plan.	Minimum value: 1. Maximum value: 120. Potential PHI; use synthetic examples and avoid logging raw values.
autoPayEnabled	body	No	boolean	Whether the patient payment plan is expected to use automatic payments. This flag does not store card data.	Default: false. Potential PHI; use synthetic examples and avoid logging raw values.
gracePeriodDays	body	No	integer	Number of days after a scheduled installment date before the plan is considered late.	Minimum value: 0. Maximum value: 90. Default: 0.

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.

{
  "installmentAmount": 125.5,
  "startDate": "2026-06-08T10:15:30Z",
  "totalInstallments": 1,
  "frequency": "MONTHLY",
  "autoPayEnabled": false,
  "gracePeriodDays": 0
}

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.

201

Created patient AR payment plan.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "paymentPlan": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001"
    }
  },
  "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.