← Technical API reference

Frontend module · STATIC DECLARATIONS

Bridge Api client API reference · mansoq-web

23 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 23 declarations come from repositories/platform/mansoq-web/src/pages/Facility/billing/rcm/bridgeApi.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
billingBridgeApi.account GET /api/v1/facility/{facilityId}/rcm/bridge/account/ literal
billingBridgeApi.encounter GET /api/v1/facility/{facilityId}/rcm/bridge/encounter/ literal
billingBridgeApi.invoice GET /api/v1/facility/{facilityId}/rcm/bridge/invoice/ literal
billingBridgeApi.remittance GET /api/v1/facility/{facilityId}/rcm/bridge/remittance/ literal
billingBridgeApi.patient GET /api/v1/facility/{facilityId}/rcm/bridge/patient/ literal
billingBridgeApi.liabilitySplit GET /api/v1/facility/{facilityId}/rcm/bridge/liability-split/ literal
rcmLiabilityApi.list GET /api/v1/facility/{facilityId}/rcm/liability/ literal
rcmLiabilityApi.retrieve GET /api/v1/facility/{facilityId}/rcm/liability/{decisionId}/ literal
rcmLiabilityApi.position GET /api/v1/facility/{facilityId}/rcm/liability/position/ literal
rcmLiabilityApi.transfer POST /api/v1/facility/{facilityId}/rcm/liability/{decisionId}/transfer/ literal
rcmLiabilityApi.undertakings GET /api/v1/facility/{facilityId}/rcm/liability/undertakings/ literal
rcmFinanceApi.listAdvices GET /api/v1/facility/{facilityId}/rcm/finance/ literal
rcmFinanceApi.retrieveAdvice GET /api/v1/facility/{facilityId}/rcm/finance/{adviceId}/ literal
rcmFinanceApi.actions GET /api/v1/facility/{facilityId}/rcm/finance/actions/ literal
rcmFinanceApi.balanceIdentities GET /api/v1/facility/{facilityId}/rcm/finance/{adviceId}/balance-identities/ literal
rcmFinanceApi.claimIdentity GET /api/v1/facility/{facilityId}/rcm/finance/claim-identity/ literal
rcmFinanceApi.suspense GET /api/v1/facility/{facilityId}/rcm/finance/suspense/ literal
rcmFinanceApi.bankAccounts GET /api/v1/facility/{facilityId}/rcm/finance/bank-accounts/ literal
rcmFinanceApi.confirmBankReceipt POST /api/v1/facility/{facilityId}/rcm/finance/confirm-bank-receipt/ literal
rcmFinanceApi.credit POST /api/v1/facility/{facilityId}/rcm/finance/credit/ literal
rcmFinanceApi.estimate POST /api/v1/facility/{facilityId}/rcm/finance/estimate/ literal
rcmFinanceApi.issue POST /api/v1/facility/{facilityId}/rcm/finance/issue/ literal
rcmFinanceApi.aging POST /api/v1/facility/{facilityId}/rcm/finance/aging/ literal

billingBridgeApi.account

Directions 1+2+3+4+6 composed for one account: one call, not ten.

GET /api/v1/facility/{facilityId}/rcm/bridge/account/. 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: AccountBridge. client-side declaration; not proof of accepted server payload.

AccountBridge declared fields:

Field Type Required Description
account string true —
patient string | null true —
as_of string | null true —
directions string[] true —
coverage AccountCoverageView true —
charges ChargeBillingMap true —
invoices InvoiceClaimMap[] true —
liability AccountLiabilitySplit true —
remittance RemittanceBridgeView 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.

billingBridgeApi.encounter

Direction 2: which charges reached which claim, and which did not.

GET /api/v1/facility/{facilityId}/rcm/bridge/encounter/. 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: ChargeBillingMap. client-side declaration; not proof of accepted server payload.

ChargeBillingMap declared fields:

Field Type Required Description
encounter string | null true —
account string | null true —
charges ChargeBillingRow[] true —
unbilled_charges string[] true —
excluded_but_captured string[] true —
undecided_charges string[] true —
charge_items_without_capture string[] true —
receivable EncounterReceivable | null true —
note 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.

billingBridgeApi.invoice

Direction 3: invoice <-> claims <-> encounters, tax and legal recipient.

GET /api/v1/facility/{facilityId}/rcm/bridge/invoice/. 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: InvoiceClaimMap. client-side declaration; not proof of accepted server payload.

InvoiceClaimMap declared fields:

Field Type Required Description
invoice string true —
number string true —
status string true —
locked boolean true —
is_refund boolean true —
account string | null true —
patient string | null true —
total_net string true —
total_gross string true —
issue_date string | null true —
charge_items string[] true —
claims ClaimRef[] true —
claim_count number true —
encounters string[] true —
receivables (EncounterReceivable | null)[] true —
distinct_charge_count number true —
tax TaxRecipientView[] true —
note 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.

billingBridgeApi.remittance

Direction 4: reconciliation, advice and bank reference as three facts.

GET /api/v1/facility/{facilityId}/rcm/bridge/remittance/. 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: RemittanceBridgeView. client-side declaration; not proof of accepted server payload.

RemittanceBridgeView declared fields:

Field Type Required Description
account string | null true —
match_facts string[] true —
reconciliations ReconciliationCandidate[] true —
advices AdviceBridgeRow[] true —
unmatched_advice_lines UnmatchedAdviceLine[] true —
unnotified_receipts UnnotifiedReceipt[] true —
note 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.

billingBridgeApi.patient

Direction 5: registration's coverages and the rung that established each.

GET /api/v1/facility/{facilityId}/rcm/bridge/patient/. 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: PatientCoverageView. client-side declaration; not proof of accepted server payload.

PatientCoverageView declared fields:

Field Type Required Description
patient string true —
as_of string | null true —
coverages CoverageView[] true —
configured_ladder DiscoveryRungRef[] true —
ladder_validated_here boolean true —
ladder_note 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.

billingBridgeApi.liabilitySplit

Direction 6: what a cashier may pursue vs what the appeals desk must.

GET /api/v1/facility/{facilityId}/rcm/bridge/liability-split/. 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: AccountLiabilitySplit. client-side declaration; not proof of accepted server payload.

AccountLiabilitySplit declared fields:

Field Type Required Description
account string true —
patient string | null true —
account_balance Stated true —
account_calculated_at string | null true —
collectable_patient_debt MoneyTally[] true —
unresolved_insurance_shortfall MoneyTally[] true —
contractual_adjustment object true —
awaiting_named_reviewer object true —
written_off MoneyTally[] true —
collectable_bases string[] true —
denial_alone_creates_patient_debt boolean true Constant false: a denial alone never creates patient debt (ch. 27).
blended_total null true Always null. The two numbers are never added.
blended_total_note string true —
encounters string[] true —
claims string[] true —
work_queues WorkQueueRef[] true —
scope_note 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.

rcmLiabilityApi.list

GET /api/v1/facility/{facilityId}/rcm/liability/. 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<LiabilityDecision>. client-side declaration; not proof of accepted server payload.

PaginatedResponse declared fields:

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

LiabilityDecision declared fields:

Field Type Required Description
id string true —
patient string true —
claim string | null true —
claim_line string | null true —
encounter string | null true —
amount string true —
currency string true —
basis string true —
disposition string true —
responsibility string true —
is_collectable boolean true Read from the model's rule, not derived from the amount being non-zero.
is_patient_debt boolean true —
controlling_clause string true —
denial_reason_code string true —
denial_reason_system string true —
reviewer string | null true —
reviewed_at string | null true —
dispute_status string true —
work_queue_key string true —
evidence 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.

rcmLiabilityApi.retrieve

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

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

response type: LiabilityDecision. 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.

rcmLiabilityApi.position

Two totals, computed apart. There is deliberately no combined figure.

GET /api/v1/facility/{facilityId}/rcm/liability/position/. 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: LiabilityPosition. client-side declaration; not proof of accepted server payload.

LiabilityPosition declared fields:

Field Type Required Description
currency_note string true —
collectable_patient_debt LiabilityTotals true —
unresolved_insurance_shortfall LiabilityTotals true —
unresolved_basis LiabilityTotals true —
contractual_adjustment LiabilityTotals & object true —
blended_total null true —
blended_total_note string true —
collectable_bases string[] true —
work_queues WorkQueueRef[] 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.

rcmLiabilityApi.transfer

Move a determination to patient_receivable. Refused without a named reviewer, refused where the basis cannot carry collectable debt, and refused outright for a contractual adjustment.

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

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

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

rcmLiabilityApi.transfer.request declared fields:

Field Type Required Description
reviewer string true —
reviewed_at string false —

response type: LiabilityDecision. 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.

rcmLiabilityApi.undertakings

The whole lawful set of pre-treatment undertakings — and the rest.

GET /api/v1/facility/{facilityId}/rcm/liability/undertakings/. 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: UndertakingCatalogue. client-side declaration; not proof of accepted server payload.

UndertakingCatalogue declared fields:

Field Type Required Description
lawful Array<object> true —
prohibited string[] true —
note 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.

rcmFinanceApi.listAdvices

Remittance advices. retrieve carries allocations + balance identities.

GET /api/v1/facility/{facilityId}/rcm/finance/. 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<AdviceSummary>. client-side declaration; not proof of accepted server payload.

AdviceSummary declared fields:

Field Type Required Description
id string true —
advice_identifier string true —
external_payment_identifier string true —
message_identifier string true —
advice_date string | null true —
received_at string | null true —
currency string true —
total_reported string true —
parties object true —
named_amounts object true —
config_package string | null 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.

rcmFinanceApi.retrieveAdvice

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

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

response type: AdviceSummary & object. client-side declaration; not proof of accepted server payload.

BalanceIdentities declared fields:

Field Type Required Description
advice_ledger object true —
cash_ledger object true —
note 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.

rcmFinanceApi.actions

The six SET-12 actions, published so a client renders six and not "post".

GET /api/v1/facility/{facilityId}/rcm/finance/actions/. 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: FinanceActionCatalogue. client-side declaration; not proof of accepted server payload.

FinanceActionCatalogue declared fields:

Field Type Required Description
actions string[] true —
maker_checker_categories string[] true —
note 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.

rcmFinanceApi.balanceIdentities

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

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

response type: BalanceIdentities. 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.

rcmFinanceApi.claimIdentity

GET /api/v1/facility/{facilityId}/rcm/finance/claim-identity/. 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: ClaimBalanceIdentity. client-side declaration; not proof of accepted server payload.

ClaimBalanceIdentity declared fields:

Field Type Required Description
gross unknown false —
contractual_adjustment LiabilityTotals false —
patient_billable LiabilityTotals false —
unresolved_insurance_shortfall LiabilityTotals false —
patient_receivable_without_reviewer LiabilityTotals & 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.

rcmFinanceApi.suspense

Both suspense accounts, with the queues that own them.

GET /api/v1/facility/{facilityId}/rcm/finance/suspense/. 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: FinanceSuspense. client-side declaration; not proof of accepted server payload.

FinanceSuspense declared fields:

Field Type Required Description
unmatched_advice_lines UnmatchedAdviceLine[] true —
unnotified_receipts UnnotifiedReceipt[] true —
work_queues WorkQueueRef[] 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.

rcmFinanceApi.bankAccounts

Settlement accounts. The IBAN is masked here and in every export.

GET /api/v1/facility/{facilityId}/rcm/finance/bank-accounts/. 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: BankAccountRef[]. client-side declaration; not proof of accepted server payload.

BankAccountRef declared fields:

Field Type Required Description
id string true —
organization string | null true —
beneficiary_name string true —
iban_masked string true —
bank_name string true —
swift_bic_masked string true —
permitted_currency string true —
status string true —
beneficiary_verified TriState true —
verified_by string | null true —
verified_at string | null true —
change_approved_by string | null true —
change_approved_at string | null true —
independent_verified_by string | null true —
dual_control_complete boolean true —
verification_note 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.

rcmFinanceApi.confirmBankReceipt

Treasury attests an imported statement line before a payment notice.

POST /api/v1/facility/{facilityId}/rcm/finance/confirm-bank-receipt/. 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: object. client-side declaration; not proof of accepted server payload.

rcmFinanceApi.confirmBankReceipt.request declared fields:

Field Type Required Description
bank_transaction string true —
statement_reference string true —

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

rcmFinanceApi.confirmBankReceipt.response declared fields:

Field Type Required Description
id string true —
is_returned object true —
return_confirmed_by string | null true —
return_confirmed_at string | null 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.

rcmFinanceApi.credit

Gate CF-U20: the credit-note taxonomy is data, never resolved in code.

POST /api/v1/facility/{facilityId}/rcm/finance/credit/. 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: object. client-side declaration; not proof of accepted server payload.

rcmFinanceApi.credit.request declared fields:

Field Type Required Description
case_kind string false —

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

CreditNoteTaxonomy declared fields:

Field Type Required Description
gate string true —
gate_verdicts GateVerdict[] true —
cases CreditNoteCaseRow[] true —
note 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.

rcmFinanceApi.estimate

Posts nothing. A quote is visibly a quote, beside the balance identity.

POST /api/v1/facility/{facilityId}/rcm/finance/estimate/. 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: object. client-side declaration; not proof of accepted server payload.

rcmFinanceApi.estimate.request declared fields:

Field Type Required Description
claim string false —
amount string true —
currency string true —
payer_verified_at string false —
assumptions string[] false —
unresolved_benefits string[] false —
expires_on string false —
certainty string false —

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

FinanceEstimate declared fields:

Field Type Required Description
claim string | null true —
estimate object true —
balance_identity ClaimBalanceIdentity | null true —
posted boolean true —
note 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.

rcmFinanceApi.issue

Returns what may lawfully be issued. Refuses contractual shortfall.

POST /api/v1/facility/{facilityId}/rcm/finance/issue/. 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: object. client-side declaration; not proof of accepted server payload.

rcmFinanceApi.issue.request declared fields:

Field Type Required Description
claim string true —
include_contractual_adjustment boolean false —

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

rcmFinanceApi.issue.response declared fields:

Field Type Required Description
claim string true —
billable unknown true —
excluded Record<string, unknown> true —
balance_identity ClaimBalanceIdentity true —
posted boolean true —
note 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.

rcmFinanceApi.aging

Aged and provisioned per payer class. There is no blended total.

POST /api/v1/facility/{facilityId}/rcm/finance/aging/. 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: object. client-side declaration; not proof of accepted server payload.

rcmFinanceApi.aging.request declared fields:

Field Type Required Description
aging_policy string false —
as_of string false —
currency string false —
receivables Array<object> false —

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

ReceivableAging declared fields:

Field Type Required Description
as_of string | null true —
anchor_basis string true —
currency string true —
blended_total null true —
blended_total_note string true —
by_payer_class AgingCohort[] true —
exceptions 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.