ERA

Get ERA

Returns stored normalized ERA details for one remittance when the `eraId` belongs to the organization selected by the bearer API key and stored detail data is available.

GETCompatibility-limitedRead-onlyERAoperationId: getErahttps://dev-api.quickintell.com/v2/era/{eraId}

Compatibility-limitedRead-onlyClaims and remittances

Route status

Compatibility-limited

Existing route is visible but version, behavior, or route-class semantics are not stable enough for happy-path guides.

Publication status

Compatibility-limited; not for happy-path guides

Requires versioning and compatibility-route classification before broad use.

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

Read-only

Reads tenant-scoped data only unless the endpoint description explicitly states an external lookup.

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 GET /v2/era/{eraId}. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.

What this does now

Shows an existing generated route for compatibility review: GET /v2/era/{eraId}.

What this does not do

Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior.

Not public from this page

Do not use this endpoint in public quickstarts or SDKs until the compatibility decision is 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	Read request; no mutation idempotency contract needed.	Use ordinary safe-read retry behavior with rate-limit backoff.
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

Compatibility routes must stay out of quickstarts, SDKs, and happy-path workflow guides until classified.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Versioning

Evidence

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

ERA public API.

ERA public APIs expose organization-scoped Electronic Remittance Advice (ERA) retrieval and stored remittance access. The bearer API key selects the organization; public requests should not include `organizationId` or `orgId` tenant selectors. The current public surface has two operations. `fetchEra` accepts a payer or trading-partner routing identifier plus a vendor transaction identifier, then attempts configured ERA vendor retrieval. When an automated vendor returns normalized details, QuickRCM stores or reuses a `Remittance` record and returns a direct sanitized ERA detail object. When no configured vendor is available or all vendor attempts fail, the endpoint creates a local high-priority manual task and returns HTTP 202 with an API acknowledgement. `getEra` reads a stored remittance by `eraId` only when that remittance belongs to the API-key organization and contains stored ERA detail data. address` can be null, address subfields can be null when an address object exists, claim status descriptions and service-line fields can be null, provider-adjustment reference IDs can be null, and arrays can be empty. The public serializer keeps the response shape stable for incomplete normalized vendor data. Docs should state that required string fields may be empty strings, required numeric amount fields may be zero, nullable fields may be null, and arrays may be empty when the underlying normalized ERA does not contain that value. For service-line amount fields, the public schema and serializer allow null when stored normalized service-line `chargeAmount` or `paidAmount` is absent or null; current Stedi-origin normalization maps missing or unparseable raw service-line amount strings to 0 before serialization. ERA detail responses intentionally omit patient names and member identifiers from claim rows. Do not describe these endpoints as payment posting, cash posting, denial creation, claim adjudication, payer acceptance, or direct raw X12 835 Electronic Data Interchange (EDI) remittance export. Route governance currently classifies ERA as compatibility-limited, so reference pages should document behavior with caveats and avoid happy-path guide language until route-class and release evidence change.

What this endpoint does

Use case

Use this endpoint after `fetchEra` returns an `eraId`, after a manual workflow produces a stored remittance, or when an integration needs to re-read sanitized ERA details already saved in QuickRCM.

Before calling

Authenticate with an API key that has `era:read` or `era:write` scope. Use only an `eraId` obtained from a trusted QuickRCM response in the same tenant context. Do not include `organizationId`, query filters, raw X12 835 content, payer credentials, or full vendor payloads.

Request and response behavior

Request guidance

`eraId` is the only public selector and is required in the path. The query schema is empty. The handler looks up `Remittance.findFirst({ where: { id: eraId, organizationId } })`, so wrong-organization IDs do not return details.

`eraId` must come from the same organization context as the bearer API key.
No query parameters are documented for this endpoint.
Do not use this endpoint to request raw X12 835 files, payer portal payloads, or payment posting side effects.

Response semantics

HTTP 200 returns the direct sanitized ERA detail object with the same public response shape as successful `fetchEra`. The required top-level response keys are `eraId`, `payer`, `payee`, `payment`, `claims`, and `providerAdjustments`. Service-line `chargeAmount` and `paidAmount` are nullable when stored normalized values are absent or null; records originally normalized from Stedi may contain 0 for missing or unparseable raw service-line amount strings. The response is read-only access to stored normalized detail data. It does not post payments, create denial records, submit claims, expose raw X12 835 loops, or prove payer-side state beyond what was stored in the remittance.

The response body is the ERA detail object itself.
Claim rows omit patient names and member identifiers.
A 200 response means stored detail data was available for the tenant-scoped remittance.
Required response objects are still present when stored normalized data is sparse; individual strings may be empty, amount fields may be zero, nullable fields may be null, and arrays may be empty.
Service-line `chargeAmount` and `paidAmount` are nullable for absent or null stored normalized values; Stedi-origin stored details may use 0 where the raw service-line amount string was missing or unparseable.

Errors and retries

Treat 404 as either a missing remittance, a wrong-tenant remittance ID, or a remittance without stored ERA detail data. Retry 429 and transient 5xx responses with backoff. Do not retry 401 or 403 without correcting credentials or scopes.

404 can hide wrong-tenant remittance IDs and can also mean stored detail data is unavailable.
403 means the API key is missing an accepted ERA scope or is not authorized for the resource.
429 should be retried 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

Name	Location	Required	Type	Description	Validation and safety notes
eraId	path	Yes	string	QuickRCM remittance identifier in the path and response. The remittance must belong to the organization selected by the bearer API key and must have stored ERA detail data.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.

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.

This endpoint does not define a JSON request body.

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.

No request example is declared.

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

Stored ERA details for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "eraId": "00000000-0000-4000-8000-000000000001",
  "payer": {
    "payerId": "87726",
    "payerName": "Example era",
    "address": {
      "address1": "example-address1",
      "city": "example-city",
      "state": "example-state",
      "postalCode": "example-postalcode"
    }
  },
  "payee": {
    "npi": "1234567893",
    "name": "Example era",
    "tin": "example-tin"
  },
  "payment": {
    "checkNumber": "example-checknumber",
    "checkDate": "2026-06-08",
    "checkAmount": 125.5,
    "paymentMethod": "example-paymentmethod",
    "eftTraceNumber": "example-efttracenumber"
  },
  "claims": [
    {
      "patientControlNumber": "example-patientcontrolnumber",
      "payerClaimControlNumber": "example-payerclaimcontrolnumber",
      "claimStatus": "example-claimstatus",
      "claimStatusDescription": "Example era note",
      "chargeAmount": 125.5,
      "paidAmount": 125.5,
      "patientResponsibility": 1.25,
      "adjustments": [
        {
          "groupCode": "example-groupcode",
          "groupCodeDescription": "Example era note",
          "reasonCode": "example-reasoncode",
          "reasonCodeDescription": "Example era note",
          "amount": 125.5
        }
      ],
      "serviceLines": [
        {
          "procedureCode": "example-procedurecode",
          "serviceDate": "2026-06-08",
          "chargeAmount": 125.5,
          "paidAmount": 125.5,
          "lineNumber": 1
        }
      ],
      "remarkCodes": [
        {
          "code": "ERROR",
          "description": "Example era note"
        }
      ]
    }
  ],
  "providerAdjustments": [
    {
      "adjustmentCode": "example-adjustmentcode",
      "adjustmentDescription": "Example era note",
      "amount": 125.5,
      "referenceId": "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.