Server : Apache/2.4.62 (Unix) OpenSSL/1.0.2k-fips System : Linux server1.richineiserver.com 3.10.0-1160.119.1.el7.x86_64 #1 SMP Tue Jun 4 14:43:51 UTC 2024 x86_64 User : fdshops ( 1003) PHP Version : 8.2.21 Disable Function : NONE Directory : /home/fdshops/public_html/public/public/docs/ |
{
"variables": [],
"info": {
"name": "Richinei Apps Cloud POS Solutions API",
"_postman_id": "4a3ad516-73b6-4642-aed4-b76b3efe444c",
"description": "",
"schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.0.0\/collection.json"
},
"item": [
{
"name": "Attendance management",
"description": "",
"item": [
{
"name": "Get Attendance",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/get-attendance\/:user_id",
"query": [],
"variable": [
{
"id": "user_id",
"key": "user_id",
"value": "1",
"description": "id of the user"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Clock In",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/clock-in",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"user_id\": 1,\n \"clock_in_time\": \"2000-06-13 13:13:00\",\n \"clock_in_note\": \"nobis\",\n \"ip_address\": \"temporibus\",\n \"latitude\": \"tenetur\",\n \"longitude\": \"et\"\n}"
},
"description": "[User must have \"essentials.allow_users_for_attendance_from_api\" permission to Clock in]",
"response": []
}
},
{
"name": "Clock Out",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/clock-out",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"user_id\": 1,\n \"clock_out_time\": \"2000-06-13 13:13:00\",\n \"clock_out_note\": \"non\",\n \"latitude\": \"cum\",\n \"longitude\": \"explicabo\"\n}"
},
"description": "[User must have \"essentials.allow_users_for_attendance_from_api\" permission to Clock out]",
"response": []
}
},
{
"name": "List Holidays",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/holidays",
"query": [
{
"key": "location_id",
"value": "1",
"description": "id of the location",
"disabled": false
},
{
"key": "start_date",
"value": "2020-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "end_date",
"value": "2020-06-25",
"description": "format:Y-m-d",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Brand management",
"description": "",
"item": [
{
"name": "List brands",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/brand",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified brand",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/brand\/:brand",
"query": [],
"variable": [
{
"id": "brand",
"key": "brand",
"value": "1",
"description": "comma separated ids of the brands"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Business Location management",
"description": "",
"item": [
{
"name": "List business locations",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/business-location",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified business location",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/business-location\/:business_location",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "CRM",
"description": "",
"item": [
{
"name": "List Follow ups",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/crm\/follow-ups",
"query": [
{
"key": "start_date",
"value": "2020-12-16",
"description": "format: Y-m-d (Ex: 2020-12-16)",
"disabled": false
},
{
"key": "end_date",
"value": "2020-12-16",
"description": "format: Y-m-d (Ex: 2020-12-16)",
"disabled": false
},
{
"key": "status",
"value": "officiis",
"description": "filter the result through status, get status from getFollowUpResources->statuses",
"disabled": false
},
{
"key": "follow_up_type",
"value": "quasi",
"description": "filter the result through follow_up_type, get follow_up_type from getFollowUpResources->follow_up_types",
"disabled": false
},
{
"key": "order_by",
"value": "start_datetime",
"description": "Column name to sort the result, Column: start_datetime",
"disabled": false
},
{
"key": "direction",
"value": "desc",
"description": "Direction to sort the result, Required if using 'order_by', direction: desc, asc",
"disabled": false
},
{
"key": "per_page",
"value": "10",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Add follow up",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/crm\/follow-ups",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"Meeting with client\",\n \"contact_id\": 2,\n \"description\": \"aspernatur\",\n \"schedule_type\": \"architecto\",\n \"user_id\": \"[2,3,5]\",\n \"notify_before\": 5,\n \"notify_type\": \"minute\",\n \"status\": \"open\",\n \"notify_via\": \"['sms' => 0 ,'mail' => 1]\",\n \"start_datetime\": \"2021-01-06 13:05:00\",\n \"end_datetime\": \"2021-01-06 13:05:00\",\n \"followup_additional_info\": \"['call duration' => '1 hour']\",\n \"allow_notification\": true\n}"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified followup",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/crm\/follow-ups\/:follow_up",
"query": [],
"variable": [
{
"id": "follow_up",
"key": "follow_up",
"value": "1%2C2",
"description": "comma separated ids of the follow_ups"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Update follow up",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/crm\/follow-ups\/:follow_up",
"query": [],
"variable": [
{
"id": "follow_up",
"key": "follow_up",
"value": "20",
"description": "id of the follow up to be updated"
}
]
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\": \"Meeting with client\",\n \"contact_id\": 2,\n \"description\": \"corporis\",\n \"schedule_type\": \"odit\",\n \"user_id\": \"[2,3,5]\",\n \"notify_before\": 5,\n \"notify_type\": \"minute\",\n \"status\": \"open\",\n \"notify_via\": \"['sms' => 0 ,'mail' => 1]\",\n \"followup_additional_info\": \"['call duration' => '1 hour']\",\n \"start_datetime\": \"2021-01-06 13:05:00\",\n \"end_datetime\": \"2021-01-06 13:05:00\",\n \"allow_notification\": true\n}"
},
"description": "",
"response": []
}
},
{
"name": "Get follow up resources",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/crm\/follow-up-resources",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "List lead",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/crm\/leads",
"query": [
{
"key": "assigned_to",
"value": "1%2C2%2C3",
"description": "comma separated ids of users to whom lead is assigned (Ex: 1,2,3)",
"disabled": false
},
{
"key": "name",
"value": "delectus",
"description": "Search term for lead name",
"disabled": false
},
{
"key": "biz_name",
"value": "voluptate",
"description": "Search term for lead's business name",
"disabled": false
},
{
"key": "mobile_num",
"value": "13",
"description": "Search term for lead's mobile number",
"disabled": false
},
{
"key": "contact_id",
"value": "accusantium",
"description": "Search term for lead's contact_id. Ex(CO0005)",
"disabled": false
},
{
"key": "order_by",
"value": "in",
"description": "Column name to sort the result, Column: name, supplier_business_name",
"disabled": false
},
{
"key": "direction",
"value": "desc",
"description": "Direction to sort the result, Required if using 'order_by', direction: desc, asc",
"disabled": false
},
{
"key": "per_page",
"value": "10",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Save Call Logs",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/crm\/call-logs",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"call_logs\": [\n {\n \"mobile_number\": \"quidem\",\n \"mobile_name\": \"id\",\n \"call_type\": \"call\",\n \"start_time\": \"earum\",\n \"end_time\": \"ducimus\",\n \"duration\": \"modi\"\n }\n ]\n}"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Cash register management",
"description": "",
"item": [
{
"name": "List Cash Registers",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/cash-register",
"query": [
{
"key": "status",
"value": "open",
"description": "status of the register (open, close)",
"disabled": false
},
{
"key": "user_id",
"value": "10",
"description": "id of the user",
"disabled": false
},
{
"key": "start_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "end_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "location_id",
"value": "1",
"description": "id of the location",
"disabled": false
},
{
"key": "per_page",
"value": "15",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Create Cash Register",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/cash-register",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"location_id\": 1,\n \"initial_amount\": 15117.279,\n \"created_at\": \"2020-5-7 15:20:22\",\n \"closed_at\": \"2020-5-7 15:20:22\",\n \"status\": \"close\",\n \"closing_amount\": 266.1992584,\n \"total_card_slips\": 16,\n \"total_cheques\": 19,\n \"closing_note\": \"dolores\",\n \"transaction_ids\": \"1,2,3\"\n}"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified Register",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/cash-register\/:cash_register",
"query": [],
"variable": [
{
"id": "cash_register",
"key": "cash_register",
"value": "59",
"description": "comma separated ids of the cash registers"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Contact management",
"description": "",
"item": [
{
"name": "List contact",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/contactapi",
"query": [
{
"key": "type",
"value": "quia",
"description": "Type of contact (supplier, customer)",
"disabled": false
},
{
"key": "name",
"value": "amet",
"description": "Search term for contact name",
"disabled": false
},
{
"key": "biz_name",
"value": "nisi",
"description": "Search term for contact's business name",
"disabled": false
},
{
"key": "mobile_num",
"value": "10",
"description": "Search term for contact's mobile number",
"disabled": false
},
{
"key": "contact_id",
"value": "totam",
"description": "Search term for contact's contact_id. Ex(CO0005)",
"disabled": false
},
{
"key": "order_by",
"value": "non",
"description": "Column name to sort the result, Column: name, supplier_business_name",
"disabled": false
},
{
"key": "direction",
"value": "et",
"description": "Direction to sort the result, Direction: desc, asc",
"disabled": false
},
{
"key": "per_page",
"value": "10",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Create contact",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/contactapi",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"customer\",\n \"supplier_business_name\": \"rerum\",\n \"prefix\": \"dolores\",\n \"first_name\": \"rerum\",\n \"middle_name\": \"id\",\n \"last_name\": \"rerum\",\n \"tax_number\": \"8787fefef\",\n \"pay_term_number\": 3,\n \"pay_term_type\": \"months\",\n \"mobile\": \"4578691009\",\n \"landline\": \"5487-8454-4145\",\n \"alternate_number\": \"841847541222\",\n \"address_line_1\": \"eius\",\n \"address_line_2\": \"ea\",\n \"city\": \"excepturi\",\n \"state\": \"nisi\",\n \"country\": \"voluptas\",\n \"zip_code\": \"nobis\",\n \"customer_group_id\": \"consequuntur\",\n \"contact_id\": \"est\",\n \"dob\": \"2000-06-13\",\n \"custom_field1\": \"perferendis\",\n \"custom_field2\": \"aliquam\",\n \"custom_field3\": \"velit\",\n \"custom_field4\": \"omnis\",\n \"email\": \"labore\",\n \"shipping_address\": \"recusandae\",\n \"position\": \"et\",\n \"opening_balance\": 0,\n \"source_id\": 11,\n \"life_stage_id\": 6,\n \"assigned_to\": []\n}"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified contact",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/contactapi\/:contactapi",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Update contact",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/contactapi\/:contactapi",
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"customer\",\n \"supplier_business_name\": \"harum\",\n \"prefix\": \"ad\",\n \"first_name\": \"sunt\",\n \"middle_name\": \"provident\",\n \"last_name\": \"cumque\",\n \"tax_number\": \"488744dwd\",\n \"pay_term_number\": 3,\n \"pay_term_type\": \"months\",\n \"mobile\": \"8795461009\",\n \"landline\": \"65484-848-848\",\n \"alternate_number\": \"9898795220\",\n \"address_line_1\": \"necessitatibus\",\n \"address_line_2\": \"rem\",\n \"city\": \"voluptatum\",\n \"state\": \"veritatis\",\n \"country\": \"dolor\",\n \"zip_code\": \"ipsam\",\n \"customer_group_id\": \"nihil\",\n \"contact_id\": \"omnis\",\n \"dob\": \"2000-06-13\",\n \"custom_field1\": \"maxime\",\n \"custom_field2\": \"nulla\",\n \"custom_field3\": \"aspernatur\",\n \"custom_field4\": \"rerum\",\n \"email\": \"maiores\",\n \"shipping_address\": \"laboriosam\",\n \"position\": \"eum\",\n \"opening_balance\": 10.3,\n \"source_id\": 20,\n \"life_stage_id\": 16,\n \"assigned_to\": []\n}"
},
"description": "",
"response": []
}
},
{
"name": "Contact payment",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/contactapi-payment",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"contact_id\": 17,\n \"amount\": 453.13,\n \"method\": \"cash\",\n \"paid_on\": \"2020-07-22 15:48:29\",\n \"account_id\": 19,\n \"card_number\": \"animi\",\n \"card_holder_name\": \"corporis\",\n \"card_transaction_number\": \"et\",\n \"card_type\": \"ea\",\n \"card_month\": \"aut\",\n \"card_year\": \"et\",\n \"card_security\": \"odio\",\n \"transaction_no_1\": \"fugiat\",\n \"transaction_no_2\": \"rem\",\n \"transaction_no_3\": \"quos\",\n \"cheque_number\": \"ipsam\",\n \"bank_account_number\": \"modi\",\n \"note\": \"eum\"\n}"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Expense management",
"description": "",
"item": [
{
"name": "List expenses",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/expense",
"query": [
{
"key": "location_id",
"value": "1",
"description": "id of the location",
"disabled": false
},
{
"key": "payment_status",
"value": "paid",
"description": "payment status",
"disabled": false
},
{
"key": "start_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "end_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "expense_for",
"value": "rerum",
"description": "id of the user for which expense is created",
"disabled": false
},
{
"key": "per_page",
"value": "15",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Create expense \/ expense refund",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/expense",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"location_id\": 1,\n \"final_total\": 6889970.550549487,\n \"transaction_date\": \"2020-5-7 15:20:22\",\n \"tax_rate_id\": 5,\n \"expense_for\": 6,\n \"contact_id\": 10,\n \"expense_category_id\": 13,\n \"expense_sub_category_id\": 6,\n \"additional_notes\": \"harum\",\n \"is_refund\": 0,\n \"is_recurring\": 0,\n \"recur_interval\": 2,\n \"recur_interval_type\": \"months\",\n \"subscription_repeat_on\": 15,\n \"subscription_no\": \"in\",\n \"recur_repetitions\": 4,\n \"payment\": [\n {\n \"amount\": 453.13,\n \"method\": \"cash\",\n \"account_id\": 7,\n \"card_number\": \"qui\",\n \"card_holder_name\": \"nulla\",\n \"card_transaction_number\": \"officia\",\n \"card_type\": \"velit\",\n \"card_month\": \"totam\",\n \"card_year\": \"quos\",\n \"card_security\": \"et\",\n \"transaction_no_1\": \"minima\",\n \"transaction_no_2\": \"nobis\",\n \"transaction_no_3\": \"consequuntur\",\n \"note\": \"delectus\",\n \"cheque_number\": \"id\"\n }\n ]\n}"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified expense \/ expense refund",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/expense\/:expense",
"query": [],
"variable": [
{
"id": "expense",
"key": "expense",
"value": "59",
"description": "comma separated ids of the expenses"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Update expense \/ expense refund",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/expense\/:expense",
"query": []
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"final_total\": 2184.722549335,\n \"transaction_date\": \"2020-5-7 15:20:22\",\n \"tax_rate_id\": 19,\n \"expense_for\": 4,\n \"contact_id\": 2,\n \"expense_category_id\": 14,\n \"expense_sub_category_id\": 20,\n \"additional_notes\": \"suscipit\",\n \"is_recurring\": 0,\n \"recur_interval\": 13,\n \"recur_interval_type\": \"months\",\n \"subscription_repeat_on\": 15,\n \"subscription_no\": \"illum\",\n \"recur_repetitions\": 11,\n \"payment\": []\n}"
},
"description": "",
"response": []
}
},
{
"name": "List expense refunds",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/expense-refund",
"query": [
{
"key": "location_id",
"value": "1",
"description": "id of the location",
"disabled": false
},
{
"key": "payment_status",
"value": "paid",
"description": "payment status",
"disabled": false
},
{
"key": "start_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "end_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "expense_for",
"value": "beatae",
"description": "id of the user for which expense is created",
"disabled": false
},
{
"key": "per_page",
"value": "15",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "List expense categories",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/expense-categories",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Field Force",
"description": "",
"item": [
{
"name": "List visits",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/field-force",
"query": [
{
"key": "contact_id",
"value": "at",
"description": "id of the contact",
"disabled": false
},
{
"key": "assigned_to",
"value": "rerum",
"description": "id of the assigned user",
"disabled": false
},
{
"key": "status",
"value": "doloremque",
"description": "status of the visit (assigned, finished)",
"disabled": false
},
{
"key": "start_date",
"value": "2018-06-25",
"description": "Start date filter for visit on format:Y-m-d",
"disabled": false
},
{
"key": "end_date",
"value": "2018-06-25",
"description": "End date filter for visit on format:Y-m-d",
"disabled": false
},
{
"key": "per_page",
"value": "15",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
},
{
"key": "order_by_date",
"value": "desc",
"description": "Sort visit by visit on date ('asc', 'desc')",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Create Visit",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/field-force\/create",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"contact_id\": 17,\n \"visit_to\": \"perspiciatis\",\n \"visit_address\": \"nobis\",\n \"assigned_to\": 3,\n \"visit_on\": \"2021-12-28 17:23:00\",\n \"visit_for\": \"sequi\"\n}"
},
"description": "",
"response": []
}
},
{
"name": "Update Visit status",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/field-force\/update-visit-status\/:id",
"query": [],
"variable": [
{
"id": "id",
"key": "id",
"value": "17",
"description": "id of the visit to be updated"
}
]
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"status\": \"finished\",\n \"reason_to_not_meet_contact\": \"enim\",\n \"visited_on\": \"2021-12-28 17:23:00\",\n \"visited_address\": \"Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India\",\n \"latitude\": \"41.40338\",\n \"longitude\": \"2.17403\",\n \"comments\": \"ut\",\n \"photo\": \"dolore\"\n}"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Product management",
"description": "",
"item": [
{
"name": "List products",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/product",
"query": [
{
"key": "order_by",
"value": "maxime",
"description": "Values: product_name or newest",
"disabled": false
},
{
"key": "order_direction",
"value": "dolores",
"description": "Values: asc or desc",
"disabled": false
},
{
"key": "brand_id",
"value": "qui",
"description": "comma separated ids of one or multiple brands",
"disabled": false
},
{
"key": "category_id",
"value": "quaerat",
"description": "comma separated ids of one or multiple category",
"disabled": false
},
{
"key": "sub_category_id",
"value": "consequuntur",
"description": "comma separated ids of one or multiple sub-category",
"disabled": false
},
{
"key": "location_id",
"value": "1",
"description": "",
"disabled": false
},
{
"key": "selling_price_group",
"value": "quis",
"description": "(1, 0)",
"disabled": false
},
{
"key": "send_lot_detail",
"value": "aut",
"description": "Send lot details in each variation location details(1, 0)",
"disabled": false
},
{
"key": "name",
"value": "non",
"description": "Search term for product name",
"disabled": false
},
{
"key": "sku",
"value": "non",
"description": "Search term for product sku",
"disabled": false
},
{
"key": "per_page",
"value": "10",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified product",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/product\/:product",
"query": [
{
"key": "selling_price_group",
"value": "qui",
"description": "(1, 0)",
"disabled": false
},
{
"key": "send_lot_detail",
"value": "et",
"description": "Send lot details in each variation location details(1, 0)",
"disabled": false
}
],
"variable": [
{
"id": "product",
"key": "product",
"value": "1",
"description": "comma separated ids of products"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "List Selling Price Group",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/selling-price-group",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "List Variations",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/variation\/:id",
"query": [
{
"key": "product_id",
"value": "velit",
"description": "Filter by comma separated products ids",
"disabled": false
},
{
"key": "location_id",
"value": "1",
"description": "",
"disabled": false
},
{
"key": "brand_id",
"value": "quia",
"description": "",
"disabled": false
},
{
"key": "category_id",
"value": "necessitatibus",
"description": "",
"disabled": false
},
{
"key": "sub_category_id",
"value": "exercitationem",
"description": "",
"disabled": false
},
{
"key": "not_for_selling",
"value": "numquam",
"description": "Values: 0 or 1",
"disabled": false
},
{
"key": "name",
"value": "eos",
"description": "Search term for product name",
"disabled": false
},
{
"key": "sku",
"value": "perferendis",
"description": "Search term for product sku",
"disabled": false
},
{
"key": "per_page",
"value": "10",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Sales management",
"description": "",
"item": [
{
"name": "List sells",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/sell",
"query": [
{
"key": "location_id",
"value": "1",
"description": "id of the location",
"disabled": false
},
{
"key": "contact_id",
"value": "aut",
"description": "id of the customer",
"disabled": false
},
{
"key": "payment_status",
"value": "due%2Cpartial",
"description": "Comma separated values of payment statuses. Available values due, partial, paid, overdue",
"disabled": false
},
{
"key": "start_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "end_date",
"value": "2018-06-25",
"description": "format:Y-m-d",
"disabled": false
},
{
"key": "user_id",
"value": "fugit",
"description": "id of the user who created the sale",
"disabled": false
},
{
"key": "service_staff_id",
"value": "omnis",
"description": "id of the service staff assigned with the sale",
"disabled": false
},
{
"key": "shipping_status",
"value": "ordered",
"description": "Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')",
"disabled": false
},
{
"key": "source",
"value": "ipsam",
"description": "Source of the sale",
"disabled": false
},
{
"key": "only_subscriptions",
"value": "dolorem",
"description": "Filter only subcription invoices (1, 0)",
"disabled": false
},
{
"key": "send_purchase_details",
"value": "odit",
"description": "Get purchase details of each sell line (1, 0)",
"disabled": false
},
{
"key": "order_by_date",
"value": "desc",
"description": "Sort sell list by date ('asc', 'desc')",
"disabled": false
},
{
"key": "per_page",
"value": "10",
"description": "Total records per page. default: 10, Set -1 for no pagination",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Create sell",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/sell",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"sells\": [\n {\n \"location_id\": 1,\n \"contact_id\": 15,\n \"transaction_date\": \"2020-07-22 15:48:29\",\n \"invoice_no\": \"autem\",\n \"source\": \"api, phone, woocommerce\",\n \"status\": \"final\",\n \"sub_status\": \"null\",\n \"is_quotation\": true,\n \"tax_rate_id\": 11,\n \"discount_amount\": 10,\n \"discount_type\": \"fixed\",\n \"sale_note\": \"doloribus\",\n \"staff_note\": \"nostrum\",\n \"commission_agent\": 17,\n \"shipping_details\": \"Express Delivery\",\n \"shipping_address\": \"aliquid\",\n \"shipping_status\": \"ordered\",\n \"delivered_to\": \"'Mr robin'\",\n \"shipping_charges\": 10,\n \"packing_charge\": 10,\n \"exchange_rate\": 1,\n \"selling_price_group_id\": 16,\n \"pay_term_number\": 3,\n \"pay_term_type\": \"months\",\n \"is_suspend\": false,\n \"is_recurring\": 0,\n \"recur_interval\": 14,\n \"recur_interval_type\": \"months\",\n \"subscription_repeat_on\": 15,\n \"subscription_no\": \"vel\",\n \"recur_repetitions\": 12,\n \"rp_redeemed\": 20,\n \"rp_redeemed_amount\": 13.5,\n \"types_of_service_id\": 20,\n \"service_custom_field_1\": \"repudiandae\",\n \"service_custom_field_2\": \"voluptas\",\n \"service_custom_field_3\": \"corporis\",\n \"service_custom_field_4\": \"sed\",\n \"service_custom_field_5\": \"accusantium\",\n \"service_custom_field_6\": \"ab\",\n \"round_off_amount\": 284236738.5747075,\n \"table_id\": 19,\n \"service_staff_id\": 7,\n \"change_return\": 0,\n \"products\": [\n {\n \"product_id\": 17,\n \"variation_id\": 58,\n \"quantity\": 1,\n \"unit_price\": 437.5,\n \"tax_rate_id\": 0,\n \"discount_amount\": 0,\n \"discount_type\": \"percentage\",\n \"sub_unit_id\": 2,\n \"note\": \"quia\"\n }\n ],\n \"payments\": [\n {\n \"amount\": 453.13,\n \"method\": \"cash\",\n \"account_id\": 5,\n \"card_number\": \"est\",\n \"card_holder_name\": \"qui\",\n \"card_transaction_number\": \"dolore\",\n \"card_type\": \"quae\",\n \"card_month\": \"ullam\",\n \"card_year\": \"occaecati\",\n \"card_security\": \"incidunt\",\n \"transaction_no_1\": \"officia\",\n \"transaction_no_2\": \"beatae\",\n \"transaction_no_3\": \"necessitatibus\",\n \"bank_account_number\": \"veritatis\",\n \"note\": \"qui\",\n \"cheque_number\": \"expedita\"\n }\n ]\n }\n ]\n}"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified sell",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/sell\/:sell",
"query": [
{
"key": "send_purchase_details",
"value": "doloremque",
"description": "Get purchase details of each sell line (1, 0)",
"disabled": false
}
],
"variable": [
{
"id": "sell",
"key": "sell",
"value": "55",
"description": "comma separated ids of the sells"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Update sell",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/sell\/:sell",
"query": [],
"variable": [
{
"id": "sell",
"key": "sell",
"value": "6",
"description": "id of sell to update"
}
]
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"contact_id\": 9,\n \"transaction_date\": \"2020-5-7 15:20:22\",\n \"status\": \"final\",\n \"sub_status\": \"null\",\n \"is_quotation\": true,\n \"tax_rate_id\": 20,\n \"discount_amount\": 10,\n \"discount_type\": \"fixed\",\n \"sale_note\": \"reprehenderit\",\n \"source\": \"nesciunt\",\n \"staff_note\": \"expedita\",\n \"is_suspend\": false,\n \"commission_agent\": 1,\n \"shipping_details\": \"Express Delivery\",\n \"shipping_address\": \"optio\",\n \"shipping_status\": \"ordered\",\n \"delivered_to\": \"Mr Robin\",\n \"shipping_charges\": 10,\n \"packing_charge\": 10,\n \"exchange_rate\": 1,\n \"selling_price_group_id\": 13,\n \"pay_term_number\": 11,\n \"pay_term_type\": \"months\",\n \"is_recurring\": 0,\n \"recur_interval\": 5,\n \"recur_interval_type\": \"days\",\n \"subscription_repeat_on\": 7,\n \"subscription_no\": \"minus\",\n \"recur_repetitions\": 10,\n \"rp_redeemed\": 4,\n \"rp_redeemed_amount\": 13.5,\n \"types_of_service_id\": 2,\n \"service_custom_field_1\": \"quae\",\n \"service_custom_field_2\": \"aut\",\n \"service_custom_field_3\": \"facilis\",\n \"service_custom_field_4\": \"excepturi\",\n \"service_custom_field_5\": \"eligendi\",\n \"service_custom_field_6\": \"numquam\",\n \"round_off_amount\": 2431065,\n \"table_id\": 15,\n \"service_staff_id\": 12,\n \"change_return\": 0,\n \"change_return_id\": 1,\n \"products\": [\n {\n \"sell_line_id\": 9,\n \"product_id\": 17,\n \"variation_id\": 58,\n \"quantity\": 1,\n \"unit_price\": 437.5,\n \"tax_rate_id\": 13,\n \"discount_amount\": 0,\n \"discount_type\": \"percentage\",\n \"sub_unit_id\": 17,\n \"note\": \"magnam\"\n }\n ],\n \"payments\": [\n {\n \"payment_id\": 3,\n \"amount\": 453.13,\n \"method\": \"cash\",\n \"account_id\": 14,\n \"card_number\": \"rerum\",\n \"card_holder_name\": \"voluptatem\",\n \"card_transaction_number\": \"tempore\",\n \"card_type\": \"voluptas\",\n \"card_month\": \"laboriosam\",\n \"card_year\": \"maxime\",\n \"card_security\": \"aperiam\",\n \"transaction_no_1\": \"exercitationem\",\n \"transaction_no_2\": \"inventore\",\n \"transaction_no_3\": \"est\",\n \"note\": \"et\",\n \"cheque_number\": \"officiis\",\n \"bank_account_number\": \"est\"\n }\n ]\n}"
},
"description": "",
"response": []
}
},
{
"name": "Delete Sell",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/sell\/:sell",
"query": [],
"variable": [
{
"id": "sell",
"key": "sell",
"value": "at",
"description": "id of the sell to be deleted"
}
]
},
"method": "DELETE",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Add Sell Return",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/sell-return",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"transaction_id\": 12,\n \"transaction_date\": \"2020-5-7 15:20:22\",\n \"invoice_no\": \"sequi\",\n \"discount_amount\": 10,\n \"discount_type\": \"fixed\",\n \"products\": [\n {\n \"sell_line_id\": 18,\n \"quantity\": 1,\n \"unit_price_inc_tax\": 437.5\n }\n ]\n}"
},
"description": "",
"response": []
}
},
{
"name": "List Sell Return",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/list-sell-return",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Update shipping status",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/update-shipping-status",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"id\": 4,\n \"shipping_status\": \"ordered\",\n \"delivered_to\": \"esse\"\n}"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Superadmin",
"description": "",
"item": [
{
"name": "If SaaS installed get active subscription details, else return the enabled modules details in package_details",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/active-subscription",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get Superadmin Package List",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/packages",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Table management",
"description": "",
"item": [
{
"name": "List tables",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/table",
"query": [
{
"key": "location_id",
"value": "1",
"description": "int id of the location",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Show the specified table",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/table\/:table",
"query": [],
"variable": [
{
"id": "table",
"key": "table",
"value": "5",
"description": "comma separated ids of required tables"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Tax management",
"description": "",
"item": [
{
"name": "List taxes",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/tax",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified tax",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/tax\/:tax",
"query": [],
"variable": [
{
"id": "tax",
"key": "tax",
"value": "1",
"description": "comma separated ids of required taxes"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Taxonomy management",
"description": "",
"item": [
{
"name": "List taxonomy",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/taxonomy",
"query": [
{
"key": "type",
"value": "est",
"description": "Type of taxonomy (product, device, hrm_department)",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified taxonomy",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/taxonomy\/:taxonomy",
"query": [],
"variable": [
{
"id": "taxonomy",
"key": "taxonomy",
"value": "1",
"description": "comma separated ids of product categories"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Types of service management",
"description": "",
"item": [
{
"name": "List types of service",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/types-of-service",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified types of service",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/types-of-service\/:types_of_service",
"query": [],
"variable": [
{
"id": "types_of_service",
"key": "types_of_service",
"value": "1",
"description": "comma separated ids of required types of services"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "Unit management",
"description": "",
"item": [
{
"name": "List units",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/unit",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified unit",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/unit\/:unit",
"query": [],
"variable": [
{
"id": "unit",
"key": "unit",
"value": "1",
"description": "comma separated ids of the units"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
}
]
},
{
"name": "User management",
"description": "",
"item": [
{
"name": "Get the loggedin user details.",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/user\/loggedin",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Register User",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/user-registration",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"surname\": \"praesentium\",\n \"first_name\": \"consequatur\",\n \"last_name\": \"perspiciatis\",\n \"email\": \"nobis\",\n \"is_active\": \"soluta\",\n \"user_type\": \"tempore\",\n \"crm_contact_id\": 20,\n \"allow_login\": false,\n \"username\": \"eos\",\n \"password\": \"ut\",\n \"role\": 16,\n \"access_all_locations\": false,\n \"location_permissions\": [],\n \"cmmsn_percent\": \"minus\",\n \"max_sales_discount_percent\": \"quas\",\n \"selected_contacts\": true,\n \"selected_contact_ids\": [],\n \"dob\": \"perspiciatis\",\n \"gender\": \"quidem\",\n \"marital_status\": \"earum\",\n \"blood_group\": \"libero\",\n \"contact_number\": \"dignissimos\",\n \"alt_number\": \"aut\",\n \"family_number\": \"consequatur\",\n \"fb_link\": \"architecto\",\n \"twitter_link\": \"maxime\",\n \"social_media_1\": \"eum\",\n \"social_media_2\": \"natus\",\n \"custom_field_1\": \"voluptatibus\",\n \"custom_field_2\": \"illum\",\n \"custom_field_3\": \"reiciendis\",\n \"custom_field_4\": \"iste\",\n \"guardian_name\": \"pariatur\",\n \"id_proof_name\": \"reiciendis\",\n \"id_proof_number\": \"itaque\",\n \"permanent_address\": \"perferendis\",\n \"current_address\": \"voluptatibus\",\n \"bank_details\": [\n {\n \"account_holder_name\": \"consequuntur\",\n \"account_number\": \"vel\",\n \"bank_name\": \"ipsa\",\n \"bank_code\": \"magni\",\n \"branch\": \"perspiciatis\",\n \"tax_payer_id\": \"architecto\"\n }\n ]\n}"
},
"description": "",
"response": []
}
},
{
"name": "List users",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/user",
"query": [
{
"key": "service_staff",
"value": "placeat",
"description": "boolean Filter service staffs from users list (0, 1)",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get the specified user",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/user\/:user",
"query": [],
"variable": [
{
"id": "user",
"key": "user",
"value": "1",
"description": "comma separated ids of the required users"
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Update user password.",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/update-password",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"current_password\": \"libero\",\n \"new_password\": \"molestiae\"\n}"
},
"description": "",
"response": []
}
},
{
"name": "Recover forgotten password.",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/forget-password",
"query": []
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"email\": \"qui\"\n}"
},
"description": "",
"response": []
}
}
]
},
{
"name": "general",
"description": "",
"item": [
{
"name": "List payment accounts",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/payment-accounts",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "List payment methods",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/payment-methods",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get business details",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/business-details",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get profit and loss report",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/profit-loss-report",
"query": [
{
"key": "location_id",
"value": "1",
"description": "optional id of the location",
"disabled": false
},
{
"key": "start_date",
"value": "2018-06-25",
"description": "optional format:Y-m-d",
"disabled": false
},
{
"key": "end_date",
"value": "2018-06-25",
"description": "optional format:Y-m-d",
"disabled": false
},
{
"key": "user_id",
"value": "1",
"description": "optional id of the user",
"disabled": false
}
]
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get product current stock",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/product-stock-report",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get notifications",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/notifications",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "[]"
},
"description": "",
"response": []
}
},
{
"name": "Get location details from coordinates",
"request": {
"url": {
"protocol": "https",
"host": "richineiapps.com\/public",
"path": "connector\/api\/get-location",
"query": []
},
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application\/json"
},
{
"key": "Accept",
"value": "application\/json"
},
{
"key": "Authorization",
"value": "Bearer {token}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"lat\": \"41.40338\",\n \"lon\": \"2.17403\"\n}"
},
"description": "",
"response": []
}
}
]
}
]
}