EOB to ERA

Create EOB to ERA conversion

Validates an Explanation of Benefits (EOB) upload request or creates a local EOB-to-ERA conversion record from an existing organization-owned File row.

POSTPublic reference baselineFile or artifactEOB to ERAoperationId: createEob2EraConversionhttps://dev-api.quickintell.com/api/v1/eob2era/conversions

Public reference baselineFile or artifactClaims and remittances

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 and E4 file and artifact governance 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

File or artifact

Touches documents, reports, transcripts, PDFs, EDI, or generated artifacts. Metadata is safer than raw content.

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/eob2era/conversions. 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/eob2era/conversions contract as a file or artifact 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	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

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.

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	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.

EOB to ERA public API.

Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) public APIs expose organization-scoped conversion tracking for EOB documents and safe local ERA classification workflow metadata. The bearer API key selects the organization; public requests should not include an `organizationId` tenant selector. The current public surface is intentionally conservative. Read endpoints return sanitized conversion summaries and file-presence booleans, not file names, storage keys, signed URLs, raw EOB text, raw X12 835 Electronic Remittance Advice transaction payloads, or parser output. Write endpoints validate requests, create local records from existing organization-owned `File` rows, perform safe local status updates, or classify caller-supplied ERA summary fields. These endpoints do not upload files, generate Amazon Simple Storage Service (S3) presigned URLs, enqueue Amazon Simple Queue Service (SQS) work, run optical character recognition (OCR) or large language model (LLM) extraction, parse raw payer payloads, submit claims, post payments, create denial records, or prove payer adjudication. Use synthetic examples and keep all notes, file names, and classification summaries free of real Protected Health Information (PHI), credentials, tokens, raw Electronic Data Interchange (EDI), transcripts, S3 keys, payer portal credentials, and vendor payloads.

What this endpoint does

Use case

Use validate-only mode while integrating file metadata, or use local-record mode after the EOB file already exists in QuickRCM and you need a conversion tracking record.

Before calling

Authenticate with `eob2era:write`. Know the file name, MIME type, and size. For record creation, resolve `inputFileId` from an existing File in the same organization; this endpoint does not create the file or upload target.

Request and response behavior

Request guidance

`fileName`, `fileType`, and `fileSize` are required. Supported MIME types are application/pdf, image/tiff, image/png, and image/jpeg. `fileSize` is capped at 50 MiB. When `validateOnly` is true, no File lookup or record creation occurs. When `validateOnly` is false or omitted, `inputFileId` is required and must belong to the authenticated organization. If `payerName` is omitted while creating a local record, the handler stores the literal value `Unknown` rather than null.

`inputFileId` is required unless `validateOnly` is true.
This endpoint never creates Amazon Simple Storage Service (S3) presigned upload URLs.
Use file names that avoid Protected Health Information (PHI) in examples and logs.
When `validateOnly` is false and `payerName` is omitted, the created local conversion uses `payerName: "Unknown"`.

Response semantics

HTTP 200 means the request shape was validated with mode VALIDATE_ONLY, null conversion, and side effects marked not_performed. HTTP 201 means a local EobConversionJob record was created with mode LOCAL_RECORD_ONLY, status UPLOADED, and side effects still marked not_performed.

`sideEffects.s3`, `sideEffects.sqs`, and `sideEffects.ocrLlm` are always `not_performed` in the public response schema.
A 201 response creates local tracking only; it does not run optical character recognition (OCR), large language model (LLM) extraction, ERA generation, or payment posting.
The created public conversion response uses sanitized conversion fields.

Errors and retries

Fix 400 validation failures before retrying. A 404 means the supplied input file was not found in the authenticated organization. After a timeout in local-record mode, list conversions or search by your own workflow context before retrying because no idempotency key is declared.

400 can mean `inputFileId` was omitted when validateOnly was false.
404 means the existing File id did not resolve inside the API key organization.
403 means the API key lacks `eob2era:write`.

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
fileName	body	Yes	string	Required display file name for the Explanation of Benefits (EOB) input. Keep it free of Protected Health Information (PHI) and do not include storage paths or signed URLs.	Minimum length: 1. Maximum length: 255. File, artifact, or raw-payload adjacent; keep examples metadata-only.
fileType	body	Yes	application/pdf \| image/tiff \| image/png \| image/jpeg	Required MIME type. Supported values are application/pdf, image/tiff, image/png, and image/jpeg.	Enum values are declared in the Type column. File, artifact, or raw-payload adjacent; keep examples metadata-only.
fileSize	body	Yes	integer	Required file size in bytes. The public schema accepts 1 through 52428800 bytes.	Minimum value: 1. Maximum value: 52428800. File, artifact, or raw-payload adjacent; keep examples metadata-only.
inputFileId	body	No	string	Existing QuickRCM File identifier in the authenticated organization. Required unless validateOnly is true.	Minimum length: 1. File, artifact, or raw-payload adjacent; keep examples metadata-only.
payerName	body	No	string	Optional payer display name stored on the local conversion record. If omitted during non-validate creation, QuickRCM stores the literal value `Unknown`.	Minimum length: 1. Maximum length: 160.
checkNumber	body	No	string	Optional payment check number or remittance reference for reconciliation.	Minimum length: 1. Maximum length: 120. Financial value; preserve decimal precision and avoid real account details.
receivedDate	body	No	string	Optional received date for the EOB. YYYY-MM-DD is accepted and stored at UTC midnight.	Minimum length: 1.
validateOnly	body	No	boolean	When true, validates the request and performs no File lookup, DB creation, Amazon Simple Storage Service (S3) work, Amazon Simple Queue Service (SQS) work, optical character recognition (OCR), or large language model (LLM) processing.	Default: false. 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.

{
  "fileName": "safe-eob.pdf",
  "fileType": "application/pdf",
  "fileSize": 1048576,
  "payerName": "Example Payer",
  "receivedDate": "2026-06-08",
  "validateOnly": true
}

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

The upload request is valid and no side effects were performed.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "VALIDATE_ONLY",
    "validated": true,
    "conversion": null,
    "sideEffects": {
      "s3": "not_performed",
      "sqs": "not_performed",
      "ocrLlm": "not_performed"
    }
  },
  "meta": {
    "organizationId": "org_example_1"
  }
}

201

A DB-only EOB conversion record was created for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "LOCAL_RECORD_ONLY",
    "validated": true,
    "conversion": {
      "id": "eob_job_example_1",
      "organizationId": "org_example_1",
      "status": "PASSED",
      "payerName": "Example Payer",
      "checkNumber": "CHK-1000",
      "totalAmount": "125.50",
      "jobId": "job_example_1",
      "eraStatus": "PAID_IN_FULL",
      "receivedDate": "2026-06-08T00:00:00Z",
      "createdAt": "2026-06-08T10:15:30Z",
      "hasInputFile": true,
      "hasOutputFile": true
    },
    "sideEffects": {
      "s3": "not_performed",
      "sqs": "not_performed",
      "ocrLlm": "not_performed"
    }
  },
  "meta": {
    "organizationId": "org_example_1"
  }
}

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.