IntaHub API
Section intro goes here. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque finibus condimentum nisl id vulputate. Praesent aliquet varius eros interdum suscipit. Donec eu purus sed nibh convallis bibendum quis vitae turpis. Duis vestibulum diam lorem, vitae dapibus nibh facilisis a. Fusce in malesuada odio.
Authentication
This used to authenticate the identity of a user or system and grant access to specific resources
•End Point URL
{{baseUrl}}/api/AuthToken/auth-token
•Header
Content-Type: application/json
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| authoriseToken | VARCHAR(150) | Access Token | OUiEAn6msZV4LIySCNKiBA== |
•Success:
{
"authoriseToken": "OUiEAn6msZV4LIySCNKiBA==",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Master Data
Master data refers to the core and most important information that a business relies on for its operations. It typically includes critical details about customers, products, suppliers, and other key entities. Master data serves as a foundational reference, ensuring consistency and accuracy across various systems and processes within an organization
Get All Foods
This allows users to retrieve a comprehensive list of various foods.•End Point URL
{{baseUrl}}/api/MasterData/all-foods
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| foodCatID | Integer | Unique Food Category Id | 2 |
| foodCategory | VARCHAR(150) | Food Category Name | “PASTRY” |
| foodTypeID | Integer | Food Type Id | 1 |
| foodType | VARCHAR(150) | Food Type Name | “BREAD & SAVOURIES” |
| uom | VARCHAR(50) | Unit of Measure | “NO” |
| foodCode | Integer | Food Code Id | 808 |
| foodName | VARCHAR(150) | Food Name | “chees -- Sandwich” |
| price | double | Price | 240.00 |
| resId | Integer | Restaurant Id | 2057 |
| resName | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
•Success:
{
"foodCode": 831,
"foodName": "Smoked Chicken Roll3",
"price": 1472.00,
"foodCategory":
{
"id": 2,
"name": "PASTRY",
},
"foodType":
{
"id": 1,
"name": "BREAD & SAVOURIES",
}
"foodUom":
{
"id": 3,
"name": "No",
}
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Items
This allows users to retrieve a comprehensive list of various Items.•End Point URL
{{baseUrl}}/api/MasterData/all-restaurant
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| itemCatID | Integer | Unique Item Category Id | 1 |
| itemCategory | VARCHAR(150) | Item Category Name | “PRODUCTION” |
| itemTypeID | Integer | Item Type Id | 1 |
| itemTypeName | VARCHAR(150) | Item Type Name | “PRODUCTION” |
| itemID | Integer | Item Id | 1 |
| itemCode | VARCHAR(150) | Item Code | “831” |
| itemName | VARCHAR(150) | Item Name | “Smoked Chicken Roll3” |
| avgCost | double | Average Cost | 0.07940090 |
| contractPrice | double | Contract Price | 0.0000 |
•Success:
{
"itemCatID": 1,
"itemCode": "PRODUCTION",
"itemName": 1,
"avgCost": "PRODUCTION",
"contractPrice": 1,
"itemCategory":
{
"id": 1,
"name": "PRODUCTION",
}
"itemType":
{
"id": 1,
"name": "PRODUCTION",
}
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Restaurant
This allows users to retrieve a comprehensive list of various Restaurants.•End Point URL
{{baseUrl}}/api/MasterData/all-restaurant
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| restaurant | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| address | VARCHAR(150) | Address | "No 59/A, C.W.W.Kannangara Mw., Colombo 07." |
| cityName | VARCHAR(150) | City Name | "WATTALA" |
| countryName | VARCHAR(150) | Country Name | "Sri Lanka" |
| mobile | VARCHAR(150) | Mobile Number | "0715356583" |
| telephone | VARCHAR(150) | Telephone Number | " " |
| VARCHAR(150) | Email Address | " " | |
| remarks | VARCHAR(150) | Additional Comments | " " |
| locationTypeId | Integer | Location Type Id | 4 |
| locationType Name | VARCHAR(150) | Location Type Name | "Banquet" |
•Success:
{
"resID": 2057,
"restaurant": "ALEXANDRA PLACE",
"address": "No 59/A, C.W.W.Kannangara Mw., Colombo 07.",
"cityName": "WATTALA",
"countryName": "Sri Lanka",
"mobile": "0715356583",
"telephone": " ",
"email": " ",
"remarks": " ",
"locationType":
{
"id": 4,
"name": "Banquet",
}
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Unit Of Measure
This allows users to retrieve a comprehensive list of unit of measures.•End Point URL
{{baseUrl}}/api/MasterData/all-restaurant
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| unitOfMeasure | VARCHAR(150) | Unit of Measure | "Kilograms" |
| unit | VARCHAR(150) | Unit | "kg" |
| uomTypeId | VARCHAR(150) | UOM Type | 1 |
| uomTypeName | VARCHAR(150) | UOM Name | "BY WEIGHT" |
| ratio | Decimal | Ratio | 1000.00 |
| childUnit | VARCHAR(150) | Smallest Unit | "Grams" |
| userName | VARCHAR(150) | User Name | "Admin IntaHub" |
•Success:
{
"unitOfMeasure": "Kilograms",
"unit": "kg",
"uomType": {
"id": 1,
"name": "BY WEIGHT",
} "ratio": "1000.00",
"childUnit": "Grams",
"userName": "Admin IntaHub",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Order
An order is a formal request or instruction made by a customer or entity to purchase goods or services from a supplier or vendor. It typically includes details such as the specific items or services requested, quantities, prices, delivery dates, and any other relevant terms and conditions.
Get All Order Summary
This summary serves as a useful reference for customers to review their order before finalizing it,•End Point URL
{{baseUrl}}/api/Order/order-summary?startDate=2023-11-01&endDate=2023-11-
03&resId=2057
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-03 | Yes |
| resId | Integer | Restaurant Id | 2057 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| orderId | Long | Unique Order Id | 243218 |
| orderDate | DateTime | Order ordered Date | 2023-11- 01T09:38:28.193 |
| ordType | VARCHAR(150) | Order Type | "TakeOut" |
| netPrice | Decimal | Net Price | 880.00 |
| discountPrice | Decimal | Promotion Price | 0.00 |
| promotionPrice | Decimal | Promotion Price | 0.00 |
| serviceChragePrice | Decimal | Service Price | 0.00 |
| otherTax | Decimal | Other Price | 0.00 |
| vatPrice | Decimal | Vat Price | 0.00 |
| totalPrice | Decimal | Total Price | 880.00 |
| resID | Integer | Restaurant Id | 2057 |
| resName | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
•Success:
{
"orderID": 243218,
"orderDate": "2023-11-01T09:38:28.193",
"ordType": "TakeOut",
"netPrice": 880.00,
"discountPrice": 0.00,
"promotionPrice": ": 0.00,
"serviceChargePrice": ": 0.00,
"otherTax": ": 0.00,
"vatPrice": ": 0.00,
"totalPrice": ": 880.00
"resName": ": "ALEXANDRA PLACE",
"resID": ": 2057,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Order Details
This allows users to retrieve a comprehensive list of the details of the orders.•End Point URL
{{baseUrl}}/api/Order/order-details?startDate=2023-11-01&endDate=2023-11-30&resId=2057s
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-03 | Yes |
| resId | Integer | Restaurant Id | 2057 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| orderId | Long | Unique Order Id | 243218 |
| foodId | Integer | Food Id | 1 |
| foodCatId | Integer | Food Category Id | 2 |
| foodCategoryName | VARCHAR(150) | Food Category Name | "PASTRY" |
| name | VARCHAR(150) | Food Name | "Smoked Chicken Roll3" |
| foodCost | Decimal | Food Cost | 78.72000000 |
| qty | Integer | Quantity of the Food | 1 |
| netPrice | Decimal | Net Price | 200.00 |
| discountPrice | Decimal | Discount Price | 0.0000 |
| resID | Integer | Restaurant Id | 2057 |
| resName | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| promotionPrice | Decimal | Promotion Price | 0.00 |
| otherTax | Decimal | Tax | 0.00 |
| vatPrice | Decimal | Vat Price | 0.00 |
| totalPrice | Decimal | Final Price | 200.00 |
•Success:
{
"orderID": 243084,
"foodID": 1,
"foodCatId": 2,
"foodCategoryName": ": "PASTRY",
"name": "Smoked Chicken Roll3",
"foodCost": 78.72000000,
"qty": 1,
"netPrice": 200.00,
"discountPrice": 0.00,
"promotionPrice": 0.00,
"otherTax": 0.00,
"vatPrice": 0.00,
"totalPrice": 200.00
"resName": "ALEXANDRA PLACE",
"resID": 2058,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Orders
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Order/all-orders?resId=2057&startDate=2023-11-01&endDate=2023-11-02
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-03 | Yes |
| resId | Integer | Restaurant Id | 2057 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| restaurant | VARCHAR(150) | Restaurant Name | “ALEXANDRA PLACE “ |
| orderDate | DateTime | Order Date | 2023-11-01 |
| foodCategoryName | VARCHAR(150) | Food Category Name | 2 |
| orderType | VARCHAR(150) | Order Type | "TakeOut" |
| guestID | Long | Guest Unique Id | 0 |
| orderID | Long | Order Id | 243084 |
| netPrice | Decimal | Net Price | 300.00 |
| promotionPrice | Decimal | Promotion Price | 0.00 |
| discountPrice | Decimal | Discount Price | 0.00 |
| otherTax | Decimal | Tax | 0.00 |
| serviceChargePrice | Decimal | Service Charge | 0.00 |
| totalPrice | Decimal | Final Price | 0.00 |
•Success:
{
"resID": 2057,
"restaurant": "ALEXANDRA PLACE",
"orderDate": "2023-11-01T06:14:42.87",,
"orderType": "TakeOut",
"guestID": 0,
"orderID": 243084,
"netPrice": 300.00,
"netPrice": 0.00,
"promotionPrice": 0.00,
"discountPrice": 0.00,
"serviceChargePrice": 0.00,
"otherTax": 0.00,
"taxPrice": 0.00
"totalPrice": 300.00
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Special Orders
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Order/special-orders?resId=-1&startDate=2023-12-01&endDate=2023-12-02
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
| resId | Integer | Restaurant Id | 2100 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| restaurant | VARCHAR(150) | Restaurant Name | “WELLAWATTA “ |
| specialOrderDate | DateTime | Special Order Date | 2023-12-02T10:00:00 |
| specialOrderID | long | Special Order Id | 403 |
| orderID | long | Order Id | 76777 |
| customerName | VARCHAR(150) | Customer Name | "Mrs.Azran " |
| mode | VARCHAR(150) | Payment Mode | "CASH" |
| totalPrice | Decimal | Final Price | 9500.00 |
| advanceAmount | Decimal | Advance Amount | 5000.00 |
| balanceAmount | Decimal | Balance Price | 4500.00 |
| status | VARCHAR(150) | Status of the Order | Finished |
•Success:
{
"resID": 2100,
"restaurant": "WELLAWATTA",
"specialOrderDate": "2023-12-02T10:00:00",,
"specialOrderID": 403,
"orderID": 76777,
"customerName": "Mrs.Azran" ,
"mode": "CASH",
"totalPrice": 9500.00,
"advanceAmount": 5000.00,
"balanceAmount": 4500.00,
"status": "Finished",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Pos
Post refers to sharing content, thoughts, or messages on various platforms, such as social media, forums, or blogs, to communicate information, ideas, or updates with an audience.
Get Payment Details
This allows users to retrieve a comprehensive list of payment details.•End Point URL
{{baseUrl}}/api/Pos/payment-details?startDate=2023-11-01&endDate=2023-11-03
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-03 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| paymentName | VARCHAR(150) | Payment Name | "CASH" |
| currencyCode | VARCHAR(150) | Currency Mode | "LKR" |
| excahngeRate | Decimal | Exchange Rate | 1.0000000000 |
| tenderAmount | Decimal | Tender Amount | 650.000000000000 |
| code | Decimal | Currency Code | "LKR" |
| baseCurrencyExch | Decimal | Base Exchange Rate | "1.00" |
| status | VARCHAR(150) | Status of the Payment | "SALES" |
| shiftNo | long | Shift Number | 1 |
| resID | Integer | Restaurant Id | 2057 |
| restaurantName | VARCHAR(150) | Restaurant Name | “ALEXANDRA PLACE “ |
•Success:
{
"paymentName": "CASH",
"currencyCode": "LKR",
"excahngeRate": 1.0000000000,
"tenderAmount": 650.000000000000,
"code": "LKR" ,
"baseCurrencyExch": 1.00 ,
"status": "SALES",
"shiftNo": 1,
"resId": "2057",
"restaurantName": "ALEXANDRA PLACE",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get Sales Summary
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Pos/sales-summary?startDate=2023-11-01&endDate=2023-11-01&resId=2057
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| resId | Integer | Restaurant Id | 2057 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| paymentDate | DateTime | Payment Date | 2023-11-01 |
| restaurant | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| invoiceNo | VARCHAR(150) | Invoice Number | "242487" |
| noOfGuest | VARCHAR(150) | Number Of Guest | "1" |
| tableNo | VARCHAR(150) | Table Number | "" |
| orderNo | VARCHAR(150) | Order Number | "243084" |
| reservationNo | VARCHAR(150) | Reservation Number | "TAKE OUT" |
| cash | Decimal | Cash | 300.00 |
| cheque | Decimal | Cheque | 0.00 |
| crediT_CARD | Decimal | Credit Card | 0.00 |
| advance | Decimal | Advance | 0.00 |
| rooM_POSTING | Decimal | listing rooms for rent | 0.00 |
| dutY_MEAL | Decimal | Duty Meal | 0.00 |
| citY_LEDGER | Decimal | City Ledger | 0.00 |
| other | Decimal | 0.00 | |
| totaL_SALES | Decimal | Today Sales | 0.00 |
| dineIn | Decimal | Dine In | 0.00 |
| tabs | Decimal | Tabs | 0.00 |
| takeAway | Decimal | Take Away | 300.00 |
| special | Decimal | Special | 0.00 |
| delivery | Decimal | Delivery | 0.00 |
| complimentory | Decimal | 0.00 | |
| discount | Decimal | Discount Price | 0.00 |
| promotionPrice | Decimal | Promotion Price | 0.00 |
| serviceCharge | Decimal | Service Charge | 0.00 |
| vat | Decimal | Vat | 0.00 |
| otherTaxes | Decimal | Tax | 0.00 |
| netSale | Decimal | Net Sale | 300.00 |
| grandTotal | Decimal | Final Price | 300.00 |
| resId | Integer | Restaurant Id | 2057 |
•Success:
{
"paymentDate": "2023-11-01,
"restaurant": ""ALEXANDRA PLACE",
"invoiceNo": "242487",,
"noOfGuest": "1",,
"tableNo": " ",
"orderNo": "243084", ,
"reservationNo": "TAKE OUT",
"cash": 300.00,
"cheque": 0.00,
"crediT_CARD": 0.00,
"advance": 0.00,
"rooM_POSTING": 0.00,
"dutY_MEAL": 0.00,
"resId": 2057,
"citY_LEDGER": 0.00,
"other": 0.00,
"totaL_SALES": 300.00 ,
"dineIn": 0.00,
"tabs": 0.00,
"takeAway": 300.00,
"special": 0.00,
"delivery": 0.00,
"deliveryCharges": 0.00,
"complimentory": 0.00,
"discount": 0.00,
"promotionPrice": 0.00,
"serviceCharge": 0.00,
"vat": 0.00,
"otherTaxes": 0.00,
"netSale": 300.00,
"grandTotal": 300.00,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get Sales Details
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Pos/sales-details?startDate=2023-11-01&endDate=2023-11-02&resId=2057
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
| resId | Integer | Restaurant Id | 2057 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| paymentDate | DateTime | Restaurant Id | 2023-11-01 |
| restaurant | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| billNo | Long | Bill Number | 242487 |
| paymentMode | VARCHAR(150) | Payment Date | "CASH" |
| cashier | VARCHAR(150) | Cashier | "Husni" |
| table | VARCHAR(150) | Table | " " |
| room | VARCHAR(150) | Room | " " |
| guestName | VARCHAR(150) | Guest Name | " " |
| orderId | Long | Order ID | 243084 |
| orderType | VARCHAR(150) | Order Type | "TAKEOUT" |
| foodCategory | VARCHAR(150) | Food Category Name | "PASTRY" |
| foodType | VARCHAR(150) | Food Type | "BREAD & SAVOURIES" |
| food | VARCHAR(150) | Food | "Smoked Chicken Roll3" |
| quantity | Integer | Quantity | 1 |
| net | Decimal | Net Price | 200.00 |
| promotion | Decimal | Promotion | 0.00 |
| discount | Decimal | Discount Price | 0.00 |
| serviceCharge | Decimal | Service Charge | 0.00 |
| tax | Decimal | Tax | 0.00 |
| total | Decimal | Final Price | 200.00 |
| foodCost | Decimal | Food Cost | 78.72000000 |
| resId | Integer | Restaurant Id | 2057 |
•Success:
{
"paymentDate": "2023-11-01",
"restaurant": "ALEXANDRA PLACE",
"billNo": 242487,,
"paymentMode": "CASH",
"cashier": "Husni",
"table": " " ,
"room": " ",
"guestName": " ",
"orderId": 243084,
"orderType": "TAKEOUT",
"foodCategory": "PASTRY",
"foodType": "BREAD & SAVOURIES",
"food": "Smoked Chicken Roll3",
"quantity": 1,
"net": 200.00,
"promotion": 0.00,
"discount": 0.00,
"serviceCharge": 0.00,
"tax": 0.00,
"total": 200.00,
"foodCost": 78.72000000,
"resId": 2057,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Receipts
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Pos/all-receipts?resId=2057&startDate=2023-11-01&endDate=2023-11-02
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2057 | Yes |
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| restaurant | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| paymentDate | DateTime | Payment Date | 2023-12-02T10:00:00 |
| billNo | long | Bill Number | 242487 |
| cashier | VARCHAR(150) | Cashier Name | "Husni" |
| netPrice | Decimal | Net Price | 300.00 |
| promotionPrice | Decimal | Promotion Price | 0.00 |
| discountPrice | Decimal | Discount Price | 0.00 |
| taxPrice | Decimal | Tax Price | 0.00 |
| otherTax | Decimal | Other Tax Price | 0.00 |
| serviceChargePrice | Decimal | Service Charge | 0.00 |
| totalPrice | Decimal | Final Price | 300.00 |
•Success:
{
"resID": 2057,
"restaurant": ""ALEXANDRA PLACE", ",
"paymentDate": "2023-11-01T06:14:45.59",
"billNo": 242487,
"cashier": "Husni",
"netPrice": 300.00 ,
"promotionPrice": 0.00,
"discountPrice": 0.00,
"taxPrice": 0.00,
"otherTax": 0.00,
"serviceChargePrice": 0.00,
"totalPrice": 300.00,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Deposits
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Pos/all-deposites?resId=2057&startDate=2023-11-01&endDate=2023-11-01
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resName | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| advanceDate | DateTime | Advance Date | 11-01-2023 |
| advanceID | long | Advance ID | 531 |
| guestId | long | Guest Unique ID | 94701287878 |
| guestName | VARCHAR(150) | Guest Name | "Pawan " |
| advancePayment | Decimal | Advance Payment | 1000.00 |
| balanceAmount | Decimal | Balance Amount | 0.00 |
| remarks | Decimal | Additional Comments | " " |
| resId | Integer | Restaurant Id | 2057 |
•Success:
{
"resName": "ALEXANDRA PLACE",
"advanceDate": "11-01-2023",
"advanceID": 531,
"guestId": 94701287878,
"guestName": "Pawan ",
"advancePayment": 1000.00,
"balanceAmount": 0.00, ,
"remarks": " ",
"resId": 2057,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Production
Production involves the process of creating goods or services through a systematic approach that encompasses manufacturing, operations, and management to efficiently bring a product to market.
Get All FTN
This records the transfer of food items•End Point URL
{{baseUrl}}/api/Production/all-ftn?resId=2057&startDate=2023-11-01&endDate=2023-11-02
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2057 | Yes |
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| id | Integer | FTN Unique Id | 2328 |
| ftnNumber | VARCHAR(150) | FTN Number | "FT/2057/2020/07/0024" |
| fromRestaurant | VARCHAR(150) | From Restaurant | "ALEXANDRA PLACE" |
| fromFoodDepartment | VARCHAR(150) | From Food Department | "ALEXANDRA PLACE" |
| toRestaurant | VARCHAR(150) | To Restaurant | "MAIN FACTORY (OUTLET)" |
| toFoodDepartment | VARCHAR(150) | To Food Department | "MAIN FACTORY (OUTLET)" |
| shiftName | VARCHAR(150) | Shift Name | "COOL PRODUCTS" |
| authorisedUser | VARCHAR(150) | User | "A Pathmanathan Arumugam" |
| authoriseDate | VARCHAR(150) | Authorized Date | "Jul 22 2020 7:37PM" |
| remarks | VARCHAR(150) | Additional Comments | " " |
| netPrice | Decimal | Net Price | 1600.00 |
| taxPrice | Decimal | Tax Price | 0.00 |
| otherCharges | Decimal | Other Charges | 0.00 |
| totalPrice | Decimal | Final Price | 1600.00 |
| fromResId | Integer | OFrom Restaurant Id | 2059 |
| toResId | Integer | To Restaurant Id | 2071 |
•Success:
{
"id": 2328,
"ftnNumber": "FT/2057/2020/07/0024",
"fromRestaurant": "ALEXANDRA PLACE",
"fromFoodDepartment": "ALEXANDRA PLACE",
"toRestaurant": "MAIN FACTORY (OUTLET)",
"toFoodDepartment": "MAIN FACTORY (OUTLET)",
"shiftName": "COOL PRODUCTS",
"authorisedUser": "A Pathmanathan Arumugam",
"authoriseDate": "Jul 22 2020 7:37PM",
"remarks": " ",
"netPrice": 1600.00,
"taxPrice": 0.00,
"otherCharges": 0.00,
"totalPrice": 1600.00,
"fromResId": 2059,
"toResId": 2071,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All FTN By FTN Id
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Production/FTNBy-FTNId?resId=2077&fGtransferId=131464
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2077 | Yes |
| fGtransferId | Integer | Food Transfer Id | 131464 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| fgTransferDetailID | Long | FTN Transfer Detail Id | 1151636 |
| foodName | VARCHAR(150) | Food Name | " Butter Cookies (150G)" |
| unitOfMeasure | VARCHAR(150) | Unit Of Measure | " Numbers" |
| quantity | Decimal | Quantity | 0.000 |
| requestQuantity | Decimal | Request Quantity | 0.000 |
| actualFoodTransferQ uantity | Decimal | Actual Food Transfer Quantity | 0.000 |
| foodCost | Decimal | Food Cost | 24972.47000000 |
| userName | VARCHAR(150) | User Name | "Chandrasekar Ranjith" |
•Success:
{
"fgTransferDetailID": 1151636,
"foodName": ""Butter Cookies (150G)",
"unitOfMeasure": "Numbers",,
"quantity": 0.000,
"requestQuantity": 0.000,
"actualFoodTransferQuantity": 0.000,
"foodCost": 24972.47000000,
"userName": "Chandrasekar Ranjith",,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Production Plan
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Production/all-productionplan?resId=2077&startDate=2023-11-
02&endDate=2023-11-05
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2077 | Yes |
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-05 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| id | Long | Production Plan Unique Id | 7531 |
| productionDate | DateTime | Production Date | 2023-11-02T00:00:00 |
| productionTime | VARCHAR(150) | Production Time | "10:00AM" |
| productionPlanDetailId | long | Production Plan Unique Id | 125610 |
| description | VARCHAR(150) | Description of The Product | "HOT KITCHEN" |
| unit | VARCHAR(150) | Unit of Measure | "NO" |
| foodID | Integer | Food Id | 7 |
| name | VARCHAR(150) | Name of the Product | "Chicken Bun1" |
| planQuantity | Decimal | Planned Quantity | 2400.000 |
| actualQuantity | Decimal | Actual Quantity | 0.000 |
| resId | Integer | Restaurant Id | 2057 |
| resName | VARCHAR(150) | Restaurant Name | “PRODUCTION” |
•Success:
{
"id": 7531,
"productionDate": "2023-11-02T00:00:00",
"productionTime": "10:00AM",
"productionPlanDetailId": 125610,
"description": "HOT KITCHEN",
"unit": "NO",
"foodID": 7 ,
"name": "Chicken Bun1",
"planQuantity": 2400.000,
"actualQuantity": 0.000,
"resId": 2077,
"resName": "PRODUCTION",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Production Plan By Production Plan Id
Thisretrieves each respective production plan details by its Id.•End Point URL
{{baseUrl}}/api/Production/productionplanBy-productionplanId?resId=2077&productionPlanId=8007
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2077 | Yes |
| productionPlanId | Integer | Production Plan Id | 8007 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| productionPlanDetailId | Long | Production Plan Detail Id | 131744 |
| foodName | VARCHAR(150) | Food Name | "Smoked Chicken Roll3" |
| unitOfMeasure | VARCHAR(150) | Unit of Measure | "Numbers" |
| planQuantity | Decimal | Plan Quantity | 23.000 |
| actualQuantity | Decimal | Actual Quantity | 23.000 |
| budgetQuantity | Decimal | Budget Quantity | 0.000 |
| userName | VARCHAR(150) | User Name | "Rechal Vishali" |
•Success:
{
"productionPlanDetailId": 131744,
"foodName": "Smoked Chicken Roll3",
"unitOfMeasure": "Numbers",
"planQuantity": 23.000,
"actualQuantity": 23.000,
"budgetQuantity": 0.000,
"userName": "Rechal Vishali",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Purchase
A transaction purchase refers to the process of acquiring goods or services by exchanging money or other forms of payment. It typically involves a buyer selecting a product or service, initiating the purchase, and completing the financial transaction with the seller.
Get All PO
This formalizes the intent to purchase goods or services.•End Point URL
{{baseUrl}}/api/Purchase/all-po?resId=2077&startDate=2023-11-01&endDate=2023-11-02
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2077 | Yes |
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| warehouseID | Integer | Restaurant Id | 2057 |
| po | Integer | Purchase Order id | 12432 |
| poNumber | VARCHAR(150) | Purchase Order numebr | "PO/2057/2023/12/0007" |
| registrationDate | DateTme | Registration Date | 2023-12- 18T15:16:51.307 |
| supplierName | VARCHAR(150) | Supplier Name | "Default" |
| remarks | VARCHAR(150) | Additional Comments | " " |
| netPrice | Decimal | Net Price | 9360.000 |
| discountPrice | Decimal | Discount Price | 0.000 |
| lineDiscountPrice | Decimal | Line Discount Price | 2.000 |
| otherCharges | Decimal | Other Chrges | 0.000 |
| vatPrice | Decimal | Vat Price | 1.000 |
| otherTaxPrice | Decimal | Other Tax | 1.000 |
| totalPrice | Decimal | Final Price | 9360.000000 |
| resName | VARCHAR(150) | Restaurant Name | “PRODUCTION” |
•Success:
{
"warehouseID": 2077,
"po": 1126,
"poNumber": "PO/2077/2020/10/0001",
"registrationDate": "2020-10-17T16:18:13",
"supplierName": "MADINA FOODS PVT LTD",
"remarks": " ",
"netPrice": 127200.000000,
"discountPrice": 0.000000,,
"lineDiscountPrice": 0.000000,,
"otherCharges": 0.000000,,
"vatPrice": 0.000000,,
"otherTaxPrice": 0.000000,,
"totalPrice": 127200.000000,
"resName": "PRODUCTION",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All PO By PO Id
Thisretrieves the respective details of the purchase orders•End Point URL
{{baseUrl}}/api/Purchase/PoBy-PoId?resId=2057&poId=1
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2057 | Yes |
| poId | Integer | Purchase Order Id | 1 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| purchaseOrderDet ailID | Long | Purchase Order Detail Id | 1 |
| purchaseOrderNu mber | VARCHAR(150) | Purchase Order Number | "PO/2057/2020/06/0001" |
| itemName | VARCHAR(150) | Item Name | "Cheese Slices" |
| unitOfMeasure | VARCHAR(150) | Unit of Measure | "Numbers" |
| quantity | Decimal | Quantity | 100.000 |
| unitPrice | Decimal | Unit Price | 24.160000 |
| netPrice | Decimal | Net Price | 2416.000000 |
| discountPrice | Decimal | Discount Price | 2416.000000 |
| lineDiscount | Decimal | Line Discount Price | 0.000000 |
| taxPrice | Decimal | Tax Price | 0.000000 |
| vatPrice | Decimal | Vat Price | 0.000000 |
| brand | VARCHAR(150) | Brand | "none" |
•Success:
{
"purchaseOrderDetailID": 1,
"purchaseOrderNumber": "PO/2057/2020/06/0001",
"itemName": "Cheese Slices",
"unitOfMeasure": "Numbers",
"quantity": "100.000",
"unitPrice": 24.16000,
"netPrice": 2416.0000 ,
"lineDiscount": 100.00,
"discountPrice": 2416.0000,
"vatPrice": 0.0000,
"taxPrice": 0.0000,
"totalPrice": : 2416.000000,
"brand": "none",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All GRN
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Production/all-productionplan?resId=2077&startDate=2023-11-
02&endDate=2023-11-05
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2057 | Yes |
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| restaurantName | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| po | Integer | PO Id | 0 |
| grnid | Integer | GRN Id | 18384 |
| grnNumber | VARCHAR(150) | GRN Number | ""GR/2057/2023/12/0014"" |
| poNumber | VARCHAR(150) | PO Number | "" |
| invoiceNo | VARCHAR(150) | Invoice Number | " " |
| supplier | Integer | Supplier Id | 1 |
| description | VARCHAR(150) | Description | " " |
| user | VARCHAR(150) | User | "Admin" |
| createdDate | DateTime | Created Date | 2023-12-19T13:43:18.98 |
| modifiedUser | VARCHAR(150) | Modified User | "Admin" |
| modifiedDate | DateTime | Modified Date | 2023-12-19T13:43:18.98 |
| authoriseUser | VARCHAR(150) | Authorized User | "Admin" |
| authoriseDate | DateTime | Authorize Date | 2023-12-19T13:43:18.98 |
| purchaseUser | VARCHAR(150) | Purchase User | "Admin" |
| purchaseDate | DateTime | Purchase Date | 2023-12- 19T08:14:40.447 |
| netPrice | Decimal | Net price | 3800.000 |
| discountPrice | Decimal | Discount Price | 0.000 |
| lineDiscountPrice | Decimal | Line Discount Price | 0.000 |
| vatPrice | Decimal | Vat Price | 0.000 |
| otherTaxPrice | Decimal | Other Tax price | 0.000 |
| totalPrice | Decimal | Final Price | 3800.000000 |
•Success:
{
"resID": 2057,
"restaurantName": "ALEXANDRA PLACE",
"po": 0,
"grnid": 18384,
"grnNumber": "GR/2057/2023/12/0014",
"poNumber": "",
"description": "",
"user": "Admin",
"createdDate": "2023-12-19T08:14:40.447",
"modifiedUser": "Admin",
"modifiedDate": "2023-12-19T08:14:40.447",
"authoriseUser": "Admin",
"authoriseDate": "2023-12-19T08:14:40.447",
"purchaseUser": "Admin",
"purchaseDate": "2023-12-19T08:14:40.447",
"netPrice": 3800.000,
"discountPrice": 0.000,
"lineDiscountPrice": 0.000,
"vatPrice": 0.000,
"otherTaxPrice": 0.000,
"totalPrice": 3800.000,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All GRN By GRN Id
Thisretrieves details about the GRN Id‟s•End Point URL
{{baseUrl}}/api/Purchase/GRNBy-GRNId?resId=2058&grnId=2
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2058 | Yes |
| grnId | Integer | GRN Id | 2 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| grnDetailID | Long | GRN Detail Id | 30 |
| itemName | VARCHAR(150) | Item Name | "Onion" |
| unitOfMeasure | VARCHAR(150) | Unit of Measure | "Kilograms" |
| quantity | Decimal | Quantity | 2.900 |
| freeQuantity | Decimal | Free Quantity | 0.000 |
| unitPrice | Decimal | Unit Price | 158.000000 |
| netPrice | Decimal | Net Price | 458.200000 |
| lineDiscount | Decimal | Line Discount | 0.0000 |
| discountPrice | Decimal | Discount Price | 458.200000 |
| vatPrice | Decimal | Vat Price | 0.0000 |
| taxPrice | Decimal | Tax Price | 0.0000 |
| totalPrice | Decimal | Total Price | 458.200000 |
| expiryDate | DATETIME | Expire Date | 2024-07-18T00:00:00 |
| userName | VARCHAR(150) | User Name | "ROHAN SITHAMBARAM" |
•Success:
{
"grnDetailID": 30,
"itemName": "Onion",
"unitOfMeasure": "Kilograms",
"quantity": 2.900,
"freeQuantity": 0.000,
"unitPrice": 158.000000,
"netPrice": 458.200000 ,
"lineDiscount": 0.0000,
"discountPrice": 458.200000,
"vatPrice": 0.00000,
"taxPrice": 0.00000,
"totalPrice": 458.200000,
"expiryDate": "2024-07-18T00:00:00",
"userName": "ROHAN SITHAMBARAM"
,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All GTN
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Purchase/all-gtn?resId=2057&startDate=2023-11-01&endDate=2023-11-02
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2057 | Yes |
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-02 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| id | Long | Production Plan Unique Id | 7531 |
| number | DateTime | Production Date | 2023-11-02T00:00:00 |
| fromRestaurant | VARCHAR(150) | Production Time | "10:00AM" |
| fromDepartment | long | Production Plan Unique Id | 125610 |
| toResturent | VARCHAR(150) | Description of The Product | "HOT KITCHEN" |
| toDepartment | VARCHAR(150) | Unit of Measure | "NO" |
| authoriseUser | Integer | Food Id | 7 |
| authoriseDate | VARCHAR(150) | Name of the Product | "Chicken Bun1" |
| transferUser | Decimal | Planned Quantity | 2400.000 |
| transferDate | Decimal | Actual Quantity | 0.000 |
| netPrice | Decimal | Actual Quantity | 0.000 |
| taxPrice | Decimal | Actual Quantity | 0.000 |
| otherCharges | Decimal | Actual Quantity | 0.000 |
| totalPrice | Decimal | Actual Quantity | 0.000 |
| remarks | Decimal | Actual Quantity | 0.000 |
| fromResId | Integer | From Restaurant Id | 2078 |
| toResId | Integer | To Restaurant Id | 2077 |
•Success:
{
"id": 43239,
"number": "MT/2057/2023/12/0001",
"fromRestaurant": "ALEXANDRA PLACE",
"fromDepartment": "ALEXANDRA PLACE",
"toResturent": "STORE",
"toDepartment": "STORE",
"authoriseUser": "Admin IntaHub" ,
"authoriseDate": "2023-12-19T16:08:03.65",
"transferUser": "Admin IntaHub",
"transferDate": "2023-12-19T15:23:59.13",
"netPrice": 433.71,
"taxPrice": 0.000,
"otherCharges": 0.000,
"totalPrice": 433.71,
"remarks": " ",
"fromResId": 2078,
"toResId": 2077,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All GTN By Id
This retrieves GTN Details by GTN Id.•End Point URL
{{baseUrl}}/api/Purchase/GTNBy-GTNId?resId=2078&gTransferId=26486
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2078 | Yes |
| gTransferId | Integer | GRN Id | 26486 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| gTransferDetailId | Long | GRN Detail Id | 302111 |
| itemName | VARCHAR(150) | Item Name | "Rice - Nadu" |
| unitOfMeasure | VARCHAR(150) | Unit of Measure | "Kilograms" |
| quantity | Decimal | Quantity | 7.000 |
| requestQuantity | Decimal | Request Quantity | 7.000 |
| netPrice | Decimal | Net Price | 1204.00 |
| taxPrice | Decimal | Tax Price | 0.0000 |
| totalPrice | Decimal | Total Price | 1204.00 |
| userName | VARCHAR(150) | User Name | "PRAVEEN YUGESH" |
•Success:
{
"gTransferDetailId": 302111,
"itemName": "Rice - Nadu",
"unitOfMeasure": "Kilograms",
"quantity": 7.000,
"requestQuantity": 7.000,
"netPrice": 1204.000000,
"netPrice": 0.000 ,
"taxPrice": 0.00000,
"totalPrice": 1204.00,
"userName": "PRAVEEN YUGESH"
,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Reservation
Reservations involve securing or holding a spot, seat, or service in advance, ensuring availability or priority for an activity, accommodation, or resource at a specified time or place.
Get All Order Summary
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Reservation/order-summary?startDate=2023-01-01&endDate=2023-12-
31&resId=2057
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-12-31 | Yes |
| resId | Integer | Restaurant Id | 2057 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| resName | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| reservationId | Long | Reservation Id | 12 |
| floorId | Integer | Floor Id | 1 |
| floorName | VARCHAR(150) | Floor name | "FIRST" |
| noTables | Integer | Number of Tables | 1 |
| reservationDate | DateTime | Reservation Date | 2023-12-13T00:00:00 |
| waiter | VARCHAR(150) | Waiter Name | "AdminIntaHub" |
•Success:
{
"resID": 2057,
"resName": "ALEXANDRA PLACE",
"reservationId": 12,
"floorId": 1,
"floorName": "FIRST",
"noTables": 1,
"reservationDate": "2023-12-13T00:00:00",
"waiter": "AdminIntaHub",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Order Details
This refers to a condensed overview of a reservation order details made by a customer•End Point URL
{{baseUrl}}/api/Reservation/order-details?startDate=2023-12-01&endDate=2023-12-
31&resId=2057
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-12-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-12-31 | Yes |
| resId | Integer | Restaurant Id | 2057 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| resName | VARCHAR(150) | Restaurant Name | "ALEXANDRA PLACE" |
| reservationDate | DateTime | Reservation Date | 2023-12-15T00:00:00 |
| reservationId | long | Reservation Id | 30 |
| foodId | Integer | Food Id | 10 |
| name | VARCHAR(150) | Name | "Hot Dog" |
| waiter | VARCHAR(150) | Waiter Name | "A PathmanathanArumugam" |
•Success:
{
"resID": 2057,
"resName": "ALEXANDRA PLACE",
"reservationDate": "2023-12-15T00:00:00",
"reservationId": 30,
"foodId": 10,
"name": "Hot Dog",
"waiter": "A PathmanathanArumugam",
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |
Get All Reservation
This allows users to retrieve a comprehensive list of the orders.•End Point URL
{{baseUrl}}/api/Reservation/all-reservation?resId=2057&startDate=2023-12-01&endDate=2023-
12-31
•Header
Content-Type: application/json
•Request Headers:
| Name | Value | Required |
|---|---|---|
| IntaAPI-Token | { api-token-value} | Yes |
•Parameter:
| Name | Data Type | Description | Example | Required |
|---|---|---|---|---|
| resId | Integer | Restaurant Id | 2057 | Yes |
| startDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-11-01 | Yes |
| endDate | DateTime | From date.[Format: yyyy-mm-dd] | 2023-12-31 | Yes |
•Response:
| Name | Data Type | Description | Example |
|---|---|---|---|
| resID | Integer | Restaurant Id | 2057 |
| reservationID | Long | Reservation Id | 32 |
| orderID | Long | Order Id | 257180 |
| reservationDate | DateTime | Reservation Id | 2023-12-15T00:00:00 |
| timeIn | VARCHAR(150) | Time In | "11:00:00" |
| timeOut | VARCHAR(150) | Time Out | "11:00:00" |
| guestID | Decimal | Guest id | 94711850656 |
| guestName | VARCHAR(150) | Guest Name | "rashmi prabodya" |
| orderType | VARCHAR(150) | Order Type | "DineIn" |
| pax | Integer | Pax Count | 2 |
| description | VARCHAR(150) | Description | "OPEN TABLE" |
| reservationType | VARCHAR(150) | Reservation Type | "STANDARD" |
| floorName | VARCHAR(150) | Floor Name | "FIRST" |
| tableNo | Integer | Table Number | 8 |
| tblName | VARCHAR(150) | Table Name | "TBL 8" |
| waiter | VARCHAR(150) | Waiter Name | "Mamoola" |
| reservationStatus | VARCHAR(150) | Status of the Reservation | "Active" |
| totalPrice | Decimal | Final Price | 680.00 |
•Success:
{
"resID": 2057,
"reservationID": 32,
"orderID": 257180,
"reservationDate": "2023-12-15T00:00:00",
"timeIn": ""11:00:00",
"timeOut": "11:00:00",
"guestID": 94711850656,
"guestName": "rashmi prabodya",
"orderType": "DineIn",
"pax": 2,
"description": "OPEN TABLE",
"reservationType": "STANDARD",
"floorName": "FIRST",
"tableNo": 8,
"tblName": "TBL 8",
"waiter": "Mamoola",
"reservationStatus": "Active",
"totalPrice": 680.000,
},
•Error Codes:
| Errors | Description |
|---|---|
| 404 not found | Requested URL is not in correct format |
| 500 Internal Server Error | Server Error |