Collections

Create bad debt placements

Creates one or more local bad debt placement records after validating that the target agency is active in the authenticated organization.

POSTNeeds publication reviewLocal writeCollectionsoperationId: createBadDebtPlacementshttps://dev-api.quickintell.com/api/v1/collections/placements

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 POST /api/v1/collections/placements. 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 POST /api/v1/collections/placements, 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 integration or workflow has selected accounts to move into QuickRCM collections tracking under a configured active agency.

Before calling

Authenticate with `collections:write`. Resolve `agencyId` from an active agency in the same tenant. Build an `accounts` array with 1 through 100 entries and include only identifiers and balances needed for placement tracking.

Request and response behavior

Request guidance

`agencyId` and `accounts` are required. Each account requires `patientId` and positive `totalBalance`; optional fields include `patientAccountId`, `claimIds`, `debtAgeDays`, `statuteState`, and `debtOriginDate`. If `statuteState` is supplied, provide a parseable `debtOriginDate` so statute metadata can be calculated. Use same-tenant patient/account/claim identifiers, but document this as caller responsibility rather than full public referential validation for every supplied id.

`accounts` must contain at least 1 and at most 100 entries.
`totalBalance` must be a positive number.
Use same-tenant `patientId`, `patientAccountId`, and `claimIds`; the handler stores these as local references.
Do not send raw statements, raw Electronic Data Interchange (EDI), transcripts, portal payloads, payment credentials, or unnecessary demographics.

Response semantics

A 201 response returns created local placement records, `count`, and a `skipped` array for account entries that could not be placed. Created placements are local records with status `PL_PENDING`; when at least one placement is created, the active agency's local `totalPlaced` count is incremented. This endpoint does not transmit debt packages to an external agency.

Created placement status is local placement workflow state.
`skipped` entries include patientId and reason for account-level failures.
This endpoint is local record creation, not external agency submission.

Errors and retries

A 404 means the target active agency was not found in the authenticated organization. A 400 can occur when validation fails or all account entries are invalid. After a timeout, list placements before retrying because the endpoint does not declare idempotent replay behavior.

404 means no active agency matched `agencyId` for the API key organization.
400 can indicate all accounts were invalid, missing required fields, invalid balances, missing debt origin date for statute metadata, or invalid debt origin date.
Retry carefully after network failures to avoid duplicate local placements.

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
agencyId	body	Yes	string	Required active collection agency identifier in the authenticated organization.	Minimum length: 1.
accounts	body	Yes	object[]	Required array of 1 through 100 account placement inputs.	OpenAPI does not declare additional validation metadata.
accounts[].patientId	body	Yes	string	QuickRCM patient identifier. The patient must belong to the organization selected by the bearer API key.	Minimum length: 1. Sensitive credential or storage-adjacent value; use placeholders only.
accounts[].patientAccountId	body	No	string	Optional QuickRCM patient AR account identifier supplied by the caller as a local reference.	Minimum length: 1. Potential PHI; use synthetic examples and avoid logging raw values.
accounts[].claimIds	body	No	string[]	Optional array of QuickRCM claim identifiers supplied by the caller as local references.	Default: .
accounts[].totalBalance	body	Yes	number	Required positive balance amount to place into local collections tracking.	Financial value; preserve decimal precision and avoid real account details.
accounts[].debtAgeDays	body	No	integer	Optional whole number of days the debt has aged.	Minimum value: 0.
accounts[].statuteState	body	No	string	Optional two-character state used for statute-of-limitations metadata.	Minimum length: 2. Maximum length: 2.
accounts[].debtOriginDate	body	No	string	Optional origin date string. Required by current behavior when `statuteState` is supplied.	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.

{
  "agencyId": "00000000-0000-4000-8000-000000000001",
  "accounts": [
    {
      "patientId": "00000000-0000-4000-8000-000000000001",
      "totalBalance": 1,
      "patientAccountId": "00000000-0000-4000-8000-000000000001",
      "claimIds": [],
      "debtAgeDays": 1,
      "statuteState": "example-statutestate",
      "debtOriginDate": "2026-06-08"
    }
  ]
}

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.

201

Bad debt placements created

Generated from the OpenAPI response schema.

{
  "success": true,
  "data": {
    "placements": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "organizationId": "00000000-0000-4000-8000-000000000001",
        "agencyId": "00000000-0000-4000-8000-000000000001",
        "patientId": "00000000-0000-4000-8000-000000000001",
        "patientAccountId": "00000000-0000-4000-8000-000000000001",
        "claimIds": [
          "example-claimids"
        ],
        "status": "PL_PENDING",
        "totalBalance": "example-totalbalance",
        "recoveredAmount": "example-recoveredamount",
        "commissionAmount": "example-commissionamount",
        "propensityScore": "example-propensityscore",
        "debtAgeDays": 1,
        "placementDate": "2026-06-08T10:15:30Z",
        "recallDate": "2026-06-08T10:15:30Z",
        "recallReason": "example-recallreason",
        "statuteOfLimitationsDate": "2026-06-08T10:15:30Z",
        "statuteState": "example-statutestate",
        "agency": {
          "id": "00000000-0000-4000-8000-000000000001",
          "name": "Example bad_debt_placement",
          "status": "CA_ACTIVE"
        },
        "createdAt": "2026-06-08T10:15:30Z",
        "updatedAt": "2026-06-08T10:15:30Z"
      }
    ],
    "count": 1,
    "skipped": [
      {
        "patientId": "00000000-0000-4000-8000-000000000001",
        "reason": "example-reason"
      }
    ]
  }
}

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