QuickRCM API Docs

Payment Posting

Update remittance status

Updates the local workflow status on one organization-owned remittance and returns the refreshed sanitized remittance summary.

PUTNeeds publication reviewPayment or creditPayment PostingoperationId: updatePaymentPostingRemittanceStatushttps://dev-api.quickintell.com/api/v1/payment-posting/remittances/{remittanceId}/status
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 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 PUT /api/v1/payment-posting/remittances/{remittanceId}/status. 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 PUT /api/v1/payment-posting/remittances/{remittanceId}/status, 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.

HeaderRequiredCurrent statusNotes
AuthorizationYesCurrentBearer <QUICKRCM_API_KEY>. OpenAPI security: bearerAuth.
Idempotency-KeyNoTarget/futureDo not claim universal header support until E3 and OpenAPI metadata exist.
X-Request-IdNoTarget/futureUse 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.

TopicStatusGuidance
Current idempotencyNo idempotency mechanism is declared.Do not retry blindly. Check resource, status, batch, or job state before repeating the request.
Universal headerNot declaredDo not document universal Idempotency-Key support until OpenAPI and E3 evidence declare it.
Conflict behaviorUnresolvedSame-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.

TopicStatusGuidance
Immediate responseNo 202 response declaredOpenAPI does not declare HTTP 202 for this operation.
Polling and terminal statesEndpoint-specificUse only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
Later side effectsNot provenDo 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.

TopicStatusGuidance
Content classNo file/artifact class inferredOpenAPI text does not indicate file or artifact handling for this endpoint.
Ownership and storage keysNot applicable unless a file field is presentTenant ownership must be proven before retrieval or upload docs. Never expose storage keys as public identifiers.
URLs, scanning, and retentionUnresolved unless endpoint-specific evidence existsShort-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.
  • Universal Idempotency-Key header support is not declared; retry only after checking endpoint-specific state.

Related platform rules

Workflow GuideRoute StatusTenant ContextErrorsRate LimitsPHI and SecurityPublication ReadinessSide-Effect ModesIdempotency

Evidence

EvidenceStatusCaveat
OpenAPI artifactdocs/openapi/openapi.json; OpenAPI 3.1.0; API 1.0.0.Generated baseline contract only.
Route registryNeeds publication review from documentation classification overlay.E6 route registry evidence is still required before external publication.
Example validationGenerated examples are internal baseline aids.No external publication claim; examples must pass no-PHI/no-secret/no-raw-payload/no-storage-key checks.
Last reviewedImplementation run 20260619T-docs-impl; source boardroom packet 20260619T064820Z.Refresh this evidence for release workspaces.
Release evidenceE9 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 when an integration or operator workflow needs to mark local remittance review, match, posting, or closure state without changing financial metadata.
Before calling
Authenticate with `payment-posting:write`, use a same-organization `remittanceId`, and choose one public remittance status enum value.

Request and response behavior

Request guidance
`status` is required and must be PROCESSING, RECEIVED, MATCHED, PARTIALLY_MATCHED, UNMATCHED, REQUIRES_REVIEW, POSTED, PARTIALLY_POSTED, or CLOSED. Do not use this endpoint to post payments or modify claim balances.
    Response semantics
    HTTP 200 returns `data.remittance`, the sanitized remittance summary after the status update. The status is local QuickRCM workflow state.

      Errors and retries

      Fix 400 invalid enum values before retrying. Treat 404 as missing or wrong-organization remittance. After timeouts, re-read the remittance before repeating the status update.
      • Fix 400 invalid enum values before retrying. Treat 404 as missing or wrong-organization remittance. After timeouts, re-read the remittance before repeating the status update.

      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

      NameLocationRequiredTypeDescriptionValidation and safety notes
      remittanceIdpathYesstringQuickRCM remittance identifier in the path.Minimum length: 1.

      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.

      NameLocationRequiredTypeDescriptionValidation and safety notes
      statusbodyYesPROCESSING | RECEIVED | MATCHED | PARTIALLY_MATCHED | UNMATCHED | REQUIRES_REVIEW | POSTED | PARTIALLY_POSTED | CLOSEDRequired local remittance workflow status to store on the remittance.Enum values are declared in the Type column.

      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.

      {
  "status": "PROCESSING"
}

      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
      Updated remittance status.
      Generated from the OpenAPI response schema.
      {
  "success": true,
  "data": {
    "remittance": {
      "id": "00000000-0000-4000-8000-000000000001",
      "organizationId": "00000000-0000-4000-8000-000000000001",
      "checkNumber": "example-checknumber",
      "checkDate": "2026-06-08T10:15:30Z",
      "paymentMethod": "example-paymentmethod",
      "totalAmount": "example-totalamount",
      "payerName": "Example payment_posting_remittance_statu",
      "payerId": "87726",
      "status": "PROCESSING",
      "matchRate": "example-matchrate",
      "overallConfidence": "HIGH",
      "paymentCount": 1,
      "remittanceClaimCount": 1,
      "postedClaimCount": 1,
      "unmatchedClaimCount": 1,
      "createdAt": "2026-06-08T10:15:30Z"
    }
  },
  "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.
      Handle this response as normal integration control flow.
      {
  "error": "Request validation failed",
  "statusCode": 400
}
      401
      Authentication required or invalid credentials.
      Handle this response as normal integration control flow.
      {
  "error": "Authentication required",
  "statusCode": 401
}
      403
      The requested organization does not match the authenticated caller.
      Handle this response as normal integration control flow.
      {
  "error": "Forbidden",
  "statusCode": 403
}
      404
      Requested payment posting resource was not found in the authenticated organization.
      Handle this response as normal integration control flow.
      {
  "error": "Resource not found",
  "statusCode": 404
}
      429
      API key rate limit exceeded.
      Handle this response as normal integration control flow.
      {
  "error": "Rate limit exceeded",
  "statusCode": 429
}
      500
      Internal server error.
      Handle this response as normal integration control flow.
      {
  "error": "Internal server error",
  "statusCode": 500
}

      Adjacent endpoints

      Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.

      POSTNeeds publication reviewPayment or credit
      Dry-run payer ID refresh
      /api/v1/payment-posting/payers/refresh
      GETNeeds publication reviewPayment or credit
      Get posted payment
      /api/v1/payment-posting/payments/{paymentId}
      GETNeeds publication reviewPayment or credit
      List payment posting remittances
      /api/v1/payment-posting/remittances
      POSTNeeds publication reviewPayment or credit
      Match remittance claims
      /api/v1/payment-posting/remittances/{remittanceId}/match
      PUTNeeds publication reviewPayment or credit
      Update remittance metadata
      /api/v1/payment-posting/remittances/{remittanceId}
      POSTNeeds publication reviewPayment or credit
      Validate direct payment posting
      /api/v1/payment-posting/remittance-claims/{remittanceClaimId}/post-payment
      All endpoint pagesOpen Scalar reference
      Update remittance status | QuickRCM API Docs | QuickRCM API Docs