← Technical API reference

Backend resource · STATIC DECLARATIONS

Billing Bridge API reference · mansoq-core

Static source contract for Billing Bridge: 7 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

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.

Declared route and availability

This resource is declared in mansoq-core at /api/v1/facility/{facility_external_id}/rcm/bridge/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Cross-navigation between MANSOQ Billing and the Saudi RCM subsystem.

Read-only by construction. Every action resolves its subject inside the facility in the URL, so an account, invoice, encounter or patient from another tenant is a 404 rather than a composed view of somebody else's money.

Operation map

Method Path Action Evidence
GET /api/v1/facility/{facility_external_id}/rcm/bridge/ list declared/inherited method
GET /api/v1/facility/{facility_external_id}/rcm/bridge/account/ account @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/bridge/encounter/ encounter @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/bridge/invoice/ invoice @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/bridge/patient/ patient @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/bridge/remittance/ remittance @action declaration
GET /api/v1/facility/{facility_external_id}/rcm/bridge/liability-split/ liability_split @action declaration

list · GET

The five directions, so the surface is discoverable rather than told.

GET /api/v1/facility/{facility_external_id}/rcm/bridge/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records.

account · GET

One billing account, joined to everything RCM knows about it.

GET /api/v1/facility/{facility_external_id}/rcm/bridge/account/ — action account. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query account not declared at read site not established
query as_of not declared at read site not established
query {computed field name} not declared at read site not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records; ValidationError (dynamic detail; inspect source); ValidationError: bridge_subject_required.

encounter · GET

Charge → claim line for one encounter, with the receivable counted once.

GET /api/v1/facility/{facility_external_id}/rcm/bridge/encounter/ — action encounter. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query account not declared at read site not established
query {computed field name} not declared at read site not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records; ValidationError: bridge_subject_required.

invoice · GET

Invoice ↔ claims ↔ encounters, plus tax and the legal recipient.

GET /api/v1/facility/{facility_external_id}/rcm/bridge/invoice/ — action invoice. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query {computed field name} not declared at read site not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records; ValidationError: bridge_subject_required.

patient · GET

Registration's coverages, with the rung that established each one.

GET /api/v1/facility/{facility_external_id}/rcm/bridge/patient/ — action patient. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query {computed field name} not declared at read site not established
query as_of not declared at read site not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records; ValidationError: bridge_subject_required; ValidationError (dynamic detail; inspect source).

remittance · GET

Billing's reconciliations beside the advice and cash ledgers.

GET /api/v1/facility/{facility_external_id}/rcm/bridge/remittance/ — action remittance. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query account not declared at read site not established
query {computed field name} not declared at read site not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records; ValidationError: bridge_subject_required.

liability_split · GET

Collectable patient debt and unresolved insurance shortfall, apart.

GET /api/v1/facility/{facility_external_id}/rcm/bridge/liability-split/ — action liability_split. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
path facility_external_id router lookup string; semantic ID validation requires handler/schema review true

Directly observed request reads (these do not constitute a complete accepted-payload or requiredness guarantee):

Location Field Declared/inferred read type Requiredness evidence
query account not declared at read site not established
query {computed field name} not declared at read site not established

Observed authorization checks: can_read_account_in_facility. Helper/queryset evidence is included; this is not proof of complete security review.

Declared refusal/error evidence: PermissionDenied: Cannot read revenue-cycle records; ValidationError: bridge_subject_required.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.