API Reference
Every endpoint with its parameters, request body and documented responses — generated from the OptoSoft OpenAPI specification and rendered right here on the site.
https://app.opto-soft.com/global/api-v1
No endpoint matches that filter.
Try it in Postman
Download the collection (80 requests, one folder per resource group),
import it into Postman, set userName and password
in the collection variables, then run the login request — it stores the JWT in
accessToken and every other request is authorised.
Response conventions
Rules that hold for every endpoint below — read these once and the rest of the reference gets shorter.
Authentication
All endpoints (except /auth/login and webhook endpoints) require Authorization: Bearer <token> header.
Encrypted identifiers
All IDs prefixed with ENC_ are encrypted strings in production. Raw numeric IDs are never exposed at API boundaries.
Error format
Standard error responses follow this shape
{
"message": "Validation failed.",
"errors": {
"mobile": [
"Mobile number is required."
],
"email": [
"Invalid email format."
]
}
}
401 Unauthorized
{
"message": "Unauthorized. Token is missing or invalid."
}
403 Forbidden
{
"message": "You do not have permission to access this resource."
}
404 Not found
{
"message": "The requested resource was not found."
}
Auth
1 endpointObtain and manage access tokens.
POST
/api/Auth/login
Authenticate user and return JWT token with session info
No bearer token required — this endpoint issues the token.
Request body — application/json
Schema OMLoginRequest — 2 fields, listed under Data models.
{
"userName": "string",
"password": "string"
}
Responses
- 200OK
Example responses
200 Success response
{
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"id": "ENC_USER_001",
"userName": "John Doe",
"userEmail": "john.doe@example.com",
"userRole": "Admin",
"yearId": "ENC_YEAR_001",
"companyID": "ENC_CO_001",
"companyName": "Vision Care LLC",
"companyEmail": "info@visioncare.com",
"branchID": "ENC_BR_001",
"branchName": "Main Branch",
"branchCity": "Dubai",
"branchStateID": "ENC_STATE_001",
"branchCountryID": "ENC_COUNTRY_001",
"logo": "logo_branch.png",
"signature": "signature.png",
"languageID": 1,
"languageCode": "en",
"languageName": "English",
"dashBoardUserSettings": null,
"maskCustomerMobileNumber": false,
"modules": [
{
"moduleID": 1,
"moduleName": "Sales Order",
"isActive": true
},
{
"moduleID": 2,
"moduleName": "Invoice",
"isActive": true
},
{
"moduleID": 3,
"moduleName": "Receipt",
"isActive": true
}
]
}
Error response
{
"message": "Invalid username or password."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Auth/login" \
-H "Content-Type: application/json" \
-d '{
"userName": "string",
"password": "string"
}'
Account
2 endpointsSigned-in user and profile details.
POST
/api/Account/get-profile
Get company/branch profile information
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
{
"profile": {
"companyID": "ENC_CO_001",
"companyName": "Vision Care LLC",
"companyEmail": "info@visioncare.com",
"companyMobile": "\u002B971500000001",
"taxNO": "TRN123456789",
"address": "123 Main Street, Dubai",
"city": "Dubai",
"stateID": "ENC_STATE_001",
"countryID": "ENC_COUNTRY_001",
"logo": "company_logo.png",
"branches": [
{
"branchID": "ENC_BR_001",
"branchName": "Main Branch",
"branchCity": "Dubai",
"branchMobile": "\u002B971500000002",
"branchEmail": "main@visioncare.com"
}
]
}
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Account/get-profile" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Account/user-details
Get the authenticated user's details
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| date | query | string | no |
Responses
- 200OK
Example response
200 Success response
{
"userID": "ENC_USER_001",
"userName": "John Doe",
"userEmail": "john.doe@example.com",
"userRole": "Admin",
"companyID": "ENC_CO_001",
"branchID": "ENC_BR_001"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Account/user-details?date=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
Customer
14 endpointsPatient/customer records and eye info.
POST
/api/Customer/check-duplicate
Check for duplicate customers by mobile or name
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMSearchCustomer — 26 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"customerID": "ENC_CUST_001",
"name": "Ahmed Al Rashid",
"mobile": "\u002B971501234567",
"phoneNO": "\u002B97142345678",
"email": "ahmed@example.com",
"city": "Dubai",
"isActive": "True",
"createdDate": "2024-01-15T09:30:00",
"prescriptionID": "ENC_PRESC_001",
"visitingDate": "2024-06-20"
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/check-duplicate" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}'
POST
/api/Customer/delete-prescription
Delete a prescription
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMAppEyeInfoModel — 1 field, listed under Data models.
{
"customerEyeInfoID": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Prescription deleted successfully."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/delete-prescription" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"customerEyeInfoID": "string"
}'
POST
/api/Customer/detail
Get detailed customer information
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMSearchCustomer — 26 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"id": "ENC_CUST_001",
"branchID": "ENC_BR_001",
"stateID": "ENC_STATE_001",
"countryID": "ENC_COUNTRY_001",
"faceShapeID": "ENC_FS_001",
"genderID": "ENC_GENDER_001",
"companyID": "ENC_CO_001",
"customerID": "ENC_CUST_001",
"yearID": "ENC_YEAR_001",
"title": "Mr.",
"firstName": "Ahmed",
"middleName": "",
"lastName": "Al Rashid",
"isMarried": true,
"reference": "Walk-in",
"birthDate": "1985-03-12T00:00:00",
"remarks": "",
"mobile": "\u002B971501234567",
"emailId": "ahmed@example.com",
"city": "Dubai",
"zipCode": "12345",
"address": "Villa 10, Street 5, Al Barsha",
"houseNumber": "10",
"societyName": "",
"street": "Street 5",
"area": "Al Barsha",
"landmark": "Near Mall of the Emirates",
"isActive": true,
"createdBy": "Admin",
"createdDate": "2024-01-15T09:30:00",
"createdIP": "192.168.1.1",
"modifiedBy": "Admin",
"modifiedDate": "2024-06-20T11:00:00",
"modifiedIP": "192.168.1.1",
"newCustomer": false,
"isNRI": false,
"marriageDate": "2010-05-20T00:00:00",
"existingCustomerReference": "",
"phoneNO": "",
"taxNO": "",
"customerSourceID": "ENC_SRC_001",
"customerCategoryID": "ENC_CCAT_001",
"isStoreCustomer": false,
"storeID": null,
"isMember": true,
"membershipID": "ENC_MEMB_001",
"age": 39,
"bloodGroup": "O\u002B",
"self": "Self",
"isBlackList": false,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": null,
"clientConsentDisplayName": null,
"prescriptionDocument": null,
"prescriptionDocumentDisplayName": null,
"isForeigner": false,
"salesOrderID": null
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/detail" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}'
POST
/api/Customer/doctor-list
Get list of doctors
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMSearchCustomer — 26 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"doctorID": "ENC_DOC_001",
"doctorName": "Dr. Khalid Ahmed",
"mobile": "\u002B971509876543",
"email": "dr.khalid@clinic.com",
"city": "Dubai",
"isActive": "True"
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/doctor-list" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}'
POST
/api/Customer/doctor-list-page
Get paginated doctor list
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMSearchCustomer — 26 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"totalRows": 25,
"data": [
{
"doctorID": "ENC_DOC_001",
"doctorName": "Dr. Khalid Ahmed",
"mobile": "\u002B971509876543",
"email": "dr.khalid@clinic.com",
"city": "Dubai",
"isActive": "True"
}
]
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/doctor-list-page" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}'
GET
/api/Customer/existing-for-quicksale/{customerId}
Get existing customer for quick sale
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| customerId | path | string | yes |
Responses
- 200OK
Example response
200 Success response
{
"customerID": "ENC_CUST_001",
"name": "Ahmed Al Rashid",
"mobile": "\u002B971501234567",
"phoneNO": "",
"email": "ahmed@example.com",
"city": "Dubai",
"isActive": "True",
"createdDate": "2024-01-15T09:30:00",
"prescriptionID": "ENC_PRESC_001",
"visitingDate": "2024-06-20"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Customer/existing-for-quicksale/string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Customer/get-doctor/{id}
Get doctor detail by ID
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| id | path | string | yes |
Responses
- 200OK
Example response
200 Success response
{
"id": "ENC_DOC_001",
"name": "Dr. Khalid Ahmed",
"mobile": "\u002B971509876543",
"email": "dr.khalid@clinic.com",
"address": "Clinic 5, Healthcare City",
"city": "Dubai",
"stateID": "ENC_STATE_001",
"countryID": "ENC_COUNTRY_001",
"zipCode": "12345",
"remarks": "",
"isActive": true
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Customer/get-doctor/string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Customer/GetPrescription
Get a specific prescription
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMAppEyeInfoModel — 1 field, listed under Data models.
{
"customerEyeInfoID": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"id": "ENC_PRESC_001",
"customerID": "ENC_CUST_001",
"typeID": 1,
"spherical_Left": "-1.50",
"cylindrical_Left": "-0.50",
"axis_Left": "90",
"spherical_Right": "-2.00",
"cylindrical_Right": "-0.75",
"axis_Right": "180",
"visitingDate": "2024-06-20T00:00:00",
"doctorName": "Dr. Khalid Ahmed",
"isActive": true
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/GetPrescription" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"customerEyeInfoID": "string"
}'
POST
/api/Customer/list
Get paginated customer list
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMSearchCustomer — 26 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"totalRows": 150,
"data": [
{
"customerID": "ENC_CUST_001",
"name": "Ahmed Al Rashid",
"mobile": "\u002B971501234567",
"phoneNO": "",
"email": "ahmed@example.com",
"city": "Dubai",
"isActive": "True",
"createdDate": "2024-01-15T09:30:00",
"prescriptionID": "ENC_PRESC_001",
"visitingDate": "2024-06-20"
}
]
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/list" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}'
POST
/api/Customer/prescription-full-detail
Get full prescription detail with company and branch info
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMAppEyeInfoModel — 1 field, listed under Data models.
{
"customerEyeInfoID": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"customerID": "ENC_CUST_001",
"firstName": "Ahmed",
"lastName": "Al Rashid",
"mobile": "\u002B971501234567",
"emailID": "ahmed@example.com",
"city": "Dubai",
"visitingDate": "2024-06-20T00:00:00",
"typeID": 1,
"spherical_Left": "-1.50",
"spherical_Right": "-2.00",
"cylindrical_Left": "-0.50",
"cylindrical_Right": "-0.75",
"axis_Left": "90",
"axis_Right": "180",
"addition_Left": "\u002B1.00",
"addition_Right": "\u002B1.00",
"vision_Left": "6/6",
"vision_Right": "6/9",
"vN_Left": "6/6",
"vN_Right": "6/9",
"pD_Left": "32",
"pD_Right": "32",
"baseCurve_Left": "8.6",
"baseCurve_Right": "8.6",
"diameter_Left": "14.2",
"diameter_Right": "14.2",
"k1_Left": "",
"k1_Right": "",
"k2_Left": "",
"k2_Right": "",
"prescriptionRemarks": "Annual check-up",
"companyName": "Vision Care LLC",
"companyAddress": "123 Main Street, Dubai",
"companyEmailID": "info@visioncare.com",
"companyMobile": "\u002B971500000001",
"branchName": "Main Branch",
"branchAddress": "123 Main Street, Dubai",
"branchEmail": "main@visioncare.com",
"branchMoile": "\u002B971500000002",
"doctorID": "ENC_DOC_001"
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/prescription-full-detail" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"customerEyeInfoID": "string"
}'
POST
/api/Customer/prescription-list
Get list of prescriptions for a customer
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMSearchCustomer — 26 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_PRESC_001",
"customerID": "ENC_CUST_001",
"itemTypeId": 2,
"typeID": 1,
"spectacleType": 1,
"eyeInfo_DoctorID": "ENC_DOC_001",
"doctorName": "Dr. Smith",
"visitingDate": "2024-06-20T00:00:00",
"visitingDateString": "20-Jun-2024",
"spherical_Left": "-1.50",
"cylindrical_Left": "-0.50",
"axis_Left": "90",
"addition_Left": "\u002B1.00",
"vision_Left": "6/6",
"baseCurve_Left": "8.6",
"diameter_Left": "14.2",
"spherical_Right": "-2.00",
"cylindrical_Right": "-0.75",
"axis_Right": "180",
"addition_Right": "\u002B1.00",
"vision_Right": "6/9",
"baseCurve_Right": "8.6",
"diameter_Right": "14.2",
"remarks": "Annual check-up",
"isActive": true,
"createdBy": "Admin",
"createdIP": "192.168.1.1",
"modifiedBy": "Admin",
"modifiedIP": "192.168.1.1",
"vN_Left": "6/6",
"vN_Right": "6/9",
"pD_Left": "32",
"pD_Right": "32",
"goToSalesOrder": false,
"eyeCheckupRecallDate": "2025-06-20T00:00:00",
"isPrevious": false,
"k1_Left": "",
"k1_Right": "",
"k2_Left": "",
"k2_Right": "",
"dist_Right": "",
"dist_Left": "",
"near_Left": "",
"near_Right": "",
"wODist_Left": "",
"wODist_Right": "",
"wONear_Left": "",
"wONear_Right": "",
"pIN_Left": "",
"pIN_Right": "",
"iOP_Left": "",
"iOP_Right": ""
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/prescription-list" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}'
POST
/api/Customer/save-doctor
Save a doctor record
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema EncryptedDoctorSaveModel — 11 fields, listed under Data models.
{
"id": "string",
"name": "string",
"mobile": "string",
"email": "string",
"address": "string",
"city": "string",
"stateID": "string",
"countryID": "string",
"zipCode": "string",
"remarks": "string",
"isActive": false
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Doctor saved successfully.",
"doctorID": "ENC_DOC_001"
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/save-doctor" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": "string",
"name": "string",
"mobile": "string",
"email": "string",
"address": "string",
"city": "string",
"stateID": "string",
"countryID": "string",
"zipCode": "string",
"remarks": "string",
"isActive": false
}'
POST
/api/Customer/save-prescription
Save a customer prescription
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMAppCustomerData — 22 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"id": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"email": "string",
"birthDate": "string",
"genderID": "string",
"houseNO": "string",
"societyName": "string",
"street": "string",
"area": "string",
"city": "string",
"sourceID": "string",
"doctorID": "string",
"presripionTypeID": "string",
"visitingDate": "string",
"prescriptionList": [
{
"lensTypeID": "string",
"sph": "string",
"cyl": "string",
"axis": "string",
"add": "string",
"va": "string",
"vn": "string",
"pd": "string",
"bc": "string",
"dia": "string",
"fh": "string",
"th": "string"
}
],
"prescriptionRemarks": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Prescription saved successfully.",
"customerID": "ENC_CUST_001",
"eyeInfoID": "ENC_PRESC_001"
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/save-prescription" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"id": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"email": "string",
"birthDate": "string",
"genderID": "string",
"houseNO": "string",
"societyName": "string",
"street": "string",
"area": "string",
"city": "string",
"sourceID": "string",
"doctorID": "string",
"presripionTypeID": "string",
"visitingDate": "string",
"prescriptionList": [
{
"lensTypeID": "string",
"sph": "string",
"cyl": "string",
"axis": "string",
"add": "string",
"va": "string",
"vn": "string",
"pd": "string",
"bc": "string",
"dia": "string",
"fh": "string",
"th": "string"
}
],
"prescriptionRemarks": "string"
}'
POST
/api/Customer/upsert
Create or update a customer
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema EncryptedCustomerModel — 77 fields, listed under Data models.
{
"id": "string",
"branchID": "string",
"stateID": "string",
"countryID": "string",
"faceShapeID": "string",
"genderID": "string",
"companyID": "string",
"customerID": "string",
"yearID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isMarried": false,
"reference": "string",
"birthDate": "2026-01-31T10:15:00Z",
"remarks": "string",
"mobile": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"newCustomer": false,
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"phoneNO": "string",
"taxNO": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"membershipID": "string",
"age": 0,
"bloodGroup": "string",
"self": "string",
"isBlackList": false,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeigner": false,
"lefT_SphericalWithSign": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AxisWithSign": "string",
"righT_AxisWithSign": "string",
"righT_AdditionWithSign": "string",
"lefT_AdditionWithSign": "string",
"leftVision": "string",
"rightVision": "string",
"leftvn": "string",
"rightvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Customer saved successfully.",
"customerID": "ENC_CUST_001"
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Customer/upsert" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": "string",
"branchID": "string",
"stateID": "string",
"countryID": "string",
"faceShapeID": "string",
"genderID": "string",
"companyID": "string",
"customerID": "string",
"yearID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isMarried": false,
"reference": "string",
"birthDate": "2026-01-31T10:15:00Z",
"remarks": "string",
"mobile": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"newCustomer": false,
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"phoneNO": "string",
"taxNO": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"membershipID": "string",
"age": 0,
"bloodGroup": "string",
"self": "string",
"isBlackList": false,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeigner": false,
"lefT_SphericalWithSign": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AxisWithSign": "string",
"righT_AxisWithSign": "string",
"righT_AdditionWithSign": "string",
"lefT_AdditionWithSign": "string",
"leftVision": "string",
"rightVision": "string",
"leftvn": "string",
"rightvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string"
}'
Orders
10 endpointsSales orders, status and advances.
GET
/api/Orders/cancellation-reasons
Get list of order cancellation reasons
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
- 401Unauthorized ProblemDetails
- 500Internal Server Error
Example response
200 Success response
[
{
"id": 1,
"cancellationReason": "Customer Request",
"isActive": true
},
{
"id": 2,
"cancellationReason": "Item Out of Stock",
"isActive": true
},
{
"id": 3,
"cancellationReason": "Duplicate Order",
"isActive": true
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Orders/cancellation-reasons" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Orders/dropdown
Get sales orders for dropdown selection
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| customerId | query | string | no | |
| yearId | query | integer (int64) | no |
Responses
- 200OK
- 500Internal Server Error
Example response
200 Success response
[
{
"salesOrderID": "ENC_SO_001",
"salesOrderNO": "SO-2026-000500",
"soNetAmount": 2500,
"receiptTotal": 1000,
"balanceAmount": 1500
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Orders/dropdown?customerId=string&yearId=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Orders/search
Search / filter sales orders with pagination
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema SalesOrderSearchRequest — 18 fields, listed under Data models.
{
"pageNumber": 0,
"pageSize": 0,
"orderBy": "string",
"yearID": 0,
"customerID": "string",
"branchName": "string",
"customerName": "string",
"customerMobile": "string",
"salesOrderNo": "string",
"date": "string",
"fromDate": "string",
"toDate": "string",
"acceptedBy": "string",
"deliveryMode": "string",
"netAmount": "string",
"deliveryDateTime": "string",
"status": "string",
"discount": "string"
}
Responses
- 200OK EncryptedSalesOrderPagedListDtoPagedResponse
- 500Internal Server Error
Example response
200 Success response
{
"totalRows": 200,
"data": [
{
"id": "ENC_SO_001",
"customerName": "Ahmed Al Rashid",
"customerMobileNo": "\u002B971501234567",
"branchName": "Main Branch",
"salesOrderNo": "SO-2026-000500",
"date": "2026-08-01T10:00:00",
"acceptedBy": "Staff01",
"deliveryModeName": "Home Delivery",
"deliveryDateTime": "2026-08-08 10:00",
"netAmount": 2500,
"statusID": 3,
"status": "Ready",
"itemCount": 2,
"totalReceipt": 1000,
"totalDiscount": 200
}
]
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Orders/search" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"pageNumber": 0,
"pageSize": 0,
"orderBy": "string",
"yearID": 0,
"customerID": "string",
"branchName": "string",
"customerName": "string",
"customerMobile": "string",
"salesOrderNo": "string",
"date": "string",
"fromDate": "string",
"toDate": "string",
"acceptedBy": "string",
"deliveryMode": "string",
"netAmount": "string",
"deliveryDateTime": "string",
"status": "string",
"discount": "string"
}'
GET
/api/Orders/with-balance
Get paged sales orders that have a remaining balance
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| yearId | query | integer (int64) | no |
Responses
- 200OK
- 500Internal Server Error
Example response
200 Success response
{
"totalRows": 45,
"data": [
{
"branchID": "ENC_BR_001",
"salesOrderIDInReceipt": "ENC_SO_001",
"soNetAmount": 2500,
"receiptTotal": 1000,
"balanceAmount": 1500,
"customerName": "Ahmed Al Rashid",
"mobileNumber": "\u002B971501234567",
"fullSalesOrderNo": "SO-2026-000500",
"shortSalesOrderNo": "000500",
"combinedSalesOrderNo": "SO-2026-000500 (000500)"
}
]
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Orders/with-balance?yearId=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Orders/{salesOrderId}/advance-receipt-data
Get data needed to create an advance receipt for a sales order
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| salesOrderId | path | string | yes |
Responses
- 200OK EncryptedSalesOrderAdvanceReceiptDto
- 404Not Found ProblemDetails
Example response
200 Success response
{
"customerID": "ENC_CUST_001",
"customerName": "Ahmed Al Rashid",
"customerFirstName": "Ahmed",
"customerMobileNo": "\u002B971501234567",
"custmoerEmail": "ahmed@example.com",
"balance": 1500,
"receiptTotalAmount": 1000,
"soTotalAmount": 2500,
"soTotalDiscountAmount": 200,
"salesOrderID": "ENC_SO_001",
"statusID": 3,
"membershipID": "ENC_MEMB_001"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Orders/string/advance-receipt-data" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Orders/{salesOrderId}/cancel
Cancel a sales order
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| salesOrderId | path | string | yes |
Request body — application/json
Schema CancelSalesOrderRequest — 4 fields, listed under Data models.
{
"statusId": 0,
"receiptStatusId": 0,
"date": "2026-01-31T10:15:00Z",
"transactionDate": "2026-01-31T10:15:00Z"
}
Responses
- 200OK
- 400Bad Request ProblemDetails
- 401Unauthorized ProblemDetails
- 500Internal Server Error
Example response
200 Success response
{
"message": "Sales order cancelled successfully."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Orders/string/cancel" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"statusId": 0,
"receiptStatusId": 0,
"date": "2026-01-31T10:15:00Z",
"transactionDate": "2026-01-31T10:15:00Z"
}'
GET
/api/Orders/{salesOrderId}/items
Get items for a specific sales order
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| salesOrderId | path | integer (int64) | yes |
Responses
- 200OK
Example response
200 Success response
[
{
"itemID": "ENC_ITEM_001",
"itemName": "Aviator Classic AV3025",
"itemTypeName": "Frame",
"qty": 1,
"price": 450,
"mrp": 500,
"totalAmount": 448.88
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Orders/0/items" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
PUT
/api/Orders/{salesOrderId}/status
Update the status of a sales order
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| salesOrderId | path | string | yes |
Request body — application/json
Schema ChangeSalesOrderStatusRequest — 1 field, listed under Data models.
{
"statusId": 0
}
Responses
- 200OK
- 400Bad Request ProblemDetails
- 401Unauthorized ProblemDetails
- 500Internal Server Error
Example response
200 Success response
{
"message": "Status updated successfully."
}
Example request
curl -X PUT "https://app.opto-soft.com/global/api-v1/api/Orders/string/status" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"statusId": 0
}'
GET
/api/Orders/{salesOrderNo}
Get sales order full details by order number
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| salesOrderNo | path | string | yes |
Responses
- 200OK
- 404Not Found ProblemDetails
- 500Internal Server Error
Example response
200 Success response
{
"salesOrderID": "ENC_SO_001",
"salesOrderNO": "SO-2026-000500",
"salseOrderDate": "2026-08-01T10:00:00",
"deliveryDate": "2026-08-08T10:00:00",
"customerID": "ENC_CUST_001",
"customerFullName": "Ahmed Al Rashid",
"houseNumber": "10",
"societyName": "",
"street": "Street 5",
"area": "Al Barsha",
"landmark": "Near Mall of the Emirates",
"emailId": "ahmed@example.com",
"customerMobile": "\u002B971501234567",
"customerTaxNO": "",
"branchID": "ENC_BR_001",
"branchName": "Main Branch",
"branchAddress": "123 Main Street",
"branchCity": "Dubai",
"brachEmailId": "main@visioncare.com",
"branchMobile": "\u002B971500000002",
"companyName": "Vision Care LLC",
"taxNO": "TRN123456789",
"isCompositionScheme": false,
"salesRepresentativeID": "ENC_SR_001",
"srName": "Sara Ali",
"yearID": "ENC_YEAR_001",
"yearName": "2025-2026",
"taxTypeID": "ENC_TAX_001",
"taxType": "VAT",
"statusID": "ENC_STATUS_003",
"transport": "",
"totalQuantity": 2,
"iTotalPrice": 2200,
"totalDiscount": 200,
"totalTaxableAmount": 2000,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 2500,
"iTotlaMRP": 2600,
"totalSavings": 100,
"acceptedBy": "Staff01",
"remarks": "Handle with care",
"salesOrderDetailID": "ENC_SOD_001",
"itemID": "ENC_ITEM_001",
"itemName": "Aviator Classic AV3025",
"hsnCode": "90041000",
"itemTypeName": "Frame",
"qty": 1,
"mrp": 500,
"price": 450,
"idTotalMRP": 500,
"idTotalPrice": 450,
"discountRate": 5,
"discountAmount": 22.5,
"taxableAmount": 427.5,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 5,
"igstAmount": 21.38,
"totalAmount": 448.88,
"spherical_Right": "-2.00",
"cylinder_Right": "-0.75",
"aXIS_Right": "180",
"aDD_Right": "\u002B1.00",
"vA_Right": "6/9",
"vN_Right": "6/9",
"pD_Right": "32",
"spherical_Left": "-1.50",
"cylinder_Left": "-0.50",
"aXIS_Left": "90",
"aDD_Left": "\u002B1.00",
"vA_Left": "6/6",
"vN_Left": "6/6",
"pD_Left": "32",
"conditions": "",
"showPrescriptionOnSalesOrderPrint": 1,
"nameOfSalesOrderPrint": "Sales Order"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Orders/string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Orders/{salesOrderNo}/ids
Get encrypted IDs for a sales order
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| salesOrderNo | path | string | yes |
Responses
- 200OK EncryptedOrderIdsDto
- 404Not Found ProblemDetails
- 500Internal Server Error
Example response
200 Success response
{
"salesOrderID": "ENC_SO_001",
"customerID": "ENC_CUST_001"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Orders/string/ids" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
Quick Sale
31 endpointsFast counter billing workflow.
GET
/api/quickSale/allCard
Get all card types
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_CARD_001",
"name": "Visa"
},
{
"id": "ENC_CARD_002",
"name": "Mastercard"
},
{
"id": "ENC_CARD_003",
"name": "American Express"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/allCard" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/app-version
Get current app version info
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
{
"version": "2.5.1",
"buildNumber": "20260810",
"forceUpdate": false,
"updateMessage": ""
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/app-version" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/quickSale/CalculateTempGrossInsurance
Calculate gross insurance amount for temporary sales order
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema CalculateTempGrossInsuranceRequest — 2 fields, listed under Data models.
{
"sessionID": "string",
"totalInsuranceAmount": 0
}
Responses
- 200OK
Example response
200 Success response
{
"grossTotal": 2500,
"insuranceAmount": 1000,
"nisAmount": 200,
"voucherAmount": 100,
"patientAmount": 1200
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/CalculateTempGrossInsurance" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"sessionID": "string",
"totalInsuranceAmount": 0
}'
POST
/api/quickSale/delete-salesorder-temp
Delete a specific temporary sales order line
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema DeleteSalesOrderTempRequest — 3 fields, listed under Data models.
{
"sessionID": "string",
"salesOrderTempId": "string",
"pairNo": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Temporary order item deleted."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/delete-salesorder-temp" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"sessionID": "string",
"salesOrderTempId": "string",
"pairNo": "string"
}'
POST
/api/quickSale/deleteSalesOrderTempBySession
Delete temporary order by session ID
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema DeleteSessionRequest — 1 field, listed under Data models.
{
"sessionID": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Temporary order deleted."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/deleteSalesOrderTempBySession" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"sessionID": "string"
}'
GET
/api/quickSale/Fetch-Receipt-Type
Get available receipt types
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_RT_001",
"name": "Cash"
},
{
"id": "ENC_RT_002",
"name": "Card"
},
{
"id": "ENC_RT_003",
"name": "Bank Transfer"
},
{
"id": "ENC_RT_004",
"name": "Cheque"
},
{
"id": "ENC_RT_005",
"name": "Insurance"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/Fetch-Receipt-Type" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-branch-details
Get details of the current branch
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
{
"branchID": "ENC_BR_001",
"branchName": "Main Branch",
"branchAddress": "123 Main Street, Dubai",
"branchCity": "Dubai",
"branchMobile": "\u002B971500000002",
"branchEmail": "main@visioncare.com",
"branchTaxNO": "TRN123456789",
"branchLogo": "logo.png",
"branchSignature": "signature.png",
"branchCountry": "United Arab Emirates",
"branchState": "Dubai",
"companyName": "Vision Care LLC"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-branch-details" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-branch-logo/{branchId}/{fileName}
Get branch logo image
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| branchId | path | integer (int64) | yes | |
| fileName | path | string | yes |
Responses
- 200OK
Response
Binary image file (image/png or image/jpeg) — not a JSON payload.
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-branch-logo/0/string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-credit-notes
Get available credit notes for a customer
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| customerId | query | integer (int64) | no |
Responses
- 200OK
Example response
200 Success response
[
{
"creditNoteID": "ENC_CN_001",
"creditNoteNo": "CN-2026-000010",
"amount": 250,
"balance": 250,
"date": "2026-07-15T00:00:00"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-credit-notes?customerId=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-doctors-dropdown
Get doctor list for dropdown
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_DOC_001",
"name": "Dr. Khalid Ahmed"
},
{
"id": "ENC_DOC_002",
"name": "Dr. Priya Sharma"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-doctors-dropdown" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-fitters-dropdown
Get fitter list for dropdown
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_FIT_001",
"name": "Mohammed Hassan"
},
{
"id": "ENC_FIT_002",
"name": "Ali Khan"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-fitters-dropdown" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-item-type-id
Get item type ID by name
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| id | query | integer (int32) | no |
Responses
- 200OK
Example response
200 Success response
{
"itemTypeID": "ENC_IT_001",
"itemTypeName": "Frame"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-item-type-id?id=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-priority-dropdown
Get priority options for dropdown
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_PRI_001",
"name": "Normal"
},
{
"id": "ENC_PRI_002",
"name": "Urgent"
},
{
"id": "ENC_PRI_003",
"name": "Express"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-priority-dropdown" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/get-suppliers-dropdown
Get supplier list for dropdown
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_SUP_001",
"name": "Luxottica"
},
{
"id": "ENC_SUP_002",
"name": "Safilo Group"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/get-suppliers-dropdown" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/getExactItemStock
Get exact stock quantity for an item
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| itemId | query | integer (int64) | no |
Responses
- 200OK
Example response
200 Success response
{
"itemID": "ENC_ITEM_001",
"stock": 12
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/getExactItemStock?itemId=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/GetFrameSunGlassForAutoComplete
Search frame / sunglass items for autocomplete
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| term | query | string | no | |
| yearId | query | integer (int64) | no |
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_ITEM_001",
"name": "Aviator Classic AV3025",
"code": "AV3025",
"price": 450,
"mrp": 500,
"stock": 12
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/GetFrameSunGlassForAutoComplete?term=string&yearId=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/getGenders
Get gender options
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_GENDER_001",
"name": "Male"
},
{
"id": "ENC_GENDER_002",
"name": "Female"
},
{
"id": "ENC_GENDER_003",
"name": "Other"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/getGenders" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/getItemDetailFromCode
Get item detail by barcode or item code
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| code | query | string | no |
Responses
- 200OK
Example response
200 Success response
{
"id": "ENC_ITEM_001",
"name": "Aviator Classic AV3025",
"code": "AV3025",
"price": 450,
"mrp": 500,
"stock": 12,
"itemTypeID": "ENC_IT_001",
"categoryID": "ENC_CAT_001",
"subCategoryID": "ENC_SCAT_001"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/getItemDetailFromCode?code=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/getMemberships
Get membership types
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| page | query | integer (int32) | no | |
| pageSize | query | integer (int32) | no |
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_MEMB_001",
"name": "Gold Member",
"discountRate": 10
},
{
"id": "ENC_MEMB_002",
"name": "Silver Member",
"discountRate": 5
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/getMemberships?page=0&pageSize=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/GetReceiptDetails
Get receipt details for printing
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| customerId | query | integer (int64) | no | |
| receiptId | query | integer (int64) | no | |
| salesOrderId | query | integer (int64) | no |
Responses
- 200OK
Example response
200 Success response
{
"receiptId": "ENC_RCPT_001",
"receiptNo": "RCPT-2026-000100",
"salesOrderNo": "SO-2026-000500",
"invoiceNo": "INV-2026-001001",
"customerFullName": "Ahmed Al Rashid",
"customerMobile": "\u002B971501234567",
"date": "2026-08-05T14:30:00",
"amount": 1000,
"balanceAmount": 1500,
"branchName": "Main Branch",
"branchAddress": "123 Main Street, Dubai",
"companyName": "Vision Care LLC"
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/GetReceiptDetails?customerId=0&receiptId=0&salesOrderId=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/quickSale/GetSalesOrderTemp
Retrieve temporary sales order by session
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema GetSalesOrderTempRequest — 5 fields, listed under Data models.
{
"sessionId": "string",
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"serviceTax": 0
}
Responses
- 200OK
Example response
200 Success response
{
"sessionID": "SESS_ABC123",
"customerID": "ENC_CUST_001",
"items": [
{
"itemID": "ENC_ITEM_001",
"itemName": "Aviator Classic AV3025",
"qty": 1,
"price": 450,
"mrp": 500
}
],
"netAmount": 450
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/GetSalesOrderTemp" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"sessionId": "string",
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"serviceTax": 0
}'
GET
/api/quickSale/getSources
Get customer source options
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| page | query | integer (int32) | no | |
| pageSize | query | integer (int32) | no |
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_SRC_001",
"name": "Walk-in"
},
{
"id": "ENC_SRC_002",
"name": "Referral"
},
{
"id": "ENC_SRC_003",
"name": "Online"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/getSources?page=0&pageSize=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/GetSpectacleLensForAutoComplete
Search spectacle lens items for autocomplete
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| term | query | string | no |
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_ITEM_002",
"name": "ClearGuard Forte UV 1.5",
"code": "CGFUV15",
"price": 350,
"mrp": 400,
"stock": 20
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/GetSpectacleLensForAutoComplete?term=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/quickSale/insurance-companies
Get list of insurance companies
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| activeOnly | query | boolean | no |
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_INS_001",
"name": "Gulf Health Insurance",
"code": "DH",
"isActive": true
},
{
"id": "ENC_INS_002",
"name": "Meridian Insurance Gulf",
"code": "MER",
"isActive": true
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/quickSale/insurance-companies?activeOnly=false" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/quickSale/insurance-companies
Save / add an insurance company
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema AddInsuranceCompanyRequest — 2 fields, listed under Data models.
{
"insuranceCompanyName": "string",
"isActive": false
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Insurance company saved successfully.",
"id": "ENC_INS_001"
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/insurance-companies" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"insuranceCompanyName": "string",
"isActive": false
}'
POST
/api/quickSale/SaveInvoiceOnly
Save invoice only (without receipt)
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema SaveInvoiceOnlyRequest — 5 fields, listed under Data models.
{
"salesOrderID": "string",
"customerID": "string",
"sessionID": "string",
"invoiceDate": "2026-01-31T10:15:00Z",
"isCompositionScheme": false
}
Responses
- 200OK
Example response
200 Success response
{
"invoiceID": "ENC_INV_001",
"invoiceNo": "INV-2026-001002",
"message": "Invoice saved successfully."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/SaveInvoiceOnly" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"salesOrderID": "string",
"customerID": "string",
"sessionID": "string",
"invoiceDate": "2026-01-31T10:15:00Z",
"isCompositionScheme": false
}'
POST
/api/quickSale/SaveReceipt
Save a receipt for a sales order
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema ReceiptWithouInvoiceModel — 192 fields, listed under Data models.
{
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"receiptID": "ENC_RCPT_001",
"receiptNo": "RCPT-2026-000100"
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/SaveReceipt" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
}'
POST
/api/quickSale/SaveSale
Save a complete quick sale (sales order + receipt)
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMFastWizardModel — 94 fields, listed under Data models.
{
"customerModel": {
"customerId": "string",
"id": 0,
"branchId": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"genderID": "string",
"isMarried": false,
"reference": "string",
"isActive": false,
"birthDate": "2026-01-31T10:15:00Z",
"stringBirthDate": "string",
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"remarks": "string",
"mobile": "string",
"foreignerMobile": "string",
"phoneNO": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"isForeigner": false,
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"stateId": 0,
"countryId": "string",
"faceShapeID": "string",
"createdBy": "string",
"createdIP": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"createdDate": "2026-01-31T10:15:00Z",
"newCustomer": false,
"createdDateString": "string",
"marriageDateString": "string",
"birthDateString": "string",
"encryptCustomerID": "string",
"branchName": "string",
"isNewRecord": false,
"gender": "string",
"doctor": "string",
"taxNO": "string",
"visitingDate": "2026-01-31T10:15:00Z",
"isBlackList": false,
"r_SPH": 0,
"r_CYL": 0,
"r_AXIS": 0,
"r_ADD": 0,
"l_SPH": 0,
"l_CYL": 0,
"l_AXIS": 0,
"l_ADD": 0,
"doctorID": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"righT_AdditionWithSign": "string",
"righT_AxisWithSign": "string",
"righT_FixFlotedText": "string",
"lefT_SphericalWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AdditionWithSign": "string",
"lefT_AxisWithSign": "string",
"lefT_FixFlotedText": "string",
"rightVision": "string",
"leftVision": "string",
"rightvn": "string",
"leftvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"age": 0,
"bloodGroup": "string",
"self": "string",
"membershipID": 0,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeignerFlag": false
},
"salesorderModel": {
"dateString": "string",
"sessionId": "string",
"companyId": "string",
"branchId": "string",
"schemeID": "string",
"salesRepresentativeID": "string",
"customerId": "string",
"cancellationReasonID": "string",
"cancellReason": "string",
"yearId": "string",
"gstNo": "string",
"salesOrderId": 0,
"isForeigner": false,
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"taxTypeId": 0,
"transport": "string",
"grandTotal": 0,
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalTax": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalMRP": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"netAmount": 0,
"remarks": "string",
"acceptedBy": "string",
"statusID": "string",
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"checkSalesOrderCustomer": "string",
"salesPriceIncludesTax": false,
"isCompositionScheme": false,
"showMRP": false,
"barcodeScan": "string",
"goToReceipt": false,
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTimeString": "string",
"deliveryTime": "string",
"rounding": 0,
"itemTypeID": "string",
"searchItem": "string",
"giftVoucherID": "string",
"giftVoucherDiscount": 0,
"giftVoucherNo": "string",
"taxTypeName": "string",
"srName": "string",
"customerTitle": "string",
"firstName": "string",
"lastName": "string",
"customerName": "string",
"customerMobile": "string",
"customerEmailID": "string",
"rightLensFittingHeight": 0,
"rightLensTotalHeight": 0,
"leftLensFittingHeight": 0,
"leftLensTotalHeight": 0,
"typeID": "string",
"getSalesOrderDetailList": [
{}
],
"salesOrderDetailList": [
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"allowUserToChangePrice": false,
"allowUserToChangeDiscount": false,
"maxUserDiscountPercentage": 0,
"allowUerToGenerateFutureDateOrder": false,
"allowUserToGeneratePastDateOrder": false,
"allowStoreManagerToGenerateFutureDateOrder": false,
"allowStoreManagerToGeneratePastDateOrder": false,
"userInRole": false,
"userInRoleStoreManager": false,
"allowWarehouseManagerToCancelOrder": false,
"allowCompanyManagerToCancelOrder": false,
"storeSalesOrderID": "string",
"isFranchise": false,
"referencePurchaseOrderID": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"visitingDate": "2026-01-31T10:15:00Z",
"visitingDateString": "string",
"isPopup": "string",
"deliveryModeID": 0,
"deliveryModeName": "string",
"isFranchise_Branch": false,
"deliveryDateDays": "string",
"dndForTransactionalMessage": false,
"dndForPromotionalMessage": false,
"isImportedOrder": false,
"isGiftVoucherApplied": false,
"branchLogo": "string",
"branchName": "string",
"companyName": "string",
"enableInsurance": false,
"customerInsuranceID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"insuranceCompanyID": 0,
"policyNo": "string",
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"totalNISAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"totalVoucherAmount": 0
},
"receiptModel": {
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
},
"eyeInfoModel": {
"doctorName": "string"
},
"eyecheckupRecallModel": {
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{}
],
"notifiedRecallList": [
{}
]
},
"purchaseOrderModel": {
"purchaseOrderId": 0,
"statusId": 0,
"priorityId": 0,
"branchId": 0,
"yearId": 0,
"sessionId": "string",
"subCategoryId": 0,
"fitterID": 0,
"condition": "string",
"priority": "string",
"taxType": "string",
"supplier": "string",
"supplierInvoiceNo": "string",
"purchaseOrderNumber": "string",
"orderDate": "2026-01-31T10:15:00Z",
"orderDateString": "string",
"receiveDate": "2026-01-31T10:15:00Z",
"receiveDateString": "string",
"transport": "string",
"supplierId": 0,
"taxTypeId": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"netAmount": 0,
"serviceTax": 0,
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"status": "string",
"remarks": "string",
"createdBy": 0,
"createdIP": "string",
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"getOrderList": [
{
"id": 0,
"itemId": 0,
"sessionId": "string",
"title": "string",
"code": "string",
"status": "string",
"salesPrice": 0,
"purchaseCost": 0,
"qty": 0,
"cost": 0,
"totalCost": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"serviceTax": 0,
"jobCharges": 0,
"otherCharges": 0,
"shippingCharges": 0,
"rounding": 0,
"netAmount": 0,
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
],
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"title": "string",
"itemTypeID": 0,
"isDirectInward": false,
"modelNo": "string",
"colorId": 0,
"brandId": 0,
"shapeId": 0,
"sizeId": 0,
"materialId": 0,
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": 0,
"code": "string",
"index": "string",
"productID": 0,
"lenseStyleID": 0,
"lensCoatID": 0,
"lensColorId": 0,
"spectacleLensTypeID": 0,
"unitTypeId": 0,
"frameId": 0,
"itemTypeCode": "string",
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoTitle": false,
"autoTitleClone": false,
"autoPRMTitle": false,
"prmCode": "string",
"deoCode": "string",
"autoDEOTitle": false,
"allowMannualBarcode": false,
"isFranchise": false,
"priceRangeID": 0,
"branchLogo": "string",
"branchName": "string",
"companyName": "string"
},
"autoItemTypeSectionList": [
{
"id": 0,
"itemTypeID": 0,
"moduleID": 0,
"isAutosection": false,
"sectionName": "string"
}
],
"isLensAdded": false,
"orderDate": "2026-01-31T10:15:00Z",
"expectedDate": "2026-01-31T10:15:00Z",
"visitorIP": "string",
"branchCity": "string",
"isSpectacleLensInOrder": false,
"sessionID": "string",
"supplierID": "string",
"fitterID": "string",
"isExternal": false,
"userId": 0,
"priorityID": "string",
"showLabOrderInQuickSale": false,
"showQuickSaleAddFrameSection": false,
"showQuickSaleAddSunGlassSection": false,
"showQuickSaleAddLensSection": false,
"showQuickSaleAddContactLensSection": false,
"showQuickSaleAddCLCPSection": false,
"showQuickSaleAddAccessoriesSection": false,
"showQuickSaleAddPerfumeSection": false,
"showQuickSaleAddDeodorantSection": false,
"showQuickSaleAddAttarSection": false,
"showQuickSaleAddFreshenerSection": false,
"showQuickSaleAddLeatherAccessoriesSection": false,
"showQuickSaleAddCosmeticsSection": false,
"showQuickSaleAddGiftSetsSection": false,
"showQuickSaleAddMenAccessoriesSection": false,
"showQuickSaleAddWomenAccessoriesSection": false,
"showQuickSaleAddWatchesSection": false,
"showQuickSaleAddImitationJewellerySection": false,
"showQuickSaleAddDressMaterialSection": false,
"showQuickSaleAddKurtiSection": false,
"showQuickSaleAddKurtiPairSection": false,
"showQuickSaleAddChaniyaCholiSection": false,
"showQuickSaleAddLegginsSection": false,
"showQuickSaleAddKurtaPentSection": false,
"showQuickSaleAddPlazzoSection": false,
"showQuickSaleAddOnePieceSection": false,
"showQuickSaleAddDupattaSection": false,
"showQuickSaleAddWesternSection": false,
"allowMannualBarcode": false,
"defaultZeroReceiptAmountForQuickSale": false,
"allowZeroAmountReceiptInQuickSale": false,
"isRemoveValidationFromCustomer": false,
"modelNo": "string",
"colorId": "string",
"brandId": "string",
"shapeId": "string",
"sizeId": "string",
"materialId": "string",
"subCategoryId": "string",
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": "string",
"code": "string",
"index": "string",
"productID": "string",
"lenseStyleID": "string",
"lensCoatID": "string",
"lensColorId": "string",
"spectacleLensTypeID": "string",
"unitTypeId": "string",
"itemTypeID": "string",
"itemTypeCode": "string",
"frameId": "string",
"priceRangeID": "string",
"autoTitle": false,
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoPerfumeTitle": false,
"autoDeodorantTitle": false,
"autoAttarTitle": false,
"autoFreshenerTitle": false,
"autoLeatherAccessoriesTitle": false,
"autoCosmeticsTitle": false,
"autoGiftSetsTitle": false,
"autoMenAccessoriesTitle": false,
"autoWomenAccessoriesTitle": false,
"autoWatchesTitle": false,
"autoImitationJewelleryTitle": false,
"autoReadymadeGarmentsTitle": false,
"branchId": 0,
"yearId": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"salesOrderID": "ENC_SO_001",
"salesOrderNo": "SO-2026-000501",
"receiptID": "ENC_RCPT_001",
"receiptNo": "RCPT-2026-000101",
"message": "Sale saved successfully."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/SaveSale" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"customerModel": {
"customerId": "string",
"id": 0,
"branchId": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"genderID": "string",
"isMarried": false,
"reference": "string",
"isActive": false,
"birthDate": "2026-01-31T10:15:00Z",
"stringBirthDate": "string",
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"remarks": "string",
"mobile": "string",
"foreignerMobile": "string",
"phoneNO": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"isForeigner": false,
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"stateId": 0,
"countryId": "string",
"faceShapeID": "string",
"createdBy": "string",
"createdIP": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"createdDate": "2026-01-31T10:15:00Z",
"newCustomer": false,
"createdDateString": "string",
"marriageDateString": "string",
"birthDateString": "string",
"encryptCustomerID": "string",
"branchName": "string",
"isNewRecord": false,
"gender": "string",
"doctor": "string",
"taxNO": "string",
"visitingDate": "2026-01-31T10:15:00Z",
"isBlackList": false,
"r_SPH": 0,
"r_CYL": 0,
"r_AXIS": 0,
"r_ADD": 0,
"l_SPH": 0,
"l_CYL": 0,
"l_AXIS": 0,
"l_ADD": 0,
"doctorID": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"righT_AdditionWithSign": "string",
"righT_AxisWithSign": "string",
"righT_FixFlotedText": "string",
"lefT_SphericalWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AdditionWithSign": "string",
"lefT_AxisWithSign": "string",
"lefT_FixFlotedText": "string",
"rightVision": "string",
"leftVision": "string",
"rightvn": "string",
"leftvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"age": 0,
"bloodGroup": "string",
"self": "string",
"membershipID": 0,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeignerFlag": false
},
"salesorderModel": {
"dateString": "string",
"sessionId": "string",
"companyId": "string",
"branchId": "string",
"schemeID": "string",
"salesRepresentativeID": "string",
"customerId": "string",
"cancellationReasonID": "string",
"cancellReason": "string",
"yearId": "string",
"gstNo": "string",
"salesOrderId": 0,
"isForeigner": false,
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"taxTypeId": 0,
"transport": "string",
"grandTotal": 0,
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalTax": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalMRP": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"netAmount": 0,
"remarks": "string",
"acceptedBy": "string",
"statusID": "string",
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"checkSalesOrderCustomer": "string",
"salesPriceIncludesTax": false,
"isCompositionScheme": false,
"showMRP": false,
"barcodeScan": "string",
"goToReceipt": false,
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTimeString": "string",
"deliveryTime": "string",
"rounding": 0,
"itemTypeID": "string",
"searchItem": "string",
"giftVoucherID": "string",
"giftVoucherDiscount": 0,
"giftVoucherNo": "string",
"taxTypeName": "string",
"srName": "string",
"customerTitle": "string",
"firstName": "string",
"lastName": "string",
"customerName": "string",
"customerMobile": "string",
"customerEmailID": "string",
"rightLensFittingHeight": 0,
"rightLensTotalHeight": 0,
"leftLensFittingHeight": 0,
"leftLensTotalHeight": 0,
"typeID": "string",
"getSalesOrderDetailList": [
{}
],
"salesOrderDetailList": [
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"allowUserToChangePrice": false,
"allowUserToChangeDiscount": false,
"maxUserDiscountPercentage": 0,
"allowUerToGenerateFutureDateOrder": false,
"allowUserToGeneratePastDateOrder": false,
"allowStoreManagerToGenerateFutureDateOrder": false,
"allowStoreManagerToGeneratePastDateOrder": false,
"userInRole": false,
"userInRoleStoreManager": false,
"allowWarehouseManagerToCancelOrder": false,
"allowCompanyManagerToCancelOrder": false,
"storeSalesOrderID": "string",
"isFranchise": false,
"referencePurchaseOrderID": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"visitingDate": "2026-01-31T10:15:00Z",
"visitingDateString": "string",
"isPopup": "string",
"deliveryModeID": 0,
"deliveryModeName": "string",
"isFranchise_Branch": false,
"deliveryDateDays": "string",
"dndForTransactionalMessage": false,
"dndForPromotionalMessage": false,
"isImportedOrder": false,
"isGiftVoucherApplied": false,
"branchLogo": "string",
"branchName": "string",
"companyName": "string",
"enableInsurance": false,
"customerInsuranceID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"insuranceCompanyID": 0,
"policyNo": "string",
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"totalNISAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"totalVoucherAmount": 0
},
"receiptModel": {
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
},
"eyeInfoModel": {
"doctorName": "string"
},
"eyecheckupRecallModel": {
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{}
],
"notifiedRecallList": [
{}
]
},
"purchaseOrderModel": {
"purchaseOrderId": 0,
"statusId": 0,
"priorityId": 0,
"branchId": 0,
"yearId": 0,
"sessionId": "string",
"subCategoryId": 0,
"fitterID": 0,
"condition": "string",
"priority": "string",
"taxType": "string",
"supplier": "string",
"supplierInvoiceNo": "string",
"purchaseOrderNumber": "string",
"orderDate": "2026-01-31T10:15:00Z",
"orderDateString": "string",
"receiveDate": "2026-01-31T10:15:00Z",
"receiveDateString": "string",
"transport": "string",
"supplierId": 0,
"taxTypeId": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"netAmount": 0,
"serviceTax": 0,
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"status": "string",
"remarks": "string",
"createdBy": 0,
"createdIP": "string",
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"getOrderList": [
{
"id": 0,
"itemId": 0,
"sessionId": "string",
"title": "string",
"code": "string",
"status": "string",
"salesPrice": 0,
"purchaseCost": 0,
"qty": 0,
"cost": 0,
"totalCost": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"serviceTax": 0,
"jobCharges": 0,
"otherCharges": 0,
"shippingCharges": 0,
"rounding": 0,
"netAmount": 0,
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
],
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"title": "string",
"itemTypeID": 0,
"isDirectInward": false,
"modelNo": "string",
"colorId": 0,
"brandId": 0,
"shapeId": 0,
"sizeId": 0,
"materialId": 0,
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": 0,
"code": "string",
"index": "string",
"productID": 0,
"lenseStyleID": 0,
"lensCoatID": 0,
"lensColorId": 0,
"spectacleLensTypeID": 0,
"unitTypeId": 0,
"frameId": 0,
"itemTypeCode": "string",
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoTitle": false,
"autoTitleClone": false,
"autoPRMTitle": false,
"prmCode": "string",
"deoCode": "string",
"autoDEOTitle": false,
"allowMannualBarcode": false,
"isFranchise": false,
"priceRangeID": 0,
"branchLogo": "string",
"branchName": "string",
"companyName": "string"
},
"autoItemTypeSectionList": [
{
"id": 0,
"itemTypeID": 0,
"moduleID": 0,
"isAutosection": false,
"sectionName": "string"
}
],
"isLensAdded": false,
"orderDate": "2026-01-31T10:15:00Z",
"expectedDate": "2026-01-31T10:15:00Z",
"visitorIP": "string",
"branchCity": "string",
"isSpectacleLensInOrder": false,
"sessionID": "string",
"supplierID": "string",
"fitterID": "string",
"isExternal": false,
"userId": 0,
"priorityID": "string",
"showLabOrderInQuickSale": false,
"showQuickSaleAddFrameSection": false,
"showQuickSaleAddSunGlassSection": false,
"showQuickSaleAddLensSection": false,
"showQuickSaleAddContactLensSection": false,
"showQuickSaleAddCLCPSection": false,
"showQuickSaleAddAccessoriesSection": false,
"showQuickSaleAddPerfumeSection": false,
"showQuickSaleAddDeodorantSection": false,
"showQuickSaleAddAttarSection": false,
"showQuickSaleAddFreshenerSection": false,
"showQuickSaleAddLeatherAccessoriesSection": false,
"showQuickSaleAddCosmeticsSection": false,
"showQuickSaleAddGiftSetsSection": false,
"showQuickSaleAddMenAccessoriesSection": false,
"showQuickSaleAddWomenAccessoriesSection": false,
"showQuickSaleAddWatchesSection": false,
"showQuickSaleAddImitationJewellerySection": false,
"showQuickSaleAddDressMaterialSection": false,
"showQuickSaleAddKurtiSection": false,
"showQuickSaleAddKurtiPairSection": false,
"showQuickSaleAddChaniyaCholiSection": false,
"showQuickSaleAddLegginsSection": false,
"showQuickSaleAddKurtaPentSection": false,
"showQuickSaleAddPlazzoSection": false,
"showQuickSaleAddOnePieceSection": false,
"showQuickSaleAddDupattaSection": false,
"showQuickSaleAddWesternSection": false,
"allowMannualBarcode": false,
"defaultZeroReceiptAmountForQuickSale": false,
"allowZeroAmountReceiptInQuickSale": false,
"isRemoveValidationFromCustomer": false,
"modelNo": "string",
"colorId": "string",
"brandId": "string",
"shapeId": "string",
"sizeId": "string",
"materialId": "string",
"subCategoryId": "string",
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": "string",
"code": "string",
"index": "string",
"productID": "string",
"lenseStyleID": "string",
"lensCoatID": "string",
"lensColorId": "string",
"spectacleLensTypeID": "string",
"unitTypeId": "string",
"itemTypeID": "string",
"itemTypeCode": "string",
"frameId": "string",
"priceRangeID": "string",
"autoTitle": false,
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoPerfumeTitle": false,
"autoDeodorantTitle": false,
"autoAttarTitle": false,
"autoFreshenerTitle": false,
"autoLeatherAccessoriesTitle": false,
"autoCosmeticsTitle": false,
"autoGiftSetsTitle": false,
"autoMenAccessoriesTitle": false,
"autoWomenAccessoriesTitle": false,
"autoWatchesTitle": false,
"autoImitationJewelleryTitle": false,
"autoReadymadeGarmentsTitle": false,
"branchId": 0,
"yearId": "string"
}'
POST
/api/quickSale/saveSalesOrderTemp
Save temporary sales order (cart)
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema SalesOrderTempModelRequest — 50 fields, listed under Data models.
{
"id": "string",
"sessionID": "string",
"salesOrderID": "string",
"isOrdered": false,
"itemID": "string",
"inventoryID": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"taxRate": 0,
"taxAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"jobCharges": 0,
"serviceTaxId": 0,
"serviceTaxRate": 0,
"serviceTaxAmount": 0,
"totalAmount": 0,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"spectacleLensType": 0,
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"near": "string",
"vision": "string",
"vn": "string",
"pd": "string",
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"pairNo": "string",
"basecurve": "string",
"diameter": "string",
"prescriptionRemarks": "string",
"k1": "string",
"k2": "string",
"typeID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
Responses
- 200OK
Example response
200 Success response
{
"sessionID": "SESS_ABC123",
"message": "Temporary order saved."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/saveSalesOrderTemp" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": "string",
"sessionID": "string",
"salesOrderID": "string",
"isOrdered": false,
"itemID": "string",
"inventoryID": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"taxRate": 0,
"taxAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"jobCharges": 0,
"serviceTaxId": 0,
"serviceTaxRate": 0,
"serviceTaxAmount": 0,
"totalAmount": 0,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"spectacleLensType": 0,
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"near": "string",
"vision": "string",
"vn": "string",
"pd": "string",
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"pairNo": "string",
"basecurve": "string",
"diameter": "string",
"prescriptionRemarks": "string",
"k1": "string",
"k2": "string",
"typeID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}'
POST
/api/quickSale/search-contact-lens
Search contact lenses by power and parameters
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema ContactLensSearchRequest — 1 field, listed under Data models.
{
"term": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_ITEM_003",
"name": "AquaSoft Oasis -2.00",
"code": "AQO200",
"price": 120,
"mrp": 140,
"stock": 30,
"spherical": "-2.00",
"baseCurve": "8.4",
"diameter": "14.0"
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/search-contact-lens" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"term": "string"
}'
POST
/api/quickSale/update-sales-order-temp-values
Update values in the temporary sales order
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema UpdateSalesOrderRequestModel — 5 fields, listed under Data models.
{
"id": 0,
"qty": 0,
"price": 0,
"discountRate": 0,
"discountAmount": 0
}
Responses
- 200OK
Example response
200 Success response
{
"message": "Temporary order updated.",
"netAmount": 450
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/quickSale/update-sales-order-temp-values" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"id": 0,
"qty": 0,
"price": 0,
"discountRate": 0,
"discountAmount": 0
}'
Invoice
6 endpointsInvoices and invoice lists.
GET
/api/Invoice/get-customers-for-invoice
Get customers available for invoice creation
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
{
"data": [
{
"id": "ENC_CUST_001",
"customerName": "Ahmed Al Rashid"
}
]
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Invoice/get-customers-for-invoice" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Invoice/get-invoice-data-by-salesorder
Get invoice data prefilled from a sales order
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| salesOrderId | query | string | no |
Responses
- 200OK
Example response
200 Success response
{
"invoiceID": null,
"invoiceNo": null,
"salesOrderID": "ENC_SO_001",
"salesOrderNO": "SO-2026-000500",
"customerID": "ENC_CUST_001",
"customerName": "Ahmed Al Rashid",
"netAmount": 2500,
"items": []
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Invoice/get-invoice-data-by-salesorder?salesOrderId=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Invoice/get-sales-orders-for-invoice
Get sales orders for invoice creation
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| customerId | query | string | no |
Responses
- 200OK
Example response
200 Success response
{
"data": [
{
"salesOrderID": "ENC_SO_001",
"salesOrderNO": "SO-2026-000500"
}
]
}
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Invoice/get-sales-orders-for-invoice?customerId=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Invoice/GetOrdersForNewInvoice
Get sales orders available for invoicing
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMRequestModel — 3 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0
}
Responses
- 200OK
Example response
200 Success response
[
{
"salesOrderID": "ENC_SO_001",
"salesOrderNO": "SO-2026-000500"
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Invoice/GetOrdersForNewInvoice" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0
}'
POST
/api/Invoice/List
Get paginated invoice list
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema SearchInvoice — 17 fields, listed under Data models.
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerMobile": "string",
"customerName": "string",
"invoiceNumber": "string",
"fromDate": "string",
"toDate": "string",
"date": "string",
"amount": "string",
"netAmount": "string",
"totalRows": "string",
"salesOrderNo": "string",
"orderBy": "string",
"customerID": "string",
"fromPage": 0,
"toPage": 0
}
Responses
- 200OK EncryptedInvoiceListDtoPagedApiResponse
- 400Bad Request ProblemDetails
- 401Unauthorized ProblemDetails
Example response
200 Success response
{
"totalRows": 320,
"data": [
{
"customerName": "Ahmed Al Rashid",
"date": "2026-08-10T09:15:00",
"id": "ENC_INV_001",
"plainId": 1001,
"invoiceNo": "INV-2026-001001",
"netAmount": 2500,
"salesOrderNo": "SO-2026-000500",
"customerMobileNo": "\u002B971501234567"
}
]
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Invoice/List" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerMobile": "string",
"customerName": "string",
"invoiceNumber": "string",
"fromDate": "string",
"toDate": "string",
"date": "string",
"amount": "string",
"netAmount": "string",
"totalRows": "string",
"salesOrderNo": "string",
"orderBy": "string",
"customerID": "string",
"fromPage": 0,
"toPage": 0
}'
POST
/api/Invoice/save-invoice-data
Save / create an invoice
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMFastWizardModel — 94 fields, listed under Data models.
{
"customerModel": {
"customerId": "string",
"id": 0,
"branchId": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"genderID": "string",
"isMarried": false,
"reference": "string",
"isActive": false,
"birthDate": "2026-01-31T10:15:00Z",
"stringBirthDate": "string",
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"remarks": "string",
"mobile": "string",
"foreignerMobile": "string",
"phoneNO": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"isForeigner": false,
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"stateId": 0,
"countryId": "string",
"faceShapeID": "string",
"createdBy": "string",
"createdIP": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"createdDate": "2026-01-31T10:15:00Z",
"newCustomer": false,
"createdDateString": "string",
"marriageDateString": "string",
"birthDateString": "string",
"encryptCustomerID": "string",
"branchName": "string",
"isNewRecord": false,
"gender": "string",
"doctor": "string",
"taxNO": "string",
"visitingDate": "2026-01-31T10:15:00Z",
"isBlackList": false,
"r_SPH": 0,
"r_CYL": 0,
"r_AXIS": 0,
"r_ADD": 0,
"l_SPH": 0,
"l_CYL": 0,
"l_AXIS": 0,
"l_ADD": 0,
"doctorID": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"righT_AdditionWithSign": "string",
"righT_AxisWithSign": "string",
"righT_FixFlotedText": "string",
"lefT_SphericalWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AdditionWithSign": "string",
"lefT_AxisWithSign": "string",
"lefT_FixFlotedText": "string",
"rightVision": "string",
"leftVision": "string",
"rightvn": "string",
"leftvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"age": 0,
"bloodGroup": "string",
"self": "string",
"membershipID": 0,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeignerFlag": false
},
"salesorderModel": {
"dateString": "string",
"sessionId": "string",
"companyId": "string",
"branchId": "string",
"schemeID": "string",
"salesRepresentativeID": "string",
"customerId": "string",
"cancellationReasonID": "string",
"cancellReason": "string",
"yearId": "string",
"gstNo": "string",
"salesOrderId": 0,
"isForeigner": false,
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"taxTypeId": 0,
"transport": "string",
"grandTotal": 0,
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalTax": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalMRP": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"netAmount": 0,
"remarks": "string",
"acceptedBy": "string",
"statusID": "string",
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"checkSalesOrderCustomer": "string",
"salesPriceIncludesTax": false,
"isCompositionScheme": false,
"showMRP": false,
"barcodeScan": "string",
"goToReceipt": false,
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTimeString": "string",
"deliveryTime": "string",
"rounding": 0,
"itemTypeID": "string",
"searchItem": "string",
"giftVoucherID": "string",
"giftVoucherDiscount": 0,
"giftVoucherNo": "string",
"taxTypeName": "string",
"srName": "string",
"customerTitle": "string",
"firstName": "string",
"lastName": "string",
"customerName": "string",
"customerMobile": "string",
"customerEmailID": "string",
"rightLensFittingHeight": 0,
"rightLensTotalHeight": 0,
"leftLensFittingHeight": 0,
"leftLensTotalHeight": 0,
"typeID": "string",
"getSalesOrderDetailList": [
{}
],
"salesOrderDetailList": [
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"allowUserToChangePrice": false,
"allowUserToChangeDiscount": false,
"maxUserDiscountPercentage": 0,
"allowUerToGenerateFutureDateOrder": false,
"allowUserToGeneratePastDateOrder": false,
"allowStoreManagerToGenerateFutureDateOrder": false,
"allowStoreManagerToGeneratePastDateOrder": false,
"userInRole": false,
"userInRoleStoreManager": false,
"allowWarehouseManagerToCancelOrder": false,
"allowCompanyManagerToCancelOrder": false,
"storeSalesOrderID": "string",
"isFranchise": false,
"referencePurchaseOrderID": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"visitingDate": "2026-01-31T10:15:00Z",
"visitingDateString": "string",
"isPopup": "string",
"deliveryModeID": 0,
"deliveryModeName": "string",
"isFranchise_Branch": false,
"deliveryDateDays": "string",
"dndForTransactionalMessage": false,
"dndForPromotionalMessage": false,
"isImportedOrder": false,
"isGiftVoucherApplied": false,
"branchLogo": "string",
"branchName": "string",
"companyName": "string",
"enableInsurance": false,
"customerInsuranceID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"insuranceCompanyID": 0,
"policyNo": "string",
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"totalNISAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"totalVoucherAmount": 0
},
"receiptModel": {
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
},
"eyeInfoModel": {
"doctorName": "string"
},
"eyecheckupRecallModel": {
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{}
],
"notifiedRecallList": [
{}
]
},
"purchaseOrderModel": {
"purchaseOrderId": 0,
"statusId": 0,
"priorityId": 0,
"branchId": 0,
"yearId": 0,
"sessionId": "string",
"subCategoryId": 0,
"fitterID": 0,
"condition": "string",
"priority": "string",
"taxType": "string",
"supplier": "string",
"supplierInvoiceNo": "string",
"purchaseOrderNumber": "string",
"orderDate": "2026-01-31T10:15:00Z",
"orderDateString": "string",
"receiveDate": "2026-01-31T10:15:00Z",
"receiveDateString": "string",
"transport": "string",
"supplierId": 0,
"taxTypeId": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"netAmount": 0,
"serviceTax": 0,
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"status": "string",
"remarks": "string",
"createdBy": 0,
"createdIP": "string",
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"getOrderList": [
{
"id": 0,
"itemId": 0,
"sessionId": "string",
"title": "string",
"code": "string",
"status": "string",
"salesPrice": 0,
"purchaseCost": 0,
"qty": 0,
"cost": 0,
"totalCost": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"serviceTax": 0,
"jobCharges": 0,
"otherCharges": 0,
"shippingCharges": 0,
"rounding": 0,
"netAmount": 0,
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
],
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"title": "string",
"itemTypeID": 0,
"isDirectInward": false,
"modelNo": "string",
"colorId": 0,
"brandId": 0,
"shapeId": 0,
"sizeId": 0,
"materialId": 0,
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": 0,
"code": "string",
"index": "string",
"productID": 0,
"lenseStyleID": 0,
"lensCoatID": 0,
"lensColorId": 0,
"spectacleLensTypeID": 0,
"unitTypeId": 0,
"frameId": 0,
"itemTypeCode": "string",
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoTitle": false,
"autoTitleClone": false,
"autoPRMTitle": false,
"prmCode": "string",
"deoCode": "string",
"autoDEOTitle": false,
"allowMannualBarcode": false,
"isFranchise": false,
"priceRangeID": 0,
"branchLogo": "string",
"branchName": "string",
"companyName": "string"
},
"autoItemTypeSectionList": [
{
"id": 0,
"itemTypeID": 0,
"moduleID": 0,
"isAutosection": false,
"sectionName": "string"
}
],
"isLensAdded": false,
"orderDate": "2026-01-31T10:15:00Z",
"expectedDate": "2026-01-31T10:15:00Z",
"visitorIP": "string",
"branchCity": "string",
"isSpectacleLensInOrder": false,
"sessionID": "string",
"supplierID": "string",
"fitterID": "string",
"isExternal": false,
"userId": 0,
"priorityID": "string",
"showLabOrderInQuickSale": false,
"showQuickSaleAddFrameSection": false,
"showQuickSaleAddSunGlassSection": false,
"showQuickSaleAddLensSection": false,
"showQuickSaleAddContactLensSection": false,
"showQuickSaleAddCLCPSection": false,
"showQuickSaleAddAccessoriesSection": false,
"showQuickSaleAddPerfumeSection": false,
"showQuickSaleAddDeodorantSection": false,
"showQuickSaleAddAttarSection": false,
"showQuickSaleAddFreshenerSection": false,
"showQuickSaleAddLeatherAccessoriesSection": false,
"showQuickSaleAddCosmeticsSection": false,
"showQuickSaleAddGiftSetsSection": false,
"showQuickSaleAddMenAccessoriesSection": false,
"showQuickSaleAddWomenAccessoriesSection": false,
"showQuickSaleAddWatchesSection": false,
"showQuickSaleAddImitationJewellerySection": false,
"showQuickSaleAddDressMaterialSection": false,
"showQuickSaleAddKurtiSection": false,
"showQuickSaleAddKurtiPairSection": false,
"showQuickSaleAddChaniyaCholiSection": false,
"showQuickSaleAddLegginsSection": false,
"showQuickSaleAddKurtaPentSection": false,
"showQuickSaleAddPlazzoSection": false,
"showQuickSaleAddOnePieceSection": false,
"showQuickSaleAddDupattaSection": false,
"showQuickSaleAddWesternSection": false,
"allowMannualBarcode": false,
"defaultZeroReceiptAmountForQuickSale": false,
"allowZeroAmountReceiptInQuickSale": false,
"isRemoveValidationFromCustomer": false,
"modelNo": "string",
"colorId": "string",
"brandId": "string",
"shapeId": "string",
"sizeId": "string",
"materialId": "string",
"subCategoryId": "string",
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": "string",
"code": "string",
"index": "string",
"productID": "string",
"lenseStyleID": "string",
"lensCoatID": "string",
"lensColorId": "string",
"spectacleLensTypeID": "string",
"unitTypeId": "string",
"itemTypeID": "string",
"itemTypeCode": "string",
"frameId": "string",
"priceRangeID": "string",
"autoTitle": false,
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoPerfumeTitle": false,
"autoDeodorantTitle": false,
"autoAttarTitle": false,
"autoFreshenerTitle": false,
"autoLeatherAccessoriesTitle": false,
"autoCosmeticsTitle": false,
"autoGiftSetsTitle": false,
"autoMenAccessoriesTitle": false,
"autoWomenAccessoriesTitle": false,
"autoWatchesTitle": false,
"autoImitationJewelleryTitle": false,
"autoReadymadeGarmentsTitle": false,
"branchId": 0,
"yearId": "string"
}
Responses
- 200OK
Example response
200 Success response
{
"invoiceID": "ENC_INV_001",
"invoiceNo": "INV-2026-001001",
"message": "Invoice saved successfully."
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Invoice/save-invoice-data" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"customerModel": {
"customerId": "string",
"id": 0,
"branchId": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"genderID": "string",
"isMarried": false,
"reference": "string",
"isActive": false,
"birthDate": "2026-01-31T10:15:00Z",
"stringBirthDate": "string",
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"remarks": "string",
"mobile": "string",
"foreignerMobile": "string",
"phoneNO": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"isForeigner": false,
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"stateId": 0,
"countryId": "string",
"faceShapeID": "string",
"createdBy": "string",
"createdIP": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"createdDate": "2026-01-31T10:15:00Z",
"newCustomer": false,
"createdDateString": "string",
"marriageDateString": "string",
"birthDateString": "string",
"encryptCustomerID": "string",
"branchName": "string",
"isNewRecord": false,
"gender": "string",
"doctor": "string",
"taxNO": "string",
"visitingDate": "2026-01-31T10:15:00Z",
"isBlackList": false,
"r_SPH": 0,
"r_CYL": 0,
"r_AXIS": 0,
"r_ADD": 0,
"l_SPH": 0,
"l_CYL": 0,
"l_AXIS": 0,
"l_ADD": 0,
"doctorID": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"righT_AdditionWithSign": "string",
"righT_AxisWithSign": "string",
"righT_FixFlotedText": "string",
"lefT_SphericalWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AdditionWithSign": "string",
"lefT_AxisWithSign": "string",
"lefT_FixFlotedText": "string",
"rightVision": "string",
"leftVision": "string",
"rightvn": "string",
"leftvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"age": 0,
"bloodGroup": "string",
"self": "string",
"membershipID": 0,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeignerFlag": false
},
"salesorderModel": {
"dateString": "string",
"sessionId": "string",
"companyId": "string",
"branchId": "string",
"schemeID": "string",
"salesRepresentativeID": "string",
"customerId": "string",
"cancellationReasonID": "string",
"cancellReason": "string",
"yearId": "string",
"gstNo": "string",
"salesOrderId": 0,
"isForeigner": false,
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"taxTypeId": 0,
"transport": "string",
"grandTotal": 0,
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalTax": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalMRP": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"netAmount": 0,
"remarks": "string",
"acceptedBy": "string",
"statusID": "string",
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"checkSalesOrderCustomer": "string",
"salesPriceIncludesTax": false,
"isCompositionScheme": false,
"showMRP": false,
"barcodeScan": "string",
"goToReceipt": false,
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTimeString": "string",
"deliveryTime": "string",
"rounding": 0,
"itemTypeID": "string",
"searchItem": "string",
"giftVoucherID": "string",
"giftVoucherDiscount": 0,
"giftVoucherNo": "string",
"taxTypeName": "string",
"srName": "string",
"customerTitle": "string",
"firstName": "string",
"lastName": "string",
"customerName": "string",
"customerMobile": "string",
"customerEmailID": "string",
"rightLensFittingHeight": 0,
"rightLensTotalHeight": 0,
"leftLensFittingHeight": 0,
"leftLensTotalHeight": 0,
"typeID": "string",
"getSalesOrderDetailList": [
{}
],
"salesOrderDetailList": [
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"allowUserToChangePrice": false,
"allowUserToChangeDiscount": false,
"maxUserDiscountPercentage": 0,
"allowUerToGenerateFutureDateOrder": false,
"allowUserToGeneratePastDateOrder": false,
"allowStoreManagerToGenerateFutureDateOrder": false,
"allowStoreManagerToGeneratePastDateOrder": false,
"userInRole": false,
"userInRoleStoreManager": false,
"allowWarehouseManagerToCancelOrder": false,
"allowCompanyManagerToCancelOrder": false,
"storeSalesOrderID": "string",
"isFranchise": false,
"referencePurchaseOrderID": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"visitingDate": "2026-01-31T10:15:00Z",
"visitingDateString": "string",
"isPopup": "string",
"deliveryModeID": 0,
"deliveryModeName": "string",
"isFranchise_Branch": false,
"deliveryDateDays": "string",
"dndForTransactionalMessage": false,
"dndForPromotionalMessage": false,
"isImportedOrder": false,
"isGiftVoucherApplied": false,
"branchLogo": "string",
"branchName": "string",
"companyName": "string",
"enableInsurance": false,
"customerInsuranceID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"insuranceCompanyID": 0,
"policyNo": "string",
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"totalNISAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"totalVoucherAmount": 0
},
"receiptModel": {
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
},
"eyeInfoModel": {
"doctorName": "string"
},
"eyecheckupRecallModel": {
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{}
],
"notifiedRecallList": [
{}
]
},
"purchaseOrderModel": {
"purchaseOrderId": 0,
"statusId": 0,
"priorityId": 0,
"branchId": 0,
"yearId": 0,
"sessionId": "string",
"subCategoryId": 0,
"fitterID": 0,
"condition": "string",
"priority": "string",
"taxType": "string",
"supplier": "string",
"supplierInvoiceNo": "string",
"purchaseOrderNumber": "string",
"orderDate": "2026-01-31T10:15:00Z",
"orderDateString": "string",
"receiveDate": "2026-01-31T10:15:00Z",
"receiveDateString": "string",
"transport": "string",
"supplierId": 0,
"taxTypeId": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"netAmount": 0,
"serviceTax": 0,
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"status": "string",
"remarks": "string",
"createdBy": 0,
"createdIP": "string",
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"getOrderList": [
{
"id": 0,
"itemId": 0,
"sessionId": "string",
"title": "string",
"code": "string",
"status": "string",
"salesPrice": 0,
"purchaseCost": 0,
"qty": 0,
"cost": 0,
"totalCost": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"serviceTax": 0,
"jobCharges": 0,
"otherCharges": 0,
"shippingCharges": 0,
"rounding": 0,
"netAmount": 0,
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
],
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"title": "string",
"itemTypeID": 0,
"isDirectInward": false,
"modelNo": "string",
"colorId": 0,
"brandId": 0,
"shapeId": 0,
"sizeId": 0,
"materialId": 0,
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": 0,
"code": "string",
"index": "string",
"productID": 0,
"lenseStyleID": 0,
"lensCoatID": 0,
"lensColorId": 0,
"spectacleLensTypeID": 0,
"unitTypeId": 0,
"frameId": 0,
"itemTypeCode": "string",
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoTitle": false,
"autoTitleClone": false,
"autoPRMTitle": false,
"prmCode": "string",
"deoCode": "string",
"autoDEOTitle": false,
"allowMannualBarcode": false,
"isFranchise": false,
"priceRangeID": 0,
"branchLogo": "string",
"branchName": "string",
"companyName": "string"
},
"autoItemTypeSectionList": [
{
"id": 0,
"itemTypeID": 0,
"moduleID": 0,
"isAutosection": false,
"sectionName": "string"
}
],
"isLensAdded": false,
"orderDate": "2026-01-31T10:15:00Z",
"expectedDate": "2026-01-31T10:15:00Z",
"visitorIP": "string",
"branchCity": "string",
"isSpectacleLensInOrder": false,
"sessionID": "string",
"supplierID": "string",
"fitterID": "string",
"isExternal": false,
"userId": 0,
"priorityID": "string",
"showLabOrderInQuickSale": false,
"showQuickSaleAddFrameSection": false,
"showQuickSaleAddSunGlassSection": false,
"showQuickSaleAddLensSection": false,
"showQuickSaleAddContactLensSection": false,
"showQuickSaleAddCLCPSection": false,
"showQuickSaleAddAccessoriesSection": false,
"showQuickSaleAddPerfumeSection": false,
"showQuickSaleAddDeodorantSection": false,
"showQuickSaleAddAttarSection": false,
"showQuickSaleAddFreshenerSection": false,
"showQuickSaleAddLeatherAccessoriesSection": false,
"showQuickSaleAddCosmeticsSection": false,
"showQuickSaleAddGiftSetsSection": false,
"showQuickSaleAddMenAccessoriesSection": false,
"showQuickSaleAddWomenAccessoriesSection": false,
"showQuickSaleAddWatchesSection": false,
"showQuickSaleAddImitationJewellerySection": false,
"showQuickSaleAddDressMaterialSection": false,
"showQuickSaleAddKurtiSection": false,
"showQuickSaleAddKurtiPairSection": false,
"showQuickSaleAddChaniyaCholiSection": false,
"showQuickSaleAddLegginsSection": false,
"showQuickSaleAddKurtaPentSection": false,
"showQuickSaleAddPlazzoSection": false,
"showQuickSaleAddOnePieceSection": false,
"showQuickSaleAddDupattaSection": false,
"showQuickSaleAddWesternSection": false,
"allowMannualBarcode": false,
"defaultZeroReceiptAmountForQuickSale": false,
"allowZeroAmountReceiptInQuickSale": false,
"isRemoveValidationFromCustomer": false,
"modelNo": "string",
"colorId": "string",
"brandId": "string",
"shapeId": "string",
"sizeId": "string",
"materialId": "string",
"subCategoryId": "string",
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": "string",
"code": "string",
"index": "string",
"productID": "string",
"lenseStyleID": "string",
"lensCoatID": "string",
"lensColorId": "string",
"spectacleLensTypeID": "string",
"unitTypeId": "string",
"itemTypeID": "string",
"itemTypeCode": "string",
"frameId": "string",
"priceRangeID": "string",
"autoTitle": false,
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoPerfumeTitle": false,
"autoDeodorantTitle": false,
"autoAttarTitle": false,
"autoFreshenerTitle": false,
"autoLeatherAccessoriesTitle": false,
"autoCosmeticsTitle": false,
"autoGiftSetsTitle": false,
"autoMenAccessoriesTitle": false,
"autoWomenAccessoriesTitle": false,
"autoWatchesTitle": false,
"autoImitationJewelleryTitle": false,
"autoReadymadeGarmentsTitle": false,
"branchId": 0,
"yearId": "string"
}'
Receipts
2 endpointsPayment receipts.
GET
/api/Receipts/id
Get receipts by ID
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| customerId | query | integer (int64) | no | |
| salesOrderId | query | integer (int64) | no |
Responses
- 200OK
- 404Not Found ProblemDetails
- 500Internal Server Error
Example response
200 Success response
[
{
"receiptId": "ENC_RCPT_001",
"receiptNo": "RCPT-2026-000100",
"name": "Ahmed Al Rashid",
"salesOrderNo": "SO-2026-000500",
"invoiceNO": "INV-2026-001001",
"date": "2026-08-05T14:30:00",
"amount": 1000,
"statusName": "Confirmed",
"balance": 1500,
"receiptTotalAmount": 1000,
"soTotalAmount": 2500
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Receipts/id?customerId=0&salesOrderId=0" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Receipts/list-paged
Get paginated and filtered receipt list
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema ReceiptFilterRequest — 18 fields, listed under Data models.
{
"companyID": "string",
"branchID": "string",
"yearID": "string",
"customerID": "string",
"receiptNo": "string",
"receiptType": "string",
"salesOrderNo": "string",
"invoiceNO": "string",
"date": "string",
"customerName": "string",
"customerMobile": "string",
"fromDate": "string",
"toDate": "string",
"amount": "string",
"status": "string",
"pageNumber": 0,
"pageSize": 0,
"orderBy": "string"
}
Responses
- 200OK EncryptedReceiptPagedDtoPagedResult
- 500Internal Server Error
Example response
200 Success response
{
"items": [
{
"receiptId": "ENC_RCPT_001",
"receiptNo": "RCPT-2026-000100",
"receiptType": "Cash",
"salesOrderNo": "SO-2026-000500",
"invoiceNO": "INV-2026-001001",
"customerName": "Ahmed Al Rashid",
"customerMobileNo": "\u002B971501234567",
"receiptDate": "2026-08-05T14:30:00",
"amount": 1000,
"salesOrderAmount": 2500,
"status": "Confirmed",
"statusID": 1,
"itemCount": 2,
"totalReceipt": 1000
}
],
"totalRecords": 320
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Receipts/list-paged" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"companyID": "string",
"branchID": "string",
"yearID": "string",
"customerID": "string",
"receiptNo": "string",
"receiptType": "string",
"salesOrderNo": "string",
"invoiceNO": "string",
"date": "string",
"customerName": "string",
"customerMobile": "string",
"fromDate": "string",
"toDate": "string",
"amount": "string",
"status": "string",
"pageNumber": 0,
"pageSize": 0,
"orderBy": "string"
}'
Dashboard
1 endpointStore performance summaries.
POST
/api/Dashboard/dashboardData
Get dashboard summary data for today, monthly, and total metrics
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema EncryptedDashboardRequestDto — 4 fields, listed under Data models.
{
"branchID": "string",
"yearID": "string",
"statusId": 0,
"date": "2026-01-31T10:15:00Z"
}
Responses
- 200OK
Example response
200 Success response
{
"todaySalesOrder": 15250.75,
"monthlySalesOrder": 425000,
"totalSalesOrder": 3250000,
"todayReceipt": 12000,
"monthlyReceipt": 390000,
"totalReceipt": 3000000,
"todayInvoiceSales": 10500,
"monthlyInvoiceSales": 310000,
"totalInvoiceSales": 2800000,
"todayCustomers": 8,
"monthlyCustomers": 210,
"totalCustomers": 4500
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Dashboard/dashboardData" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"branchID": "string",
"yearID": "string",
"statusId": 0,
"date": "2026-01-31T10:15:00Z"
}'
Common
13 endpointsShared lookups and master data.
POST
/api/Common/GetCategoriesByItemType
Get categories by item type ID
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema EncryptedItemTypeIdRequest — 1 field, listed under Data models.
{
"itemTypeID": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_CAT_001",
"name": "Metal Frames",
"code": "MF",
"itemTypeID": "ENC_IT_001"
},
{
"id": "ENC_CAT_002",
"name": "Plastic Frames",
"code": "PF",
"itemTypeID": "ENC_IT_001"
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/GetCategoriesByItemType" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"itemTypeID": "string"
}'
GET
/api/Common/GetCountries
Get list of countries
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_COUNTRY_001",
"name": "United Arab Emirates"
},
{
"id": "ENC_COUNTRY_002",
"name": "India"
},
{
"id": "ENC_COUNTRY_003",
"name": "United Kingdom"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Common/GetCountries" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
GET
/api/Common/GetItemTypes
Get all item types
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_IT_001",
"name": "Frame",
"value": 1
},
{
"id": "ENC_IT_002",
"name": "Lens",
"value": 2
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Common/GetItemTypes" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Common/GetItemTypesByModule
Get item types filtered by module
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema EncryptedModuleIdRequest — 1 field, listed under Data models.
{
"moduleID": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_IT_001",
"name": "Frame",
"value": 1
},
{
"id": "ENC_IT_002",
"name": "Lens",
"value": 2
},
{
"id": "ENC_IT_003",
"name": "Contact Lens",
"value": 3
},
{
"id": "ENC_IT_004",
"name": "Accessories",
"value": 4
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/GetItemTypesByModule" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"moduleID": "string"
}'
POST
/api/Common/GetQuickSaleTypes
Get list of quick sale types
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema OMEnumModelEncrypted — 4 fields, listed under Data models.
{
"value": "string",
"name": "string",
"moduleID": "string",
"itemImagePath": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_QST_001",
"name": "Cash Sale",
"value": 1
},
{
"id": "ENC_QST_002",
"name": "Credit Sale",
"value": 2
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/GetQuickSaleTypes" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"value": "string",
"name": "string",
"moduleID": "string",
"itemImagePath": "string"
}'
GET
/api/Common/GetStates/{countryId}
Get states by country ID
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| countryId | path | string | yes |
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_STATE_001",
"name": "Dubai",
"countryID": "ENC_COUNTRY_001"
},
{
"id": "ENC_STATE_002",
"name": "Abu Dhabi",
"countryID": "ENC_COUNTRY_001"
},
{
"id": "ENC_STATE_003",
"name": "Sharjah",
"countryID": "ENC_COUNTRY_001"
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Common/GetStates/string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Common/GetSubCategoriesByCategory
Get sub-categories by category ID
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema EncryptedCategoryIdRequest — 1 field, listed under Data models.
{
"categoryID": "string"
}
Responses
- 200OK
Example response
200 Success response
[
{
"id": "ENC_SCAT_001",
"name": "Full Rim",
"code": "FR",
"categoryID": "ENC_CAT_001"
},
{
"id": "ENC_SCAT_002",
"name": "Half Rim",
"code": "HR",
"categoryID": "ENC_CAT_001"
}
]
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/GetSubCategoriesByCategory" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"categoryID": "string"
}'
GET
/api/Common/GetYears
Get available financial years
Send Authorization: Bearer <token> — see Authentication.
Responses
- 200OK
Example response
200 Success response
[
{
"yearID": 1,
"yearName": "2024-2025",
"isActive": true
},
{
"yearID": 2,
"yearName": "2025-2026",
"isActive": true
}
]
Example request
curl -X GET "https://app.opto-soft.com/global/api-v1/api/Common/GetYears" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN"
POST
/api/Common/invoice/pdf
Generate invoice PDF
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| BranchID | query | string | no | |
| CompanyID | query | string | no |
Request body — application/json
"string"
Responses
- 200OK
Response
Binary PDF file stream (application/pdf) — not a JSON payload.
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/invoice/pdf?BranchID=string&CompanyID=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '"string"'
POST
/api/Common/invoice/pdf/html
Generate invoice PDF from HTML
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| BranchID | query | string | no | |
| CompanyID | query | string | no |
Request body — application/json
"string"
Responses
- 200OK
Response
Binary PDF file stream (application/pdf) — not a JSON payload.
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/invoice/pdf/html?BranchID=string&CompanyID=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '"string"'
POST
/api/Common/receipt/pdf
Generate receipt PDF
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| receiptNo | query | string | no | |
| external | query | boolean | no | |
| BranchID | query | string | no | |
| CompanyID | query | string | no |
Request body — application/json
"string"
Responses
- 200OK
Response
Binary PDF file stream (application/pdf) — not a JSON payload.
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/receipt/pdf?receiptNo=string&external=false&BranchID=string&CompanyID=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '"string"'
POST
/api/Common/receipt/pdf/html
Generate receipt PDF from HTML
Send Authorization: Bearer <token> — see Authentication.
Parameters
| Name | In | Type | Required | Notes |
|---|---|---|---|---|
| receiptNo | query | string | no | |
| external | query | boolean | no | |
| BranchID | query | string | no | |
| CompanyID | query | string | no |
Request body — application/json
"string"
Responses
- 200OK
Response
Binary PDF file stream (application/pdf) — not a JSON payload.
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/receipt/pdf/html?receiptNo=string&external=false&BranchID=string&CompanyID=string" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '"string"'
POST
/api/Common/SearchItems
Search items with pagination
Send Authorization: Bearer <token> — see Authentication.
Request body — application/json
Schema EncryptedItemSearchRequest — 6 fields, listed under Data models.
{
"itemTypeID": "string",
"categoryID": "string",
"subCategoryID": "string",
"searchTerm": "string",
"pageNumber": 0,
"pageSize": 0
}
Responses
- 200OK
Example response
200 Success response
{
"items": [
{
"id": "ENC_ITEM_001",
"name": "Aviator Classic AV3025",
"code": "AV3025",
"price": 450,
"mrp": 500,
"stock": 12,
"itemTypeID": "ENC_IT_001",
"categoryID": "ENC_CAT_001",
"subCategoryID": "ENC_SCAT_001"
}
],
"total": 1,
"pageNumber": 1,
"pageSize": 10
}
Example request
curl -X POST "https://app.opto-soft.com/global/api-v1/api/Common/SearchItems" \
-H "Authorization: Bearer $OPTOSOFT_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"itemTypeID": "string",
"categoryID": "string",
"subCategoryID": "string",
"searchTerm": "string",
"pageNumber": 0,
"pageSize": 0
}'
Data models
54 schemasThe JSON objects exchanged with the API. Field names and types come straight from the OpenAPI specification.
AddInsuranceCompanyRequest
| Field | Type | Notes |
|---|---|---|
| insuranceCompanyName | string | nullable |
| isActive | boolean |
{
"insuranceCompanyName": "string",
"isActive": false
}
CalculateTempGrossInsuranceRequest
| Field | Type | Notes |
|---|---|---|
| sessionID | string | nullable |
| totalInsuranceAmount | number (double) |
{
"sessionID": "string",
"totalInsuranceAmount": 0
}
CancelSalesOrderRequest
| Field | Type | Notes |
|---|---|---|
| statusId | integer (int32) | |
| receiptStatusId | integer (int32) | |
| date | string (date-time) | |
| transactionDate | string (date-time) |
{
"statusId": 0,
"receiptStatusId": 0,
"date": "2026-01-31T10:15:00Z",
"transactionDate": "2026-01-31T10:15:00Z"
}
ChangeSalesOrderStatusRequest
| Field | Type | Notes |
|---|---|---|
| statusId | integer (int64) |
{
"statusId": 0
}
CompanyConditionModel
| Field | Type | Notes |
|---|---|---|
| condition | string | nullable |
{
"condition": "string"
}
ContactLensSearchRequest
| Field | Type | Notes |
|---|---|---|
| term | string | nullable |
{
"term": "string"
}
CustomerEyeInfoModel
| Field | Type | Notes |
|---|---|---|
| doctorName | string | nullable |
{
"doctorName": "string"
}
DeleteSalesOrderTempRequest
| Field | Type | Notes |
|---|---|---|
| sessionID | string | nullable |
| salesOrderTempId | string | nullable |
| pairNo | string | nullable |
{
"sessionID": "string",
"salesOrderTempId": "string",
"pairNo": "string"
}
DeleteSessionRequest
| Field | Type | Notes |
|---|---|---|
| sessionID | string | nullable |
{
"sessionID": "string"
}
EncryptedCategoryIdRequest
| Field | Type | Notes |
|---|---|---|
| categoryID | string | nullable |
{
"categoryID": "string"
}
EncryptedCustomerModel
| Field | Type | Notes |
|---|---|---|
| id | string | nullable |
| branchID | string | nullable |
| stateID | string | nullable |
| countryID | string | nullable |
| faceShapeID | string | nullable |
| genderID | string | nullable |
| companyID | string | nullable |
| customerID | string | nullable |
| yearID | string | nullable |
| title | string | nullable |
| firstName | string | nullable |
| middleName | string | nullable |
| lastName | string | nullable |
| isMarried | boolean | |
| reference | string | nullable |
| birthDate | string (date-time) | nullable |
| remarks | string | nullable |
| mobile | string | nullable |
| emailId | string | nullable |
| city | string | nullable |
| zipCode | string | nullable |
| address | string | nullable |
| houseNumber | string | nullable |
| societyName | string | nullable |
| street | string | nullable |
| area | string | nullable |
| landmark | string | nullable |
| isActive | boolean | |
| createdBy | string | nullable |
| createdDate | string (date-time) | nullable |
| createdIP | string | nullable |
| modifiedBy | string | nullable |
| modifiedDate | string (date-time) | nullable |
| modifiedIP | string | nullable |
| newCustomer | boolean | |
| isNRI | boolean | |
| marriageDate | string (date-time) | nullable |
| existingCustomerReference | string | nullable |
| phoneNO | string | nullable |
| taxNO | string | nullable |
| customerSourceID | string | nullable |
| customerCategoryID | string | nullable |
| isStoreCustomer | boolean | |
| storeID | string | nullable |
| isMember | boolean | nullable |
| membershipID | string | nullable |
| age | integer (int32) | nullable |
| bloodGroup | string | nullable |
| self | string | nullable |
| isBlackList | boolean | |
| dndForPromotionalMessage | boolean | nullable |
| dndForTransactionalMessage | boolean | nullable |
| clientConsentImage | string | nullable |
| clientConsentDisplayName | string | nullable |
| prescriptionDocument | string | nullable |
| prescriptionDocumentDisplayName | string | nullable |
| isForeigner | boolean | |
| lefT_SphericalWithSign | string | nullable |
| righT_SphericalWithSign | string | nullable |
| righT_CylinderWithSign | string | nullable |
| lefT_CylinderWithSign | string | nullable |
| lefT_AxisWithSign | string | nullable |
| righT_AxisWithSign | string | nullable |
| righT_AdditionWithSign | string | nullable |
| lefT_AdditionWithSign | string | nullable |
| leftVision | string | nullable |
| rightVision | string | nullable |
| leftvn | string | nullable |
| rightvn | string | nullable |
| rightpd | string | nullable |
| leftpd | string | nullable |
| leftbc | string | nullable |
| rightbc | string | nullable |
| leftdia | string | nullable |
| rightdia | string | nullable |
| prescriptionRemarks | string | nullable |
| salesOrderID | string | nullable |
{
"id": "string",
"branchID": "string",
"stateID": "string",
"countryID": "string",
"faceShapeID": "string",
"genderID": "string",
"companyID": "string",
"customerID": "string",
"yearID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"isMarried": false,
"reference": "string",
"birthDate": "2026-01-31T10:15:00Z",
"remarks": "string",
"mobile": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"newCustomer": false,
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"phoneNO": "string",
"taxNO": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"membershipID": "string",
"age": 0,
"bloodGroup": "string",
"self": "string",
"isBlackList": false,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeigner": false,
"lefT_SphericalWithSign": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AxisWithSign": "string",
"righT_AxisWithSign": "string",
"righT_AdditionWithSign": "string",
"lefT_AdditionWithSign": "string",
"leftVision": "string",
"rightVision": "string",
"leftvn": "string",
"rightvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string"
}
EncryptedDashboardRequestDto
| Field | Type | Notes |
|---|---|---|
| branchID | string | nullable |
| yearID | string | nullable |
| statusId | integer (int32) | |
| date | string (date-time) | nullable |
{
"branchID": "string",
"yearID": "string",
"statusId": 0,
"date": "2026-01-31T10:15:00Z"
}
EncryptedDoctorSaveModel
| Field | Type | Notes |
|---|---|---|
| id | string | nullable |
| name | string | nullable |
| mobile | string | nullable |
| string | nullable | |
| address | string | nullable |
| city | string | nullable |
| stateID | string | nullable |
| countryID | string | nullable |
| zipCode | string | nullable |
| remarks | string | nullable |
| isActive | boolean |
{
"id": "string",
"name": "string",
"mobile": "string",
"email": "string",
"address": "string",
"city": "string",
"stateID": "string",
"countryID": "string",
"zipCode": "string",
"remarks": "string",
"isActive": false
}
EncryptedInvoiceListDto
| Field | Type | Notes |
|---|---|---|
| customerName | string | nullable |
| date | string (date-time) | |
| id | string | nullable |
| plainId | integer (int64) | |
| invoiceNo | string | nullable |
| netAmount | number (double) | |
| salesOrderNo | string | nullable |
| customerMobileNo | string | nullable |
{
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"id": "string",
"plainId": 0,
"invoiceNo": "string",
"netAmount": 0,
"salesOrderNo": "string",
"customerMobileNo": "string"
}
EncryptedInvoiceListDtoPagedApiResponse
| Field | Type | Notes |
|---|---|---|
| totalRows | integer (int32) | |
| data | array of EncryptedInvoiceListDto | nullable |
{
"totalRows": 0,
"data": [
{
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"id": "string",
"plainId": 0,
"invoiceNo": "string",
"netAmount": 0,
"salesOrderNo": "string",
"customerMobileNo": "string"
}
]
}
EncryptedItemSearchRequest
| Field | Type | Notes |
|---|---|---|
| itemTypeID | string | nullable |
| categoryID | string | nullable |
| subCategoryID | string | nullable |
| searchTerm | string | nullable |
| pageNumber | integer (int32) | nullable |
| pageSize | integer (int32) | nullable |
{
"itemTypeID": "string",
"categoryID": "string",
"subCategoryID": "string",
"searchTerm": "string",
"pageNumber": 0,
"pageSize": 0
}
EncryptedItemTypeIdRequest
| Field | Type | Notes |
|---|---|---|
| itemTypeID | string | nullable |
{
"itemTypeID": "string"
}
EncryptedModuleIdRequest
| Field | Type | Notes |
|---|---|---|
| moduleID | string | nullable |
{
"moduleID": "string"
}
EncryptedOrderIdsDto
| Field | Type | Notes |
|---|---|---|
| salesOrderID | string | nullable |
| customerID | string | nullable |
{
"salesOrderID": "string",
"customerID": "string"
}
EncryptedReceiptListDto
| Field | Type | Notes |
|---|---|---|
| receiptId | string | nullable |
| receiptNo | string | nullable |
| name | string | nullable |
| salesOrderNo | string | nullable |
| invoiceNO | string | nullable |
| date | string (date-time) | |
| amount | number (double) | |
| statusName | string | nullable |
| balance | number (double) | |
| receiptTotalAmount | number (double) | |
| soTotalAmount | number (double) |
{
"receiptId": "string",
"receiptNo": "string",
"name": "string",
"salesOrderNo": "string",
"invoiceNO": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"statusName": "string",
"balance": 0,
"receiptTotalAmount": 0,
"soTotalAmount": 0
}
EncryptedReceiptPagedDto
| Field | Type | Notes |
|---|---|---|
| receiptId | string | nullable |
| receiptNo | string | nullable |
| receiptType | string | nullable |
| salesOrderNo | string | nullable |
| invoiceNO | string | nullable |
| customerName | string | nullable |
| customerMobileNo | string | nullable |
| receiptDate | string (date-time) | nullable |
| amount | number (double) | nullable |
| salesOrderAmount | number (double) | nullable |
| status | string | nullable |
| statusID | integer (int32) | nullable |
| itemCount | integer (int32) | nullable |
| totalReceipt | number (double) | nullable |
{
"receiptId": "string",
"receiptNo": "string",
"receiptType": "string",
"salesOrderNo": "string",
"invoiceNO": "string",
"customerName": "string",
"customerMobileNo": "string",
"receiptDate": "2026-01-31T10:15:00Z",
"amount": 0,
"salesOrderAmount": 0,
"status": "string",
"statusID": 0,
"itemCount": 0,
"totalReceipt": 0
}
EncryptedReceiptPagedDtoPagedResult
| Field | Type | Notes |
|---|---|---|
| items | array of EncryptedReceiptPagedDto | nullable |
| totalRecords | integer (int32) |
{
"items": [
{
"receiptId": "string",
"receiptNo": "string",
"receiptType": "string",
"salesOrderNo": "string",
"invoiceNO": "string",
"customerName": "string",
"customerMobileNo": "string",
"receiptDate": "2026-01-31T10:15:00Z",
"amount": 0,
"salesOrderAmount": 0,
"status": "string",
"statusID": 0,
"itemCount": 0,
"totalReceipt": 0
}
],
"totalRecords": 0
}
EncryptedSalesOrderAdvanceReceiptDto
| Field | Type | Notes |
|---|---|---|
| customerID | string | nullable |
| customerName | string | nullable |
| customerFirstName | string | nullable |
| customerMobileNo | string | nullable |
| custmoerEmail | string | nullable |
| balance | number (double) | |
| receiptTotalAmount | number (double) | |
| soTotalAmount | number (double) | |
| soTotalDiscountAmount | number (double) | |
| salesOrderID | string | nullable |
| statusID | integer (int32) | |
| membershipID | string | nullable |
{
"customerID": "string",
"customerName": "string",
"customerFirstName": "string",
"customerMobileNo": "string",
"custmoerEmail": "string",
"balance": 0,
"receiptTotalAmount": 0,
"soTotalAmount": 0,
"soTotalDiscountAmount": 0,
"salesOrderID": "string",
"statusID": 0,
"membershipID": "string"
}
EncryptedSalesOrderDropdownDto
| Field | Type | Notes |
|---|---|---|
| salesOrderID | string | nullable |
| salesOrderNO | string | nullable |
| soNetAmount | number (double) | |
| receiptTotal | number (double) | |
| balanceAmount | number (double) |
{
"salesOrderID": "string",
"salesOrderNO": "string",
"soNetAmount": 0,
"receiptTotal": 0,
"balanceAmount": 0
}
EncryptedSalesOrderPagedListDto
| Field | Type | Notes |
|---|---|---|
| id | string | nullable |
| customerName | string | nullable |
| customerMobileNo | string | nullable |
| branchName | string | nullable |
| salesOrderNo | string | nullable |
| date | string (date-time) | nullable |
| acceptedBy | string | nullable |
| deliveryModeName | string | nullable |
| deliveryDateTime | string | nullable |
| netAmount | number (double) | |
| statusID | integer (int32) | |
| status | string | nullable |
| itemCount | integer (int32) | |
| totalReceipt | number (double) | |
| totalDiscount | number (double) |
{
"id": "string",
"customerName": "string",
"customerMobileNo": "string",
"branchName": "string",
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"acceptedBy": "string",
"deliveryModeName": "string",
"deliveryDateTime": "string",
"netAmount": 0,
"statusID": 0,
"status": "string",
"itemCount": 0,
"totalReceipt": 0,
"totalDiscount": 0
}
EncryptedSalesOrderPagedListDtoPagedResponse
| Field | Type | Notes |
|---|---|---|
| data | array of EncryptedSalesOrderPagedListDto | nullable |
| totalRows | integer (int32) |
{
"data": [
{
"id": "string",
"customerName": "string",
"customerMobileNo": "string",
"branchName": "string",
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"acceptedBy": "string",
"deliveryModeName": "string",
"deliveryDateTime": "string",
"netAmount": 0,
"statusID": 0,
"status": "string",
"itemCount": 0,
"totalReceipt": 0,
"totalDiscount": 0
}
],
"totalRows": 0
}
GetSalesOrderTempRequest
| Field | Type | Notes |
|---|---|---|
| sessionId | string | nullable |
| jobCharges | number (double) | |
| shippingCharges | number (double) | |
| otherCharges | number (double) | |
| serviceTax | number (double) |
{
"sessionId": "string",
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"serviceTax": 0
}
Invoice_TempModel
| Field | Type | Notes |
|---|---|---|
| id | string | nullable |
| invoiceTempID | string | nullable |
| invoiceDetailID | string | nullable |
| salesOrderDetailID | string | nullable |
| itemID | string | nullable |
| title | string | nullable |
| name | string | nullable |
| code | string | nullable |
| hsnCode | string | nullable |
| sessionID | string | nullable |
| description | string | nullable |
| qty | number (double) | nullable |
| price | number (double) | nullable |
| totalPrice | number (double) | nullable |
| discountRate | number (double) | nullable |
| discountAmount | number (double) | nullable |
| taxableAmount | number (double) | nullable |
| sgstRate | number (double) | nullable |
| sgstAmount | number (double) | nullable |
| cgstRate | number (double) | nullable |
| cgstAmount | number (double) | nullable |
| igstRate | number (double) | nullable |
| igstAmount | number (double) | nullable |
| totalAmount | number (double) | nullable |
| mrp | number (double) | nullable |
| totalMRP | number (double) | nullable |
| isCompositionScheme | boolean | |
| isSalesPriceIncludeTax | boolean | |
| isCustomerStateSameAsCompanyState | boolean | |
| isCustomerStateNOTSameAsCompanyState | boolean | |
| inventoryID | string | nullable |
| batchNo | string | nullable |
| expiredDate | string (date-time) | nullable |
| totalQuantity | number (double) | nullable |
| totalDiscount | number (double) | nullable |
| totalTaxableAmount | number (double) | nullable |
| grandTotal | number (double) | nullable |
| totalSGST | number (double) | nullable |
| totalCGST | number (double) | nullable |
| totalIGST | number (double) | nullable |
| totalSavings | number (double) | nullable |
| jobCharges | number (double) | nullable |
| serviceTax | number (double) | nullable |
| shippingCharges | number (double) | nullable |
| otherCharges | number (double) | nullable |
| rounding | number (double) | nullable |
| netAmount | number (double) | nullable |
| itemName | string | nullable |
| cptCode | string | nullable |
| cpt | string | nullable |
| estimateInsuranceAllowance | number (double) | nullable |
| estimatePatientResponsibility | number (double) | nullable |
| taxRate | number (double) | nullable |
| taxAmount | number (double) | nullable |
| tax | string | nullable |
| pairNo | string | nullable |
| spectacleLensType | string | nullable |
| spherical | string | nullable |
| cylinder | string | nullable |
| axis | string | nullable |
| addition | string | nullable |
| pd | string | nullable |
| vn | string | nullable |
| vision | string | nullable |
| near | string | nullable |
| isOrderd | string | nullable |
| lensFittingHeight | string | nullable |
| lensTotalHeight | string | nullable |
| baseCurve | string | nullable |
| diameter | string | nullable |
| k1 | string | nullable |
| k2 | string | nullable |
| typeID | string | nullable |
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
OMAppCustomerData
| Field | Type | Notes |
|---|---|---|
| companyID | integer (int64) | |
| branchID | integer (int64) | |
| yearID | integer (int64) | nullable |
| customerID | string | nullable |
| id | string | nullable |
| firstName | string | nullable |
| lastName | string | nullable |
| mobile | string | nullable |
| string | nullable | |
| birthDate | string | nullable |
| genderID | string | nullable |
| houseNO | string | nullable |
| societyName | string | nullable |
| street | string | nullable |
| area | string | nullable |
| city | string | nullable |
| sourceID | string | nullable |
| doctorID | string | nullable |
| presripionTypeID | string | nullable |
| visitingDate | string | nullable |
| prescriptionList | array of OMPrescriptionRequestModel | nullable |
| prescriptionRemarks | string | nullable |
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"id": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"email": "string",
"birthDate": "string",
"genderID": "string",
"houseNO": "string",
"societyName": "string",
"street": "string",
"area": "string",
"city": "string",
"sourceID": "string",
"doctorID": "string",
"presripionTypeID": "string",
"visitingDate": "string",
"prescriptionList": [
{
"lensTypeID": "string",
"sph": "string",
"cyl": "string",
"axis": "string",
"add": "string",
"va": "string",
"vn": "string",
"pd": "string",
"bc": "string",
"dia": "string",
"fh": "string",
"th": "string"
}
],
"prescriptionRemarks": "string"
}
OMAppEyeInfoModel
| Field | Type | Notes |
|---|---|---|
| customerEyeInfoID | string | nullable |
{
"customerEyeInfoID": "string"
}
OMAutoItemTypeSectionModel
| Field | Type | Notes |
|---|---|---|
| id | integer (int64) | nullable |
| itemTypeID | integer (int64) | nullable |
| moduleID | integer (int64) | nullable |
| isAutosection | boolean | |
| sectionName | string | nullable |
{
"id": 0,
"itemTypeID": 0,
"moduleID": 0,
"isAutosection": false,
"sectionName": "string"
}
OMCustomerModel
| Field | Type | Notes |
|---|---|---|
| customerId | string | nullable |
| id | integer (int64) | |
| branchId | string | nullable |
| customerSourceID | string | nullable |
| customerCategoryID | string | nullable |
| title | string | nullable |
| firstName | string | required |
| middleName | string | nullable |
| lastName | string | required |
| genderID | string | nullable |
| isMarried | boolean | |
| reference | string | nullable |
| isActive | boolean | |
| birthDate | string (date-time) | nullable |
| stringBirthDate | string | nullable |
| isNRI | boolean | |
| marriageDate | string (date-time) | nullable |
| existingCustomerReference | string | nullable |
| remarks | string | nullable |
| mobile | string | nullable |
| foreignerMobile | string | nullable |
| phoneNO | string | nullable |
| emailId | string | nullable |
| city | string | nullable |
| zipCode | string | nullable |
| isForeigner | boolean | |
| address | string | nullable |
| houseNumber | string | nullable |
| societyName | string | nullable |
| street | string | nullable |
| area | string | nullable |
| landmark | string | nullable |
| stateId | integer (int64) | nullable |
| countryId | string | nullable |
| faceShapeID | string | nullable |
| createdBy | string | nullable |
| createdIP | string | nullable |
| modifiedDate | string (date-time) | nullable |
| modifiedIP | string | nullable |
| createdDate | string (date-time) | nullable |
| newCustomer | boolean | |
| createdDateString | string | nullable |
| marriageDateString | string | nullable |
| birthDateString | string | nullable |
| encryptCustomerID | string | nullable |
| branchName | string | nullable |
| isNewRecord | boolean | |
| gender | string | nullable |
| doctor | string | nullable |
| taxNO | string | nullable |
| visitingDate | string (date-time) | nullable |
| isBlackList | boolean | |
| r_SPH | number (double) | |
| r_CYL | number (double) | |
| r_AXIS | number (double) | |
| r_ADD | number (double) | |
| l_SPH | number (double) | |
| l_CYL | number (double) | |
| l_AXIS | number (double) | |
| l_ADD | number (double) | |
| doctorID | string | nullable |
| righT_SphericalWithSign | string | nullable |
| righT_CylinderWithSign | string | nullable |
| righT_AdditionWithSign | string | nullable |
| righT_AxisWithSign | string | nullable |
| righT_FixFlotedText | string | nullable |
| lefT_SphericalWithSign | string | nullable |
| lefT_CylinderWithSign | string | nullable |
| lefT_AdditionWithSign | string | nullable |
| lefT_AxisWithSign | string | nullable |
| lefT_FixFlotedText | string | nullable |
| rightVision | string | nullable |
| leftVision | string | nullable |
| rightvn | string | nullable |
| leftvn | string | nullable |
| rightpd | string | nullable |
| leftpd | string | nullable |
| leftbc | string | nullable |
| rightbc | string | nullable |
| leftdia | string | nullable |
| rightdia | string | nullable |
| prescriptionRemarks | string | nullable |
| salesOrderID | string | nullable |
| isStoreCustomer | boolean | |
| storeID | string | nullable |
| isMember | boolean | nullable |
| age | integer (int32) | nullable |
| bloodGroup | string | nullable |
| self | string | nullable |
| membershipID | integer (int64) | nullable |
| dndForPromotionalMessage | boolean | nullable |
| dndForTransactionalMessage | boolean | nullable |
| clientConsentImage | string | nullable |
| clientConsentDisplayName | string | nullable |
| prescriptionDocument | string | nullable |
| prescriptionDocumentDisplayName | string | nullable |
| isForeignerFlag | boolean | nullable |
{
"customerId": "string",
"id": 0,
"branchId": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"genderID": "string",
"isMarried": false,
"reference": "string",
"isActive": false,
"birthDate": "2026-01-31T10:15:00Z",
"stringBirthDate": "string",
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"remarks": "string",
"mobile": "string",
"foreignerMobile": "string",
"phoneNO": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"isForeigner": false,
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"stateId": 0,
"countryId": "string",
"faceShapeID": "string",
"createdBy": "string",
"createdIP": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"createdDate": "2026-01-31T10:15:00Z",
"newCustomer": false,
"createdDateString": "string",
"marriageDateString": "string",
"birthDateString": "string",
"encryptCustomerID": "string",
"branchName": "string",
"isNewRecord": false,
"gender": "string",
"doctor": "string",
"taxNO": "string",
"visitingDate": "2026-01-31T10:15:00Z",
"isBlackList": false,
"r_SPH": 0,
"r_CYL": 0,
"r_AXIS": 0,
"r_ADD": 0,
"l_SPH": 0,
"l_CYL": 0,
"l_AXIS": 0,
"l_ADD": 0,
"doctorID": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"righT_AdditionWithSign": "string",
"righT_AxisWithSign": "string",
"righT_FixFlotedText": "string",
"lefT_SphericalWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AdditionWithSign": "string",
"lefT_AxisWithSign": "string",
"lefT_FixFlotedText": "string",
"rightVision": "string",
"leftVision": "string",
"rightvn": "string",
"leftvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"age": 0,
"bloodGroup": "string",
"self": "string",
"membershipID": 0,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeignerFlag": false
}
OMEyecheckupRecallModel
| Field | Type | Notes |
|---|---|---|
| id | integer (int64) | |
| customerID | integer (int64) | nullable |
| customerName | string | nullable |
| date | string (date-time) | nullable |
| dateString | string | nullable |
| remarks | string | nullable |
| group | string | nullable |
| recallList | array of OMEyecheckupRecallModel | nullable |
| notifiedRecallList | array of OMEyecheckupRecallModel | nullable |
{
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{}
],
"notifiedRecallList": [
{}
]
}
],
"notifiedRecallList": [
{
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{}
],
"notifiedRecallList": [
{}
]
}
]
}
OMFastWizardModel
| Field | Type | Notes |
|---|---|---|
| customerModel | OMCustomerModel | |
| salesorderModel | OMSalesOrderModel | |
| receiptModel | ReceiptWithouInvoiceModel | |
| eyeInfoModel | CustomerEyeInfoModel | |
| eyecheckupRecallModel | OMEyecheckupRecallModel | |
| purchaseOrderModel | OMPurchaseOrderModel | |
| autoItemTypeSectionList | array of OMAutoItemTypeSectionModel | nullable |
| isLensAdded | boolean | |
| orderDate | string (date-time) | |
| expectedDate | string (date-time) | |
| visitorIP | string | nullable |
| branchCity | string | nullable |
| isSpectacleLensInOrder | boolean | nullable |
| sessionID | string | nullable |
| supplierID | string | nullable |
| fitterID | string | nullable |
| isExternal | boolean | |
| userId | integer (int64) | |
| priorityID | string | nullable |
| showLabOrderInQuickSale | boolean | |
| showQuickSaleAddFrameSection | boolean | nullable |
| showQuickSaleAddSunGlassSection | boolean | nullable |
| showQuickSaleAddLensSection | boolean | nullable |
| showQuickSaleAddContactLensSection | boolean | nullable |
| showQuickSaleAddCLCPSection | boolean | nullable |
| showQuickSaleAddAccessoriesSection | boolean | nullable |
| showQuickSaleAddPerfumeSection | boolean | nullable |
| showQuickSaleAddDeodorantSection | boolean | nullable |
| showQuickSaleAddAttarSection | boolean | nullable |
| showQuickSaleAddFreshenerSection | boolean | nullable |
| showQuickSaleAddLeatherAccessoriesSection | boolean | nullable |
| showQuickSaleAddCosmeticsSection | boolean | nullable |
| showQuickSaleAddGiftSetsSection | boolean | nullable |
| showQuickSaleAddMenAccessoriesSection | boolean | nullable |
| showQuickSaleAddWomenAccessoriesSection | boolean | nullable |
| showQuickSaleAddWatchesSection | boolean | nullable |
| showQuickSaleAddImitationJewellerySection | boolean | nullable |
| showQuickSaleAddDressMaterialSection | boolean | nullable |
| showQuickSaleAddKurtiSection | boolean | nullable |
| showQuickSaleAddKurtiPairSection | boolean | nullable |
| showQuickSaleAddChaniyaCholiSection | boolean | nullable |
| showQuickSaleAddLegginsSection | boolean | nullable |
| showQuickSaleAddKurtaPentSection | boolean | nullable |
| showQuickSaleAddPlazzoSection | boolean | nullable |
| showQuickSaleAddOnePieceSection | boolean | nullable |
| showQuickSaleAddDupattaSection | boolean | nullable |
| showQuickSaleAddWesternSection | boolean | nullable |
| allowMannualBarcode | boolean | nullable |
| defaultZeroReceiptAmountForQuickSale | boolean | nullable |
| allowZeroAmountReceiptInQuickSale | boolean | nullable |
| isRemoveValidationFromCustomer | boolean | nullable |
| modelNo | string | nullable |
| colorId | string | nullable |
| brandId | string | nullable |
| shapeId | string | nullable |
| sizeId | string | nullable |
| materialId | string | nullable |
| subCategoryId | string | nullable |
| price | number (double) | nullable |
| cost | number (double) | nullable |
| mrp | number (double) | nullable |
| taxID | string | nullable |
| code | string | nullable |
| index | string | nullable |
| productID | string | nullable |
| lenseStyleID | string | nullable |
| lensCoatID | string | nullable |
| lensColorId | string | nullable |
| spectacleLensTypeID | string | nullable |
| unitTypeId | string | nullable |
| itemTypeID | string | nullable |
| itemTypeCode | string | nullable |
| frameId | string | nullable |
| priceRangeID | string | nullable |
| autoTitle | boolean | |
| autoFrameTitle | boolean | |
| autoSunGlassTitle | boolean | |
| autoSpectacleLensTitle | boolean | |
| autoContactLensTitle | boolean | |
| autoContactLensCareProductTitle | boolean | |
| autoPerfumeTitle | boolean | |
| autoDeodorantTitle | boolean | |
| autoAttarTitle | boolean | |
| autoFreshenerTitle | boolean | |
| autoLeatherAccessoriesTitle | boolean | |
| autoCosmeticsTitle | boolean | |
| autoGiftSetsTitle | boolean | |
| autoMenAccessoriesTitle | boolean | |
| autoWomenAccessoriesTitle | boolean | |
| autoWatchesTitle | boolean | |
| autoImitationJewelleryTitle | boolean | |
| autoReadymadeGarmentsTitle | boolean | |
| branchId | integer (int64) | |
| yearId | string | nullable |
{
"customerModel": {
"customerId": "string",
"id": 0,
"branchId": "string",
"customerSourceID": "string",
"customerCategoryID": "string",
"title": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"genderID": "string",
"isMarried": false,
"reference": "string",
"isActive": false,
"birthDate": "2026-01-31T10:15:00Z",
"stringBirthDate": "string",
"isNRI": false,
"marriageDate": "2026-01-31T10:15:00Z",
"existingCustomerReference": "string",
"remarks": "string",
"mobile": "string",
"foreignerMobile": "string",
"phoneNO": "string",
"emailId": "string",
"city": "string",
"zipCode": "string",
"isForeigner": false,
"address": "string",
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"stateId": 0,
"countryId": "string",
"faceShapeID": "string",
"createdBy": "string",
"createdIP": "string",
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"createdDate": "2026-01-31T10:15:00Z",
"newCustomer": false,
"createdDateString": "string",
"marriageDateString": "string",
"birthDateString": "string",
"encryptCustomerID": "string",
"branchName": "string",
"isNewRecord": false,
"gender": "string",
"doctor": "string",
"taxNO": "string",
"visitingDate": "2026-01-31T10:15:00Z",
"isBlackList": false,
"r_SPH": 0,
"r_CYL": 0,
"r_AXIS": 0,
"r_ADD": 0,
"l_SPH": 0,
"l_CYL": 0,
"l_AXIS": 0,
"l_ADD": 0,
"doctorID": "string",
"righT_SphericalWithSign": "string",
"righT_CylinderWithSign": "string",
"righT_AdditionWithSign": "string",
"righT_AxisWithSign": "string",
"righT_FixFlotedText": "string",
"lefT_SphericalWithSign": "string",
"lefT_CylinderWithSign": "string",
"lefT_AdditionWithSign": "string",
"lefT_AxisWithSign": "string",
"lefT_FixFlotedText": "string",
"rightVision": "string",
"leftVision": "string",
"rightvn": "string",
"leftvn": "string",
"rightpd": "string",
"leftpd": "string",
"leftbc": "string",
"rightbc": "string",
"leftdia": "string",
"rightdia": "string",
"prescriptionRemarks": "string",
"salesOrderID": "string",
"isStoreCustomer": false,
"storeID": "string",
"isMember": false,
"age": 0,
"bloodGroup": "string",
"self": "string",
"membershipID": 0,
"dndForPromotionalMessage": false,
"dndForTransactionalMessage": false,
"clientConsentImage": "string",
"clientConsentDisplayName": "string",
"prescriptionDocument": "string",
"prescriptionDocumentDisplayName": "string",
"isForeignerFlag": false
},
"salesorderModel": {
"dateString": "string",
"sessionId": "string",
"companyId": "string",
"branchId": "string",
"schemeID": "string",
"salesRepresentativeID": "string",
"customerId": "string",
"cancellationReasonID": "string",
"cancellReason": "string",
"yearId": "string",
"gstNo": "string",
"salesOrderId": 0,
"isForeigner": false,
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"taxTypeId": 0,
"transport": "string",
"grandTotal": 0,
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalTax": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalMRP": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"netAmount": 0,
"remarks": "string",
"acceptedBy": "string",
"statusID": "string",
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"checkSalesOrderCustomer": "string",
"salesPriceIncludesTax": false,
"isCompositionScheme": false,
"showMRP": false,
"barcodeScan": "string",
"goToReceipt": false,
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTimeString": "string",
"deliveryTime": "string",
"rounding": 0,
"itemTypeID": "string",
"searchItem": "string",
"giftVoucherID": "string",
"giftVoucherDiscount": 0,
"giftVoucherNo": "string",
"taxTypeName": "string",
"srName": "string",
"customerTitle": "string",
"firstName": "string",
"lastName": "string",
"customerName": "string",
"customerMobile": "string",
"customerEmailID": "string",
"rightLensFittingHeight": 0,
"rightLensTotalHeight": 0,
"leftLensFittingHeight": 0,
"leftLensTotalHeight": 0,
"typeID": "string",
"getSalesOrderDetailList": [
{}
],
"salesOrderDetailList": [
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"allowUserToChangePrice": false,
"allowUserToChangeDiscount": false,
"maxUserDiscountPercentage": 0,
"allowUerToGenerateFutureDateOrder": false,
"allowUserToGeneratePastDateOrder": false,
"allowStoreManagerToGenerateFutureDateOrder": false,
"allowStoreManagerToGeneratePastDateOrder": false,
"userInRole": false,
"userInRoleStoreManager": false,
"allowWarehouseManagerToCancelOrder": false,
"allowCompanyManagerToCancelOrder": false,
"storeSalesOrderID": "string",
"isFranchise": false,
"referencePurchaseOrderID": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"visitingDate": "2026-01-31T10:15:00Z",
"visitingDateString": "string",
"isPopup": "string",
"deliveryModeID": 0,
"deliveryModeName": "string",
"isFranchise_Branch": false,
"deliveryDateDays": "string",
"dndForTransactionalMessage": false,
"dndForPromotionalMessage": false,
"isImportedOrder": false,
"isGiftVoucherApplied": false,
"branchLogo": "string",
"branchName": "string",
"companyName": "string",
"enableInsurance": false,
"customerInsuranceID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"insuranceCompanyID": 0,
"policyNo": "string",
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"totalNISAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"totalVoucherAmount": 0
},
"receiptModel": {
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
},
"eyeInfoModel": {
"doctorName": "string"
},
"eyecheckupRecallModel": {
"id": 0,
"customerID": 0,
"customerName": "string",
"date": "2026-01-31T10:15:00Z",
"dateString": "string",
"remarks": "string",
"group": "string",
"recallList": [
{}
],
"notifiedRecallList": [
{}
]
},
"purchaseOrderModel": {
"purchaseOrderId": 0,
"statusId": 0,
"priorityId": 0,
"branchId": 0,
"yearId": 0,
"sessionId": "string",
"subCategoryId": 0,
"fitterID": 0,
"condition": "string",
"priority": "string",
"taxType": "string",
"supplier": "string",
"supplierInvoiceNo": "string",
"purchaseOrderNumber": "string",
"orderDate": "2026-01-31T10:15:00Z",
"orderDateString": "string",
"receiveDate": "2026-01-31T10:15:00Z",
"receiveDateString": "string",
"transport": "string",
"supplierId": 0,
"taxTypeId": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"netAmount": 0,
"serviceTax": 0,
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"status": "string",
"remarks": "string",
"createdBy": 0,
"createdIP": "string",
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"getOrderList": [
{
"id": 0,
"itemId": 0,
"sessionId": "string",
"title": "string",
"code": "string",
"status": "string",
"salesPrice": 0,
"purchaseCost": 0,
"qty": 0,
"cost": 0,
"totalCost": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"serviceTax": 0,
"jobCharges": 0,
"otherCharges": 0,
"shippingCharges": 0,
"rounding": 0,
"netAmount": 0,
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
],
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"title": "string",
"itemTypeID": 0,
"isDirectInward": false,
"modelNo": "string",
"colorId": 0,
"brandId": 0,
"shapeId": 0,
"sizeId": 0,
"materialId": 0,
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": 0,
"code": "string",
"index": "string",
"productID": 0,
"lenseStyleID": 0,
"lensCoatID": 0,
"lensColorId": 0,
"spectacleLensTypeID": 0,
"unitTypeId": 0,
"frameId": 0,
"itemTypeCode": "string",
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoTitle": false,
"autoTitleClone": false,
"autoPRMTitle": false,
"prmCode": "string",
"deoCode": "string",
"autoDEOTitle": false,
"allowMannualBarcode": false,
"isFranchise": false,
"priceRangeID": 0,
"branchLogo": "string",
"branchName": "string",
"companyName": "string"
},
"autoItemTypeSectionList": [
{
"id": 0,
"itemTypeID": 0,
"moduleID": 0,
"isAutosection": false,
"sectionName": "string"
}
],
"isLensAdded": false,
"orderDate": "2026-01-31T10:15:00Z",
"expectedDate": "2026-01-31T10:15:00Z",
"visitorIP": "string",
"branchCity": "string",
"isSpectacleLensInOrder": false,
"sessionID": "string",
"supplierID": "string",
"fitterID": "string",
"isExternal": false,
"userId": 0,
"priorityID": "string",
"showLabOrderInQuickSale": false,
"showQuickSaleAddFrameSection": false,
"showQuickSaleAddSunGlassSection": false,
"showQuickSaleAddLensSection": false,
"showQuickSaleAddContactLensSection": false,
"showQuickSaleAddCLCPSection": false,
"showQuickSaleAddAccessoriesSection": false,
"showQuickSaleAddPerfumeSection": false,
"showQuickSaleAddDeodorantSection": false,
"showQuickSaleAddAttarSection": false,
"showQuickSaleAddFreshenerSection": false,
"showQuickSaleAddLeatherAccessoriesSection": false,
"showQuickSaleAddCosmeticsSection": false,
"showQuickSaleAddGiftSetsSection": false,
"showQuickSaleAddMenAccessoriesSection": false,
"showQuickSaleAddWomenAccessoriesSection": false,
"showQuickSaleAddWatchesSection": false,
"showQuickSaleAddImitationJewellerySection": false,
"showQuickSaleAddDressMaterialSection": false,
"showQuickSaleAddKurtiSection": false,
"showQuickSaleAddKurtiPairSection": false,
"showQuickSaleAddChaniyaCholiSection": false,
"showQuickSaleAddLegginsSection": false,
"showQuickSaleAddKurtaPentSection": false,
"showQuickSaleAddPlazzoSection": false,
"showQuickSaleAddOnePieceSection": false,
"showQuickSaleAddDupattaSection": false,
"showQuickSaleAddWesternSection": false,
"allowMannualBarcode": false,
"defaultZeroReceiptAmountForQuickSale": false,
"allowZeroAmountReceiptInQuickSale": false,
"isRemoveValidationFromCustomer": false,
"modelNo": "string",
"colorId": "string",
"brandId": "string",
"shapeId": "string",
"sizeId": "string",
"materialId": "string",
"subCategoryId": "string",
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": "string",
"code": "string",
"index": "string",
"productID": "string",
"lenseStyleID": "string",
"lensCoatID": "string",
"lensColorId": "string",
"spectacleLensTypeID": "string",
"unitTypeId": "string",
"itemTypeID": "string",
"itemTypeCode": "string",
"frameId": "string",
"priceRangeID": "string",
"autoTitle": false,
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoPerfumeTitle": false,
"autoDeodorantTitle": false,
"autoAttarTitle": false,
"autoFreshenerTitle": false,
"autoLeatherAccessoriesTitle": false,
"autoCosmeticsTitle": false,
"autoGiftSetsTitle": false,
"autoMenAccessoriesTitle": false,
"autoWomenAccessoriesTitle": false,
"autoWatchesTitle": false,
"autoImitationJewelleryTitle": false,
"autoReadymadeGarmentsTitle": false,
"branchId": 0,
"yearId": "string"
}
OMGetSalesOrderDetailData_Result
| Field | Type | Notes |
|---|---|---|
| id | string | nullable |
| itemId | string | nullable |
| sessionId | string | nullable |
| name | string | nullable |
| code | string | nullable |
| qty | number (double) | nullable |
| mrp | number (double) | nullable |
| totalMRP | number (double) | nullable |
| price | number (double) | |
| totalPrice | number (double) | nullable |
| discountRate | number (double) | nullable |
| discountAmount | number (double) | nullable |
| taxableAmount | number (double) | nullable |
| sgstRate | number (double) | nullable |
| sgstAmount | number (double) | nullable |
| cgstRate | number (double) | nullable |
| cgstAmount | number (double) | nullable |
| igstRate | number (double) | nullable |
| igstAmount | number (double) | nullable |
| totalAmount | number (double) | nullable |
| pairNo | string | nullable |
| spectacleLensType | string | nullable |
| spherical | string | nullable |
| cylinder | string | nullable |
| axis | string | nullable |
| addition | string | nullable |
| pd | string | nullable |
| vn | string | nullable |
| vision | string | nullable |
| near | string | nullable |
| isOrdered | boolean | nullable |
| lensFittingHeight | number (double) | nullable |
| lensTotalHeight | number (double) | nullable |
| basecurve | string | nullable |
| diameter | string | nullable |
| k1 | string | nullable |
| k2 | string | nullable |
| typeID | string | nullable |
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
OMLoginRequest
| Field | Type | Notes |
|---|---|---|
| userName | string | nullable |
| password | string | nullable |
{
"userName": "string",
"password": "string"
}
OMPrescriptionRequestModel
| Field | Type | Notes |
|---|---|---|
| lensTypeID | string | nullable |
| sph | string | nullable |
| cyl | string | nullable |
| axis | string | nullable |
| add | string | nullable |
| va | string | nullable |
| vn | string | nullable |
| pd | string | nullable |
| bc | string | nullable |
| dia | string | nullable |
| fh | string | nullable |
| th | string | nullable |
{
"lensTypeID": "string",
"sph": "string",
"cyl": "string",
"axis": "string",
"add": "string",
"va": "string",
"vn": "string",
"pd": "string",
"bc": "string",
"dia": "string",
"fh": "string",
"th": "string"
}
OMPurchaseOrderModel
| Field | Type | Notes |
|---|---|---|
| purchaseOrderId | integer (int64) | nullable |
| statusId | integer (int32) | nullable |
| priorityId | integer (int32) | nullable |
| branchId | integer (int64) | nullable |
| yearId | integer (int64) | nullable |
| sessionId | string | nullable |
| subCategoryId | integer (int64) | nullable |
| fitterID | integer (int64) | nullable |
| condition | string | nullable |
| priority | string | nullable |
| taxType | string | nullable |
| supplier | string | nullable |
| supplierInvoiceNo | string | nullable |
| purchaseOrderNumber | string | nullable |
| orderDate | string (date-time) | nullable |
| orderDateString | string | nullable |
| receiveDate | string (date-time) | nullable |
| receiveDateString | string | nullable |
| transport | string | nullable |
| supplierId | integer (int64) | required |
| taxTypeId | integer (int64) | nullable |
| totalQuantity | number (double) | nullable |
| grandTotal | number (double) | nullable |
| totalDiscount | number (double) | nullable |
| totalTaxableAmount | number (double) | nullable |
| totalSGST | number (double) | nullable |
| totalCGST | number (double) | nullable |
| totalIGST | number (double) | nullable |
| rounding | number (double) | nullable |
| netAmount | number (double) | nullable |
| serviceTax | number (double) | nullable |
| jobCharges | number (double) | nullable |
| shippingCharges | number (double) | nullable |
| otherCharges | number (double) | nullable |
| status | string | nullable |
| remarks | string | nullable |
| createdBy | integer (int64) | nullable |
| createdIP | string | nullable |
| isCompositionScheme | boolean | |
| isReverseTaxCalculation | boolean | |
| getOrderList | array of OMPurchaseOrderTempModel | nullable |
| isSupplierStateSameAsCompanyState | boolean | |
| isSupplierStateNOTSameAsCompanyState | boolean | |
| title | string | nullable |
| itemTypeID | integer (int64) | nullable |
| isDirectInward | boolean | |
| modelNo | string | nullable |
| colorId | integer (int64) | nullable |
| brandId | integer (int64) | nullable |
| shapeId | integer (int64) | nullable |
| sizeId | integer (int64) | nullable |
| materialId | integer (int64) | nullable |
| price | number (double) | nullable |
| cost | number (double) | nullable |
| mrp | number (double) | nullable |
| taxID | integer (int64) | nullable |
| code | string | nullable |
| index | string | nullable |
| productID | integer (int64) | nullable |
| lenseStyleID | integer (int64) | nullable |
| lensCoatID | integer (int64) | nullable |
| lensColorId | integer (int64) | nullable |
| spectacleLensTypeID | integer (int64) | nullable |
| unitTypeId | integer (int64) | nullable |
| frameId | integer (int64) | nullable |
| itemTypeCode | string | nullable |
| autoFrameTitle | boolean | |
| autoSunGlassTitle | boolean | |
| autoSpectacleLensTitle | boolean | |
| autoContactLensTitle | boolean | |
| autoContactLensCareProductTitle | boolean | |
| autoTitle | boolean | |
| autoTitleClone | boolean | |
| autoPRMTitle | boolean | |
| prmCode | string | nullable |
| deoCode | string | nullable |
| autoDEOTitle | boolean | |
| allowMannualBarcode | boolean | |
| isFranchise | boolean | |
| priceRangeID | integer (int64) | nullable |
| branchLogo | string | nullable |
| branchName | string | nullable |
| companyName | string | nullable |
{
"purchaseOrderId": 0,
"statusId": 0,
"priorityId": 0,
"branchId": 0,
"yearId": 0,
"sessionId": "string",
"subCategoryId": 0,
"fitterID": 0,
"condition": "string",
"priority": "string",
"taxType": "string",
"supplier": "string",
"supplierInvoiceNo": "string",
"purchaseOrderNumber": "string",
"orderDate": "2026-01-31T10:15:00Z",
"orderDateString": "string",
"receiveDate": "2026-01-31T10:15:00Z",
"receiveDateString": "string",
"transport": "string",
"supplierId": 0,
"taxTypeId": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"netAmount": 0,
"serviceTax": 0,
"jobCharges": 0,
"shippingCharges": 0,
"otherCharges": 0,
"status": "string",
"remarks": "string",
"createdBy": 0,
"createdIP": "string",
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"getOrderList": [
{
"id": 0,
"itemId": 0,
"sessionId": "string",
"title": "string",
"code": "string",
"status": "string",
"salesPrice": 0,
"purchaseCost": 0,
"qty": 0,
"cost": 0,
"totalCost": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"serviceTax": 0,
"jobCharges": 0,
"otherCharges": 0,
"shippingCharges": 0,
"rounding": 0,
"netAmount": 0,
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
],
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"title": "string",
"itemTypeID": 0,
"isDirectInward": false,
"modelNo": "string",
"colorId": 0,
"brandId": 0,
"shapeId": 0,
"sizeId": 0,
"materialId": 0,
"price": 0,
"cost": 0,
"mrp": 0,
"taxID": 0,
"code": "string",
"index": "string",
"productID": 0,
"lenseStyleID": 0,
"lensCoatID": 0,
"lensColorId": 0,
"spectacleLensTypeID": 0,
"unitTypeId": 0,
"frameId": 0,
"itemTypeCode": "string",
"autoFrameTitle": false,
"autoSunGlassTitle": false,
"autoSpectacleLensTitle": false,
"autoContactLensTitle": false,
"autoContactLensCareProductTitle": false,
"autoTitle": false,
"autoTitleClone": false,
"autoPRMTitle": false,
"prmCode": "string",
"deoCode": "string",
"autoDEOTitle": false,
"allowMannualBarcode": false,
"isFranchise": false,
"priceRangeID": 0,
"branchLogo": "string",
"branchName": "string",
"companyName": "string"
}
OMPurchaseOrderTempModel
| Field | Type | Notes |
|---|---|---|
| id | integer (int64) | |
| itemId | integer (int64) | nullable |
| sessionId | string | nullable |
| title | string | nullable |
| code | string | nullable |
| status | string | nullable |
| salesPrice | number (double) | nullable |
| purchaseCost | number (double) | nullable |
| qty | number (double) | nullable |
| cost | number (double) | nullable |
| totalCost | number (double) | nullable |
| discountRate | number (double) | nullable |
| discountAmount | number (double) | nullable |
| taxableAmount | number (double) | nullable |
| sgstRate | number (double) | nullable |
| sgstAmount | number (double) | nullable |
| cgstRate | number (double) | nullable |
| cgstAmount | number (double) | nullable |
| igstRate | number (double) | nullable |
| igstAmount | number (double) | nullable |
| totalAmount | number (double) | nullable |
| totalQuantity | number (double) | nullable |
| grandTotal | number (double) | nullable |
| totalDiscount | number (double) | nullable |
| totalTaxableAmount | number (double) | nullable |
| totalSGST | number (double) | nullable |
| totalCGST | number (double) | nullable |
| totalIGST | number (double) | nullable |
| serviceTax | number (double) | nullable |
| jobCharges | number (double) | nullable |
| otherCharges | number (double) | nullable |
| shippingCharges | number (double) | nullable |
| rounding | number (double) | nullable |
| netAmount | number (double) | nullable |
| isCompositionScheme | boolean | |
| isReverseTaxCalculation | boolean | |
| isSupplierStateSameAsCompanyState | boolean | |
| isSupplierStateNOTSameAsCompanyState | boolean | |
| batchNo | string | nullable |
| expiredDate | string (date-time) | nullable |
{
"id": 0,
"itemId": 0,
"sessionId": "string",
"title": "string",
"code": "string",
"status": "string",
"salesPrice": 0,
"purchaseCost": 0,
"qty": 0,
"cost": 0,
"totalCost": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"totalQuantity": 0,
"grandTotal": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"serviceTax": 0,
"jobCharges": 0,
"otherCharges": 0,
"shippingCharges": 0,
"rounding": 0,
"netAmount": 0,
"isCompositionScheme": false,
"isReverseTaxCalculation": false,
"isSupplierStateSameAsCompanyState": false,
"isSupplierStateNOTSameAsCompanyState": false,
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
OMReceiptTypeModel
| Field | Type | Notes |
|---|---|---|
| id | integer (int64) | |
| name | string | nullable |
| code | string | nullable |
| remarks | string | nullable |
| isActive | boolean | |
| createdBy | integer (int64) | |
| createdDate | string (date-time) | |
| createdIP | string | nullable |
| modifiedBy | integer (int64) | nullable |
| modifiedDate | string (date-time) | nullable |
| modifiedIP | string | nullable |
| allowDeposit | boolean | nullable |
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
OMRequestModel
| Field | Type | Notes |
|---|---|---|
| companyID | integer (int64) | |
| branchID | integer (int64) | |
| yearID | integer (int64) | nullable |
{
"companyID": 0,
"branchID": 0,
"yearID": 0
}
OMSalesOrderModel
| Field | Type | Notes |
|---|---|---|
| dateString | string | nullable |
| sessionId | string | nullable |
| companyId | string | nullable |
| branchId | string | nullable |
| schemeID | string | nullable |
| salesRepresentativeID | string | nullable |
| customerId | string | required |
| cancellationReasonID | string | nullable |
| cancellReason | string | nullable |
| yearId | string | nullable |
| gstNo | string | nullable |
| salesOrderId | integer (int64) | |
| isForeigner | boolean | nullable |
| salesOrderNo | string | nullable |
| date | string (date-time) | required |
| taxTypeId | integer (int64) | nullable |
| transport | string | nullable |
| grandTotal | number (double) | nullable |
| totalQuantity | number (double) | nullable |
| totalDiscount | number (double) | nullable |
| totalTaxableAmount | number (double) | nullable |
| totalTax | number (double) | nullable |
| totalSGST | number (double) | nullable |
| totalCGST | number (double) | nullable |
| totalIGST | number (double) | nullable |
| totalMRP | number (double) | nullable |
| totalSavings | number (double) | nullable |
| jobCharges | number (double) | nullable |
| serviceTax | number (double) | nullable |
| shippingCharges | number (double) | nullable |
| otherCharges | number (double) | nullable |
| netAmount | number (double) | nullable |
| remarks | string | nullable |
| acceptedBy | string | nullable |
| statusID | string | nullable |
| createdBy | string | nullable |
| createdDate | string (date-time) | nullable |
| creatorName | string | nullable |
| createdIP | string | nullable |
| checkSalesOrderCustomer | string | nullable |
| salesPriceIncludesTax | boolean | |
| isCompositionScheme | boolean | |
| showMRP | boolean | |
| barcodeScan | string | nullable |
| goToReceipt | boolean | |
| deliveryDate | string (date-time) | required |
| deliveryDateString | string | nullable |
| deliveryTimeString | string | nullable |
| deliveryTime | string (time) | nullable |
| rounding | number (double) | nullable |
| itemTypeID | string | nullable |
| searchItem | string | nullable |
| giftVoucherID | string | nullable |
| giftVoucherDiscount | number (double) | nullable |
| giftVoucherNo | string | nullable |
| taxTypeName | string | nullable |
| srName | string | nullable |
| customerTitle | string | nullable |
| firstName | string | nullable |
| lastName | string | nullable |
| customerName | string | nullable |
| customerMobile | string | nullable |
| customerEmailID | string | nullable |
| rightLensFittingHeight | number (double) | nullable |
| rightLensTotalHeight | number (double) | nullable |
| leftLensFittingHeight | number (double) | nullable |
| leftLensTotalHeight | number (double) | nullable |
| typeID | string | nullable |
| getSalesOrderDetailList | array of OMSalesOrderModel | nullable |
| salesOrderDetailList | array of OMGetSalesOrderDetailData_Result | nullable |
| allowUserToChangePrice | boolean | nullable |
| allowUserToChangeDiscount | boolean | nullable |
| maxUserDiscountPercentage | number (double) | nullable |
| allowUerToGenerateFutureDateOrder | boolean | |
| allowUserToGeneratePastDateOrder | boolean | |
| allowStoreManagerToGenerateFutureDateOrder | boolean | |
| allowStoreManagerToGeneratePastDateOrder | boolean | |
| userInRole | boolean | |
| userInRoleStoreManager | boolean | |
| allowWarehouseManagerToCancelOrder | boolean | |
| allowCompanyManagerToCancelOrder | boolean | |
| storeSalesOrderID | string | nullable |
| isFranchise | boolean | |
| referencePurchaseOrderID | string | nullable |
| isSalesPriceIncludeTax | boolean | |
| isCustomerStateSameAsCompanyState | boolean | |
| isCustomerStateNOTSameAsCompanyState | boolean | |
| visitingDate | string (date-time) | nullable |
| visitingDateString | string | nullable |
| isPopup | string | nullable |
| deliveryModeID | integer (int64) | |
| deliveryModeName | string | nullable |
| isFranchise_Branch | boolean | |
| deliveryDateDays | string | nullable |
| dndForTransactionalMessage | boolean | |
| dndForPromotionalMessage | boolean | |
| isImportedOrder | boolean | |
| isGiftVoucherApplied | boolean | |
| branchLogo | string | nullable |
| branchName | string | nullable |
| companyName | string | nullable |
| enableInsurance | boolean | |
| customerInsuranceID | integer (int64) | nullable |
| insuranceID | integer (int64) | nullable |
| policyHolderID | integer (int64) | nullable |
| insuranceCompanyID | integer (int64) | nullable |
| policyNo | string | nullable |
| insuranceInformation | string | nullable |
| insuranceStartDate | string (date-time) | nullable |
| insuranceEndDate | string (date-time) | nullable |
| coverageLimit | number (double) | nullable |
| remainingCoverage | number (double) | nullable |
| availableBenefit | number (double) | nullable |
| topupAmount | number (double) | nullable |
| membershipType | string | nullable |
| verificationNumber | string | nullable |
| totalInsuranceAmount | number (double) | nullable |
| totalInsuranceBenefitAmount | number (double) | nullable |
| grossTotal | number (double) | nullable |
| nisNumber | string | nullable |
| nisCoverageLimit | number (double) | nullable |
| nisUsedAmount | number (double) | nullable |
| totalNISAmount | number (double) | nullable |
| voucherNumber | string | nullable |
| voucherCoverageLimit | number (double) | nullable |
| voucherUsedAmount | number (double) | nullable |
| totalVoucherAmount | number (double) | nullable |
{
"dateString": "string",
"sessionId": "string",
"companyId": "string",
"branchId": "string",
"schemeID": "string",
"salesRepresentativeID": "string",
"customerId": "string",
"cancellationReasonID": "string",
"cancellReason": "string",
"yearId": "string",
"gstNo": "string",
"salesOrderId": 0,
"isForeigner": false,
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"taxTypeId": 0,
"transport": "string",
"grandTotal": 0,
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalTax": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalMRP": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"netAmount": 0,
"remarks": "string",
"acceptedBy": "string",
"statusID": "string",
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"checkSalesOrderCustomer": "string",
"salesPriceIncludesTax": false,
"isCompositionScheme": false,
"showMRP": false,
"barcodeScan": "string",
"goToReceipt": false,
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTimeString": "string",
"deliveryTime": "string",
"rounding": 0,
"itemTypeID": "string",
"searchItem": "string",
"giftVoucherID": "string",
"giftVoucherDiscount": 0,
"giftVoucherNo": "string",
"taxTypeName": "string",
"srName": "string",
"customerTitle": "string",
"firstName": "string",
"lastName": "string",
"customerName": "string",
"customerMobile": "string",
"customerEmailID": "string",
"rightLensFittingHeight": 0,
"rightLensTotalHeight": 0,
"leftLensFittingHeight": 0,
"leftLensTotalHeight": 0,
"typeID": "string",
"getSalesOrderDetailList": [
{
"dateString": "string",
"sessionId": "string",
"companyId": "string",
"branchId": "string",
"schemeID": "string",
"salesRepresentativeID": "string",
"customerId": "string",
"cancellationReasonID": "string",
"cancellReason": "string",
"yearId": "string",
"gstNo": "string",
"salesOrderId": 0,
"isForeigner": false,
"salesOrderNo": "string",
"date": "2026-01-31T10:15:00Z",
"taxTypeId": 0,
"transport": "string",
"grandTotal": 0,
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"totalTax": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalMRP": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"netAmount": 0,
"remarks": "string",
"acceptedBy": "string",
"statusID": "string",
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"checkSalesOrderCustomer": "string",
"salesPriceIncludesTax": false,
"isCompositionScheme": false,
"showMRP": false,
"barcodeScan": "string",
"goToReceipt": false,
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTimeString": "string",
"deliveryTime": "string",
"rounding": 0,
"itemTypeID": "string",
"searchItem": "string",
"giftVoucherID": "string",
"giftVoucherDiscount": 0,
"giftVoucherNo": "string",
"taxTypeName": "string",
"srName": "string",
"customerTitle": "string",
"firstName": "string",
"lastName": "string",
"customerName": "string",
"customerMobile": "string",
"customerEmailID": "string",
"rightLensFittingHeight": 0,
"rightLensTotalHeight": 0,
"leftLensFittingHeight": 0,
"leftLensTotalHeight": 0,
"typeID": "string",
"getSalesOrderDetailList": [
{}
],
"salesOrderDetailList": [
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"allowUserToChangePrice": false,
"allowUserToChangeDiscount": false,
"maxUserDiscountPercentage": 0,
"allowUerToGenerateFutureDateOrder": false,
"allowUserToGeneratePastDateOrder": false,
"allowStoreManagerToGenerateFutureDateOrder": false,
"allowStoreManagerToGeneratePastDateOrder": false,
"userInRole": false,
"userInRoleStoreManager": false,
"allowWarehouseManagerToCancelOrder": false,
"allowCompanyManagerToCancelOrder": false,
"storeSalesOrderID": "string",
"isFranchise": false,
"referencePurchaseOrderID": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"visitingDate": "2026-01-31T10:15:00Z",
"visitingDateString": "string",
"isPopup": "string",
"deliveryModeID": 0,
"deliveryModeName": "string",
"isFranchise_Branch": false,
"deliveryDateDays": "string",
"dndForTransactionalMessage": false,
"dndForPromotionalMessage": false,
"isImportedOrder": false,
"isGiftVoucherApplied": false,
"branchLogo": "string",
"branchName": "string",
"companyName": "string",
"enableInsurance": false,
"customerInsuranceID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"insuranceCompanyID": 0,
"policyNo": "string",
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"totalNISAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"totalVoucherAmount": 0
}
],
"salesOrderDetailList": [
{
"id": "string",
"itemId": "string",
"sessionId": "string",
"name": "string",
"code": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrdered": false,
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"basecurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"allowUserToChangePrice": false,
"allowUserToChangeDiscount": false,
"maxUserDiscountPercentage": 0,
"allowUerToGenerateFutureDateOrder": false,
"allowUserToGeneratePastDateOrder": false,
"allowStoreManagerToGenerateFutureDateOrder": false,
"allowStoreManagerToGeneratePastDateOrder": false,
"userInRole": false,
"userInRoleStoreManager": false,
"allowWarehouseManagerToCancelOrder": false,
"allowCompanyManagerToCancelOrder": false,
"storeSalesOrderID": "string",
"isFranchise": false,
"referencePurchaseOrderID": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"visitingDate": "2026-01-31T10:15:00Z",
"visitingDateString": "string",
"isPopup": "string",
"deliveryModeID": 0,
"deliveryModeName": "string",
"isFranchise_Branch": false,
"deliveryDateDays": "string",
"dndForTransactionalMessage": false,
"dndForPromotionalMessage": false,
"isImportedOrder": false,
"isGiftVoucherApplied": false,
"branchLogo": "string",
"branchName": "string",
"companyName": "string",
"enableInsurance": false,
"customerInsuranceID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"insuranceCompanyID": 0,
"policyNo": "string",
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"totalNISAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"totalVoucherAmount": 0
}
OMSearchCustomer
| Field | Type | Notes |
|---|---|---|
| companyID | integer (int64) | |
| branchID | integer (int64) | |
| yearID | integer (int64) | nullable |
| customerID | string | nullable |
| firstName | string | nullable |
| lastName | string | nullable |
| mobile | string | nullable |
| phoneNO | string | nullable |
| string | nullable | |
| city | string | nullable |
| isActive | string | nullable |
| orderBy | string | nullable |
| customerSourceStringID | string | nullable |
| typeID | string | nullable |
| fromPage | integer (int32) | |
| toPage | integer (int32) | |
| customerNo | string | nullable |
| identityNumber | string | nullable |
| occupation | string | nullable |
| birthDate | string | nullable |
| visitingDate | string | nullable |
| customerSource | string | nullable |
| customerCategory | string | nullable |
| isMember | string | nullable |
| membershipName | string | nullable |
| isBlackList | string | nullable |
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerID": "string",
"firstName": "string",
"lastName": "string",
"mobile": "string",
"phoneNO": "string",
"email": "string",
"city": "string",
"isActive": "string",
"orderBy": "string",
"customerSourceStringID": "string",
"typeID": "string",
"fromPage": 0,
"toPage": 0,
"customerNo": "string",
"identityNumber": "string",
"occupation": "string",
"birthDate": "string",
"visitingDate": "string",
"customerSource": "string",
"customerCategory": "string",
"isMember": "string",
"membershipName": "string",
"isBlackList": "string"
}
ProblemDetails
| Field | Type | Notes |
|---|---|---|
| type | string | nullable |
| title | string | nullable |
| status | integer (int32) | nullable |
| detail | string | nullable |
| instance | string | nullable |
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string"
}
ReceiptFilterRequest
| Field | Type | Notes |
|---|---|---|
| companyID | string | nullable |
| branchID | string | nullable |
| yearID | string | nullable |
| customerID | string | nullable |
| receiptNo | string | nullable |
| receiptType | string | nullable |
| salesOrderNo | string | nullable |
| invoiceNO | string | nullable |
| date | string | nullable |
| customerName | string | nullable |
| customerMobile | string | nullable |
| fromDate | string | nullable |
| toDate | string | nullable |
| amount | string | nullable |
| status | string | nullable |
| pageNumber | integer (int32) | |
| pageSize | integer (int32) | |
| orderBy | string | nullable |
{
"companyID": "string",
"branchID": "string",
"yearID": "string",
"customerID": "string",
"receiptNo": "string",
"receiptType": "string",
"salesOrderNo": "string",
"invoiceNO": "string",
"date": "string",
"customerName": "string",
"customerMobile": "string",
"fromDate": "string",
"toDate": "string",
"amount": "string",
"status": "string",
"pageNumber": 0,
"pageSize": 0,
"orderBy": "string"
}
ReceiptWithouInvoiceModel
| Field | Type | Notes |
|---|---|---|
| receiptId | string | nullable |
| yearId | string | nullable |
| repairingID | string | nullable |
| repairingNO | string | nullable |
| referenceNo | string | nullable |
| receiptTypeId | string | nullable |
| receiptPrintFormat | integer (int32) | nullable |
| netAmount | number (double) | nullable |
| otherCharges | number (double) | nullable |
| branchId | integer (int64) | |
| branchName | string | nullable |
| branchAddress | string | nullable |
| branchCity | string | nullable |
| branchEmailID | string | nullable |
| branchMobile | string | nullable |
| branchEmail | string | nullable |
| branchMobileNo | string | nullable |
| totalQuantity | number (double) | nullable |
| totalPrice | number (double) | nullable |
| totalTaxableAmount | number (double) | nullable |
| totalSGST | number (double) | nullable |
| totalCGST | number (double) | nullable |
| totalIGST | number (double) | nullable |
| rounding | number (double) | nullable |
| totalDiscount | number (double) | nullable |
| salesOrderID | string | nullable |
| salesOrderIDStr | string | nullable |
| receiptAmount | number (double) | nullable |
| isForeigner | boolean | nullable |
| taxNotApplicable | boolean | |
| taxNO | string | nullable |
| signature | string | nullable |
| termsAndConditions | string | nullable |
| intrenalReceiptName | string | nullable |
| isExternalReceiptFormat | boolean | |
| receiptName | string | nullable |
| salesOrderNo | string | nullable |
| salesOrderDate | string (date-time) | nullable |
| statusId | integer (int32) | nullable |
| encryptSalesID | string | nullable |
| repairingReceiptNO | string | nullable |
| invoiceId | string | nullable |
| showDiscountOnReceipt | boolean | |
| htmlContent | string | nullable |
| invoiceNo | string | nullable |
| customerID | integer (int64) | |
| customerIDStr | string | nullable |
| customerFullName | string | nullable |
| customerAddress | string | nullable |
| material | string | nullable |
| work | string | nullable |
| cardTypeId | string | nullable |
| cardType | string | nullable |
| receiptNo | string | nullable |
| date | string (date-time) | required |
| amount | number (double) | required |
| redemAmount | number (double) | nullable |
| balanceAmount | number (double) | nullable |
| advanceAmount | number (double) | nullable |
| bankName | string | nullable |
| bankBranch | string | nullable |
| bankAccountNo | string | nullable |
| chequeDate | string (date-time) | nullable |
| chequeNo | string | nullable |
| cardBankName | string | nullable |
| cardNo | string | nullable |
| validFrom | string (date-time) | nullable |
| cardValidFrom | string (date-time) | nullable |
| cardExpiry | string (date-time) | nullable |
| cardSecurityNo | string | nullable |
| nameOnCard | string | nullable |
| remarks | string | nullable |
| gstNo | string | nullable |
| acceptedBy | string | nullable |
| isActive | boolean | |
| createdBy | string | nullable |
| createdDate | string (date-time) | nullable |
| creatorName | string | nullable |
| createdIP | string | nullable |
| chequeDateString | string | nullable |
| dateString | string | nullable |
| salesOrderDateString | string | nullable |
| cardExpiryDateString | string | nullable |
| cardValidFromDateString | string | nullable |
| creditNoteID | string | nullable |
| creditAmount | number (double) | nullable |
| lC_CardNO | string | nullable |
| lC_Point | number (double) | nullable |
| lC_Redemption | number (double) | nullable |
| lC_ID | string | nullable |
| getSAlesOrderList | array of Invoice_TempModel | nullable |
| houseNumber | string | nullable |
| societyName | string | nullable |
| street | string | nullable |
| area | string | nullable |
| landmark | string | nullable |
| customerTitle | string | nullable |
| customerFirstName | string | nullable |
| customerLastName | string | nullable |
| emailId | string | nullable |
| customerMobile | string | nullable |
| customerTaxNO | string | nullable |
| salesValue | number (double) | nullable |
| getEyePrescription | CustomerEyeInfoModel | |
| prescriptionList | array of SalesOrderDetail | nullable |
| spherical_Right | string | nullable |
| spherical_Left | string | nullable |
| cylinder_Right | string | nullable |
| cylinder_Left | string | nullable |
| axiS_Right | string | nullable |
| axiS_Left | string | nullable |
| adD_Right | string | nullable |
| adD_Left | string | nullable |
| vA_Right | string | nullable |
| vA_Left | string | nullable |
| vN_Right | string | nullable |
| vN_Left | string | nullable |
| pD_Right | string | nullable |
| pD_Left | string | nullable |
| balance | number (double) | nullable |
| previousAdvance | number (double) | nullable |
| salesPerson | string | nullable |
| deliveryDate | string (date-time) | nullable |
| deliveryDateString | string | nullable |
| deliveryTime | string | nullable |
| receiptType | string | nullable |
| deliveryTimeString | string | nullable |
| isSalesPriceIncludeTax | boolean | |
| isCustomerStateSameAsCompanyState | boolean | |
| isCustomerStateNOTSameAsCompanyState | boolean | |
| policyNo | string | nullable |
| insuranceCompanyID | integer (int64) | nullable |
| insuranceID | integer (int64) | nullable |
| policyHolderID | integer (int64) | nullable |
| customerInsuranceID | integer (int64) | nullable |
| insuranceInformation | string | nullable |
| insuranceStartDate | string (date-time) | nullable |
| insuranceEndDate | string (date-time) | nullable |
| coverageLimit | number (double) | nullable |
| remainingCoverage | number (double) | nullable |
| availableBenefit | number (double) | nullable |
| topupAmount | number (double) | nullable |
| membershipType | string | nullable |
| verificationNumber | string | nullable |
| insuranceRemarks | string | nullable |
| grossTotal | number (double) | nullable |
| nisNumber | string | nullable |
| nisCoverageLimit | number (double) | nullable |
| nisUsedAmount | number (double) | nullable |
| voucherNumber | string | nullable |
| voucherCoverageLimit | number (double) | nullable |
| voucherUsedAmount | number (double) | nullable |
| isCompositionScheme | boolean | |
| showPrescriptionOnReceiptPrint | boolean | |
| termsAndConditionList | array of CompanyConditionModel | nullable |
| genrateInvoice | boolean | |
| allowUerToGenerateFutureDateReceipt | boolean | |
| allowUserToGeneratePastDateReceipt | boolean | |
| allowStoreManagerToGenerateFutureDateReceipt | boolean | |
| allowStoreManagerToGeneratePastDateReceipt | boolean | |
| allowGenerateInvoiceBeforeFullPayment | boolean | |
| userInRole | boolean | |
| userInRoleStoreManager | boolean | |
| showItemNameOnReceipt | boolean | |
| showMRP | boolean | |
| enableInsurance | boolean | |
| totalTax | number (double) | nullable |
| totalNISAmount | number (double) | nullable |
| totalVoucherAmount | number (double) | nullable |
| totalInsuranceAmount | number (double) | nullable |
| totalInsuranceBenefitAmount | number (double) | nullable |
| displayCompanyName | string | nullable |
| soCreatedDate | string (date-time) | nullable |
| soCreatedDateTimeString | string | nullable |
| printAmount | number (double) | nullable |
| soTotalDiscountAmount | number (double) | nullable |
| soTotalNetAmount | number (double) | nullable |
| totalReceipt | number (double) | nullable |
| getReceiptTypeList | array of OMReceiptTypeModel | nullable |
| conversionRate | number (double) | nullable |
| rewardPoints | integer (int32) | nullable |
| actualRedemAmount | number (double) | nullable |
| membershipName | string | nullable |
| membershipID | string | nullable |
| dndForPramotionalMessage | boolean | |
| dndForTransactionalMessage | boolean | |
| branchTaxNO | string | nullable |
| branchLogo | string | nullable |
| branchSignature | string | nullable |
| branchCountry | string | nullable |
| branchState | string | nullable |
| companyName | string | nullable |
{
"receiptId": "string",
"yearId": "string",
"repairingID": "string",
"repairingNO": "string",
"referenceNo": "string",
"receiptTypeId": "string",
"receiptPrintFormat": 0,
"netAmount": 0,
"otherCharges": 0,
"branchId": 0,
"branchName": "string",
"branchAddress": "string",
"branchCity": "string",
"branchEmailID": "string",
"branchMobile": "string",
"branchEmail": "string",
"branchMobileNo": "string",
"totalQuantity": 0,
"totalPrice": 0,
"totalTaxableAmount": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"rounding": 0,
"totalDiscount": 0,
"salesOrderID": "string",
"salesOrderIDStr": "string",
"receiptAmount": 0,
"isForeigner": false,
"taxNotApplicable": false,
"taxNO": "string",
"signature": "string",
"termsAndConditions": "string",
"intrenalReceiptName": "string",
"isExternalReceiptFormat": false,
"receiptName": "string",
"salesOrderNo": "string",
"salesOrderDate": "2026-01-31T10:15:00Z",
"statusId": 0,
"encryptSalesID": "string",
"repairingReceiptNO": "string",
"invoiceId": "string",
"showDiscountOnReceipt": false,
"htmlContent": "string",
"invoiceNo": "string",
"customerID": 0,
"customerIDStr": "string",
"customerFullName": "string",
"customerAddress": "string",
"material": "string",
"work": "string",
"cardTypeId": "string",
"cardType": "string",
"receiptNo": "string",
"date": "2026-01-31T10:15:00Z",
"amount": 0,
"redemAmount": 0,
"balanceAmount": 0,
"advanceAmount": 0,
"bankName": "string",
"bankBranch": "string",
"bankAccountNo": "string",
"chequeDate": "2026-01-31T10:15:00Z",
"chequeNo": "string",
"cardBankName": "string",
"cardNo": "string",
"validFrom": "2026-01-31T10:15:00Z",
"cardValidFrom": "2026-01-31T10:15:00Z",
"cardExpiry": "2026-01-31T10:15:00Z",
"cardSecurityNo": "string",
"nameOnCard": "string",
"remarks": "string",
"gstNo": "string",
"acceptedBy": "string",
"isActive": false,
"createdBy": "string",
"createdDate": "2026-01-31T10:15:00Z",
"creatorName": "string",
"createdIP": "string",
"chequeDateString": "string",
"dateString": "string",
"salesOrderDateString": "string",
"cardExpiryDateString": "string",
"cardValidFromDateString": "string",
"creditNoteID": "string",
"creditAmount": 0,
"lC_CardNO": "string",
"lC_Point": 0,
"lC_Redemption": 0,
"lC_ID": "string",
"getSAlesOrderList": [
{
"id": "string",
"invoiceTempID": "string",
"invoiceDetailID": "string",
"salesOrderDetailID": "string",
"itemID": "string",
"title": "string",
"name": "string",
"code": "string",
"hsnCode": "string",
"sessionID": "string",
"description": "string",
"qty": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"totalAmount": 0,
"mrp": 0,
"totalMRP": 0,
"isCompositionScheme": false,
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"inventoryID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z",
"totalQuantity": 0,
"totalDiscount": 0,
"totalTaxableAmount": 0,
"grandTotal": 0,
"totalSGST": 0,
"totalCGST": 0,
"totalIGST": 0,
"totalSavings": 0,
"jobCharges": 0,
"serviceTax": 0,
"shippingCharges": 0,
"otherCharges": 0,
"rounding": 0,
"netAmount": 0,
"itemName": "string",
"cptCode": "string",
"cpt": "string",
"estimateInsuranceAllowance": 0,
"estimatePatientResponsibility": 0,
"taxRate": 0,
"taxAmount": 0,
"tax": "string",
"pairNo": "string",
"spectacleLensType": "string",
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"pd": "string",
"vn": "string",
"vision": "string",
"near": "string",
"isOrderd": "string",
"lensFittingHeight": "string",
"lensTotalHeight": "string",
"baseCurve": "string",
"diameter": "string",
"k1": "string",
"k2": "string",
"typeID": "string"
}
],
"houseNumber": "string",
"societyName": "string",
"street": "string",
"area": "string",
"landmark": "string",
"customerTitle": "string",
"customerFirstName": "string",
"customerLastName": "string",
"emailId": "string",
"customerMobile": "string",
"customerTaxNO": "string",
"salesValue": 0,
"getEyePrescription": {
"doctorName": "string"
},
"prescriptionList": [
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
],
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"adD_Right": "string",
"adD_Left": "string",
"vA_Right": "string",
"vA_Left": "string",
"vN_Right": "string",
"vN_Left": "string",
"pD_Right": "string",
"pD_Left": "string",
"balance": 0,
"previousAdvance": 0,
"salesPerson": "string",
"deliveryDate": "2026-01-31T10:15:00Z",
"deliveryDateString": "string",
"deliveryTime": "string",
"receiptType": "string",
"deliveryTimeString": "string",
"isSalesPriceIncludeTax": false,
"isCustomerStateSameAsCompanyState": false,
"isCustomerStateNOTSameAsCompanyState": false,
"policyNo": "string",
"insuranceCompanyID": 0,
"insuranceID": 0,
"policyHolderID": 0,
"customerInsuranceID": 0,
"insuranceInformation": "string",
"insuranceStartDate": "2026-01-31T10:15:00Z",
"insuranceEndDate": "2026-01-31T10:15:00Z",
"coverageLimit": 0,
"remainingCoverage": 0,
"availableBenefit": 0,
"topupAmount": 0,
"membershipType": "string",
"verificationNumber": "string",
"insuranceRemarks": "string",
"grossTotal": 0,
"nisNumber": "string",
"nisCoverageLimit": 0,
"nisUsedAmount": 0,
"voucherNumber": "string",
"voucherCoverageLimit": 0,
"voucherUsedAmount": 0,
"isCompositionScheme": false,
"showPrescriptionOnReceiptPrint": false,
"termsAndConditionList": [
{
"condition": "string"
}
],
"genrateInvoice": false,
"allowUerToGenerateFutureDateReceipt": false,
"allowUserToGeneratePastDateReceipt": false,
"allowStoreManagerToGenerateFutureDateReceipt": false,
"allowStoreManagerToGeneratePastDateReceipt": false,
"allowGenerateInvoiceBeforeFullPayment": false,
"userInRole": false,
"userInRoleStoreManager": false,
"showItemNameOnReceipt": false,
"showMRP": false,
"enableInsurance": false,
"totalTax": 0,
"totalNISAmount": 0,
"totalVoucherAmount": 0,
"totalInsuranceAmount": 0,
"totalInsuranceBenefitAmount": 0,
"displayCompanyName": "string",
"soCreatedDate": "2026-01-31T10:15:00Z",
"soCreatedDateTimeString": "string",
"printAmount": 0,
"soTotalDiscountAmount": 0,
"soTotalNetAmount": 0,
"totalReceipt": 0,
"getReceiptTypeList": [
{
"id": 0,
"name": "string",
"code": "string",
"remarks": "string",
"isActive": false,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"modifiedBy": 0,
"modifiedDate": "2026-01-31T10:15:00Z",
"modifiedIP": "string",
"allowDeposit": false
}
],
"conversionRate": 0,
"rewardPoints": 0,
"actualRedemAmount": 0,
"membershipName": "string",
"membershipID": "string",
"dndForPramotionalMessage": false,
"dndForTransactionalMessage": false,
"branchTaxNO": "string",
"branchLogo": "string",
"branchSignature": "string",
"branchCountry": "string",
"branchState": "string",
"companyName": "string"
}
SalesOrderDetail
| Field | Type | Notes |
|---|---|---|
| spectacleLensType | integer (int32) | |
| spherical | string | nullable |
| spherical_Right | string | nullable |
| spherical_Left | string | nullable |
| cylinder | string | nullable |
| cylinder_Right | string | nullable |
| cylinder_Left | string | nullable |
| axis | string | nullable |
| axiS_Right | string | nullable |
| axiS_Left | string | nullable |
| addition | string | nullable |
| adD_Right | string | nullable |
| adD_Left | string | nullable |
| vision | string | nullable |
| vA_Right | string | nullable |
| vA_Left | string | nullable |
| vn | string | nullable |
| vN_Right | string | nullable |
| vN_Left | string | nullable |
| pd | string | nullable |
| pD_Right | string | nullable |
| pD_Left | string | nullable |
| pairNo | string | nullable |
{
"spectacleLensType": 0,
"spherical": "string",
"spherical_Right": "string",
"spherical_Left": "string",
"cylinder": "string",
"cylinder_Right": "string",
"cylinder_Left": "string",
"axis": "string",
"axiS_Right": "string",
"axiS_Left": "string",
"addition": "string",
"adD_Right": "string",
"adD_Left": "string",
"vision": "string",
"vA_Right": "string",
"vA_Left": "string",
"vn": "string",
"vN_Right": "string",
"vN_Left": "string",
"pd": "string",
"pD_Right": "string",
"pD_Left": "string",
"pairNo": "string"
}
SalesOrderSearchRequest
| Field | Type | Notes |
|---|---|---|
| pageNumber | integer (int32) | |
| pageSize | integer (int32) | |
| orderBy | string | nullable |
| yearID | integer (int64) | nullable |
| customerID | string | nullable |
| branchName | string | nullable |
| customerName | string | nullable |
| customerMobile | string | nullable |
| salesOrderNo | string | nullable |
| date | string | nullable |
| fromDate | string | nullable |
| toDate | string | nullable |
| acceptedBy | string | nullable |
| deliveryMode | string | nullable |
| netAmount | string | nullable |
| deliveryDateTime | string | nullable |
| status | string | nullable |
| discount | string | nullable |
{
"pageNumber": 0,
"pageSize": 0,
"orderBy": "string",
"yearID": 0,
"customerID": "string",
"branchName": "string",
"customerName": "string",
"customerMobile": "string",
"salesOrderNo": "string",
"date": "string",
"fromDate": "string",
"toDate": "string",
"acceptedBy": "string",
"deliveryMode": "string",
"netAmount": "string",
"deliveryDateTime": "string",
"status": "string",
"discount": "string"
}
SalesOrderTempModelRequest
| Field | Type | Notes |
|---|---|---|
| id | string | nullable |
| sessionID | string | nullable |
| salesOrderID | string | nullable |
| isOrdered | boolean | |
| itemID | string | nullable |
| inventoryID | string | nullable |
| qty | number (double) | |
| mrp | number (double) | nullable |
| totalMRP | number (double) | nullable |
| price | number (double) | |
| totalPrice | number (double) | |
| discountRate | number (double) | |
| discountAmount | number (double) | |
| taxableAmount | number (double) | |
| taxRate | number (double) | |
| taxAmount | number (double) | |
| sgstRate | number (double) | |
| sgstAmount | number (double) | |
| cgstRate | number (double) | |
| cgstAmount | number (double) | |
| igstRate | number (double) | |
| igstAmount | number (double) | |
| jobCharges | number (double) | nullable |
| serviceTaxId | integer (int32) | nullable |
| serviceTaxRate | number (double) | nullable |
| serviceTaxAmount | number (double) | nullable |
| totalAmount | number (double) | |
| createdBy | integer (int64) | |
| createdDate | string (date-time) | |
| createdIP | string | nullable |
| spectacleLensType | integer (int32) | |
| spherical | string | nullable |
| cylinder | string | nullable |
| axis | string | nullable |
| addition | string | nullable |
| near | string | nullable |
| vision | string | nullable |
| vn | string | nullable |
| pd | string | nullable |
| lensFittingHeight | number (double) | nullable |
| lensTotalHeight | number (double) | nullable |
| pairNo | string | nullable |
| basecurve | string | nullable |
| diameter | string | nullable |
| prescriptionRemarks | string | nullable |
| k1 | string | nullable |
| k2 | string | nullable |
| typeID | string | nullable |
| batchNo | string | nullable |
| expiredDate | string (date-time) | nullable |
{
"id": "string",
"sessionID": "string",
"salesOrderID": "string",
"isOrdered": false,
"itemID": "string",
"inventoryID": "string",
"qty": 0,
"mrp": 0,
"totalMRP": 0,
"price": 0,
"totalPrice": 0,
"discountRate": 0,
"discountAmount": 0,
"taxableAmount": 0,
"taxRate": 0,
"taxAmount": 0,
"sgstRate": 0,
"sgstAmount": 0,
"cgstRate": 0,
"cgstAmount": 0,
"igstRate": 0,
"igstAmount": 0,
"jobCharges": 0,
"serviceTaxId": 0,
"serviceTaxRate": 0,
"serviceTaxAmount": 0,
"totalAmount": 0,
"createdBy": 0,
"createdDate": "2026-01-31T10:15:00Z",
"createdIP": "string",
"spectacleLensType": 0,
"spherical": "string",
"cylinder": "string",
"axis": "string",
"addition": "string",
"near": "string",
"vision": "string",
"vn": "string",
"pd": "string",
"lensFittingHeight": 0,
"lensTotalHeight": 0,
"pairNo": "string",
"basecurve": "string",
"diameter": "string",
"prescriptionRemarks": "string",
"k1": "string",
"k2": "string",
"typeID": "string",
"batchNo": "string",
"expiredDate": "2026-01-31T10:15:00Z"
}
SaveInvoiceOnlyRequest
| Field | Type | Notes |
|---|---|---|
| salesOrderID | string | nullable |
| customerID | string | nullable |
| sessionID | string | nullable |
| invoiceDate | string (date-time) | nullable |
| isCompositionScheme | boolean | nullable |
{
"salesOrderID": "string",
"customerID": "string",
"sessionID": "string",
"invoiceDate": "2026-01-31T10:15:00Z",
"isCompositionScheme": false
}
SearchInvoice
| Field | Type | Notes |
|---|---|---|
| companyID | integer (int64) | |
| branchID | integer (int64) | |
| yearID | integer (int64) | nullable |
| customerMobile | string | nullable |
| customerName | string | nullable |
| invoiceNumber | string | nullable |
| fromDate | string | nullable |
| toDate | string | nullable |
| date | string | nullable |
| amount | string | nullable |
| netAmount | string | nullable |
| totalRows | string | nullable |
| salesOrderNo | string | nullable |
| orderBy | string | nullable |
| customerID | string | nullable |
| fromPage | integer (int32) | |
| toPage | integer (int32) |
{
"companyID": 0,
"branchID": 0,
"yearID": 0,
"customerMobile": "string",
"customerName": "string",
"invoiceNumber": "string",
"fromDate": "string",
"toDate": "string",
"date": "string",
"amount": "string",
"netAmount": "string",
"totalRows": "string",
"salesOrderNo": "string",
"orderBy": "string",
"customerID": "string",
"fromPage": 0,
"toPage": 0
}
SOCancellationReasonDto
| Field | Type | Notes |
|---|---|---|
| id | integer (int64) | |
| cancellationReason | string | nullable |
| isActive | boolean |
{
"id": 0,
"cancellationReason": "string",
"isActive": false
}
UpdateSalesOrderRequestModel
| Field | Type | Notes |
|---|---|---|
| id | integer (int32) | |
| qty | number (double) | |
| price | number (double) | |
| discountRate | number (double) | |
| discountAmount | number (double) |
{
"id": 0,
"qty": 0,
"price": 0,
"discountRate": 0,
"discountAmount": 0
}