Reports

Get reports summary

Returns the `revenue-cycle-summary` report for the authenticated organization, with aggregate claim and denial counts by status plus decimal-string money totals.

GETNeeds publication reviewFile or artifactReportsoperationId: getReportsSummaryhttps://dev-api.quickintell.com/api/v1/reports/summary

Needs publication reviewFile or artifactReporting

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 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 reporting contract generated for GET /api/v1/reports/summary. 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 GET /api/v1/reports/summary, 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.

Not public from this page

Raw file contents, storage keys, signed URLs, and generated artifacts are not public from this page.

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	Endpoint-specific	Use only operation-specific status endpoints visible in OpenAPI; generic job behavior, cancellation, retries, and retention are unresolved.
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

This endpoint needs explicit product, security/compliance, tenancy, or side-effect approval before publication.
File and artifact examples must stay metadata-only until scanning, retention, ownership, and URL policy are approved.
Reports need aggregation, freshness, filtering, suppression, and export policy before publication.

Related platform rules

Workflow Guide Route Status Tenant Context Errors Rate Limits PHI and Security Publication Readiness Side-Effect Modes 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	Needs publication review 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.

Reports public API.

Reports public APIs expose a narrow, organization-scoped reporting surface: catalog discovery and one aggregate revenue-cycle summary. The bearer API key determines the authenticated organization; public callers should not send `organizationId` or `orgId` as tenant selectors. Use the catalog endpoint to discover public report definitions, supported filter identifiers, metric identifiers, and whether a report is `AVAILABLE` or `PLANNED`. Use the summary endpoint for the currently implemented `revenue-cycle-summary` aggregate metrics across claims and denial cases. The summary response is deliberately aggregate-only and omits patient-level rows, payer payloads, raw Electronic Data Interchange (EDI), raw Electronic Health Record (EHR) responses, and clinical-note text. Existing Reports module docs describe custom report builder, scheduled delivery, CSV/PDF exports, email delivery, and optional EHR archive behavior as placeholder or planned scope. Do not document those capabilities as implemented public API behavior unless a later OpenAPI operation explicitly exposes them.

What this endpoint does

Use case

Use this endpoint for lightweight organization-level revenue-cycle dashboards, integration health checks, or reporting snapshots that need aggregate claim and denial metrics without exporting patient, payer, EDI, or clinical-note detail.

Before calling

Authenticate with an API key accepted for Reports public API reads, such as one with `reports:read` or `reports:write`. Choose explicit UTC date bounds when a client needs a repeatable reporting period, and send `facilityId` only when the client needs to narrow metrics to one facility in the authenticated organization.

Request and response behavior

Request guidance

Send optional query parameters only. `startDate` and `endDate` are ISO 8601 date-time strings; when both are supplied, `startDate` must be before or equal to `endDate`. `facilityId` is an optional non-empty string. The endpoint does not declare a request body and does not accept a tenant selector.

The API key selects the organization; do not include `organizationId` or `orgId`.
If date filters are omitted, the response period fields are `null`; the public contract does not promise a default reporting window.
The OpenAPI contract does not declare a 404 response for an unknown `facilityId`; clients should treat facility validation as tenant-scoped input validation rather than resource retrieval.

Response semantics

HTTP 200 returns `success`, `data`, and `meta`. `data.reportId` is fixed to `revenue-cycle-summary`; `period` and `filters` echo the effective filters; `metrics.claims` and `metrics.denials` contain aggregate status-count maps and decimal-string money fields. Status-map keys are local status labels and are not fixed by the OpenAPI schema.

`reportId` is currently always `revenue-cycle-summary`.
`claims.total` and `denials.total` are aggregate counts derived from returned status-count maps.
`totalCharges`, `totalPaid`, `patientBalance`, `deniedAmount`, and `paidAmount` are serialized as decimal strings, not JSON numbers.
The response intentionally omits patient names, member IDs, payer payloads, raw EDI, raw EHR responses, transcripts, and clinical-note text.

Errors and retries

Treat 400 as invalid query shape, invalid date-time, or invalid date ordering; 401 as missing or invalid authentication; 403 as missing or insufficient Reports/public API scope; 429 as rate limiting; and 5xx as potentially transient. Correct 400/401/403 before retrying, and use bounded backoff for 429 or transient 5xx.

400 can include invalid ISO date-time values or `startDate` later than `endDate`.
403 indicates the API key is authenticated but not accepted for this Reports public API endpoint.
Retry 429 with backoff instead of repeated immediate polling.

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

Name	Location	Required	Type	Description	Validation and safety notes
startDate	query	No	string (date-time)	Optional inclusive UTC start of the reporting period, supplied as an ISO 8601 date-time query parameter.	Format: date-time.
endDate	query	No	string (date-time)	Optional inclusive UTC end of the reporting period, supplied as an ISO 8601 date-time query parameter. When paired with `startDate`, it must be greater than or equal to `startDate`.	Format: date-time.
facilityId	query	No	string	Optional facility filter applied inside the authenticated organization context.	Minimum length: 1.

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

Organization-scoped revenue-cycle summary metrics.

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "reportId": "revenue-cycle-summary",
    "organizationId": "00000000-0000-4000-8000-000000000001",
    "period": {
      "startDate": "2026-06-08T10:15:30Z",
      "endDate": "2026-06-08T10:15:30Z"
    },
    "filters": {
      "facilityId": "00000000-0000-4000-8000-000000000001"
    },
    "metrics": {
      "claims": {
        "total": 1,
        "byStatus": {},
        "totalCharges": "125.50",
        "totalPaid": "125.50",
        "patientBalance": "125.50"
      },
      "denials": {
        "total": 1,
        "byStatus": {},
        "deniedAmount": "125.50",
        "paidAmount": "125.50"
      }
    }
  },
  "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.