MANSOQ Frontend module · STATIC DECLARATIONS
Price List Api client API reference · mansoq-web
17 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 17 declarations come from repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.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 |
|---|---|---|---|
| default.tariffs | GET | /api/v1/facility/{facilityId}/rcm/tariffs/ |
literal |
| default.tariff | GET | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/ |
literal |
| default.tariffLines | GET | /api/v1/facility/{facilityId}/rcm/tariff_lines/ |
literal |
| default.dryRun | GET | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/dry-run/ |
literal |
| default.diff | POST | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/diff/ |
literal |
| default.simulatedEncounter | POST | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/simulated-encounter/ |
literal |
| default.makerChecker | GET | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/maker-checker/ |
literal |
| default.publish | POST | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/publish/ |
literal |
| default.tariffReadiness | GET | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/readiness/ |
literal |
| default.newTariffVersion | POST | /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/new-version/ |
literal |
| default.assignments | GET | /api/v1/facility/{facilityId}/rcm/tariff_assignments/ |
literal |
| default.assignmentReadiness | GET | /api/v1/facility/{facilityId}/rcm/tariff_assignments/{assignmentId}/readiness/ |
literal |
| default.basePriceSchedules | GET | /api/v1/facility/{facilityId}/rcm/base_price_schedules/ |
literal |
| default.basePriceScheduleLines | GET | /api/v1/facility/{facilityId}/rcm/base_price_schedule_lines/ |
literal |
| default.packages | GET | /api/v1/facility/{facilityId}/rcm/packages/ |
literal |
| default.services | GET | /api/v1/facility/{facilityId}/rcm/services/ |
literal |
| default.serviceCodeMappings | GET | /api/v1/facility/{facilityId}/rcm/service_code_mappings/ |
literal |
default.tariffs
GET /api/v1/facility/{facilityId}/rcm/tariffs/. 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: PaginatedRcm<Tariff>. client-side declaration; not proof of accepted server payload.
PaginatedRcm declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | T[] | true | — |
Tariff declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | true | — |
| label | string | true | — |
| currency | string | true | — |
| default_method | StatedText | true | — |
| unit_basis | StatedText | true | — |
| precision_dp | StatedValue | true | — |
| states_its_billing_basis | boolean | true | A tariff that does not say what unit it prices in cannot be traceable. |
| owner_org | RcmRef | null | true | — |
| authority_agreement | RcmRef | null | true | — |
| valid_from | string | null | true | — |
| valid_to | string | null | true | — |
| is_published | boolean | true | A published tariff is immutable: the screen offers a new version, not an edit. |
| lines | TariffLine[] | false | — |
Composed/inherited schema references: ConfigurableRow. Exact generic composition is retained in the structured reference and requires server-side confirmation.
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.
default.tariff
GET /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
response type: Tariff. 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.
default.tariffLines
GET /api/v1/facility/{facilityId}/rcm/tariff_lines/. 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: PaginatedRcm<TariffLine>. client-side declaration; not proof of accepted server payload.
TariffLine declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| tariff | RcmRef | true | — |
| service | RcmRef | null | true | — |
| code_system | string | true | — |
| code_system_version | string | true | — |
| code_value | string | true | — |
| method | string | true | — |
| amount | StatedValue | true | — |
| percentage | StatedValue | true | — |
| multiplier | StatedValue | true | — |
| base_price_reference | string | true | — |
| requires_base_price | boolean | true | True for the two derived methods only. |
| unit | string | true | — |
| modifiers | unknown | true | — |
| effective_from | string | null | true | — |
| effective_to | string | null | true | — |
| effective_to_is_inclusive | boolean | true | — |
| prices_nothing | boolean | true | Every one of amount, percentage and multiplier is unestablished. |
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.
default.dryRun
GET /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/dry-run/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
response type: TariffDryRun. client-side declaration; not proof of accepted server payload.
TariffDryRun declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| tariff | Tariff | true | — |
| lines_read | number | true | — |
| refusals | Refusal[] | true | — |
| unmapped_lines | Array<object> | true | — |
| publishable | boolean | true | — |
| maker_checker | MakerCheckerPolicyBlock | true | — |
| posted_nothing | boolean | 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.
default.diff
POST /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/diff/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
request type: object. client-side declaration; not proof of accepted server payload.
default.diff.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| against | string | true | — |
response type: TariffDiff. client-side declaration; not proof of accepted server payload.
TariffDiff declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| tariff | RcmRef | true | — |
| against | RcmRef | true | — |
| added | TariffLine[] | true | — |
| removed | TariffLine[] | true | — |
| changed | Array<object> | true | — |
| posted_nothing | boolean | 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.
default.simulatedEncounter
POST /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/simulated-encounter/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
request type: SimulatedEncounterBody. client-side declaration; not proof of accepted server payload.
SimulatedEncounterBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| service_date | string | true | Required: a pricing date is never defaulted to today. |
| service | object | true | — |
| coverage | object | false | — |
| encounter | object | false | — |
response type: SimulatedEncounter. client-side declaration; not proof of accepted server payload.
Composed/inherited schema references: SimulatedEncounterResolved, SimulatedEncounterHold. Exact generic composition is retained in the structured reference and requires server-side confirmation.
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.
default.makerChecker
GET /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/maker-checker/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
response type: MakerCheckerReport. client-side declaration; not proof of accepted server payload.
MakerCheckerReport declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| tariff | RcmRef | true | — |
| category | string | true | — |
| required | boolean | true | — |
| satisfied | boolean | true | — |
| detail | string | true | — |
| author | RcmRef | null | true | — |
| approver | RcmRef | null | true | — |
| policy | MakerCheckerPolicyBlock | 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.
default.publish
POST /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/publish/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
request type: PublishTariffBody. client-side declaration; not proof of accepted server payload.
PublishTariffBody declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| approved_by | string | true | Required. The approver cannot be the publisher. |
| validation_passed | boolean | true | Required. A default of true would assert the publisher's own validation. |
| label | string | false | — |
| test_run_reference | string | false | — |
response type: Record<string, unknown>. 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.
default.tariffReadiness
GET /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
response type: ReadinessBlock. client-side declaration; not proof of accepted server payload.
ReadinessBlock declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| subject | string | true | — |
| target_status | string | true | — |
| is_ready | boolean | true | — |
| checked_overlap | boolean | true | — |
| open_gates | string[] | true | — |
| refusals | Refusal[] | true | — |
| screen_refusals | Refusal[] | true | — |
| gates | GateBlock | true | — |
| evidence | EvidenceBlock | true | — |
| lock_token | string | 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.
default.newTariffVersion
The only way to change a published tariff: a successor draft.
POST /api/v1/facility/{facilityId}/rcm/tariffs/{tariffId}/new-version/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, tariffId. Transport strings are declared here; semantic identifier types require the server contract.
request type: object. client-side declaration; not proof of accepted server payload.
default.newTariffVersion.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| change_reason | string | true | — |
| actor_role | string | false | — |
response type: Tariff. 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.
default.assignments
GET /api/v1/facility/{facilityId}/rcm/tariff_assignments/. 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: PaginatedRcm<TariffAssignment>. client-side declaration; not proof of accepted server payload.
TariffAssignment declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| tariff | RcmRef | true | — |
| provider_contract | RcmRef | null | true | — |
| legacy_contract_reference | StatedText | true | — |
| authority_agreement | RcmRef | null | true | — |
| scope | TariffAssignmentScope | true | — |
| date_rule | StatedText | true | — |
| pricing_date_is_established | boolean | true | — |
| priority | number | true | — |
| drg_mode | StatedText | true | — |
| drg_applicability | RcmRef | null | true | — |
Composed/inherited schema references: ConfigurableRow. Exact generic composition is retained in the structured reference and requires server-side confirmation.
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.
default.assignmentReadiness
GET /api/v1/facility/{facilityId}/rcm/tariff_assignments/{assignmentId}/readiness/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, assignmentId. Transport strings are declared here; semantic identifier types require the server contract.
response type: ReadinessBlock. 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.
default.basePriceSchedules
GET /api/v1/facility/{facilityId}/rcm/base_price_schedules/. 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: PaginatedRcm<BasePriceSchedule>. client-side declaration; not proof of accepted server payload.
BasePriceSchedule declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| reference | string | true | — |
| label | string | true | — |
| currency | string | true | — |
| is_published | boolean | true | — |
| matched_verbatim | boolean | true | — |
| note | string | true | — |
| lines | BasePriceScheduleLine[] | false | — |
Composed/inherited schema references: ConfigurableRow. Exact generic composition is retained in the structured reference and requires server-side confirmation.
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.
default.basePriceScheduleLines
GET /api/v1/facility/{facilityId}/rcm/base_price_schedule_lines/. 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: PaginatedRcm<BasePriceScheduleLine>. client-side declaration; not proof of accepted server payload.
BasePriceScheduleLine declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| schedule | RcmRef | true | — |
| service | RcmRef | null | true | — |
| code_system | string | true | — |
| code_system_version | string | true | — |
| code_value | string | true | — |
| amount | StatedValue | true | — |
| unit | StatedText | true | — |
| effective_from | string | null | true | — |
| effective_to | string | null | true | — |
| evidence | EvidenceBlock | 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.
default.packages
GET /api/v1/facility/{facilityId}/rcm/packages/. 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: PaginatedRcm<PackageDefinition>. client-side declaration; not proof of accepted server payload.
PackageDefinition declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| tariff_line | RcmRef | true | — |
| inclusion_definition | string | true | — |
| inclusion_model | string | true | — |
| excluded_scope | unknown | true | — |
| includes | object | true | — |
| assumed_los_days | StatedValue | true | — |
| outlier_rule | unknown | true | — |
| complication_rule | unknown | true | — |
| carve_outs | unknown | true | — |
| cancellation_rule | unknown | true | — |
| partial_service_rule | unknown | 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.
default.services
GET /api/v1/facility/{facilityId}/rcm/services/. 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: PaginatedRcm<ServiceMaster>. client-side declaration; not proof of accepted server payload.
ServiceMaster declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | true | — |
| label | string | true | — |
Composed/inherited schema references: ConfigurableRow. Exact generic composition is retained in the structured reference and requires server-side confirmation.
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.
default.serviceCodeMappings
GET /api/v1/facility/{facilityId}/rcm/service_code_mappings/. 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: PaginatedRcm<ServiceCodeMapping>. client-side declaration; not proof of accepted server payload.
ServiceCodeMapping declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| service | RcmRef | true | — |
| code_system | string | true | — |
| code_system_version | string | true | — |
| terminology_release | RcmRef | null | true | — |
| code_value | string | true | — |
| map_equivalence | StatedText | true | — |
| effective_from | string | true | — |
| effective_to | string | null | true | — |
| terminology_verification | TerminologyVerification | true | — |
| evidence | EvidenceBlock | 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.
Pinned source evidence
Links require access to the private source repository.
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:377
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:382
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:387
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:392
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:397
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:403
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:409
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:414
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:420
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:426
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:432
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:437
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:442
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:447
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:452
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:457
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:462
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/components/ruleSurfaces.tsx:188
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:110
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:128
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:227
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:400
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:256
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:329
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:326
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:245
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:361
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/components/ruleSurfaces.tsx:167
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:429
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:214
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:151
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:161
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:175
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:77
- repositories/platform/mansoq-web/src/pages/Facility/settings/rcm/priceListApi.ts:96