Backend resource · STATIC DECLARATIONS

Fatoora Document API reference · mansoq-core

Static source contract for Fatoora Document: 6 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/fatoora_documents/. verified core mount in config/urls.py A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method	Path	Action	Evidence
GET	`/api/v1/facility/{facility_external_id}/rcm/fatoora_documents/`	list	declared/inherited method
GET	`/api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/`	retrieve	declared/inherited method
POST	`/api/v1/facility/{facility_external_id}/rcm/fatoora_documents/prepare/`	prepare	@action declaration
POST	`/api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/submit/`	submit	@action declaration
GET	`/api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/invoice-xml/`	invoice_xml	@action declaration
GET	`/api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/invoice-pdf/`	invoice_pdf	@action declaration

list · GET

GET /api/v1/facility/{facility_external_id}/rcm/fatoora_documents/ — 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

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

Location	Field	Declared/inferred read type	Requiredness evidence
query	`invoice`	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).

retrieve · GET

GET /api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/ — action retrieve. 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
path	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	`invoice`	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).

prepare · POST

POST /api/v1/facility/{facility_external_id}/rcm/fatoora_documents/prepare/ — action prepare. 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	`invoice`	not declared at read site	not established

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

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

submit · POST

POST /api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/submit/ — action submit. 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
path	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	`invoice`	not declared at read site	not established

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

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

invoice_xml · GET

GET /api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/invoice-xml/ — action invoice_xml. 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
path	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	`invoice`	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: ValidationError: FATOORA_FINAL_DOCUMENT_NOT_AVAILABLE; PermissionDenied: Cannot read revenue-cycle records; ValidationError (dynamic detail; inspect source).

invoice_pdf · GET

GET /api/v1/facility/{facility_external_id}/rcm/fatoora_documents/{external_id}/invoice-pdf/ — action invoice_pdf. 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
path	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	`invoice`	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: ValidationError (dynamic detail; inspect source); PermissionDenied: Cannot read revenue-cycle records.

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.