AR Management

Generate AR correspondence

Generates and stores local AR correspondence metadata and content without external delivery.

POSTPublic reference baselineLocal writeAR ManagementoperationId: generateArCorrespondencehttps://dev-api.quickintell.com/api/v1/ar-management/correspondence

Public reference baselineLocal writeRevenue 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

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

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/correspondence. 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/correspondence contract as a local write 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 to prepare payer letters, patient balance communication, appeal support, or collection documentation before any send workflow.

Before calling

Choose the recipient, subject, body or template, and related claim or patient-account context.

Request and response behavior

Request guidance

Keep correspondence content sanitized. Do not include credentials, raw EDI, or unnecessary PHI in template variables.

recipient fields identify the intended audience.
templateId and extraVars can render standardized content.

Response semantics

The response creates local correspondence. It is not proof that email, fax, mail, or portal delivery occurred.

Stores correspondence locally.
Use sendArCorrespondence for queued or simulated send state.

Errors and retries

After timeouts, list or inspect correspondence before generating another copy.

400 means content, recipient, or template data is invalid.
Do not retry blindly if duplicate letters would confuse staff.

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

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
claimId	body	Yes	string	QuickRCM claim identifier. The claim must belong to the organization selected by the bearer API key.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
templateId	body	No	string	QuickRCM template identifier used to render correspondence or workflow text.	Minimum length: 1.
type	body	Yes	string	Type discriminator for the surrounding object, such as product type, provider type, queue type, or appeal type.	Minimum length: 1. Maximum length: 100.
method	body	Yes	string	Follow-up or correspondence channel, such as phone, portal, fax, mail, email, or internal note.	Minimum length: 1. Maximum length: 100. Potential PHI; use synthetic examples and avoid logging raw values.
subject	body	No	string	Subject line for local correspondence. Avoid secrets and unnecessary PHI.	Maximum length: 500. Sensitive credential or storage-adjacent value; use placeholders only.
body	body	No	string	Message body for locally generated correspondence. Keep it payer-appropriate and avoid credentials, raw EDI, and excessive PHI.	Maximum length: 50000. Sensitive credential or storage-adjacent value; use placeholders only.
recipientName	body	No	string	Display name of the correspondence recipient, such as payer department, patient, guarantor, or agency.	Maximum length: 200. Potential PHI; use synthetic examples and avoid logging raw values.
recipientFax	body	No	string	Fax destination for locally generated correspondence metadata. Validate formatting before external delivery is enabled.	Maximum length: 80.
recipientAddress	body	No	string	Mailing address for correspondence. Treat as sensitive and verify the recipient before use.	Maximum length: 1000. Potential PHI; use synthetic examples and avoid logging raw values.
recipientEmail	body	No	string (email)	Email destination for locally generated correspondence metadata. Do not include credentials or tokens.	Format: email. Maximum length: 320. Sensitive credential or storage-adjacent value; use placeholders only.
extraVars	body	No	object	Template variables or caller-supplied values used to render local correspondence. Do not include credentials.	Sensitive credential or storage-adjacent value; use placeholders only.

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.

{
  "claimId": "00000000-0000-4000-8000-000000000001",
  "type": "example-type",
  "method": "example-method",
  "templateId": "00000000-0000-4000-8000-000000000001",
  "subject": "example-subject",
  "body": "example-body",
  "recipientName": "Example ar_correspondence",
  "recipientFax": "+15551234567",
  "recipientAddress": "example-recipientaddress",
  "recipientEmail": "[email protected]",
  "extraVars": {}
}

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

Generated AR correspondence.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "correspondence": {
      "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.

Handle this response as normal integration control flow.

{
  "error": "Request validation failed",
  "statusCode": 400
}

401

Authentication required.

Handle this response as normal integration control flow.

{
  "error": "Authentication required",
  "statusCode": 401
}

403

Caller is not authorized for the requested organization or resource.

Handle this response as normal integration control flow.

{
  "error": "Forbidden",
  "statusCode": 403
}

404

Claim or template was not found.

Handle this response as normal integration control flow.

{
  "error": "Resource not found",
  "statusCode": 404
}

Adjacent endpoints

Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.

PUTPublic reference baselineLocal write

Advance patient AR collection stage

/api/v1/ar-management/patient-accounts/{accountId}/collection-stage

PUTPublic reference baselineLocal write

Bulk assign AR work queue items

/api/v1/ar-management/work-queue-items/bulk-assignment

POSTPublic reference baselineLocal write

Create AR appeal tracking record

/api/v1/ar-management/appeals

POSTPublic reference baselineExternal or credentialed

Create AR follow-up

/api/v1/ar-management/follow-ups

POSTPublic reference baselineExternal or credentialed

Create AR work queue

/api/v1/ar-management/work-queues

POSTPublic reference baselineLocal write

Create AR work queue item

/api/v1/ar-management/work-queue-items

All endpoint pages Open Scalar reference