{ "info": { "_postman_id": "9f3c71a4-2d68-4b5e-9a07-6c81e0f4b3d2", "name": "OptoSoft REST API (v1)", "description": "# OptoSoft REST API\n\nOfficial Postman collection for the OptoSoft optical retail API - **85 endpoints** across 8 modules.\n\nFull documentation: https://www.optosoft.in/developers/api\n\n## Quick start\n\n1. Open **Variables** on this collection and set `username` and `password` to your OptoSoft credentials.\n2. Run **01 Authentication \u0026 Account \u003e Login**. Its test script stores the JWT in `{{token}}` automatically.\n3. Every other request inherits Bearer `{{token}}` - just send them.\n4. Set `companyId`, `branchId` and `yearId` from your profile / `List financial years` before running the search endpoints.\n\n## Encrypted identifiers\n\nFields typed as a string id (`customerID`, `salesOrderID`, `itemTypeID`, ...) are **opaque encrypted tokens**, not numbers.\nNever construct one. Read it from an earlier response and echo it back verbatim. The `enc*` variables in this collection\nare placeholders for you to paste real values into as you obtain them.\n\nA few endpoints instead take **numeric** ids - those use the `*IdNum` variables. Each affected request says so in its description.\n\n## Paging\n\nTwo conventions are in use: `pageNumber`/`pageSize` (orders, receipts, item search) and `fromPage`/`toPage`\n(customers, invoices, doctors, WhatsApp templates). Paged responses wrap rows as `{ \"totalRows\": n, \"data\": [...] }`.\n\n## Notes on request bodies\n\nBodies are pre-filled with the most-used fields, not every field. Several models are very large\n(ReceiptWithouInvoiceModel has 164 fields, OMFastWizardModel 94) - for those, call the corresponding GET first\nand round-trip the returned object rather than building it from scratch.\n\n## Why some bodies show a JSON warning in the editor\n\nNumeric fields use bare variables, e.g. \"companyID\": {{companyId}} without quotes. Postman substitutes the value\nBEFORE sending, so the request that actually goes out is valid JSON (\"companyID\": 18). Quoting them would send a\nstring where the API expects an int64. The squiggle in the body editor is cosmetic - ignore it.\n\nGenerated from the OptoSoft OpenAPI 3.0 specification, snapshot 2026-07-26.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// Warn early if the token has not been set yet.", "if (!pm.collectionVariables.get(\"token\") \u0026\u0026 pm.request.url.getPath().indexOf(\"/api/Auth/login\") === -1) {", " console.warn(\"OptoSoft: {{token}} is empty - run \\\"Login (get JWT token)\\\" first.\");", "}" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://api.opto-soft.com", "type": "string", "description": "API host. No trailing slash." }, { "key": "username", "value": "", "type": "string", "description": "Your OptoSoft login name." }, { "key": "password", "value": "", "type": "string", "description": "Your OptoSoft password." }, { "key": "token", "value": "", "type": "string", "description": "JWT bearer token. Filled automatically by the Login request." }, { "key": "companyId", "value": "0", "type": "string", "description": "Numeric company (tenant) id." }, { "key": "branchId", "value": "0", "type": "string", "description": "Numeric branch (store) id." }, { "key": "yearId", "value": "0", "type": "string", "description": "Numeric financial year id - see \"List financial years\"." }, { "key": "encCompanyId", "value": "", "type": "string", "description": "Encrypted company id (string form)." }, { "key": "encBranchId", "value": "", "type": "string", "description": "Encrypted branch id." }, { "key": "encYearId", "value": "", "type": "string", "description": "Encrypted financial year id." }, { "key": "encCustomerId", "value": "", "type": "string", "description": "Encrypted customer id, from \"Search customers\"." }, { "key": "encSalesOrderId", "value": "", "type": "string", "description": "Encrypted sales order id, from \"Search sales orders\"." }, { "key": "encItemTypeId", "value": "", "type": "string", "description": "Encrypted item type id, from \"List item types\"." }, { "key": "encCategoryId", "value": "", "type": "string", "description": "Encrypted category id." }, { "key": "encModuleId", "value": "", "type": "string", "description": "Encrypted module id." }, { "key": "encEyeInfoId", "value": "", "type": "string", "description": "Encrypted prescription (eye info) id." }, { "key": "encDoctorId", "value": "", "type": "string", "description": "Encrypted doctor id." }, { "key": "encItemId", "value": "", "type": "string", "description": "Encrypted item id." }, { "key": "encCountryId", "value": "", "type": "string", "description": "Encrypted country id, from \"List countries\"." }, { "key": "encTemplateId", "value": "", "type": "string", "description": "Encrypted WhatsApp template id." }, { "key": "encConfigId", "value": "", "type": "string", "description": "Encrypted WhatsApp configuration id." }, { "key": "customerIdNum", "value": "0", "type": "string", "description": "NUMERIC customer id (only the endpoints that say so)." }, { "key": "salesOrderIdNum", "value": "0", "type": "string", "description": "NUMERIC sales order id (only /items and receipt lookups)." }, { "key": "receiptIdNum", "value": "0", "type": "string", "description": "NUMERIC receipt id." }, { "key": "itemIdNum", "value": "0", "type": "string", "description": "NUMERIC item id for stock lookup." }, { "key": "salesOrderNo", "value": "", "type": "string", "description": "Human-readable order number, e.g. SO/2026/001842." }, { "key": "receiptNo", "value": "", "type": "string", "description": "Human-readable receipt number." }, { "key": "sessionId", "value": "", "type": "string", "description": "Quick Sale cart session key - use a fresh GUID per transaction." }, { "key": "branchLogoFileName", "value": "logo.png", "type": "string", "description": "Logo file name from \"Get branch details\"." } ], "item": [ { "name": "01 Authentication \u0026 Account", "description": "Get a JWT bearer token, then read the signed-in user profile and working context. **Run \"Login\" first** - it saves the token into the {{token}} collection variable automatically.", "item": [ { "name": "Get my profile", "request": { "method": "POST", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Account/get-profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "Account", "get-profile" ] }, "description": "**POST /api/Account/get-profile**" } }, { "name": "Get user working context", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Account/user-details?date=2026-07-26", "host": [ "{{baseUrl}}" ], "path": [ "api", "Account", "user-details" ], "query": [ { "key": "date", "value": "2026-07-26", "description": "string" } ] }, "description": "**GET /api/Account/user-details**" } }, { "name": "Login (get JWT token)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Auth/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "Auth", "login" ] }, "body": { "mode": "raw", "raw": "{\n \"userName\": \"{{username}}\",\n \"password\": \"{{password}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Auth/login**\n\nExchange your OptoSoft username and password for a JWT. The test script on this request saves the token into {{token}}, so every other request in the collection then works without further setup. This is the only request that does not need an existing token.", "auth": { "type": "noauth" } }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "// Saves the JWT into the {{token}} collection variable so every other", "// request in this collection authenticates automatically.", "if (pm.response.code === 200) {", " let t = null;", " try {", " const j = pm.response.json();", " t = j.token || j.Token || j.accessToken || j.access_token ||", " (j.data \u0026\u0026 (j.data.token || j.data.Token));", " } catch (e) { /* non-JSON response */ }", " if (t) {", " pm.collectionVariables.set(\"token\", t);", " console.log(\"OptoSoft: token saved to {{token}}\");", " } else {", " console.warn(\"OptoSoft: no token field found - set {{token}} manually.\");", " }", "} else {", " console.warn(\"OptoSoft: login returned HTTP \" + pm.response.code);", "}" ] } } ] } ] }, { "name": "02 Customers \u0026 Prescriptions", "description": "Search and upsert customers, detect duplicates, manage optical prescriptions (SPH/CYL/AXIS/ADD/PD) and the referring-doctor master.", "item": [ { "name": "Check duplicate customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/check-duplicate", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "check-duplicate" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"phoneNO\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"isActive\": \"\",\n \"orderBy\": \"\",\n \"customerSourceStringID\": \"\",\n \"typeID\": \"\",\n \"fromPage\": 0,\n \"toPage\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/check-duplicate**" } }, { "name": "Delete prescription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/delete-prescription", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "delete-prescription" ] }, "body": { "mode": "raw", "raw": "{\n \"customerEyeInfoID\": \"{{encEyeInfoId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/delete-prescription**" } }, { "name": "Get customer detail", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "detail" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"phoneNO\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"isActive\": \"\",\n \"orderBy\": \"\",\n \"customerSourceStringID\": \"\",\n \"typeID\": \"\",\n \"fromPage\": 0,\n \"toPage\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/detail**" } }, { "name": "List doctors", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/doctor-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "doctor-list" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"phoneNO\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"isActive\": \"\",\n \"orderBy\": \"\",\n \"customerSourceStringID\": \"\",\n \"typeID\": \"\",\n \"fromPage\": 0,\n \"toPage\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/doctor-list**" } }, { "name": "List doctors (paged)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/doctor-list-page", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "doctor-list-page" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"phoneNO\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"isActive\": \"\",\n \"orderBy\": \"\",\n \"customerSourceStringID\": \"\",\n \"typeID\": \"\",\n \"fromPage\": 0,\n \"toPage\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/doctor-list-page**" } }, { "name": "Get doctor by ID", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Customer/get-doctor/{{encDoctorId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "get-doctor", "{{encDoctorId}}" ] }, "description": "**GET /api/Customer/get-doctor/{id}**" } }, { "name": "Get prescription (summary)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/GetPrescription", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "GetPrescription" ] }, "body": { "mode": "raw", "raw": "{\n \"customerEyeInfoID\": \"{{encEyeInfoId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/GetPrescription**" } }, { "name": "Search customers", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/list", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "list" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"phoneNO\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"isActive\": \"\",\n \"orderBy\": \"\",\n \"customerSourceStringID\": \"\",\n \"typeID\": \"\",\n \"fromPage\": 0,\n \"toPage\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/list**" } }, { "name": "Get prescription (full detail)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/prescription-full-detail", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "prescription-full-detail" ] }, "body": { "mode": "raw", "raw": "{\n \"customerEyeInfoID\": \"{{encEyeInfoId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/prescription-full-detail**" } }, { "name": "List prescriptions", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/prescription-list", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "prescription-list" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"phoneNO\": \"\",\n \"email\": \"\",\n \"city\": \"\",\n \"isActive\": \"\",\n \"orderBy\": \"\",\n \"customerSourceStringID\": \"\",\n \"typeID\": \"\",\n \"fromPage\": 0,\n \"toPage\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/prescription-list**" } }, { "name": "Create or update doctor", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/save-doctor", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "save-doctor" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"name\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"address\": \"\",\n \"city\": \"\",\n \"stateID\": \"\",\n \"countryID\": \"\",\n \"zipCode\": \"\",\n \"remarks\": \"\",\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/save-doctor**" } }, { "name": "Save prescription", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/save-prescription", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "save-prescription" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"id\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"email\": \"\",\n \"birthDate\": \"2026-07-26\",\n \"genderID\": \"\",\n \"houseNO\": \"\",\n \"societyName\": \"\",\n \"street\": \"\",\n \"area\": \"\",\n \"city\": \"\",\n \"sourceID\": \"\",\n \"doctorID\": \"{{encDoctorId}}\",\n \"presripionTypeID\": \"\",\n \"visitingDate\": \"2026-07-26\",\n \"prescriptionList\": [],\n \"prescriptionRemarks\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/save-prescription**" } }, { "name": "Create or update customer", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Customer/upsert", "host": [ "{{baseUrl}}" ], "path": [ "api", "Customer", "upsert" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": \"{{encCompanyId}}\",\n \"branchID\": \"{{encBranchId}}\",\n \"yearID\": \"{{encYearId}}\",\n \"title\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"mobile\": \"\",\n \"emailId\": \"\",\n \"genderID\": \"\",\n \"birthDate\": \"2026-07-26T00:00:00\",\n \"address\": \"\",\n \"city\": \"\",\n \"zipCode\": \"\",\n \"stateID\": \"\",\n \"countryID\": \"\",\n \"gstno\": \"\",\n \"customerSourceID\": \"\",\n \"isActive\": false,\n \"dndForPromotionalMessage\": false,\n \"dndForTransactionalMessage\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Customer/upsert**\n\nBody shows the most-used fields only (the full model has 77). Scoping ids are ENCRYPTED STRINGS here, unlike the numeric ones used by the customer search endpoints." } } ] }, { "name": "03 Sales Orders", "description": "Search orders, read line items and balances, change status and cancel. Note: /items takes a NUMERIC id; the other order endpoints take encrypted string ids.", "item": [ { "name": "Get advance receipt data", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Orders/{{encSalesOrderId}}/advance-receipt-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "{{encSalesOrderId}}", "advance-receipt-data" ] }, "description": "**GET /api/Orders/{salesOrderId}/advance-receipt-data**" } }, { "name": "Cancel order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Orders/{{encSalesOrderId}}/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "{{encSalesOrderId}}", "cancel" ] }, "body": { "mode": "raw", "raw": "{\n \"statusId\": 0,\n \"receiptStatusId\": 0,\n \"date\": \"2026-07-26T00:00:00\",\n \"transactionDate\": \"2026-07-26T00:00:00\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Orders/{salesOrderId}/cancel**\n\nCancellation is NOT reversible through the API. Confirm the reason and receipt treatment before sending." } }, { "name": "Get order line items", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Orders/{{salesOrderIdNum}}/items", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "{{salesOrderIdNum}}", "items" ] }, "description": "**GET /api/Orders/{salesOrderId}/items**\n\nNOTE: this path takes a NUMERIC int64 sales order id ({{salesOrderIdNum}}), unlike the other Orders endpoints which take the encrypted string id." } }, { "name": "Change order status", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Orders/{{encSalesOrderId}}/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "{{encSalesOrderId}}", "status" ] }, "body": { "mode": "raw", "raw": "{\n \"statusId\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**PUT /api/Orders/{salesOrderId}/status**" } }, { "name": "Get order by order number", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Orders/{{salesOrderNo}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "{{salesOrderNo}}" ] }, "description": "**GET /api/Orders/{salesOrderNo}**" } }, { "name": "Resolve order number to IDs", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Orders/{{salesOrderNo}}/ids", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "{{salesOrderNo}}", "ids" ] }, "description": "**GET /api/Orders/{salesOrderNo}/ids**" } }, { "name": "List cancellation reasons", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Orders/cancellation-reasons", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "cancellation-reasons" ] }, "description": "**GET /api/Orders/cancellation-reasons**" } }, { "name": "Customer order dropdown", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Orders/dropdown?customerId={{encCustomerId}}\u0026yearId={{yearId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "dropdown" ], "query": [ { "key": "customerId", "value": "{{encCustomerId}}", "description": "string" }, { "key": "yearId", "value": "{{yearId}}", "description": "integer(int64)" } ] }, "description": "**GET /api/Orders/dropdown**" } }, { "name": "Search sales orders", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Orders/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "search" ] }, "body": { "mode": "raw", "raw": "{\n \"pageNumber\": 0,\n \"pageSize\": 0,\n \"orderBy\": \"\",\n \"yearID\": {{yearId}},\n \"customerID\": \"{{encCustomerId}}\",\n \"branchName\": \"\",\n \"customerName\": \"\",\n \"customerMobile\": \"\",\n \"salesOrderNo\": \"{{salesOrderNo}}\",\n \"date\": \"2026-07-26\",\n \"fromDate\": \"2026-07-26\",\n \"toDate\": \"2026-07-26\",\n \"acceptedBy\": \"\",\n \"deliveryMode\": \"\",\n \"netAmount\": \"\",\n \"deliveryDateTime\": \"\",\n \"status\": \"\",\n \"discount\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Orders/search**" } }, { "name": "List orders with outstanding balance", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Orders/with-balance?yearId={{yearId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Orders", "with-balance" ], "query": [ { "key": "yearId", "value": "{{yearId}}", "description": "integer(int64)" } ] }, "description": "**GET /api/Orders/with-balance**" } } ] }, { "name": "04 Invoices", "description": "List GST invoices, find orders awaiting invoicing, pull a pre-filled invoice draft and post it back. Always round-trip the draft rather than building it by hand.", "item": [ { "name": "Customers awaiting invoicing", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Invoice/get-customers-for-invoice", "host": [ "{{baseUrl}}" ], "path": [ "api", "Invoice", "get-customers-for-invoice" ] }, "description": "**GET /api/Invoice/get-customers-for-invoice**" } }, { "name": "Get invoice draft for an order", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Invoice/get-invoice-data-by-salesorder?salesOrderId={{encSalesOrderId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Invoice", "get-invoice-data-by-salesorder" ], "query": [ { "key": "salesOrderId", "value": "{{encSalesOrderId}}", "description": "string" } ] }, "description": "**GET /api/Invoice/get-invoice-data-by-salesorder**" } }, { "name": "Orders awaiting invoicing (branch-wide)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Invoice/GetOrdersForNewInvoice", "host": [ "{{baseUrl}}" ], "path": [ "api", "Invoice", "GetOrdersForNewInvoice" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}}\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Invoice/GetOrdersForNewInvoice**" } }, { "name": "Orders awaiting invoicing (by customer)", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Invoice/get-sales-orders-for-invoice?customerId={{encCustomerId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Invoice", "get-sales-orders-for-invoice" ], "query": [ { "key": "customerId", "value": "{{encCustomerId}}", "description": "string" } ] }, "description": "**GET /api/Invoice/get-sales-orders-for-invoice**" } }, { "name": "Search invoices", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Invoice/List", "host": [ "{{baseUrl}}" ], "path": [ "api", "Invoice", "List" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"yearID\": {{yearId}},\n \"customerMobile\": \"\",\n \"customerName\": \"\",\n \"invoiceNumber\": \"\",\n \"fromDate\": \"2026-07-26\",\n \"toDate\": \"2026-07-26\",\n \"amount\": \"\",\n \"netAmount\": \"\",\n \"totalRows\": \"\",\n \"salesOrderNo\": \"{{salesOrderNo}}\",\n \"orderBy\": \"\",\n \"customerID\": \"{{encCustomerId}}\",\n \"fromPage\": 0,\n \"toPage\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Invoice/List**" } }, { "name": "Save invoice", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Invoice/save-invoice-data", "host": [ "{{baseUrl}}" ], "path": [ "api", "Invoice", "save-invoice-data" ] }, "body": { "mode": "raw", "raw": "{\n \"sessionID\": \"{{sessionId}}\",\n \"orderDate\": \"2026-07-26T00:00:00\",\n \"expectedDate\": \"2026-07-26T00:00:00\",\n \"supplierID\": \"\",\n \"fitterID\": \"\",\n \"priorityID\": \"\",\n \"userId\": 0,\n \"branchCity\": \"\",\n \"isLensAdded\": false,\n \"isSpectacleLensInOrder\": false,\n \"isExternal\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Invoice/save-invoice-data**\n\nBody is the composite OMFastWizardModel (94 top-level properties). ALWAYS round-trip: call \"Get invoice draft for an order\" first, modify what you need, and post the whole object back. Building this by hand produces incorrect tax totals." } } ] }, { "name": "05 Payments \u0026 Reporting", "description": "Read receipts against a customer/order, page the receipt register, and pull dashboard aggregates.", "item": [ { "name": "Get dashboard data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Dashboard/dashboardData", "host": [ "{{baseUrl}}" ], "path": [ "api", "Dashboard", "dashboardData" ] }, "body": { "mode": "raw", "raw": "{\n \"branchID\": \"{{encBranchId}}\",\n \"yearID\": \"{{encYearId}}\",\n \"statusId\": 0,\n \"date\": \"2026-07-26T00:00:00\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Dashboard/dashboardData**" } }, { "name": "Get receipts for customer + order", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Receipts/id?customerId={{customerIdNum}}\u0026salesOrderId={{salesOrderIdNum}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Receipts", "id" ], "query": [ { "key": "customerId", "value": "{{customerIdNum}}", "description": "integer(int64)" }, { "key": "salesOrderId", "value": "{{salesOrderIdNum}}", "description": "integer(int64)" } ] }, "description": "**GET /api/Receipts/id**\n\nNOTE: both ids here are NUMERIC int64, not encrypted strings. Despite the path ending in /id, the identifiers are query parameters and the response is an array." } }, { "name": "Search receipt register", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Receipts/list-paged", "host": [ "{{baseUrl}}" ], "path": [ "api", "Receipts", "list-paged" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": \"{{encCompanyId}}\",\n \"branchID\": \"{{encBranchId}}\",\n \"yearID\": \"{{encYearId}}\",\n \"customerID\": \"{{encCustomerId}}\",\n \"receiptNo\": \"\",\n \"receiptType\": \"\",\n \"salesOrderNo\": \"{{salesOrderNo}}\",\n \"invoiceNO\": \"\",\n \"date\": \"2026-07-26\",\n \"customerName\": \"\",\n \"customerMobile\": \"\",\n \"fromDate\": \"2026-07-26\",\n \"toDate\": \"2026-07-26\",\n \"amount\": \"\",\n \"status\": \"\",\n \"pageNumber\": 0,\n \"pageSize\": 0,\n \"orderBy\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Receipts/list-paged**" } } ] }, { "name": "06 Quick Sale", "description": "Counter billing. Build a server-side cart against a sessionID, look up items by barcode or autocomplete, check stock, then commit sale + invoice + receipt in one call.", "item": [ { "name": "Card types", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/allCard", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "allCard" ] }, "description": "**GET /api/quickSale/allCard**" } }, { "name": "Get minimum app version", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/app-version", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "app-version" ] }, "description": "**GET /api/quickSale/app-version**" } }, { "name": "Delete cart line", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/delete-salesorder-temp", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "delete-salesorder-temp" ] }, "body": { "mode": "raw", "raw": "{\n \"sessionID\": \"{{sessionId}}\",\n \"salesOrderTempId\": \"\",\n \"pairNo\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/delete-salesorder-temp**" } }, { "name": "Abandon cart (clear session)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/deleteSalesOrderTempBySession", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "deleteSalesOrderTempBySession" ] }, "body": { "mode": "raw", "raw": "{\n \"sessionID\": \"{{sessionId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/deleteSalesOrderTempBySession**" } }, { "name": "List payment methods", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/Fetch-Receipt-Type", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "Fetch-Receipt-Type" ] }, "description": "**GET /api/quickSale/Fetch-Receipt-Type**" } }, { "name": "Get branch details", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-branch-details", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-branch-details" ] }, "description": "**GET /api/quickSale/get-branch-details**" } }, { "name": "Get branch logo", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-branch-logo/{{branchId}}/{{branchLogoFileName}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-branch-logo", "{{branchId}}", "{{branchLogoFileName}}" ] }, "description": "**GET /api/quickSale/get-branch-logo/{branchId}/{fileName}**\n\nReturns image bytes, not JSON." } }, { "name": "List customer credit notes", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-credit-notes?customerId={{customerIdNum}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-credit-notes" ], "query": [ { "key": "customerId", "value": "{{customerIdNum}}", "description": "integer(int64)" } ] }, "description": "**GET /api/quickSale/get-credit-notes**" } }, { "name": "Doctors dropdown", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-doctors-dropdown", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-doctors-dropdown" ] }, "description": "**GET /api/quickSale/get-doctors-dropdown**" } }, { "name": "Get live item stock", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/getExactItemStock?itemId={{itemIdNum}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "getExactItemStock" ], "query": [ { "key": "itemId", "value": "{{itemIdNum}}", "description": "integer(int64)" } ] }, "description": "**GET /api/quickSale/getExactItemStock**" } }, { "name": "Fitters dropdown", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-fitters-dropdown", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-fitters-dropdown" ] }, "description": "**GET /api/quickSale/get-fitters-dropdown**" } }, { "name": "Autocomplete frames \u0026 sunglasses", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/GetFrameSunGlassForAutoComplete?term=ray\u0026yearId={{yearId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "GetFrameSunGlassForAutoComplete" ], "query": [ { "key": "term", "value": "ray", "description": "string" }, { "key": "yearId", "value": "{{yearId}}", "description": "integer(int64)" } ] }, "description": "**GET /api/quickSale/GetFrameSunGlassForAutoComplete**" } }, { "name": "Genders", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/getGenders", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "getGenders" ] }, "description": "**GET /api/quickSale/getGenders**" } }, { "name": "Get item by barcode", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/getItemDetailFromCode?code=8901234567890", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "getItemDetailFromCode" ], "query": [ { "key": "code", "value": "8901234567890", "description": "string" } ] }, "description": "**GET /api/quickSale/getItemDetailFromCode**" } }, { "name": "Get item type by ID", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-item-type-id?id=0", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-item-type-id" ], "query": [ { "key": "id", "value": "0", "description": "integer(int32)" } ] }, "description": "**GET /api/quickSale/get-item-type-id**" } }, { "name": "Memberships (paged)", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/getMemberships?page=1\u0026pageSize=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "getMemberships" ], "query": [ { "key": "page", "value": "1", "description": "integer(int32)" }, { "key": "pageSize", "value": "50", "description": "integer(int32)" } ] }, "description": "**GET /api/quickSale/getMemberships**" } }, { "name": "Job priority dropdown", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-priority-dropdown", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-priority-dropdown" ] }, "description": "**GET /api/quickSale/get-priority-dropdown**" } }, { "name": "Get receipt detail (for reprint)", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/GetReceiptDetails?customerId={{customerIdNum}}\u0026receiptId={{receiptIdNum}}\u0026salesOrderId={{salesOrderIdNum}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "GetReceiptDetails" ], "query": [ { "key": "customerId", "value": "{{customerIdNum}}", "description": "integer(int64)" }, { "key": "receiptId", "value": "{{receiptIdNum}}", "description": "integer(int64)" }, { "key": "salesOrderId", "value": "{{salesOrderIdNum}}", "description": "integer(int64)" } ] }, "description": "**GET /api/quickSale/GetReceiptDetails**" } }, { "name": "Get cart with totals", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/GetSalesOrderTemp", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "GetSalesOrderTemp" ] }, "body": { "mode": "raw", "raw": "{\n \"sessionId\": \"{{sessionId}}\",\n \"jobCharges\": 0,\n \"shippingCharges\": 0,\n \"otherCharges\": 0,\n \"serviceTax\": 0,\n \"isCompositionScheme\": false,\n \"isCustomerStateNotSameAsCompanyState\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/GetSalesOrderTemp**" } }, { "name": "Customer sources (paged)", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/getSources?page=1\u0026pageSize=50", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "getSources" ], "query": [ { "key": "page", "value": "1", "description": "integer(int32)" }, { "key": "pageSize", "value": "50", "description": "integer(int32)" } ] }, "description": "**GET /api/quickSale/getSources**" } }, { "name": "Autocomplete spectacle lenses", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/GetSpectacleLensForAutoComplete?term=ray", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "GetSpectacleLensForAutoComplete" ], "query": [ { "key": "term", "value": "ray", "description": "string" } ] }, "description": "**GET /api/quickSale/GetSpectacleLensForAutoComplete**" } }, { "name": "Suppliers dropdown", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/quickSale/get-suppliers-dropdown", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "get-suppliers-dropdown" ] }, "description": "**GET /api/quickSale/get-suppliers-dropdown**" } }, { "name": "Raise invoice for existing order", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/SaveInvoiceOnly", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "SaveInvoiceOnly" ] }, "body": { "mode": "raw", "raw": "{\n \"salesOrderID\": \"{{encSalesOrderId}}\",\n \"customerID\": \"{{encCustomerId}}\",\n \"sessionID\": \"{{sessionId}}\",\n \"invoiceDate\": \"2026-07-26T00:00:00\",\n \"isCompositionScheme\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/SaveInvoiceOnly**" } }, { "name": "Record payment (receipt)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/SaveReceipt", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "SaveReceipt" ] }, "body": { "mode": "raw", "raw": "{\n \"salesOrderID\": \"{{encSalesOrderId}}\",\n \"yearId\": \"{{encYearId}}\",\n \"branchId\": {{branchId}},\n \"receiptTypeId\": 0,\n \"receiptAmount\": 0,\n \"referenceNo\": \"\",\n \"salesOrderNo\": \"{{salesOrderNo}}\",\n \"netAmount\": 0,\n \"statusId\": 0,\n \"taxNotApplicable\": false,\n \"isForeigner\": false,\n \"receiptPrintFormat\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/SaveReceipt**\n\nBody shows the most-used fields only (the full model has 164; the remainder are branch letterhead and print-layout fields)." } }, { "name": "Commit sale (order + invoice + receipt)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/SaveSale", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "SaveSale" ] }, "body": { "mode": "raw", "raw": "{\n \"sessionID\": \"{{sessionId}}\",\n \"orderDate\": \"2026-07-26T00:00:00\",\n \"expectedDate\": \"2026-07-26T00:00:00\",\n \"supplierID\": \"\",\n \"fitterID\": \"\",\n \"priorityID\": \"\",\n \"userId\": 0,\n \"branchCity\": \"\",\n \"isLensAdded\": false,\n \"isSpectacleLensInOrder\": false,\n \"isExternal\": false\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/SaveSale**\n\nCommits the cart identified by sessionID into a real order + invoice + receipt. Do not blindly retry on timeout - query \"Search sales orders\" first to check whether it already succeeded." } }, { "name": "Add line item to cart", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/saveSalesOrderTemp", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "saveSalesOrderTemp" ] }, "body": { "mode": "raw", "raw": "{\n \"sessionID\": \"{{sessionId}}\",\n \"itemID\": \"{{encItemId}}\",\n \"inventoryID\": \"\",\n \"qty\": 0,\n \"mrp\": 0,\n \"price\": 0,\n \"discountRate\": 0,\n \"discountAmount\": 0,\n \"sgstRate\": 0,\n \"cgstRate\": 0,\n \"igstRate\": 0,\n \"jobCharges\": 0,\n \"pairNo\": \"\",\n \"spectacleLensType\": 0,\n \"spherical\": \"\",\n \"cylinder\": \"\",\n \"axis\": \"\",\n \"addition\": \"\",\n \"pd\": \"\",\n \"lensFittingHeight\": 0,\n \"lensTotalHeight\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/saveSalesOrderTemp**\n\nAdds ONE line item to the cart. Leave the computed total/tax fields unset - OptoSoft calculates them. Use pairNo to group lines into complete spectacle pairs." } }, { "name": "Search contact lenses", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/search-contact-lens", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "search-contact-lens" ] }, "body": { "mode": "raw", "raw": "{\n \"term\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/search-contact-lens**" } }, { "name": "Update cart line", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/quickSale/update-sales-order-temp-values", "host": [ "{{baseUrl}}" ], "path": [ "api", "quickSale", "update-sales-order-temp-values" ] }, "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"qty\": 0,\n \"price\": 0,\n \"discountRate\": 0,\n \"discountAmount\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/quickSale/update-sales-order-temp-values**" } } ] }, { "name": "07 Catalog \u0026 Master Data", "description": "Item type/category/sub-category tree, item search, country/state/financial-year masters, and invoice/receipt PDF + HTML rendering.", "item": [ { "name": "List categories by item type", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Common/GetCategoriesByItemType", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "GetCategoriesByItemType" ] }, "body": { "mode": "raw", "raw": "{\n \"itemTypeID\": \"{{encItemTypeId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Common/GetCategoriesByItemType**" } }, { "name": "List countries", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Common/GetCountries", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "GetCountries" ] }, "description": "**GET /api/Common/GetCountries**" } }, { "name": "List item types", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Common/GetItemTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "GetItemTypes" ] }, "description": "**GET /api/Common/GetItemTypes**" } }, { "name": "List states by country", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Common/GetStates/{{encCountryId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "GetStates", "{{encCountryId}}" ] }, "description": "**GET /api/Common/GetStates/{countryId}**" } }, { "name": "List sub-categories by category", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Common/GetSubCategoriesByCategory", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "GetSubCategoriesByCategory" ] }, "body": { "mode": "raw", "raw": "{\n \"categoryID\": \"{{encCategoryId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Common/GetSubCategoriesByCategory**" } }, { "name": "List financial years", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/Common/GetYears", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "GetYears" ] }, "description": "**GET /api/Common/GetYears**" } }, { "name": "Render invoice PDF", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Common/invoice/pdf?BranchID={{branchId}}\u0026CompanyID={{companyId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "invoice", "pdf" ], "query": [ { "key": "BranchID", "value": "{{branchId}}", "description": "string" }, { "key": "CompanyID", "value": "{{companyId}}", "description": "string" } ] }, "body": { "mode": "raw", "raw": "\"\u003cserialised document model - round-trip it from the invoice draft endpoint\u003e\"", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Common/invoice/pdf**\n\nReturns binary PDF bytes, not JSON. The spec types the body as a bare string; in practice it is the serialised invoice document model - round-trip it from \"Get invoice draft for an order\"." } }, { "name": "Render invoice HTML", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Common/invoice/pdf/html?BranchID={{branchId}}\u0026CompanyID={{companyId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "invoice", "pdf", "html" ], "query": [ { "key": "BranchID", "value": "{{branchId}}", "description": "string" }, { "key": "CompanyID", "value": "{{companyId}}", "description": "string" } ] }, "body": { "mode": "raw", "raw": "\"\u003cserialised document model - round-trip it from the invoice draft endpoint\u003e\"", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Common/invoice/pdf/html**" } }, { "name": "Render receipt PDF", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Common/receipt/pdf?receiptNo={{receiptNo}}\u0026external=true\u0026BranchID={{branchId}}\u0026CompanyID={{companyId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "receipt", "pdf" ], "query": [ { "key": "receiptNo", "value": "{{receiptNo}}", "description": "string" }, { "key": "external", "value": "true", "description": "boolean" }, { "key": "BranchID", "value": "{{branchId}}", "description": "string" }, { "key": "CompanyID", "value": "{{companyId}}", "description": "string" } ] }, "body": { "mode": "raw", "raw": "\"\u003cserialised document model - round-trip it from the invoice draft endpoint\u003e\"", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Common/receipt/pdf**\n\nReturns binary PDF bytes, not JSON. This one can locate the document itself from receiptNo." } }, { "name": "Render receipt HTML", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Common/receipt/pdf/html?receiptNo={{receiptNo}}\u0026external=true\u0026BranchID={{branchId}}\u0026CompanyID={{companyId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "receipt", "pdf", "html" ], "query": [ { "key": "receiptNo", "value": "{{receiptNo}}", "description": "string" }, { "key": "external", "value": "true", "description": "boolean" }, { "key": "BranchID", "value": "{{branchId}}", "description": "string" }, { "key": "CompanyID", "value": "{{companyId}}", "description": "string" } ] }, "body": { "mode": "raw", "raw": "\"\u003cserialised document model - round-trip it from the invoice draft endpoint\u003e\"", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Common/receipt/pdf/html**" } }, { "name": "Search catalog items", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Common/SearchItems", "host": [ "{{baseUrl}}" ], "path": [ "api", "Common", "SearchItems" ] }, "body": { "mode": "raw", "raw": "{\n \"itemTypeID\": \"{{encItemTypeId}}\",\n \"categoryID\": \"{{encCategoryId}}\",\n \"subCategoryID\": \"\",\n \"searchTerm\": \"\",\n \"pageNumber\": 0,\n \"pageSize\": 0\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Common/SearchItems**" } }, { "name": "Get full category tree", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Module/GetCategoryTreeByItemType", "host": [ "{{baseUrl}}" ], "path": [ "api", "Module", "GetCategoryTreeByItemType" ] }, "body": { "mode": "raw", "raw": "{\n \"itemTypeID\": \"{{encItemTypeId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Module/GetCategoryTreeByItemType**" } }, { "name": "List item types by module", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Module/GetItemTypesByModule", "host": [ "{{baseUrl}}" ], "path": [ "api", "Module", "GetItemTypesByModule" ] }, "body": { "mode": "raw", "raw": "{\n \"moduleID\": \"{{encModuleId}}\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Module/GetItemTypesByModule**" } }, { "name": "List quick sale types", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Module/GetQuickSaleTypes", "host": [ "{{baseUrl}}" ], "path": [ "api", "Module", "GetQuickSaleTypes" ] }, "body": { "mode": "raw", "raw": "{\n \"value\": \"\",\n \"name\": \"\",\n \"moduleID\": \"{{encModuleId}}\",\n \"itemImagePath\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Module/GetQuickSaleTypes**" } }, { "name": "Commit sale (module-scoped)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/Module/SaveSale", "host": [ "{{baseUrl}}" ], "path": [ "api", "Module", "SaveSale" ] }, "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/Module/SaveSale**\n\nThe OpenAPI spec declares this request body as an untyped object with no schema, so its contract is not verifiable. Prefer /api/quickSale/SaveSale. Contact OptoSoft before building against this." } } ] }, { "name": "08 WhatsApp Messaging", "description": "Register a WhatsApp Business Account against a branch and manage the Meta-approved message-template library.", "item": [ { "name": "Get WhatsApp configuration", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/ClientWhatsAppConfig/{{encConfigId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "ClientWhatsAppConfig", "{{encConfigId}}" ] }, "description": "**GET /api/ClientWhatsAppConfig/{id}**" } }, { "name": "List WhatsApp configurations", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/ClientWhatsAppConfig/List", "host": [ "{{baseUrl}}" ], "path": [ "api", "ClientWhatsAppConfig", "List" ] }, "body": { "mode": "raw", "raw": "{\n \"companyID\": {{companyId}},\n \"branchID\": {{branchId}},\n \"displayName\": \"\",\n \"phoneNumber\": \"\",\n \"wabaID\": \"\",\n \"phoneNumberID\": \"\",\n \"accessToken\": \"\",\n \"fromPage\": 0,\n \"toPage\": 0,\n \"orderBy\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/ClientWhatsAppConfig/List**" } }, { "name": "Create or update WhatsApp configuration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/ClientWhatsAppConfig/Save", "host": [ "{{baseUrl}}" ], "path": [ "api", "ClientWhatsAppConfig", "Save" ] }, "body": { "mode": "raw", "raw": "{\n \"encryptedWhatsAppConfigID\": \"\",\n \"wabaID\": \"\",\n \"wabaName\": \"\",\n \"phoneNumberID\": \"\",\n \"phoneNumber\": \"\",\n \"accessToken\": \"\",\n \"displayName\": \"\",\n \"isActive\": false,\n \"status\": \"\",\n \"webhookURL\": \"\",\n \"remarks\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "description": "**POST /api/ClientWhatsAppConfig/Save**" } }, { "name": "Get template by ID", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/WhatsAppTemplateMaster/{{encTemplateId}}", "host": [ "{{baseUrl}}" ], "path": [ "api", "WhatsAppTemplateMaster", "{{encTemplateId}}" ] }, "description": "**GET /api/WhatsAppTemplateMaster/{id}**" } }, { "name": "List approved templates", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/WhatsAppTemplateMaster/approved?companyId={{companyId}}\u0026branchId={{branchId}}\u0026templateName=\u0026category=UTILITY\u0026language=en\u0026fromPage=1\u0026toPage=50\u0026orderBy=", "host": [ "{{baseUrl}}" ], "path": [ "api", "WhatsAppTemplateMaster", "approved" ], "query": [ { "key": "companyId", "value": "{{companyId}}", "description": "integer(int64)" }, { "key": "branchId", "value": "{{branchId}}", "description": "integer(int64)" }, { "key": "templateName", "value": "", "description": "string" }, { "key": "category", "value": "UTILITY", "description": "string" }, { "key": "language", "value": "en", "description": "string" }, { "key": "fromPage", "value": "1", "description": "integer(int32)" }, { "key": "toPage", "value": "50", "description": "integer(int32)" }, { "key": "orderBy", "value": "", "description": "string" } ] }, "description": "**GET /api/WhatsAppTemplateMaster/approved**" } }, { "name": "List message templates", "request": { "method": "GET", "header": [ ], "url": { "raw": "{{baseUrl}}/api/WhatsAppTemplateMaster/list?companyId={{companyId}}\u0026branchId={{branchId}}\u0026templateName=\u0026category=UTILITY\u0026language=en\u0026isActive=true\u0026fromPage=1\u0026toPage=50\u0026orderBy=", "host": [ "{{baseUrl}}" ], "path": [ "api", "WhatsAppTemplateMaster", "list" ], "query": [ { "key": "companyId", "value": "{{companyId}}", "description": "integer(int64)" }, { "key": "branchId", "value": "{{branchId}}", "description": "integer(int64)" }, { "key": "templateName", "value": "", "description": "string" }, { "key": "category", "value": "UTILITY", "description": "string" }, { "key": "language", "value": "en", "description": "string" }, { "key": "isActive", "value": "true", "description": "boolean" }, { "key": "fromPage", "value": "1", "description": "integer(int32)" }, { "key": "toPage", "value": "50", "description": "integer(int32)" }, { "key": "orderBy", "value": "", "description": "string" } ] }, "description": "**GET /api/WhatsAppTemplateMaster/list**" } }, { "name": "Sync templates from Meta", "request": { "method": "POST", "header": [ ], "url": { "raw": "{{baseUrl}}/api/WhatsAppTemplateMaster/sync", "host": [ "{{baseUrl}}" ], "path": [ "api", "WhatsAppTemplateMaster", "sync" ] }, "description": "**POST /api/WhatsAppTemplateMaster/sync**" } } ] } ] }