This collection contains integration endpoints used between external systems (e.g., HIS) and TMS/Odoo.
\nSelect the environment TMS-DEV.
\nEnsure the following environment variables are set:
\n\n\nTip: keep
\nBase_URLwithout a trailing slash andBase_PATHwith a leading slash (or vice-versa), but be consistent so{{Base_URL}}{{Base_PATH}}/...resolves correctly.
Most requests in this collection expect an API key in the header:
\nx-api-key:Some deployments may also require a login/session step (see IF017 Authentication folder). If your API returns a token/cookie, you can store it in an environment variable and reference it in subsequent requests.
\nUnless stated otherwise per-request:
\nContent-Type: application/json
Accept: application/json
x-api-key:
401 / 403: missing/invalid x-api-key, or key does not have access to the target database/company.
400: schema validation errors (missing required fields, wrong date formats, invalid codes).
\n404: wrong Base_URL / Base_PATH or endpoint path.
409: duplicate event_id / idempotency conflicts (implementation-specific).
5xx: server error. Check server logs using meta.correlation_id.
Use Runner to execute a folder (e.g., IF008 / IF017) or the entire collection.
\nFor event-driven APIs, use a data file (CSV/JSON) and parameterize fields like {{mrn}}, {{encounter_id}}, etc.
Login:
\n postman login --with-api-key PMAK-xxxxx\n\nRun:
\n postman collection run 50495697-79882afd-5e27-4d92-b8c5-42e64ca12f34 -e 50495697-2308e3a2-6d83-482b-98b5-f3616ab97189\n\nIF017 Authentication: obtain/validate credentials for integrations (if required by your deployment).
\nIF008 Patien Encounter: patient and encounter upsert flows.
\nIF009 Stock Dispense Create: stock dispense creation events.
\nIF011 Notify Stock on Hand Change: stock-on-hand notifications (if implemented).
\nIF017 Transaction Update: transaction, invoice, payment, deposit, cancel flows.
\nMost event-style endpoints follow an envelope pattern:
\nmeta: tracking fields such as event_id and correlation_id
payload: business content
When in doubt:
\nkeep meta.event_id unique per submission
reuse meta.correlation_id to trace a workflow across multiple related calls
Authenciation Interface.
\nThis is required in order to make interfacing call between external system and Odoo.
It's necessary as it's foreseeable that there must be more than 1 database per a instance in the future, e.g. On-prem UAT Environment to host both Database for UAT activities and Production Support Activitiy.
Upsert (create or update) a Patient Encounter record, focusing on patient demographics within the encounter payload. This request is designed for event-driven integrations where the source system (e.g., HIS) sends an event envelope (meta) and the business data (payload).
POST {{Base_URL}}{{Base_PATH}}/patientencounter-upsert
This endpoint uses an API key passed via a custom header:
\nx-api-key: {{APIKey}}\n\nEnsure the active environment has
\nAPIKeyset. In this workspace, the active environment is TMS-DEV.
This request relies on the following Postman variables:
\nThe request body is JSON with two top-level objects:
\nmeta — event envelope and tracing metadatapayload — business data being upsertedpayload.patient — patient demographic detailsmetapayload.patientCommon patient demographic fields include (not exhaustive):
\nmeta.event_id: should be unique and ideally consistent for retries to support idempotent processing.meta.correlation_id: should be a UUID. Generate a new one per business transaction to enable end-to-end traceability.dob: YYYY-MM-DDYYYY-MM-DDThh:mm:ss with timezone as required by the API.Based on the current request body (with long address redacted/truncated):
\n{\n \"meta\": {\n \"event_id\": \"HIS-20260129-083000101\",\n \"correlation_id\": \"c3a1c2d0-3d5a-4e6c-8e91-8a3c2fd4c9a1\",\n \"event_type\": \"PatientEncounterUpsert\",\n \"source_system\": \"HIS\"\n },\n \"payload\": {\n \"patient\": {\n \"mrn\": \"00998877\",\n \"title\": \"Mr.\",\n \"title_th\": \"นาย\",\n \"first_name\": \"Somsak\",\n \"last_name\": \"Deejai\",\n \"first_name_th\": \"สมศักดิ์\",\n \"last_name_th\": \"ดีใจ\",\n \"gender\": \"M\",\n \"dob\": \"1985-12-31\",\n \"country_code\": \"TH\",\n \"phone\": \"081-999-8888\",\n \"email\": \"somsak.d@email.com\",\n \"address_full\": \"123 Sukhumvit Road, Watthana, Bangkok ... (truncated)\"\n }\n }\n}\nExact response bodies depend on implementation, but typical outcomes include:
\nx-api-key, or key lacks permission.Add these in the Tests tab if you want basic automated checks:
\npm.test(\"Status code is 200 or 201\", function () {\n pm.expect([200, 201]).to.include(pm.response.code);\n});\n\npm.test(\"Response is JSON\", function () {\n pm.response.to.be.json;\n});\n\npm.test(\"Response has expected top-level keys (if JSON)\", function () {\n const json = pm.response.json();\n // Adjust keys to match your API's response contract\n pm.expect(json).to.be.an(\"object\");\n // Example assertions (enable/modify as appropriate):\n // pm.expect(json).to.have.any.keys(\"meta\", \"payload\");\n});\n\n\n","urlObject":{"path":["patientencounter-upsert"],"host":["{{Base_URL}}{{Base_PATH}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"715c23d4-4b6b-4930-8068-72bf589e826b"},{"name":"Encounter Only","id":"6b2b1929-c864-41aa-9035-b5bbcb51f217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"x-api-key","value":"{{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"meta\": {\n \"event_id\": \"HIS-20260129-083000109\",\n \"correlation_id\": \"c3a1c2d0-3d5a-4e6c-8e91-8a3c2fd4c9a1\",\n \"event_type\": \"PatientEncounterUpsert\",\n \"source_system\": \"HIS\"\n },\n \"payload\": {\n \"encounter\": {\n \"encounter_id\": \"6601290005\",\n \"type_code\": \"OPD\",\n \"visit_date\": \"2026-01-29T08:30:00\",\n \"doctor_code\": \"D0055\",\n \"clinic_code\": \"TNCSTOCK\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{Base_URL}}{{Base_PATH}}/patientencounter-upsert","description":"If your API returns a standard envelope (e.g.,
\nsuccess,message,data,errors,timestamp), update the key assertions accordingly.
Upsert (create or update) Patient Encounter data (encounter only) into the TMS backend via an event-style payload.
\nThis request is typically used by upstream systems (e.g., HIS) to send encounter details. If the encounter already exists, the backend is expected to update it; if it does not exist, the backend is expected to create it.
\nPOST{{Base_URL}}{{Base_PATH}}/patientencounter-upsertThis endpoint uses an API key passed in a request header.
\nThis request relies on the following variables (active environment: TMS-DEV):
Content-Type: JSON (raw)
\n{\n \"meta\": {\n \"event_id\": \"string\",\n \"correlation_id\": \"string\",\n \"event_type\": \"string\",\n \"source_system\": \"string\"\n },\n \"payload\": {\n \"encounter\": {\n \"encounter_id\": \"string\",\n \"type_code\": \"string\",\n \"visit_date\": \"string\",\n \"doctor_code\": \"string\",\n \"clinic_code\": \"string\"\n }\n }\n}\nmetameta.event_id (string): Unique event identifier from the source system (often time-based). Useful for auditing and replay handling.meta.correlation_id (string, UUID recommended): Correlates logs/traces across systems for the same business transaction.meta.event_type (string): Event name for routing/validation (expected: PatientEncounterUpsert).meta.source_system (string): Source system identifier (e.g., HIS).payload.encounterpayload.encounter.encounter_id (string): Encounter identifier in the source system (primary business key for upsert).payload.encounter.type_code (string): Encounter type (example: OPD).payload.encounter.visit_date (string, ISO-8601 datetime): Visit date/time (example: 2026-01-29T08:30:00).payload.encounter.doctor_code (string): Attending doctor code.payload.encounter.clinic_code (string): Clinic/location code.{\"meta\":{\"event_id\":\"HIS-20260129-083000109\",\"correlation_id\":\"c3a1c2d0-3d5a-4e6c-8e91-8a3c2fd4c9a1\",\"event_type\":\"PatientEncounterUpsert\",\"source_system\":\"HIS\"},\"payload\":{\"encounter\":{\"encounter_id\":\"6601290005\",\"type_code\":\"OPD\",\"visit_date\":\"2026-01-29T08:30:00\",\"doctor_code\":\"D0055\",\"clinic_code\":\"TNCSTOCK\"}}}\nActual response payload may vary by environment/version.
\nx-api-key).payload.encounter.encounter_id should update the existing encounter rather than create duplicates (exact behavior depends on backend implementation).meta.correlation_id consistent across related calls in the same workflow to simplify tracing.meta.event_id should be unique per event submission to support audit and replay protection, if implemented.Upsert (create or update) a Patient record together with a related Encounter/Visit in HIS. Use this endpoint when you need to sync patient demographics and the encounter details in a single call.
\nPOST{{Base_URL}}{{Base_PATH}}/patientencounter-upsertThis request is parameterized using environment variables (recommended: set them in the active environment TMS-DEV).
{{Base_URL}} — Host (example: https://tnh-dev.vgroupth.com){{Base_PATH}} — Base API path (example: api/v2/his/){{APIKey}} — API key value used in x-api-keyBody is JSON with two top-level objects: meta and payload.
metaMetadata about the event being submitted.
\nevent_id (string): Unique event identifier (should be unique per submission)correlation_id (string, UUID recommended): Used to trace across systems/logsevent_type (string): Expected value: PatientEncounterUpsertsource_system (string): Source system identifier (example: HIS)payloadThe actual business data.
\npayload.patientPatient demographics and contact details.
\nCommon fields include:
\nmrn (string): Medical Record Number (patient identifier)first_name, last_name (string)first_name_th, last_name_th (string): Thai names (if applicable)gender (string): See Field notesdob (string): See Field notesphone, email, address_full (string, optional)payload.encounterEncounter/visit information.
\nCommon fields include:
\nencounter_id (string): Visit/encounter identifier (often VN)type_code (string): Encounter type (example: OPD)visit_date (string): See Field notesdoctor_code (string)clinic_code (string)meta values are free-form strings unless your backend validates them.patient.dob should be ISO date: YYYY-MM-DD (example: 1985-12-31).encounter.visit_date should be ISO 8601 datetime (recommended): YYYY-MM-DDTHH:mm:ss (example: 2026-01-29T08:30:00).event_id should be unique per event to prevent unintended duplicates.correlation_id should remain the same for all requests in the same workflow/transaction.patient.mrn and encounter.encounter_id are key identifiers used for upsert behavior.M, F (follow your HIS validation rules; use consistent casing).{\n \"meta\": {\n \"event_id\": \"HIS-20260129-083000104\",\n \"correlation_id\": \"c3a1c2d0-3d5a-4e6c-8e91-8a3c2fd4c9a1\",\n \"event_type\": \"PatientEncounterUpsert\",\n \"source_system\": \"HIS\"\n },\n \"payload\": {\n \"patient\": {\n \"mrn\": \"MRN-001\",\n \"title\": \"Mr.\",\n \"title_th\": \"นาย\",\n \"first_name\": \"Aryan\",\n \"last_name\": \"Khan\",\n \"first_name_th\": \"สมศักดิ์\",\n \"last_name_th\": \"ดีใจ\",\n \"gender\": \"M\",\n \"dob\": \"1985-12-31\",\n \"country_code\": \"TH\",\n \"phone\": \"081-999-8888\",\n \"email\": \"somsak.d@email.com\",\n \"address_full\": \"123 Sukhumvit Road, Watthana, Bangkok\"\n },\n \"encounter\": {\n \"encounter_id\": \"VN-001\",\n \"type_code\": \"OPD\",\n \"visit_date\": \"2026-01-29T08:30:00\",\n \"doctor_code\": \"D0055\",\n \"clinic_code\": \"TNCSTOCK\"\n }\n }\n}\n{{mrn}}, {{encounter_id}}, {{visit_date}}).correlation_id consistent per run iteration if you are chaining multiple related requests.event_id is unique per iteration (for example, include a timestamp or row number).Upsert (create or update) OPD patient + encounter data into TMS by sending a PatientEncounterUpsert event.
POST {{Base_URL}}{{Base_PATH}}/patientencounter-upsert
Send API key in header:
\nx-api-key: {{APIKey}}This request depends on the following variables (active environment: TMS-DEV):
\nBase_URL – API host, including protocol (e.g., https://...)Base_PATH – base path/prefix for the API (e.g., /tms/v3)APIKey – API key used in x-api-key headerRequest body is JSON with the following top-level structure:
\nmeta (object) – event metadataevent_id (string) – must be unique per eventcorrelation_id (string) – UUID used to correlate logs/traces across systemsevent_type (string) – fixed value: PatientEncounterUpsertsource_system (string) – origin system identifier (e.g., HIS)payload (object) – business datapatient (object) – patient demographics/contacts/identifiersencounter (object) – visit/encounter details (VN, type, visit date/time, clinic/doctor codes)meta.event_id: should be unique (commonly used for idempotency / de-duplication).meta.correlation_id: should be a valid UUID (e.g., xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).meta.event_type: must be exactly PatientEncounterUpsert.{\"meta\":{\"event_id\":\"HIS-20260129-083000122\",\"correlation_id\":\"c3a1c2d0-3d5a-4e6c-8e91-8a3c2fd4c9a1\",\"event_type\":\"PatientEncounterUpsert\",\"source_system\":\"HIS\"},\"payload\":{\"patient\":{\"mrn\":\"MRN-001\",\"title\":\"Mr.\",\"title_th\":\"นาย\",\"first_name\":\"Ary\",\"last_name\":\"Kha\",\"first_name_th\":\"สมศักดิ์\",\"last_name_th\":\"ดีใจ\",\"gender\":\"M\",\"dob\":\"1985-12-31\",\"country_code\":\"TH\",\"phone\":\"081-999-8888\",\"email\":\"somsak.d@email.com\",\"address_full\":\"123 Sukhumvit Road, Watthana, Bangkok 10...<truncated>\"},\"encounter\":{\"encounter_id\":\"VN-001\",\"type_code\":\"OPD\",\"visit_date\":\"2026-01-29T08:30:00\",\"doctor_code\":\"D0055\",\"clinic_code\":\"TNCSTOCK\"}}}\nTypical HTTP responses you may see:
\nx-api-key or not permitted.event_id or idempotency conflict (implementation-specific).Creates or updates (upserts) a patient record and an associated encounter in TMS. Use this endpoint to synchronize patient demographics and encounter/visit details from the source HIS into TMS.
\nPOST{{Base_URL}}{{Base_PATH}}/patientencounter-upsertThis request relies on these variables (typically set in the active environment TMS-DEV):
\n{{Base_URL}} – API host (e.g., https://...){{Base_PATH}} – Base path/prefix for the API (e.g., /tms/v3){{APIKey}} – API key used in x-api-keyThe body is JSON with two top-level sections:
\nmeta (event envelope)
event_id (string): Unique event identifier from the source systemcorrelation_id (string, UUID recommended): Trace ID used to link retries and downstream logsevent_type (string): Should be PatientEncounterUpsertsource_system (string): Originating system (e.g., HIS)payload (business data)
patient (object): Patient demographics/contacts (e.g., mrn, names, gender, DOB, phone, email, address)encounter (object): Encounter/visit data (e.g., encounter_id, type_code, visit_date, doctor_code)payload.patient.mrn and payload.encounter.encounter_id as stable business keys for upsert behavior.correlation_id so the event can be traced end-to-end.event_id remains unique per event emitted from the source system; if you replay the same event intentionally, keep the same event_id to help the receiver detect duplicates (depending on server-side behavior).{\n \"meta\": {\n \"event_id\": \"HIS-20260129-083000304\",\n \"correlation_id\": \"c3a1c2d0-3d5a-4e6c-8e91-8a3c2fd4c9a1\",\n \"event_type\": \"PatientEncounterUpsert\",\n \"source_system\": \"HIS\"\n },\n \"payload\": {\n \"patient\": {\n \"mrn\": \"009988810998771\",\n \"title\": \"Mrs.\",\n \"first_name\": \"Div\",\n \"last_name\": \"Kas\",\n \"first_name_th\": \"สมศักดิ์\",\n \"last_name_th\": \"ดีใจ\",\n \"gender\": \"F\",\n \"dob\": \"1985-12-31\",\n \"country_code\": \"TH\",\n \"phone\": \"081-999-8888\",\n \"email\": \"kashi.d@email.com\",\n \"address_full\": \"123 Sukhumvit Road, Watthana, Bangkok ...\"\n },\n \"encounter\": {\n \"encounter_id\": \"660129000102\",\n \"type_code\": \"IPD\",\n \"visit_date\": \"2026-01-29T08:30:00\",\n \"doctor_code\": \"D0055\"\n }\n }\n}\nCreates a stock dispense transaction in TMS from an upstream system (e.g., HIS). Use this endpoint to submit a dispense header plus one or more dispensed item lines.
\nPOST {{Base_URL}}{{Base_PATH}}/StockDispense-Create
\n\nNote:
\nContent-Typeis typically set automatically by Postman when using a raw JSON body.
Top-level structure:
\nmeta (object, required): Event and tracking information.payload (object, required): Dispense data (header + line items).meta fieldspayload fields (header)payload.items[] fields (lines){\n \"meta\": {\n \"event_id\": \"HIS-20260129-144000231\",\n \"correlation_id\": \"RX-998877\",\n \"event_type\": \"StockDispenseCreate\",\n \"source_system\": \"HIS\"\n },\n \"payload\": {\n \"dispense_no\": \"DSP-2026-133\",\n \"encounter_id\": \"967568568\",\n \"dispense_date\": \"2026-01-29T14:30:00\",\n \"doctor_code\": \"D0055\",\n \"items\": [\n {\n \"line_id\": \"1\",\n \"item_code\": \"FPMSYR05\",\n \"quantity\": 10,\n \"uom_code\": \"ชุด\",\n \"lot_serial_no\": \"LOT-FPMSYR05-100\",\n \"location_code\": \"PHSTOCK\",\n \"cost_center_code\": \"CC002\"\n }\n ]\n }\n}\nCreates (or upserts) a Transaction Record event from HIS into TMS for downstream billing/accounting processing. Use this endpoint to submit a batch containing transactions, invoices, and optional deposits, along with event metadata for traceability.
\nPOST{{Base_URL}}{{Base_PATH}}/TransactionRecordThis API uses an API key passed as a request header.
\nContent-Type: application/jsonx-api-key: {{APIKey}}This request expects the following variables to be set (for example, in the active environment):
\n{{Base_URL}} – API host/base URL{{Base_PATH}} – base path/prefix for the API{{APIKey}} – API key valueThe JSON payload contains two top-level objects: meta and payload.
meta (event metadata)event_id (string, required): Unique event identifier from source system (e.g., HIS-20260216-001).event_type (string, required): Event name/type. For this endpoint: TransactionRecord.source_system (string, required): Source system identifier (e.g., HIS).correlation_id (string, optional): Used to correlate calls across systems/flows.payload (business content)batch_id (string, required): Batch identifier grouping this submission.auto_reverse_accruals (boolean, optional): Whether accruals should be auto-reversed for items in this batch.payload.transactions[]Array of transaction (service/item) records.\nCommon key fields:
\ntransaction_id (string, required): Unique ID for the transaction line (used for linking from invoices).mrn (string, required): Patient MRN.encounter_id (string, optional/required by your workflow): Visit/encounter reference.product_code (string, required): Item/service code.uom_code (string, required): Unit of measure.quantity (number, required)unit_price (number, required)sold_final_price, sold_cover_price, sold_final_excess_price (number, optional)payor_type (string, optional)cost_center_code (string, optional)order_doctor_code (string, optional)status_code (string, optional; e.g., active)transaction_datetime (string, required): Datetime of the transaction.payload.invoices[]Array of invoice/bill records.\nCommon key fields:
\ninvoice_id (string, required)bill_no (string, required)bill_date (string, required)invoice_type (string, optional; e.g., cgd)mrn (string, required)payor_type (string, optional)payor_code (string, nullable/optional)is_void (boolean, optional)is_credit_note (boolean, optional)ref_original_bill_no (string, nullable/optional)is_paid (boolean, optional)auto_reverse_accruals (boolean, optional)transaction_ids (string[], required): Links invoice to payload.transactions[].transaction_id values.items[] (invoice line items):
item_code, item_name, uom_code (string)quantity, unit_price, total_amount (number)cost_center_code (string)payments[] (payments against invoice):
payment_method_code (string)amount (number)payment_date (string)payment_ref (string)type (string; e.g., payment)payload.deposits[] (optional)Array of deposit records.\nCommon key fields:
\ndeposit_id (string, required)mrn (string, required)encounter_id (string, optional/required by your workflow)amount (number, required)payment_method_code (string, required)payment_datetime (string, required){\n \"meta\": {\n \"event_id\": \"HIS-20260216-001\",\n \"event_type\": \"TransactionRecord\",\n \"source_system\": \"HIS\",\n \"correlation_id\": \"optional\"\n },\n \"payload\": {\n \"batch_id\": \"BATCH-001\",\n \"auto_reverse_accruals\": true,\n \"transactions\": [\n {\n \"transaction_id\": \"PT-001\",\n \"mrn\": \"MRN-001\",\n \"encounter_id\": \"VN-001\",\n \"product_code\": \"SRV-CONSULT\",\n \"uom_code\": \"UNIT\",\n \"quantity\": 1,\n \"unit_price\": 500,\n \"sold_final_price\": 500,\n \"sold_cover_price\": 0,\n \"sold_final_excess_price\": 500,\n \"payor_type\": \"Self\",\n \"cost_center_code\": \"OPD-A\",\n \"order_doctor_code\": \"DOC-001\",\n \"status_code\": \"active\",\n \"transaction_datetime\": \"2026-02-16T10:00:00\"\n }\n ],\n \"invoices\": [\n {\n \"invoice_id\": \"INV-001\",\n \"bill_no\": \"B-001\",\n \"bill_date\": \"2026-02-16T10:00:00\",\n \"invoice_type\": \"cgd\",\n \"mrn\": \"MRN-001\",\n \"payor_type\": \"Self\",\n \"payor_code\": null,\n \"is_void\": false,\n \"is_credit_note\": false,\n \"ref_original_bill_no\": null,\n \"is_paid\": true,\n \"auto_reverse_accruals\": true,\n \"transaction_ids\": [\"PT-001\"],\n \"items\": [\n {\n \"item_code\": \"SRV-CONSULT\",\n \"item_name\": \"Doctor Consultation\",\n \"uom_code\": \"UNIT\",\n \"quantity\": 1,\n \"unit_price\": 500,\n \"total_amount\": 500,\n \"cost_center_code\": \"OPD-A\"\n }\n ],\n \"payments\": [\n {\n \"payment_method_code\": \"CASH\",\n \"amount\": 500,\n \"payment_date\": \"2026-02-16T10:05:00\",\n \"payment_ref\": \"REC-001\",\n \"type\": \"payment\"\n }\n ]\n }\n ],\n \"deposits\": [\n {\n \"deposit_id\": \"DEP-001\",\n \"mrn\": \"MRN-001\",\n \"encounter_id\": \"AN-001\",\n \"amount\": 50000,\n \"payment_method_code\": \"CASH\",\n \"payment_datetime\": \"2026-02-16T09:00:00\"\n }\n ]\n }\n}\nYYYY-MM-DDTHH:mm:ss or with timezone offset if applicable).meta.event_id and transactions[].transaction_id should be unique to avoid accidental duplicates.invoices[].transaction_ids[] should match an existing transactions[].transaction_id within the same payload/batch.items[].total_amount is consistent with quantity * unit_price based on your business rules.No saved examples are attached to this request yet. Typically, expect:
\naggregated planty of necessary interface functions as follows:
\nTranaction interface
\nInvoice Interface
\nDeposit Interfac
\nCancel Transaction Interface
\nCancel Invoice Interface
\nPayment Interface
\nCreates or updates (upserts) a Price List record in TMS/Odoo from an external system (e.g., HIS). Use this endpoint to synchronize pricing data including item codes, prices, units of measure, and validity periods.
\nPOST {{Base_URL}}{{Base_PATH}}/pricelist
All requests must include a valid API key in the request header:
\nThe request body must be a JSON object with two top-level fields: meta and pricelist.
meta Objectpricelist Objectpricelist.items[] — Line Item Object{\n \"meta\": {\n \"event_id\": \"HIS-20260325-123456790\",\n \"source_system\": \"HIS\",\n \"event_type\": \"PriceListUpsert\"\n },\n \"pricelist\": {\n \"pricelist_code\": \"PL001\",\n \"name\": \"Standard Pricelist\",\n \"currency_code\": \"USD\",\n \"active\": true,\n \"items\": [\n {\n \"item_code\": \"ITEM001\",\n \"price\": 100,\n \"uom_code\": \"UNIT\",\n \"min_quantity\": 1,\n \"date_start\": \"2026-01-01\",\n \"date_end\": \"2026-12-31\"\n },\n {\n \"item_code\": \"ITEM002\",\n \"price\": 200\n }\n ]\n }\n}\n\nIf a price list with the given pricelist_code already exists, it will be updated.
If it does not exist, a new price list will be created.
\nItems within the price list are also upserted based on item_code.
Partial item definitions (e.g., omitting uom_code, date_start, date_end) are accepted; missing optional fields will be left as default or unchanged.
Set these in the TMS-DEV environment before sending requests.
\n","urlObject":{"path":["pricelist"],"host":["{{Base_URL}}{{Base_PATH}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a29d4a38-5f27-45ad-872f-170a263c1125"},{"name":"Upsert Payor","id":"2571f593-1e31-4bbd-ad56-d8c3af03f81b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"{{APIKey}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"meta\": {\n \"event_id\": \"PAYOR-20260325-997654324\",\n \"correlation_id\": \"CORR-001\",\n \"source_system\": \"HIS\"\n },\n \"payor\": {\n \"payor_code\": \"PAY001\",\n \"name\": \"Name chneg Insurance\",\n \"payor_type\": \"insurance\",\n \"tax_id\": \"GST12345\",\n \"email\": \"INSURANCE@abc.com\",\n \"phone\": \"1234567\",\n \"mobile\": \"18262266\",\n \"website\": \"https://abcinsurance.com\",\n \"street\": \"Main Road\",\n \"city\": \"Calicut\",\n \"state_code\": \"KL\",\n \"zip\": \"673001\",\n \"country_code\": \"IN\",\n \"requires_claim_ref\": true,\n \"contact_person\": \"John Doe\",\n \"contact_person_phone\": \"9999999999\",\n \"contact_person_email\": \"john@abc.com\",\n \"payment_terms\": \"30 Days\",\n \"credit_limit\": 50000,\n \"active\": true,\n \"notes\": \"Preferred insurance partner\",\n \"is_payer\": true\n }\n}"},"url":"{{Base_URL}}/api/v1/his/payors","description":"Creates a new payor record or updates an existing one in the HIS (Hospital Information System). The upsert logic is driven by payor_code — if a payor with the given code already exists, it will be updated; otherwise, a new record is inserted.
This endpoint requires an API key passed as a request header:
\nThe request body is a JSON object with two top-level keys: meta and payor.
meta — Event MetadataProvides traceability and context for the event being submitted.
\npayor — Payor RecordContains the full details of the payor to be inserted or updated.
\npayor_code — Acts as the natural key for upsert. Always provide a stable, unique code per payor.payor_type — Determines how billing and claim workflows are handled for this payor. Ensure the value matches the system's supported types.requires_claim_ref — When set to true, the billing module will enforce a claim reference number during invoice creation for this payor.is_payer — Distinguishes between entities that are financially responsible (true) versus those that are only referenced for administrative purposes.active — Inactive payors (false) are excluded from billing dropdowns and transaction flows without being deleted from the system.credit_limit — Used by the AR module to enforce credit controls. Set to 0 if no credit is extended.Creates or updates (upserts) a doctor record in TMS/Odoo from an external system (e.g., HIS). Use this endpoint to synchronize doctor master data — including contact details, department, specialization, and license information.
\nThis endpoint requires an API key passed via the request header:
\n\n\nSet the
\nAPIKeyvariable in the active environment (e.g., TMS-DEV).
The full endpoint URL is constructed from environment variables:
\n{{Base_URL}}{{Base_PATH}}/doctors\nSend a JSON payload with two top-level keys: meta and doctor.
meta Objectdoctor Object{\n \"meta\": {\n \"event_id\": \"HIS-20260325-111222334\",\n \"source_system\": \"HIS\",\n \"event_type\": \"DoctorUpsert\"\n },\n \"doctor\": {\n \"doctor_code\": \"DOC001\",\n \"name\": \"Dr. John Mathew\",\n \"email\": \"john.mathew@hospital.com\",\n \"phone\": \"04842345678\",\n \"mobile\": \"9876543210\",\n \"active\": true,\n \"doctor_type\": \"consultant\",\n \"license_no\": \"LIC12345fffffffffff6\",\n \"department_code\": \"CARD\",\n \"specialization_code\": \"CARDIO\"\n }\n}\ndoctor_code already exists, the record will be updated.active flag can be used to deactivate a doctor without deleting the record.Cancels a previously created stock dispense record in TMS/Odoo. Use this endpoint when a stock dispensing event initiated by HIS needs to be reversed or voided.
\nPOST {{Base_URL}}{{Base_PATH}}/StockDispense-Cancel
This endpoint requires an API key passed as a request header:
\nThe request body must be a JSON object with two top-level fields: meta and payload.
meta Objectpayload Object{\n \"meta\": {\n \"event_id\": \"HIS-20260325-000000002\",\n \"source_system\": \"HIS\",\n \"event_type\": \"StockDispenseCancel\"\n },\n \"payload\": {\n \"dispense_no\": \"DSP-2026-133\"\n }\n}\ndispense_no references an existing and active dispense record before calling this endpoint.event_id should be unique per event to support idempotency and traceability.Creates a stock dispense transaction in TMS from an upstream system (e.g., HIS). Use this endpoint to submit a dispense header plus one or more dispensed item lines.
\nPOST {{Base_URL}}{{Base_PATH}}/StockDispense-Create
\n\nNote:
\nContent-Typeis typically set automatically by Postman when using a raw JSON body.
Top-level structure:
\nmeta (object, required): Event and tracking information.payload (object, required): Dispense data (header + line items).meta fieldspayload fields (header)payload.items[] fields (lines){\n \"meta\": {\n \"event_id\": \"HIS-20260129-144000231\",\n \"correlation_id\": \"RX-998877\",\n \"event_type\": \"StockDispenseCreate\",\n \"source_system\": \"HIS\"\n },\n \"payload\": {\n \"dispense_no\": \"DSP-2026-133\",\n \"encounter_id\": \"967568568\",\n \"dispense_date\": \"2026-01-29T14:30:00\",\n \"doctor_code\": \"D0055\",\n \"items\": [\n {\n \"line_id\": \"1\",\n \"item_code\": \"FPMSYR05\",\n \"quantity\": 10,\n \"uom_code\": \"ชุด\",\n \"lot_serial_no\": \"LOT-FPMSYR05-100\",\n \"location_code\": \"PHSTOCK\",\n \"cost_center_code\": \"CC002\"\n }\n ]\n }\n}\n