ERA

Fetch ERA

Attempts to retrieve an ERA for the authenticated organization using `tradingPartnerServiceId` and `transactionId`, returning normalized ERA details on automated success or a manual-operations acknowledgement when automated retrieval cannot complete.

POSTCompatibility-limitedQueue or asyncERAoperationId: fetchErahttps://dev-api.quickintell.com/v2/era

Compatibility-limitedQueue or asyncClaims 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. Also requires E2 side-effect policy and E3 async and idempotency 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

Queue or async

May return queued work or HTTP 202. Queueing is not completion, and terminal job semantics are endpoint-specific.

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 /v2/era. 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: POST /v2/era.

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

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Versioning Side-Effect Modes Idempotency Async Jobs

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 when an integration already has a payer or trading-partner routing identifier plus the vendor transaction identifier for an ERA retrieval request and wants QuickRCM to retrieve or queue follow-up for that remittance.

Before calling

Authenticate with an API key that has `era:write` scope. Resolve `tradingPartnerServiceId` from the payer or trading-partner context used by QuickRCM routing, and pass the vendor transaction ID exactly as provided by the retrieval workflow. Do not send tenant selectors, raw X12 835 content, payer portal credentials, API keys, OAuth tokens, signed storage URLs, or full vendor payloads.

Request and response behavior

Request guidance

`tradingPartnerServiceId` and `transactionId` are required non-empty strings and are trimmed by the handler. The handler resolves the trading partner to a known payer, then asks the routing service for ERA vendor candidates. This operation can call an external ERA vendor when configured and can write local QuickRCM data because a successful fetch stores or reuses a `Remittance`, while fallback creates a local `Task`.

`tradingPartnerServiceId` is a payer or trading-partner routing value, not an organization selector.
`transactionId` is the vendor transaction identifier used for ERA retrieval and may also serve as the fallback remittance idempotency key when no check number exists.
Do not send raw Electronic Data Interchange (EDI), raw X12 835 files, payer responses, credentials, Protected Health Information (PHI)-heavy notes, or storage keys in this request.

Response semantics

HTTP 200 returns a direct ERA detail object, not a `{ success, data }` envelope. The required top-level response keys are `eraId`, `payer`, `payee`, `payment`, `claims`, and `providerAdjustments`. Nested values can still be empty strings, zero amounts, null nullable fields, or empty arrays when normalized vendor data is incomplete. For service-line `chargeAmount` and `paidAmount`, null means the stored normalized value was absent or null; Stedi-origin missing or unparseable raw service-line amount strings are normalized to 0 before public serialization. HTTP 202 returns a direct acknowledgement with `taskId`, API acknowledgement `status` (`QUEUED` or `IN_PROGRESS`), `message`, and `estimatedCompletion`; it means QuickRCM queued manual work, not that a payer accepted, adjudicated, or posted the remittance.

The 200 response body is the ERA detail object itself.
Claim rows intentionally omit patient name and member ID fields even though internal normalized ERA types can contain them.
Required response objects are still present when source data is sparse; individual strings may be empty, amount fields may be zero, nullable fields may be null, and arrays may be empty.
The 202 response is a local manual-operations queue acknowledgement, not a remittance retrieval success, remittance posting, payer acceptance, or the internal Task row status.
Service-line `chargeAmount` and `paidAmount` are nullable in the public schema and serializer; Stedi-origin missing or unparseable raw service-line amount strings currently arrive at the serializer as 0.

Errors and retries

Treat 400 as invalid request shape or unknown payer routing, 401 as missing or invalid authentication, 403 as missing ERA scope or authorization failure, and 429 as a backoff signal. If a 200 response is lost after a timeout, retrying the same transaction may reuse the existing Remittance by check number or by `ERA-${transactionId}` when no check number exists. If a 202 response is lost, re-check local task or remittance state before retrying because manual fallback task creation is not documented as idempotent.

400 can mean a required string is blank or the trading partner cannot be resolved to a known payer.
403 means the API key is missing an accepted ERA scope or is not authorized for the resource.
Retry 429 or transient 5xx responses with backoff and state checks to avoid duplicate manual work.

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
tradingPartnerServiceId	body	Yes	string	Required payer or trading-partner service identifier used by QuickRCM to resolve payer routing for ERA retrieval. It is trimmed and must not be blank. It is not a tenant selector.	Minimum length: 1. Tenant context is selected by the API key; do not treat this as a public tenant selector.
transactionId	body	Yes	string	Required vendor transaction identifier for the ERA retrieval request. It is trimmed and can be used as a fallback Remittance lookup key when the retrieved ERA has no check number.	Minimum length: 1.

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.

{
  "tradingPartnerServiceId": "00000000-0000-4000-8000-000000000001",
  "transactionId": "00000000-0000-4000-8000-000000000001"
}

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

Fetched ERA details for the authenticated organization.

Generated from the OpenAPI response schema.

{
  "eraId": "00000000-0000-4000-8000-000000000001",
  "payer": {
    "payerId": "87726",
    "payerName": "Example fetch_era",
    "address": {
      "address1": "example-address1",
      "city": "example-city",
      "state": "example-state",
      "postalCode": "example-postalcode"
    }
  },
  "payee": {
    "npi": "1234567893",
    "name": "Example fetch_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 fetch_era note",
      "chargeAmount": 125.5,
      "paidAmount": 125.5,
      "patientResponsibility": 1.25,
      "adjustments": [
        {
          "groupCode": "example-groupcode",
          "groupCodeDescription": "Example fetch_era note",
          "reasonCode": "example-reasoncode",
          "reasonCodeDescription": "Example fetch_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 fetch_era note"
        }
      ]
    }
  ],
  "providerAdjustments": [
    {
      "adjustmentCode": "example-adjustmentcode",
      "adjustmentDescription": "Example fetch_era note",
      "amount": 125.5,
      "referenceId": "00000000-0000-4000-8000-000000000001"
    }
  ]
}

202

ERA retrieval was queued for manual operations.

Generated from the OpenAPI response schema.

{
  "taskId": "00000000-0000-4000-8000-000000000001",
  "status": "QUEUED",
  "message": "Request failed",
  "estimatedCompletion": "2026-06-08T10:15:30Z"
}

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.