← Technical API reference

Frontend module · STATIC DECLARATIONS

Tax Setup client API reference · mansoq-web

9 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Client contract scope

These 9 declarations come from repositories/platform/mansoq-web/src/types/rcm/taxSetup.ts. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints.

Operation map

Client method HTTP method Path pattern Resolution
taxSetupApi.rules GET /api/v1/facility/{facilityId}/rcm/tax_rules/ literal
taxSetupApi.list GET /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/ literal
taxSetupApi.create POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/ literal
taxSetupApi.update PATCH /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/ literal
taxSetupApi.transition POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/transition/ literal
taxSetupApi.activate POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/activate/ literal
taxSetupApi.suspend POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/suspend/ literal
taxSetupApi.newVersion POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/new-version/ literal
taxSetupApi.bindPackage POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/bind-package/ literal

taxSetupApi.rules

GET /api/v1/facility/{facilityId}/rcm/tax_rules/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

response type: PaginatedResponse<TaxRuleOption>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

Field Type Required Description
count number true —
results TItem[] true —

TaxRuleOption declared fields:

Field Type Required Description
id string true —
category string true —
treatment string true —
rate_percent StatedValue true —
lifecycle LifecycleBlock true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.list

GET /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

response type: PaginatedResponse<TaxAllocationPolicy>. client-side declaration; not proof of accepted server payload.

TaxAllocationPolicy declared fields:

Field Type Required Description
id string true —
provider_contract RowRef true —
category string true —
weights_bps Partial<Record<"insurer" | "patient" | "state", number>> true —
allocation_basis string true —
lifecycle LifecycleBlock true —
evidence EvidenceBlock true —
gates GateBlock true —

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.create

POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId. Transport strings are declared here; semantic identifier types require the server contract.

request type: TaxAllocationBody. client-side declaration; not proof of accepted server payload.

response type: TaxAllocationPolicy. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.update

PATCH /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.

request type: TaxAllocationBody. client-side declaration; not proof of accepted server payload.

response type: TaxAllocationPolicy. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.transition

POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/transition/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.

request type: unknown. client-side declaration; not proof of accepted server payload.

response type: TaxAllocationPolicy. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.activate

POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/activate/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.

request type: unknown. client-side declaration; not proof of accepted server payload.

response type: TaxAllocationPolicy. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.suspend

POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/suspend/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.

request type: unknown. client-side declaration; not proof of accepted server payload.

response type: TaxAllocationPolicy. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.newVersion

POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/new-version/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.

request type: unknown. client-side declaration; not proof of accepted server payload.

response type: TaxAllocationPolicy. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

taxSetupApi.bindPackage

POST /api/v1/facility/{facilityId}/rcm/tax_allocation_policies/{id}/bind-package/. typed route object; literal. single static method/path match; deployment boundary still requires review.

Path parameters: facilityId, id. Transport strings are declared here; semantic identifier types require the server contract.

request type: object. client-side declaration; not proof of accepted server payload.

taxSetupApi.bindPackage.request declared fields:

Field Type Required Description
package string true —
lock_token string true —

response type: TaxAllocationPolicy. client-side declaration; not proof of accepted server payload.

Operational limitation: request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use.

Pinned source evidence

Links require access to the private source repository.