MANSOQ Frontend module · STATIC DECLARATIONS
Revenue Cycle Api client API reference · mansoq-web
15 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 15 declarations come from repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.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.dashboard | GET | /api/v1/facility/{facilityId}/revenue_cycle/dashboard/ |
literal |
| default.list | GET | /api/v1/facility/{facilityId}/revenue_cycle/ |
literal |
| default.retrieve | GET | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/ |
literal |
| default.prepareInsuredVisit | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/prepare-insured-visit/ |
literal |
| default.recalculate | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/recalculate/ |
literal |
| default.estimate | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/estimate/ |
literal |
| default.chargeAudit | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/charge_audit/ |
literal |
| default.buildClaim | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/build_claim/ |
literal |
| default.submitClaim | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/submit_claim/ |
literal |
| default.eligibility | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/eligibility/ |
literal |
| default.authorization | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/authorization/ |
literal |
| default.nphiesSupport | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/nphies-support/ |
literal |
| default.nphiesCommunication | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/nphies-communication/ |
literal |
| default.nphiesPaymentNotice | POST | /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/nphies-payment-notice/ |
literal |
| default.configuration | GET | /api/v1/facility/{facilityId}/revenue_cycle/configuration/ |
literal |
default.dashboard
GET /api/v1/facility/{facilityId}/revenue_cycle/dashboard/. 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: RevenueCycleDashboard. client-side declaration; not proof of accepted server payload.
RevenueCycleDashboard declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| cases | number | true | — |
| stages | Partial<Record<RevenueCycleStage, number>> | true | — |
| statuses | Record<string, number> | true | — |
| financials | object | true | — |
| currency | "SAR" | true | — |
| open_work_items | number | true | — |
| open_denials | number | true | — |
| denied_amount | string | true | — |
| ready_to_claim | number | true | — |
| exchanges_queued | number | 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.list
GET /api/v1/facility/{facilityId}/revenue_cycle/. 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<RevenueCycleCase>. client-side declaration; not proof of accepted server payload.
PaginatedResponse declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| count | number | true | — |
| results | TItem[] | true | — |
RevenueCycleCase declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| patient | object | true | — |
| encounter | string | null | false | — |
| encounter_class | string | null | false | — |
| account | string | true | — |
| account_name | string | true | — |
| coverage | RevenueCycleCoverage | null | false | — |
| canonical_visit_preparation | object | null | false | — |
| stage | RevenueCycleStage | true | — |
| status | string | true | — |
| front_office_status | string | true | — |
| middle_office_status | string | true | — |
| back_office_status | string | true | — |
| claim_type | string | true | — |
| financial_class | string | true | — |
| priority | string | true | — |
| currency | "SAR" | true | — |
| estimated_amount | string | null | true | — |
| estimate_status | string | null | false | — |
| authorized_amount | string | true | — |
| charged_amount | string | true | — |
| claimed_amount | string | true | — |
| allowed_amount | string | true | — |
| paid_amount | string | true | — |
| patient_responsibility | string | true | — |
| readiness_score | number | true | — |
| blockers | RevenueCycleBlocker[] | true | — |
| stage_summary | Record<string, string | number> | true | — |
| created_date | string | true | — |
| modified_date | string | true | — |
| eligibility_checks | Array<object> | false | — |
| authorizations | Array<object> | false | — |
| estimates | Array<object> | false | — |
| utilization_reviews | Array<Record<string, unknown>> | false | — |
| charge_capture_audit | object | null | false | — |
| coding | Record<string, unknown> | null | false | — |
| claims | RevenueClaim[] | false | — |
| work_items | Array<object> | false | — |
| denials | Array<Record<string, unknown>> | false | — |
| payment_allocations | Array<object> | false | — |
| collections | Array<Record<string, unknown>> | false | — |
| exchanges | Array<object> | false | — |
| communications | Array<object> | false | — |
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.retrieve
GET /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. Transport strings are declared here; semantic identifier types require the server contract.
response type: RevenueCycleCase. 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.prepareInsuredVisit
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/prepare-insured-visit/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.prepareInsuredVisit.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| event_key | string | true | — |
| expires_at | string | true | — |
| supersedes_id | string | false | — |
| correction_reason | string | false | — |
response type: object. client-side declaration; not proof of accepted server payload.
default.prepareInsuredVisit.response declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| status | string | true | — |
| source_sha256 | 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.recalculate
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/recalculate/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, never>. client-side declaration; not proof of accepted server payload.
response type: RevenueCycleCase. 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.estimate
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/estimate/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.estimate.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| lines | Array<Record<string, unknown>> | false | — |
| present | boolean | false | — |
| id | string | false | — |
| acknowledge | boolean | false | — |
| deposit_received | string | false | — |
response type: RevenueCycleCase. 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.chargeAudit
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/charge_audit/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.chargeAudit.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| expected_services | Array<Record<string, unknown>> | false | — |
| late_charges | Array<Record<string, unknown>> | false | — |
| status | string | false | — |
response type: RevenueCycleCase. 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.buildClaim
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/build_claim/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.buildClaim.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| invoice | string | false | — |
| prior_claim | string | false | — |
| supporting_information | Array<Record<string, unknown>> | false | — |
response type: RevenueClaim. client-side declaration; not proof of accepted server payload.
RevenueClaim declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | true | — |
| claim_number | string | true | — |
| submission_type | "initial" | "resubmission" | "correction" | true | — |
| prior_claim | string | null | false | — |
| claim_type | string | true | — |
| status | string | true | — |
| outcome | string | true | — |
| submission_channel | string | true | — |
| currency | "SAR" | true | — |
| total | string | true | — |
| allowed_amount | string | true | — |
| paid_amount | string | true | — |
| patient_responsibility | string | true | — |
| validation_results | Array<Record<string, unknown>> | true | — |
| payer_claim_reference | string | true | — |
| submitted_at | string | null | false | — |
| adjudicated_at | string | null | false | — |
| diagnoses | Array<Record<string, unknown>> | false | — |
| procedures | Array<Record<string, unknown>> | false | — |
| lines | RevenueClaimLine[] | false | — |
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.submitClaim
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/submit_claim/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.submitClaim.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| claim | string | true | — |
response type: object. client-side declaration; not proof of accepted server payload.
default.submitClaim.response declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| claim | RevenueClaim | true | — |
| exchange | object | 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.eligibility
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/eligibility/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. Transport strings are declared here; semantic identifier types require the server contract.
request type: Record<string, never>. client-side declaration; not proof of accepted server payload.
response type: RevenueCycleCase. 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.authorization
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/authorization/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.authorization.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | false | — |
| parent_authorization | string | false | — |
| submit | boolean | false | — |
| acknowledge_patient_responsibility | boolean | false | — |
| authorization_type | string | false | — |
| urgency | string | false | — |
| requested_amount | string | false | — |
| services | Array<Record<string, unknown>> | false | — |
| clinical_information | Record<string, unknown> | false | — |
response type: RevenueCycleCase. 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.nphiesSupport
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/nphies-support/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.nphiesSupport.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| operation | "poll" | "status" | "cancel" | "retry" | true | — |
| exchange | string | false | — |
| count | number | false | — |
| message_types | string[] | false | — |
| include_message_types | string[] | false | — |
| exclude_message_types | string[] | false | — |
| period | object | false | — |
| reason_code | "WP" | "NP" | "TAS" | false | — |
response type: RevenueCycleCase. 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.nphiesCommunication
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/nphies-communication/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.nphiesCommunication.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| kind | "submission" | true | — |
| claim | string | false | — |
| authorization | string | false | — |
| based_on_communication | string | false | — |
| subject | string | false | — |
| category | string | false | — |
| payload | Array<Record<string, unknown>> | false | — |
| attachments | Array<Record<string, unknown>> | false | — |
response type: RevenueCycleCase. 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.nphiesPaymentNotice
POST /api/v1/facility/{facilityId}/revenue_cycle/{caseId}/nphies-payment-notice/. typed route object; literal. single static method/path match; deployment boundary still requires review.
Path parameters: facilityId, caseId. 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.nphiesPaymentNotice.request declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| payment_reconciliation | string | true | — |
| bank_received_at | string | false | — |
response type: RevenueCycleCase. 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.configuration
GET /api/v1/facility/{facilityId}/revenue_cycle/configuration/. 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: RevenueCycleConfiguration. client-side declaration; not proof of accepted server payload.
RevenueCycleConfiguration declared fields:
| Field | Type | Required | Description |
|---|---|---|---|
| payers | Array<Record<string, unknown>> | true | — |
| plans | Array<Record<string, unknown>> | true | — |
| contracts | Array<Record<string, unknown>> | true | — |
| claim_edit_rules | Array<Record<string, 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.
Pinned source evidence
Links require access to the private source repository.
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:11
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:16
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:21
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:26
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:37
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:43
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:55
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:65
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:75
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:89
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:95
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:111
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:126
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:141
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:150
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycle.ts:245
- repositories/platform/mansoq-web/src/Utils/request/types.ts:66
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycle.ts:65
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:30
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:29
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:47
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:59
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:69
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycle.ts:42
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:87
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:78
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:99
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:115
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:130
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycleApi.ts:145
- repositories/platform/mansoq-web/src/types/revenueCycle/revenueCycle.ts:264