Patient AR

Update patient AR payment plan

Updates local payment-plan status, installment amount, next payment date, or cancellation reason for an organization-scoped payment plan.

PUTPublic reference baselinePayment or creditPatient ARoperationId: updatePatientArPaymentPlanhttps://dev-api.quickintell.com/api/v1/patient-ar/payment-plans/{planId}

Public reference baselinePayment or creditPatient 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. 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 patient financials contract generated for PUT /api/v1/patient-ar/payment-plans/{planId}. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Documents the generated PUT /api/v1/patient-ar/payment-plans/{planId} 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	Request body exposes an endpoint-specific idempotencyKey compatibility field.	Retry only with the documented key location and after checking endpoint state; 409 behavior and retention still need release evidence.
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	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
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.

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 for local payment-plan maintenance, status movement, installment changes, or cancellation after the plan already exists.

Before calling

Resolve the plan under the API key organization and decide whether the update should cancel pending scheduled payments.

Request and response behavior

Request guidance

Send `planId` in the path and any editable fields in the body. If `status` is CANCELLED, the handler cancels pending scheduled payments for that plan in the same organization.

`status` accepts DRAFT, ACTIVE, COMPLETED, CANCELLED, DEFAULTED, or ON_HOLD.
`nextPaymentDate` must be an ISO date-time when supplied.
`cancelReason` is optional and capped at 500 characters.

Response semantics

HTTP 200 returns `resourceType: PaymentPlan`, `externalRisk: LOCAL_ONLY`, and operation-result status equal to the requested status when supplied or UPDATED otherwise. It does not create new scheduled payments or process patient payments.

Cancellation updates pending scheduled payments to CANCELLED.
The response is an acknowledgement, not a full plan detail body.
Payment collection remains outside this endpoint.

Errors and retries

Treat 404 as missing or wrong-organization plan. Re-read plan and schedule state after timeouts before retrying cancellation or installment changes.

400 can indicate invalid status or date format.
404 can intentionally hide wrong-tenant plans.
Retry only after checking whether the prior update completed.

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
planId	path	Yes	string	Payment plan identifier in the path.	Minimum length: 1. Financial value; preserve decimal precision and avoid real account details.

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
status	body	No	DRAFT \| ACTIVE \| COMPLETED \| CANCELLED \| DEFAULTED \| ON_HOLD	Optional target payment-plan status.	Enum values are declared in the Type column. Financial value; preserve decimal precision and avoid real account details.
installmentAmount	body	No	number	Optional new positive installment amount.	Financial value; preserve decimal precision and avoid real account details.
nextPaymentDate	body	No	string (date-time)	Optional ISO date-time for the next scheduled payment.	Format: date-time. Financial value; preserve decimal precision and avoid real account details.
cancelReason	body	No	string	Optional cancellation reason capped at 500 characters.	Minimum length: 1. Maximum length: 500.
idempotencyKey	body	No	string	Optional caller marker stored in local metadata.	Minimum length: 1. Maximum length: 128. Endpoint-specific compatibility key; universal Idempotency-Key header support is not declared.

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.

{
  "status": "DRAFT",
  "installmentAmount": 125.5,
  "nextPaymentDate": "2026-06-08T10:15:30Z",
  "cancelReason": "example-cancelreason",
  "idempotencyKey": "example-idempotencykey"
}

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 public API operation completed.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "resourceType": "example-resourcetype",
    "status": "active",
    "id": "00000000-0000-4000-8000-000000000001",
    "externalRisk": "LOCAL_ONLY"
  },
  "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.