Payment Posting

Validate or queue ERA remittance import

Validates ERA import metadata for the authenticated organization and checks for a duplicate remittance by exact organization, check number, parsed check date, and payer name. The public wrapper does not download files, parse raw X12 835 EDI, or create remittance rows.

POSTNeeds publication reviewPayment or creditPayment PostingoperationId: importPaymentPostingRemittancehttps://dev-api.quickintell.com/api/v1/payment-posting/remittances/import

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, E3 async and idempotency 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/remittances/import. 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/remittances/import, 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	202	Treat the response as accepted or queued work, not completed workflow execution.
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	Possible	Queued work may later cause local or external effects only where endpoint evidence says so.

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.
HTTP 202 or queued behavior requires endpoint-specific polling, terminal-state, retry, and retention guidance.
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 Async Jobs 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 before an external integration asks QuickRCM to accept ERA import metadata, especially to detect duplicate check metadata without exposing raw remittance content through the public API.

Before calling

Authenticate with `payment-posting:write`. Prepare metadata from a trusted storage workflow. Use `validateOnly: true` for validation, or `queueOnly: true` for queue simulation. Do not send both safe-mode flags as false.

Request and response behavior

Request guidance

Either `s3Key` or `s3Url` is required by the schema, but examples must use synthetic placeholders only. `checkNumber`, `checkDate`, and `payerName` are required. `checkDate` must be a date-time string. `validateOnly` defaults to true and takes precedence in the response mode. When both `validateOnly` and `queueOnly` are false, the handler returns 400.

Response semantics

HTTP 202 returns action `IMPORT_ERA`, mode `VALIDATE_ONLY` or `QUEUE_ONLY`, `externalRisk: SIMULATED_ONLY`, `queued: false`, and duplicate metadata. `accepted` is false when a duplicate remittance exists. This is not evidence that an ERA file was downloaded, parsed, persisted, queued, or posted.

Errors and retries

Fix 400 validation failures, missing storage pointer placeholders, invalid `checkDate`, or unsafe flag combinations before retrying. Treat duplicate responses as business outcomes rather than transient failures. Retry 429 and transient 5xx responses with backoff.

Fix 400 validation failures, missing storage pointer placeholders, invalid `checkDate`, or unsafe flag combinations before retrying. Treat duplicate responses as business outcomes rather than transient failures. Retry 429 and transient 5xx responses with backoff.

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
s3Key	body	No	string	Optional organization-scoped storage object key accepted by the schema. Public docs should use non-resolving placeholders only and must not expose real keys.	Minimum length: 1. Maximum length: 1024. Sensitive credential or storage-adjacent value; use placeholders only.
s3Url	body	No	string	Optional ERA object URL accepted by the schema. Public docs should use placeholders only and must not expose signed or real storage URLs.	Minimum length: 1. Maximum length: 2048. Sensitive credential or storage-adjacent value; use placeholders only.
fileName	body	No	string	Optional display filename for operator context; do not include patient names or secrets.	Minimum length: 1. Maximum length: 255. Sensitive credential or storage-adjacent value; use placeholders only.
checkNumber	body	Yes	string	Required remittance check or EFT trace identifier used for duplicate detection with check date, payer name, and authenticated organization.	Minimum length: 1. Maximum length: 120.
checkDate	body	Yes	string (date-time)	Required remittance check date as an ISO date-time string. The handler parses this value before duplicate lookup.	Format: date-time.
payerName	body	Yes	string	Required local payer display name used in exact duplicate lookup with check number and check date.	Minimum length: 1. Maximum length: 200.
validateOnly	body	No	boolean	Safe-mode flag that defaults to true. When true, response mode is VALIDATE_ONLY and no live import side effects occur.	Default: true.
queueOnly	body	No	boolean	Safe-mode flag for queue simulation. Current public handler still returns `queued: false`.	Default: false.

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.

{
  "checkNumber": "example-checknumber",
  "checkDate": "2026-06-08T10:15:30Z",
  "payerName": "Example import_payment_posting_remittance",
  "s3Key": "example-s3key",
  "s3Url": "https://example.quickintell.com/resource",
  "fileName": "Example import_payment_posting_remittance",
  "validateOnly": true,
  "queueOnly": false
}

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.

202

ERA import request validated or accepted for safe queue simulation.

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.