Payment Posting

Dry-run payer ID refresh

Finds organization-owned remittances whose local `payerId` is `UNKNOWN` and returns sanitized refresh candidates without fetching files or parsing EDI payloads.

POSTNeeds publication reviewPayment or creditPayment PostingoperationId: refreshPaymentPostingPayershttps://dev-api.quickintell.com/api/v1/payment-posting/payers/refresh

Needs publication reviewPayment or creditClaims and remittances

Route status

Needs publication review

The endpoint contract is visible, but QuickRCM has not approved it yet for normal production API use.

Publication status

Needs publication review

Requires product, security/compliance, tenancy, side-effect, or module-owner approval before production public API use. Also requires E2 side-effect policy, E4 file and artifact governance, and E7 credential, webhook, and vendor trust 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 claims and remittances contract generated for POST /api/v1/payment-posting/payers/refresh. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows the generated OpenAPI shape for POST /api/v1/payment-posting/payers/refresh, but keeps the route out of ordinary production API positioning until review is complete.

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

Do not publish this endpoint as an ordinary developer API until its unresolved decisions are closed.

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	Potential file or artifact	Documents, PDFs, reports, transcripts, EDI, OCR, or generated artifacts need E4 classification before public examples.
Ownership and storage keys	Evidence required	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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.
File and artifact examples must stay metadata-only until scanning, retention, ownership, and URL policy are approved.
External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.

Related platform rules

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

Evidence

Evidence	Status	Caveat
OpenAPI artifact	docs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.	Generated baseline contract only.
Route registry	Needs publication review 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.

Payment Posting public API.

Payment Posting public APIs expose organization-scoped remittance visibility, payment posting record detail, local remittance metadata updates, local matching controls, dry-run staging, safe posting validation, payer-ID refresh previews, and finalization validation for Electronic Remittance Advice (ERA) workflows. The bearer API key selects the organization. Public callers should not send `organizationId` as a tenant selector. Read endpoints accept `payment-posting:read` or `payment-posting:write`; mutation and workflow endpoints require `payment-posting:write`. This public surface is intentionally conservative. Read responses return sanitized local QuickRCM records and omit patient demographics, raw X12 835 Electronic Data Interchange (EDI), payer payloads, transcripts, credentials, and storage object details. Workflow endpoints that return `externalRisk: SIMULATED_ONLY` should be documented as validation, dry-run, or safe queue simulation responses. They do not download Amazon Simple Storage Service (S3) objects, parse raw X12 835 payloads, create live queue work, post cash, mutate claim balances, deduct credits, or invoke Hash-based Message Authentication Code (HMAC) internal worker endpoints unless a future implementation changes the handler.

What this endpoint does

Use case

Use this endpoint to preview payer-ID cleanup candidates before an internal or operator-controlled refresh workflow.

Before calling

Authenticate with `payment-posting:write`. Keep `dryRun` true for preview mode or set `queueOnly` true for queue simulation. Use `take` to bound the candidate scan.

Request and response behavior

Request guidance

`dryRun` defaults to true, `queueOnly` defaults to false, and `take` defaults to 50 with a maximum of 50. At least one of `dryRun` or `queueOnly` must be true. Do not document this public wrapper as reading S3 objects or parsing ERA files.

Response semantics

HTTP 200 returns action `REFRESH_PAYER_IDS`, mode `DRY_RUN` or `QUEUE_ONLY`, `externalRisk: SIMULATED_ONLY`, `queued: false`, `candidateCount`, and candidate id/payerName/checkNumber triples. Storage file details are selected internally but intentionally omitted from the public response.

Errors and retries

Fix 400 unsafe flag combinations or invalid `take` values before retrying. Treat 429 as a backoff signal. Because this is a preview/simulation endpoint, retry transient 5xx failures with the same bounded `take`.

Fix 400 unsafe flag combinations or invalid `take` values before retrying. Treat 429 as a backoff signal. Because this is a preview/simulation endpoint, retry transient 5xx failures with the same bounded `take`.

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
dryRun	body	No	boolean	Safe-mode flag for preview mode. It defaults to true.	Default: true.
queueOnly	body	No	boolean	Safe-mode flag for queue simulation. Current public handler still returns `queued: false`.	Default: false.
take	body	No	integer	Maximum candidate remittances to inspect and return. Defaults to 50 and cannot exceed 50.	Minimum value: 1. Maximum value: 50. Default: 50.

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.

{
  "dryRun": true,
  "queueOnly": false,
  "take": 50
}

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

Payer refresh dry-run candidates.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "action": "example-action",
    "mode": "example-mode",
    "externalRisk": "example-externalrisk"
  },
  "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.