EOB to ERA

Bulk update EOB to ERA conversions

Bulk-updates safe public fields on Explanation of Benefits (EOB) to Electronic Remittance Advice (ERA) conversion records whose IDs belong to the authenticated organization.

PUTPublic reference baselineLocal writeEOB to ERAoperationId: bulkUpdateEob2EraConversionshttps://dev-api.quickintell.com/api/v1/eob2era/conversions/bulk

Public reference baselineLocal writeClaims 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 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 claims and remittances contract generated for PUT /api/v1/eob2era/conversions/bulk. 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/eob2era/conversions/bulk 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.

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 this for internal review workflows that need to move multiple local conversion records to a shared status or apply a sanitized operator note.

Before calling

Authenticate with `eob2era:write`. Collect up to 500 conversion IDs from the same tenant and decide whether to update `status`, `note`, or both.

Request and response behavior

Request guidance

`ids` is required and accepts 1 through 500 identifiers. Send at least one editable field: `status` and/or `note`. Keep notes short, sanitized, and free of Protected Health Information (PHI), raw Electronic Data Interchange (EDI), Amazon Simple Storage Service (S3) keys, credentials, transcripts, and raw payer payloads.

`ids` must contain at least one and at most 500 conversion identifiers.
`status` must be one of the EOB conversion job status enum values when supplied.
No output file links, processing side effects, or classification changes are performed by this endpoint.

Response semantics

HTTP 200 returns mode SAFE_WRITE_DB_ONLY, `requested`, and `updated`. The handler uses an organization-scoped updateMany; `updated` can be lower than `requested` when IDs are missing, already filtered out by tenant scope, or otherwise not updated.

`requested` is the number of ids supplied.
`updated` is the number of organization-owned records affected by the update.
The response does not list per-id success or failure details.

Errors and retries

Fix empty id arrays, too-large batches, invalid statuses, or missing update fields after a 400. After a timeout, list or read affected conversions before retrying to avoid duplicate note/status writes.

400 can mean no editable fields were supplied.
403 means the caller lacks write access.
This endpoint does not declare a 404 for individual missing IDs; use the updated count and follow-up reads.

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
ids	body	Yes	string[]	Array of EOB to ERA conversion identifiers to update. The update remains scoped to the API key organization.	Sensitive credential or storage-adjacent value; use placeholders only.
status	body	No	PENDING \| UPLOADED \| PROCESSING \| COMPLETED \| PASSED \| REQUIRED_CORRECTION \| HUMAN_IN_LOOP \| FAILED \| INVALID	Optional target local EOB conversion job status.	Enum values are declared in the Type column.
note	body	No	string	Optional sanitized operator note. The note can be updated but is not exposed in sanitized conversion responses.	Maximum length: 2000.

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.

{
  "ids": [
    "example-ids"
  ],
  "status": "PENDING",
  "note": "Example update_eob2_era_conversion note"
}

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

Bulk update result for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "mode": "SAFE_WRITE_DB_ONLY",
    "requested": 1,
    "updated": 1
  },
  "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.