{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-nhcx-paymentviewset-a7357a39","title":"Payment API reference · mansoq-nhcx","summary":"Static source contract for Payment: 1 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"Billing","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":"Declared route and availability","body":"This resource is declared in **mansoq-nhcx** at `/api/{installed_plugin_prefix}/payment/`. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| POST | `/api/{installed_plugin_prefix}/payment/{external_id}/acknowledge/` | acknowledge | @action declaration |"},{"title":"acknowledge · POST","body":"**POST /api/{installed_plugin_prefix}/payment/{external_id}/acknowledge/** — action `acknowledge`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n| path | external_id | router lookup string; semantic ID validation requires handler/schema review | true |\n\n**decorator responses: PaymentNoticeRetrieveSpec**. Declared fields below; inherited fields are retained in the schema inventory.\n\n| Field | Type | Required | Constraints |\n| --- | --- | --- | --- |\n| meta | dict | false | No extra constraint extracted |\n| id | UUID4 \\| None | false | No extra constraint extracted |\n| identifier | str | true | No extra constraint extracted |\n| status | str | true | No extra constraint extracted |\n| period | dict \\| None | true | No extra constraint extracted |\n| outcome | str \\| None | true | No extra constraint extracted |\n| disposition | str \\| None | true | No extra constraint extracted |\n| payment_date | datetime | true | No extra constraint extracted |\n| payment_amount | float | true | No extra constraint extracted |\n| payment_identifier | str \\| None | true | No extra constraint extracted |\n| detail | list \\| None | true | No extra constraint extracted |\n| process_note | list \\| None | true | No extra constraint extracted |\n| request | UUID4 | true | No extra constraint extracted |\n| claim | UUID4 | true | No extra constraint extracted |\n| payment_reconciliation | dict \\| None | false | No extra constraint extracted |\n| created_date | datetime \\| None | false | No extra constraint extracted |\n| modified_date | datetime \\| None | false | No extra constraint extracted |\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access.\n\n**Explicit response statuses in observed code:** status.HTTP_200_OK. Other branches/framework exception handling may differ.\n\n**Declared refusal/error evidence:** ValidationError (dynamic detail; inspect source)."},{"title":"Integration review checklist","body":"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."}],"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/teleicu/mansoq-nhcx/nhcx/urls.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":22,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":30,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":322,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":12,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-142bee01a7357a39","backend-resource-142bee01a7357a39:POST:acknowledge"]},"backend":{"resources":[{"id":"backend-resource-142bee01a7357a39","localPrefix":"payment","viewset":"PaymentViewSet","classId":"repositories/teleicu/mansoq-nhcx:nhcx.viewsets.payment.PaymentViewSet","basename":"nhcx-payment","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-nhcx","classSource":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":22,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/payment/","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-142bee01a7357a39:POST:acknowledge"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-142bee01a7357a39:POST:acknowledge","resourceId":"backend-resource-142bee01a7357a39","repository":"repositories/teleicu/mansoq-nhcx","boundary":"optional-plugin/local-service","method":"POST","path":"/api/{installed_plugin_prefix}/payment/{external_id}/acknowledge/","declaredPattern":"/api/{installed_plugin_prefix}/payment/{external_id}/acknowledge/","action":"acknowledge","viewset":"PaymentViewSet","classId":"repositories/teleicu/mansoq-nhcx:nhcx.viewsets.payment.PaymentViewSet","detail":true,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":30,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py:30:acknowledge","repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:322:get_queryset"],"schemaIds":{"decorator responses":"repositories/teleicu/mansoq-nhcx:nhcx.specs.payment.PaymentNoticeRetrieveSpec"},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}},{"name":"external_id","in":"path","type":"router lookup string; semantic ID validation requires handler/schema review","required":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/urls.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py:30:acknowledge","name":"acknowledge","owner":"repositories/teleicu/mansoq-nhcx:nhcx.viewsets.payment.PaymentViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":30,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[{"exception":"ValidationError","message":null,"dynamicMessage":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":115,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"explicitResponseStatuses":[{"value":null,"symbol":"status.HTTP_200_OK","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":118,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"conditions":[],"schemaIds":["repositories/teleicu/mansoq-nhcx:nhcx.specs.payment.PaymentNoticeRetrieveSpec"],"schemaUsages":[{"purpose":"decorator responses","schemaId":"repositories/teleicu/mansoq-nhcx:nhcx.specs.payment.PaymentNoticeRetrieveSpec","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/viewsets/payment.py","line":25,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"},{"id":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py:322:get_queryset","name":"get_queryset","owner":"repositories/platform/mansoq-core:mansoq.emr.api.viewsets.base.EMRBaseViewSet","summary":"","source":{"path":"repositories/platform/mansoq-core/mansoq/emr/api/viewsets/base.py","line":322,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[{"id":"repositories/teleicu/mansoq-nhcx:nhcx.specs.payment.PaymentNoticeRetrieveSpec","name":"PaymentNoticeRetrieveSpec","source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":12,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"kind":"Python declared schema/model evidence","fields":[{"name":"meta","type":"dict","required":false,"hasDefault":true,"source":{"path":"repositories/platform/mansoq-core/mansoq/emr/resources/base.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"id","type":"UUID4 | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"identifier","type":"str","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":18,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"status","type":"str","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":19,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"period","type":"dict | None","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":20,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"outcome","type":"str | None","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":21,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"disposition","type":"str | None","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":22,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"payment_date","type":"datetime","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":23,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"payment_amount","type":"float","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":24,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"payment_identifier","type":"str | None","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":25,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"detail","type":"list | None","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":26,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"process_note","type":"list | None","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":27,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"request","type":"UUID4","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":28,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"claim","type":"UUID4","required":true,"hasDefault":false,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"payment_reconciliation","type":"dict | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":30,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"created_date","type":"datetime | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":32,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}},{"name":"modified_date","type":"datetime | None","required":false,"hasDefault":true,"source":{"path":"repositories/teleicu/mansoq-nhcx/nhcx/specs/payment.py","line":33,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"constraints":{}}],"validation":[],"baseTypes":["EMRResource"],"reviewStatus":"declared fields extracted; runtime validation review pending","referencedSchemaIds":[]}],"frameworkSettings":[{"name":"DEFAULT_AUTHENTICATION_CLASSES","value":["config.authentication.CustomJWTAuthentication","config.authentication.CustomBasicAuthentication","rest_framework.authentication.SessionAuthentication","rest_framework.authentication.TokenAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PERMISSION_CLASSES","value":["rest_framework.permissions.IsAuthenticated","mansoq.security.utils.permission_class.MansoqAuthentication"],"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"DEFAULT_PAGINATION_CLASS","value":"mansoq.utils.pagination.mansoq_pagination.MansoqLimitOffsetPagination","source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"},{"name":"PAGE_SIZE","value":14,"source":{"path":"repositories/platform/mansoq-core/config/settings/base.py","line":372,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"scope":"source default; deployment overrides and action-level policies may differ"}]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}