{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-client-mansoq-web-src-types-rcm-fatooraapi-ts","title":"Fatoora Api client API reference · mansoq-web","summary":"4 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.","module":"RCM & insurance","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Client contract scope","body":"These 4 declarations come from **repositories/platform/mansoq-web/src/types/rcm/fatooraApi.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."},{"title":"Operation map","body":"| Client method | HTTP method | Path pattern | Resolution |\n| --- | --- | --- | --- |\n| default.list | GET | `/api/v1/facility/{facilityId}/rcm/fatoora_units/` | literal |\n| default.prepare | POST | `/api/v1/facility/{facilityId}/rcm/fatoora_units/prepare/` | literal |\n| default.activate | POST | `/api/v1/facility/{facilityId}/rcm/fatoora_units/{id}/activate/` | literal |\n| default.continueChecks | POST | `/api/v1/facility/{facilityId}/rcm/fatoora_units/{id}/continue-checks/` | literal |"},{"title":"default.list","body":"**GET /api/v1/facility/{facilityId}/rcm/fatoora_units/**. typed route object; literal. single static method/path match; deployment boundary still requires review.\n\n**Path parameters:** `facilityId`. Transport strings are declared here; semantic identifier types require the server contract.\n\n**response type:** `PaginatedResponse<FatooraUnit>`. client-side declaration; not proof of accepted server payload.\n\n**PaginatedResponse declared fields:**\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| count | number | true | — |\n| results | TItem[] | true | — |\n\n**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."},{"title":"default.prepare","body":"**POST /api/v1/facility/{facilityId}/rcm/fatoora_units/prepare/**. typed route object; literal. single static method/path match; deployment boundary still requires review.\n\n**Path parameters:** `facilityId`. Transport strings are declared here; semantic identifier types require the server contract.\n\n**request type:** `FatooraPrepare`. client-side declaration; not proof of accepted server payload.\n\n**response type:** `FatooraUnit`. client-side declaration; not proof of accepted server payload.\n\n**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."},{"title":"default.activate","body":"**POST /api/v1/facility/{facilityId}/rcm/fatoora_units/{id}/activate/**. typed route object; literal. single static method/path match; deployment boundary still requires review.\n\n**Path parameters:** `facilityId`, `id`. Transport strings are declared here; semantic identifier types require the server contract.\n\n**request type:** `FatooraActivation`. client-side declaration; not proof of accepted server payload.\n\n**response type:** `FatooraUnit`. client-side declaration; not proof of accepted server payload.\n\n**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."},{"title":"default.continueChecks","body":"**POST /api/v1/facility/{facilityId}/rcm/fatoora_units/{id}/continue-checks/**. typed route object; literal. single static method/path match; deployment boundary still requires review.\n\n**Path parameters:** `facilityId`, `id`. Transport strings are declared here; semantic identifier types require the server contract.\n\n**request type:** `object`. client-side declaration; not proof of accepted server payload.\n\n**default.continueChecks.request declared fields:**\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| run_id | string | true | — |\n| mfa_code | string | true | — |\n\n**response type:** `FatooraUnit`. client-side declaration; not proof of accepted server payload.\n\n**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."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":14,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":20,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":26,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/Utils/request/types.ts","line":66,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts","line":194,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts","line":195,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts","line":196,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["frontend-operation-fbefff20cfd3cd0fd5","frontend-operation-0c71d9adbefdda9b91","frontend-operation-eea0a85e2c4a490193","frontend-operation-e9c922e51c9264a4f2"]},"backend":{"resources":[],"operations":[],"methodEvidence":[],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[{"id":"frontend-operation-fbefff20cfd3cd0fd5","repository":"repositories/platform/mansoq-web","apiModule":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","operationKey":"default.list","method":"GET","path":"/api/v1/facility/{facilityId}/rcm/fatoora_units/","resolution":"literal","originOmitted":false,"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","pathParameters":[{"name":"facilityId","type":"path string; semantic ID type requires contract confirmation","required":true}],"declaredQueryParameters":[],"request":null,"response":{"type":"PaginatedResponse<FatooraUnit>","schemaIds":["repositories/platform/mansoq-web/src/Utils/request/types.ts#PaginatedResponse","repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraUnit"],"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":12,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"query":null,"clientNoAuth":null,"contractKind":"typed route object","reviewStatus":"client contract extracted; runtime behavior and authorization review pending","backendOperationIds":["backend-resource-8506d3d409500e82:GET:list"],"sourceFamily":"primary frontend","backendMatchStatus":"single static method/path match; deployment boundary still requires review"},{"id":"frontend-operation-0c71d9adbefdda9b91","repository":"repositories/platform/mansoq-web","apiModule":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","operationKey":"default.prepare","method":"POST","path":"/api/v1/facility/{facilityId}/rcm/fatoora_units/prepare/","resolution":"literal","originOmitted":false,"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":14,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","pathParameters":[{"name":"facilityId","type":"path string; semantic ID type requires contract confirmation","required":true}],"declaredQueryParameters":[],"request":{"type":"FatooraPrepare","schemaIds":["repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraPrepare"],"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"response":{"type":"FatooraUnit","schemaIds":["repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraUnit"],"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":18,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"query":null,"clientNoAuth":null,"contractKind":"typed route object","reviewStatus":"client contract extracted; runtime behavior and authorization review pending","backendOperationIds":["backend-resource-8506d3d409500e82:POST:prepare"],"sourceFamily":"primary frontend","backendMatchStatus":"single static method/path match; deployment boundary still requires review"},{"id":"frontend-operation-eea0a85e2c4a490193","repository":"repositories/platform/mansoq-web","apiModule":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","operationKey":"default.activate","method":"POST","path":"/api/v1/facility/{facilityId}/rcm/fatoora_units/{id}/activate/","resolution":"literal","originOmitted":false,"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":20,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","pathParameters":[{"name":"facilityId","type":"path string; semantic ID type requires contract confirmation","required":true},{"name":"id","type":"path string; semantic ID type requires contract confirmation","required":true}],"declaredQueryParameters":[],"request":{"type":"FatooraActivation","schemaIds":["repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraActivation"],"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"response":{"type":"FatooraUnit","schemaIds":["repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraUnit"],"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":24,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"query":null,"clientNoAuth":null,"contractKind":"typed route object","reviewStatus":"client contract extracted; runtime behavior and authorization review pending","backendOperationIds":["backend-resource-8506d3d409500e82:POST:activate"],"sourceFamily":"primary frontend","backendMatchStatus":"single static method/path match; deployment boundary still requires review"},{"id":"frontend-operation-e9c922e51c9264a4f2","repository":"repositories/platform/mansoq-web","apiModule":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","operationKey":"default.continueChecks","method":"POST","path":"/api/v1/facility/{facilityId}/rcm/fatoora_units/{id}/continue-checks/","resolution":"literal","originOmitted":false,"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":26,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","pathParameters":[{"name":"facilityId","type":"path string; semantic ID type requires contract confirmation","required":true},{"name":"id","type":"path string; semantic ID type requires contract confirmation","required":true}],"declaredQueryParameters":[],"request":{"type":"object","schemaIds":["repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts#default.continueChecks.request"],"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"response":{"type":"FatooraUnit","schemaIds":["repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraUnit"],"source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":30,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"query":null,"clientNoAuth":null,"contractKind":"typed route object","reviewStatus":"client contract extracted; runtime behavior and authorization review pending","backendOperationIds":["backend-resource-8506d3d409500e82:POST:continue_checks"],"sourceFamily":"primary frontend","backendMatchStatus":"single static method/path match; deployment boundary still requires review"}],"schemas":[{"id":"repositories/platform/mansoq-web/src/Utils/request/types.ts#PaginatedResponse","name":"PaginatedResponse","kind":"InterfaceDeclaration","description":"","source":{"path":"repositories/platform/mansoq-web/src/Utils/request/types.ts","line":66,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":["TItem"],"fields":[{"name":"count","type":"number","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/Utils/request/types.ts","line":67,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"results","type":"TItem[]","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/Utils/request/types.ts","line":68,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]}],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","baseTypes":[]},{"id":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraUnit","name":"FatooraUnit","kind":"TypeAliasDeclaration","description":"","source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts","line":194,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":[],"fields":[],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","expression":"z.infer<typeof FatooraUnitSchema>"},{"id":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraPrepare","name":"FatooraPrepare","kind":"TypeAliasDeclaration","description":"","source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts","line":195,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":[],"fields":[],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","expression":"z.infer<typeof FatooraPrepareSchema>"},{"id":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts#FatooraActivation","name":"FatooraActivation","kind":"TypeAliasDeclaration","description":"","source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatoora.ts","line":196,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":[],"fields":[],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","expression":"z.infer<typeof FatooraActivationSchema>"},{"id":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts#default.continueChecks.request","name":"default.continueChecks.request","kind":"inline object type","source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"fields":[{"name":"run_id","type":"string","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"mfa_code","type":"string","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/types/rcm/fatooraApi.ts","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]}],"baseSchemaIds":[],"typeParameters":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending"}]},"services":{"operations":[]},"boundaries":[]}