Appeals
Get appeal payer compliance report
Returns payer-focused appeal compliance report data for the authenticated organization.
operationId: getAppealPayerComplianceReporthttps://dev-api.quickintell.com/api/v1/appeals/compliance-reports/payerRoute 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, E4 file and artifact governance, and E7 credential, webhook, and vendor trust 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
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 claims and denials contract generated for GET /api/v1/appeals/compliance-reports/payer. External use still depends on route classification, release evidence, and endpoint-specific side-effect approval.
What this does now
Documents the generated GET /api/v1/appeals/compliance-reports/payer contract as a file or artifact baseline endpoint.
What this does not do
Does not prove external GA readiness, SDK readiness, live production execution, or complete module behavior. Read behavior still needs release evidence before broad external publication.
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 | 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 | 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
- File and artifact examples must stay metadata-only until scanning, retention, ownership, and URL policy are approved.
- External or credentialed behavior needs vendor trust, credential, webhook, and callback evidence before publication.
Related platform rules
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. |
Appeals public API.
What this endpoint does
Request and response behavior
Errors and retries
Template boundary before examples
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 lower ISO datetime bound for the payer compliance report period. | Format: date-time. |
| endDate | query | No | string (date-time) | Optional upper ISO datetime bound for the payer compliance report period. | Format: date-time. |
| payerId | query | No | string | QuickRCM payer configuration identifier. | Minimum length: 1. |
| payerName | query | No | string | Payer name filter for the report. | Minimum length: 1. Maximum length: 255. |
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.
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.
Adjacent endpoints
Nearby generated endpoints in the same OpenAPI tag. Route class and side-effect labels still apply per endpoint.