Catalog & Master Data – OptoSoft API

Returns the top level of the catalog. Start here, then drill into categories. This is one of the few endpoints whose response schema is declared in the specification.

Response

Example request

curl https://api.opto-soft.com/api/Common/GetItemTypes \
  -H "Authorization: Bearer YOUR_TOKEN"

Example response

[
  {
    "value": "ENCRYPTED_ITEM_TYPE_ID",
    "name": "Frame",
    "moduleID": "ENCRYPTED_MODULE_ID",
    "itemImagePath": "/images/itemtypes/frame.png"
  }
]

Returns the categories under one item type — the second level of the tree.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/Common/GetCategoriesByItemType \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "itemTypeID": "ENCRYPTED_ITEM_TYPE_ID" }'

Returns the sub-categories under one category — the third and deepest level.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/Common/GetSubCategoriesByCategory \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "categoryID": "ENCRYPTED_CATEGORY_ID" }'

The general-purpose catalog search: filter by any level of the tree, by free text, or by all three. Paging uses the pageNumber / pageSize style.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/Common/SearchItems \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "itemTypeID": "ENCRYPTED_ITEM_TYPE_ID",
    "searchTerm": "titanium",
    "pageNumber": 1,
    "pageSize": 25
  }'

Returns the item types belonging to one module — the module-scoped equivalent of GetItemTypes.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/Module/GetItemTypesByModule \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "moduleID": "ENCRYPTED_MODULE_ID" }'

Returns the entire category and sub-category tree for an item type in one call. Prefer this over calling GetCategoriesByItemType and then GetSubCategoriesByCategory per node — it saves a round trip per category.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/Module/GetCategoryTreeByItemType \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "itemTypeID": "ENCRYPTED_ITEM_TYPE_ID" }'

Returns the sale types available in the Quick Sale screen for a module — which product sections the counter operator can bill from.

Request body

Example request

curl -X POST https://api.opto-soft.com/api/Module/GetQuickSaleTypes \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "moduleID": "ENCRYPTED_MODULE_ID" }'

A module-scoped sale commit, parallel to /api/quickSale/SaveSale.

Request body

Untyped JSON object. Not specified.

Returns the country master with encrypted IDs, for countryID on customer and doctor records.

Query parameters

None.

Example request

curl https://api.opto-soft.com/api/Common/GetCountries \
  -H "Authorization: Bearer YOUR_TOKEN"

Returns the states within a country. For India this is the list that drives the GST place-of-supply rule, so setting a customer’s state correctly is what makes CGST + SGST versus IGST come out right on their invoices.

Path parameters

Example request

curl https://api.opto-soft.com/api/Common/GetStates/ENCRYPTED_COUNTRY_ID \
  -H "Authorization: Bearer YOUR_TOKEN"

Returns the financial years configured for the company. Almost every search endpoint takes a yearID, so resolve the current year from here at start-up rather than hard-coding it — it rolls over every 1 April in India.

Query parameters

None.

Example request

curl https://api.opto-soft.com/api/Common/GetYears \
  -H "Authorization: Bearer YOUR_TOKEN"

Renders a GST invoice as a PDF. Returns binary bytes, not JSON.

Query parameters

Example request

curl -X POST "https://api.opto-soft.com/api/Common/invoice/pdf?CompanyID=ENCRYPTED_COMPANY_ID&BranchID=ENCRYPTED_BRANCH_ID" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @invoice.json \
  -o invoice.pdf

The HTML variant of the invoice renderer. Use it to preview an invoice in a browser or an in-app web view, or to apply your own print stylesheet.

Query parameters

Example request

curl -X POST "https://api.opto-soft.com/api/Common/invoice/pdf/html?CompanyID=ENCRYPTED_COMPANY_ID&BranchID=ENCRYPTED_BRANCH_ID" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @invoice.json \
  -o invoice.html

Renders a payment receipt as a PDF. Unlike the invoice renderer, this one can locate the receipt itself from receiptNo.

Query parameters

Example request

curl -X POST "https://api.opto-soft.com/api/Common/receipt/pdf?receiptNo=RCP%2F2026%2F002210&external=true&CompanyID=ENCRYPTED_COMPANY_ID&BranchID=ENCRYPTED_BRANCH_ID" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -o receipt.pdf

The HTML variant of the receipt renderer — ideal for thermal printers driven from a browser, or for emailing a receipt as inline HTML.

Query parameters

Example request

curl -X POST "https://api.opto-soft.com/api/Common/receipt/pdf/html?receiptNo=RCP%2F2026%2F002210&CompanyID=ENCRYPTED_COMPANY_ID&BranchID=ENCRYPTED_BRANCH_ID" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -o receipt.html