Collections

Update collections compliance rule

Replaces the editable body-backed fields on a collections compliance rule after an organization-scoped rule lookup.

PUTNeeds publication reviewLocal writeCollectionsoperationId: updateCollectionsComplianceRulehttps://dev-api.quickintell.com/api/v1/collections/compliance/rules/{ruleId}

Needs publication reviewLocal writePatient financials

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

Local write

May mutate QuickRCM records. It does not prove live payer, EHR, clearinghouse, payment, or communication execution.

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 patient financials contract generated for PUT /api/v1/collections/compliance/rules/{ruleId}. 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/collections/compliance/rules/{ruleId}, 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.

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

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

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.

Collections public API.

Collections APIs expose organization-scoped collection agency configuration, local bad debt placement tracking, recovery posting, placement dispute notes, safe debt validation notice simulation or queue evidence, and collections compliance rule/check workflows. The bearer API key selects the organization. Public callers should not send an `organizationId` tenant selector. The public handlers enforce organization scope when looking up collection agencies, bad debt placements, and compliance rules. For caller-supplied `patientId`, `patientAccountId`, and `claimIds` in placement creation, callers should use identifiers from the same authenticated organization; the public placement create endpoint stores those local references and does not document full referential validation for every supplied patient, account, or claim. For compliance checks, an optional `placementId` is used only for organization-scoped enrichment when found. These endpoints manage QuickRCM local workflow state and audit evidence. They do not by themselves transmit debt to an external agency, send mail, email, or SMS, collect payment, post cash, update payer systems, or create legal compliance guarantees. Use synthetic examples only, and keep request notes free of Protected Health Information (PHI), credentials, tokens, raw Electronic Data Interchange (EDI), transcripts, S3 keys, payer portal credentials, payment card details, and vendor payloads. Compliance language should expand Telephone Consumer Protection Act (TCPA) and Fair Debt Collection Practices Act (FDCPA) on first use and avoid presenting local checks as legal advice.

What this endpoint does

Use case

Use this when an existing local compliance rule needs a new name, type, threshold set, state, description, or active flag.

Before calling

Authenticate with `collections:write`, retrieve the existing rule, and send the intended complete rule body. This endpoint is not a partial PATCH.

Request and response behavior

Request guidance

`ruleName` and `ruleType` are required on update. Omitted optional fields are written as null by the current upsert path: `description`, `maxCallsPerWeek`, `noCallBeforeHour`, `noCallAfterHour`, `debtValidationDays`, and `state`. Omitted `isActive` defaults to true, which can reactivate a previously disabled rule. Include every value you want to preserve.

Always send the full intended rule state.
Include `isActive: false` explicitly when the rule should remain disabled.
Do not describe this endpoint as a PATCH-style partial update.

Response semantics

The response returns the updated local rule. The update can affect future compliance checks but does not retroactively update past check results or perform outreach.

Returned threshold fields reflect replacement semantics.
The returned rule is local configuration, not legal advice.

Errors and retries

Treat 400 as missing required ruleName/ruleType or invalid threshold values. Treat 404 as missing or wrong-organization rule context. Re-read after timeouts before retrying to avoid clearing or reactivating fields unintentionally.

400 can indicate required fields were omitted even though the route is named update.
404 can hide wrong-tenant rule identifiers.

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
ruleId	path	Yes	string	QuickRCM collections compliance rule identifier from 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.

Name	Location	Required	Type	Description	Validation and safety notes
ruleName	body	Yes	string	Required on update. Human-readable rule name to store.	Minimum length: 1. Maximum length: 200.
ruleType	body	Yes	string	Required on update. Organization-local rule classification to store.	Minimum length: 1. Maximum length: 80.
description	body	No	string	Human-readable description of the queue, workflow, or record. Avoid secrets and unnecessary PHI.	Minimum length: 1. Maximum length: 1000. Sensitive credential or storage-adjacent value; use placeholders only.
maxCallsPerWeek	body	No	integer	Optional collections compliance rule threshold for maximum weekly calls, from 0 through 100.	Minimum value: 0. Maximum value: 100.
noCallBeforeHour	body	No	integer	Optional earliest contact hour in 24-hour local time, from 0 through 23.	Minimum value: 0. Maximum value: 23.
noCallAfterHour	body	No	integer	Optional latest contact hour in 24-hour local time, from 0 through 23.	Minimum value: 0. Maximum value: 23.
debtValidationDays	body	No	integer	Optional compliance rule threshold for debt validation timing, from 0 through 365.	Minimum value: 0. Maximum value: 365.
state	body	No	string	US state, provider state, submitter state, or workflow state depending on context.	Minimum length: 2. Maximum length: 2.
isActive	body	No	boolean	Optional in schema but defaults to true when omitted by the current upsert path; send false explicitly to keep a rule inactive.	OpenAPI does not declare additional validation metadata.

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.

{
  "ruleName": "Example collections_compliance_rule",
  "ruleType": "example-ruletype",
  "description": "Example collections_compliance_rule note",
  "maxCallsPerWeek": 1,
  "noCallBeforeHour": 1,
  "noCallAfterHour": 1,
  "debtValidationDays": 1,
  "state": "example-state",
  "isActive": true
}

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

Collections compliance rule updated

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "organizationId": "00000000-0000-4000-8000-000000000001",
    "ruleName": "Example collections_compliance_rule",
    "ruleType": "example-ruletype",
    "description": "Example collections_compliance_rule note",
    "maxCallsPerWeek": 1,
    "noCallBeforeHour": 1,
    "noCallAfterHour": 1,
    "debtValidationDays": 1,
    "state": "example-state",
    "isActive": true,
    "createdAt": "2026-06-08T10:15:30Z",
    "updatedAt": "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