Info
Welcome to the generated API reference. Get Postman Collection
Attendance management
Get Attendance
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/get-attendance/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/get-attendance/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 4,
"user_id": 1,
"business_id": 1,
"clock_in_time": "2020-09-12 13:13:00",
"clock_out_time": "2020-09-12 13:15:00",
"essentials_shift_id": 3,
"ip_address": null,
"clock_in_note": "test clock in from api",
"clock_out_note": "test clock out from api",
"created_at": "2020-09-12 13:14:39",
"updated_at": "2020-09-12 13:15:39"
}
}HTTP Request
GET connector/api/get-attendance/{user_id}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
user_id |
required | id of the user |
Clock In
Requires authentication
[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock in]
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/clock-in" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_id":1,"clock_in_time":"2000-06-13 13:13:00","clock_in_note":"assumenda","ip_address":"molestias","latitude":"quisquam","longitude":"similique"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/clock-in"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_id": 1,
"clock_in_time": "2000-06-13 13:13:00",
"clock_in_note": "assumenda",
"ip_address": "molestias",
"latitude": "quisquam",
"longitude": "similique"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"success": true,
"msg": "Clocked In successfully",
"type": "clock_in"
}HTTP Request
POST connector/api/clock-in
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
user_id |
integer | required | id of the user |
clock_in_time |
string | optional | Clock in time.If not given current date time will be used Fromat: Y-m-d H:i:s |
clock_in_note |
string | optional | Clock in note. |
ip_address |
string | optional | IP address. |
latitude |
string | optional | Latitude of the clock in location. |
longitude |
string | optional | Longitude of the clock in location. |
Clock Out
Requires authentication
[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock out]
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/clock-out" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_id":1,"clock_out_time":"2000-06-13 13:13:00","clock_out_note":"quisquam","latitude":"velit","longitude":"vel"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/clock-out"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_id": 1,
"clock_out_time": "2000-06-13 13:13:00",
"clock_out_note": "quisquam",
"latitude": "velit",
"longitude": "vel"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"success": true,
"msg": "Clocked Out successfully",
"type": "clock_out"
}HTTP Request
POST connector/api/clock-out
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
user_id |
integer | required | id of the user |
clock_out_time |
string | optional | Clock out time.If not given current date time will be used Fromat: Y-m-d H:i:s |
clock_out_note |
string | optional | Clock out note. |
latitude |
string | optional | Latitude of the clock out location. |
longitude |
string | optional | Longitude of the clock out location. |
List Holidays
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/holidays?location_id=1&start_date=2020-06-25&end_date=2020-06-25" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/holidays"
);
let params = {
"location_id": "1",
"start_date": "2020-06-25",
"end_date": "2020-06-25",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 2,
"name": "Independence Day",
"start_date": "2020-08-15",
"end_date": "2020-09-15",
"business_id": 1,
"location_id": null,
"note": "test holiday",
"created_at": "2020-09-15 11:25:56",
"updated_at": "2020-09-15 11:25:56"
}
]
}HTTP Request
GET connector/api/holidays
Query Parameters
| Parameter | Status | Description |
|---|---|---|
location_id |
optional | id of the location |
start_date |
optional | format:Y-m-d |
end_date |
optional | format:Y-m-d |
Brand management
List brands
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/brand" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/brand"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"name": "Levis",
"description": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 21:19:47",
"updated_at": "2018-01-03 21:19:47"
},
{
"id": 2,
"business_id": 1,
"name": "Espirit",
"description": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 21:19:58",
"updated_at": "2018-01-03 21:19:58"
}
]
}HTTP Request
GET connector/api/brand
Get the specified brand
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/brand/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/brand/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"name": "Levis",
"description": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 21:19:47",
"updated_at": "2018-01-03 21:19:47"
}
]
}HTTP Request
GET connector/api/brand/{brand}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
brand |
required | comma separated ids of the brands |
Business Location management
List business locations
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/business-location" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/business-location"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"location_id": null,
"name": "Awesome Shop",
"landmark": "Linking Street",
"country": "USA",
"state": "Arizona",
"city": "Phoenix",
"zip_code": "85001",
"invoice_scheme_id": 1,
"invoice_layout_id": 1,
"selling_price_group_id": null,
"print_receipt_on_invoice": 1,
"receipt_printer_type": "browser",
"printer_id": null,
"mobile": null,
"alternate_number": null,
"email": null,
"website": null,
"featured_products": [
"5",
"71"
],
"is_active": 1,
"payment_methods": [
{
"name": "cash",
"label": "Cash",
"account_id": "1"
},
{
"name": "card",
"label": "Card",
"account_id": null
},
{
"name": "cheque",
"label": "Cheque",
"account_id": null
},
{
"name": "bank_transfer",
"label": "Bank Transfer",
"account_id": null
},
{
"name": "other",
"label": "Other",
"account_id": null
},
{
"name": "custom_pay_1",
"label": "Custom Payment 1",
"account_id": null
},
{
"name": "custom_pay_2",
"label": "Custom Payment 2",
"account_id": null
},
{
"name": "custom_pay_3",
"label": "Custom Payment 3",
"account_id": null
}
],
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:20",
"updated_at": "2020-06-05 00:56:54"
}
]
}HTTP Request
GET connector/api/business-location
Get the specified business location
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/business-location/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/business-location/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"location_id": null,
"name": "Awesome Shop",
"landmark": "Linking Street",
"country": "USA",
"state": "Arizona",
"city": "Phoenix",
"zip_code": "85001",
"invoice_scheme_id": 1,
"invoice_layout_id": 1,
"selling_price_group_id": null,
"print_receipt_on_invoice": 1,
"receipt_printer_type": "browser",
"printer_id": null,
"mobile": null,
"alternate_number": null,
"email": null,
"website": null,
"featured_products": [
"5",
"71"
],
"is_active": 1,
"payment_methods": [
{
"name": "cash",
"label": "Cash",
"account_id": "1"
},
{
"name": "card",
"label": "Card",
"account_id": null
},
{
"name": "cheque",
"label": "Cheque",
"account_id": null
},
{
"name": "bank_transfer",
"label": "Bank Transfer",
"account_id": null
},
{
"name": "other",
"label": "Other",
"account_id": null
},
{
"name": "custom_pay_1",
"label": "Custom Payment 1",
"account_id": null
},
{
"name": "custom_pay_2",
"label": "Custom Payment 2",
"account_id": null
},
{
"name": "custom_pay_3",
"label": "Custom Payment 3",
"account_id": null
}
],
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:20",
"updated_at": "2020-06-05 00:56:54"
}
]
}HTTP Request
GET connector/api/business-location/{business_location}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
location |
required | comma separated ids of the business location |
CRM
List Follow ups
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/crm/follow-ups?start_date=2020-12-16&end_date=2020-12-16&status=modi&follow_up_type=et&followup_category_id=quos&order_by=start_datetime&direction=desc&per_page=10" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/crm/follow-ups"
);
let params = {
"start_date": "2020-12-16",
"end_date": "2020-12-16",
"status": "modi",
"follow_up_type": "et",
"followup_category_id": "quos",
"order_by": "start_datetime",
"direction": "desc",
"per_page": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"contact_id": 50,
"title": "Test Follow up",
"status": "scheduled",
"start_datetime": "2020-12-16 15:15:00",
"end_datetime": "2020-12-16 15:15:00",
"description": "<p>tst<\/p>",
"schedule_type": "call",
"allow_notification": 0,
"notify_via": {
"sms": 0,
"mail": 1
},
"notify_before": null,
"notify_type": "minute",
"created_by": 1,
"followup_additional_info": null,
"created_at": "2020-12-16 03:15:23",
"updated_at": "2020-12-16 15:46:34",
"customer": {
"id": 50,
"business_id": 1,
"type": "lead",
"supplier_business_name": null,
"name": " Lead 4 ",
"prefix": null,
"first_name": "Lead 4",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CO0011",
"contact_status": "active",
"tax_number": null,
"city": null,
"state": null,
"country": null,
"address_line_1": null,
"address_line_2": null,
"zip_code": null,
"dob": null,
"mobile": "234567",
"landline": null,
"alternate_number": null,
"pay_term_number": null,
"pay_term_type": null,
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 0,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": "55",
"crm_life_stage": "62",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"deleted_at": null,
"created_at": "2020-12-15 23:14:48",
"updated_at": "2021-01-07 15:32:52",
"remember_token": null,
"password": null
}
},
{
"id": 2,
"business_id": 1,
"contact_id": 50,
"title": "Test Follow up 1",
"status": "completed",
"start_datetime": "2020-12-16 15:46:00",
"end_datetime": "2020-12-16 15:46:00",
"description": "<p>Test Follow up<\/p>",
"schedule_type": "call",
"allow_notification": 0,
"notify_via": {
"sms": 0,
"mail": 1
},
"notify_before": null,
"notify_type": "minute",
"created_by": 1,
"followup_additional_info": null,
"created_at": "2020-12-16 15:46:57",
"updated_at": "2020-12-17 10:24:11",
"customer": {
"id": 50,
"business_id": 1,
"type": "lead",
"supplier_business_name": null,
"name": " Lead 4 ",
"prefix": null,
"first_name": "Lead 4",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CO0011",
"contact_status": "active",
"tax_number": null,
"city": null,
"state": null,
"country": null,
"address_line_1": null,
"address_line_2": null,
"zip_code": null,
"dob": null,
"mobile": "234567",
"landline": null,
"alternate_number": null,
"pay_term_number": null,
"pay_term_type": null,
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 0,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": "55",
"crm_life_stage": "62",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"deleted_at": null,
"created_at": "2020-12-15 23:14:48",
"updated_at": "2021-01-07 15:32:52",
"remember_token": null,
"password": null
}
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/crm\/follow-ups?page=1",
"last": "http:\/\/local.pos.com\/connector\/api\/crm\/follow-ups?page=21",
"prev": null,
"next": "http:\/\/local.pos.com\/connector\/api\/crm\/follow-ups?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 21,
"path": "http:\/\/local.pos.com\/connector\/api\/crm\/follow-ups",
"per_page": "2",
"to": 2,
"total": 42
}
}HTTP Request
GET connector/api/crm/follow-ups
Query Parameters
| Parameter | Status | Description |
|---|---|---|
start_date |
optional | format: Y-m-d (Ex: 2020-12-16) |
end_date |
optional | format: Y-m-d (Ex: 2020-12-16) |
status |
optional | filter the result through status, get status from getFollowUpResources->statuses |
follow_up_type |
optional | filter the result through follow_up_type, get follow_up_type from getFollowUpResources->follow_up_types |
followup_category_id |
optional | filter the result through followup_category_id |
order_by |
optional | Column name to sort the result, Column: start_datetime |
direction |
optional | Direction to sort the result, Required if using 'order_by', direction: desc, asc |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Add follow up
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/crm/follow-ups" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"Meeting with client","contact_id":2,"description":"odio","schedule_type":"possimus","user_id":"[2,3,5]","notify_before":5,"notify_type":"minute","status":"open","notify_via":"['sms' => 0 ,'mail' => 1]","start_datetime":"2021-01-06 13:05:00","end_datetime":"2021-01-06 13:05:00","followup_additional_info":"['call duration' => '1 hour']","allow_notification":true}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/crm/follow-ups"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "Meeting with client",
"contact_id": 2,
"description": "odio",
"schedule_type": "possimus",
"user_id": "[2,3,5]",
"notify_before": 5,
"notify_type": "minute",
"status": "open",
"notify_via": "['sms' => 0 ,'mail' => 1]",
"start_datetime": "2021-01-06 13:05:00",
"end_datetime": "2021-01-06 13:05:00",
"followup_additional_info": "['call duration' => '1 hour']",
"allow_notification": true
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"title": "test",
"contact_id": "1",
"description": null,
"schedule_type": "call",
"followup_category_id": "1",
"notify_before": null,
"status": null,
"start_datetime": "2021-01-06 15:27:00",
"end_datetime": "2021-01-06 15:27:00",
"allow_notification": 0,
"notify_via": {
"sms": 1,
"mail": 1
},
"notify_type": "hour",
"business_id": 1,
"created_by": 1,
"updated_at": "2021-01-06 17:04:54",
"created_at": "2021-01-06 17:04:54",
"id": 20
}
}HTTP Request
POST connector/api/crm/follow-ups
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | Follow up title |
contact_id |
integer | required | Contact to be followed up |
description |
text | optional | Follow up description |
schedule_type |
string | required | Follow up type default get from getFollowUpResources->follow_up_types |
user_id |
array | required | Integer ID; Follow up to be assigned Ex: [2,3,8] |
notify_before |
integer | optional | Integer value will be used to send auto notification before follow up starts. |
notify_type |
string | optional | Notify type Ex: 'minute', 'hour', 'day'. default is hour |
status |
string | optional | Follow up status |
notify_via |
array | optional | Will be used to send notification Ex: ['sms' => 0 ,'mail' => 1] |
start_datetime |
datetime | required | Follow up start datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 |
end_datetime |
datetime | required | Follow up end datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 |
followup_additional_info |
array | optional | Follow up additional info Ex: ['call duration' => '1 hour'] |
allow_notification |
boolean | optional | 0/1 : If notification will be send before follow up starts. default is 1(true) |
Get the specified followup
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/crm/follow-ups/1,2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/crm/follow-ups/1,2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 20,
"business_id": 1,
"contact_id": 1,
"title": "Meeting with client",
"status": null,
"start_datetime": "2021-01-06 15:27:00",
"end_datetime": "2021-01-06 15:27:00",
"description": null,
"schedule_type": "call",
"allow_notification": 0,
"notify_via": {
"sms": 1,
"mail": 1
},
"notify_before": null,
"notify_type": "hour",
"created_by": 1,
"created_at": "2021-01-06 17:04:54",
"updated_at": "2021-01-06 17:04:54",
"customer": {
"id": 1,
"business_id": 1,
"type": "customer",
"supplier_business_name": null,
"name": "Walk-In Customer",
"prefix": null,
"first_name": "Walk-In Customer",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CO0005",
"contact_status": "active",
"tax_number": null,
"city": "Phoenix",
"state": "Arizona",
"country": "USA",
"address_line_1": "Linking Street",
"address_line_2": null,
"zip_code": null,
"dob": null,
"mobile": "(378) 400-1234",
"landline": null,
"alternate_number": null,
"pay_term_number": null,
"pay_term_type": null,
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 1,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": null,
"crm_life_stage": null,
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"deleted_at": null,
"created_at": "2018-01-03 20:45:20",
"updated_at": "2018-06-11 22:22:05",
"remember_token": null,
"password": null
},
"users": [
{
"id": 2,
"user_type": "user",
"surname": "Mr",
"first_name": "Demo",
"last_name": "Cashier",
"username": "cashier",
"email": "cashier@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:20:58",
"updated_at": "2018-01-04 02:20:58",
"pivot": {
"schedule_id": 20,
"user_id": 2
}
}
]
}
]
}HTTP Request
GET connector/api/crm/follow-ups/{follow_up}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
follow_up |
required | comma separated ids of the follow_ups |
Update follow up
Requires authentication
Example request:
curl -X PUT \
"https://dev.scalerp.com/public/connector/api/crm/follow-ups/20" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"Meeting with client","contact_id":2,"description":"officiis","schedule_type":"necessitatibus","user_id":"[2,3,5]","notify_before":5,"notify_type":"minute","status":"open","notify_via":"['sms' => 0 ,'mail' => 1]","followup_additional_info":"['call duration' => '1 hour']","start_datetime":"2021-01-06 13:05:00","end_datetime":"2021-01-06 13:05:00","allow_notification":true}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/crm/follow-ups/20"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "Meeting with client",
"contact_id": 2,
"description": "officiis",
"schedule_type": "necessitatibus",
"user_id": "[2,3,5]",
"notify_before": 5,
"notify_type": "minute",
"status": "open",
"notify_via": "['sms' => 0 ,'mail' => 1]",
"followup_additional_info": "['call duration' => '1 hour']",
"start_datetime": "2021-01-06 13:05:00",
"end_datetime": "2021-01-06 13:05:00",
"allow_notification": true
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 20,
"business_id": 1,
"contact_id": "1",
"title": "Meeting with client",
"status": null,
"start_datetime": "2021-01-06 15:27:00",
"end_datetime": "2021-01-06 15:27:00",
"description": null,
"schedule_type": "call",
"allow_notification": 0,
"notify_via": {
"sms": 1,
"mail": 0
},
"notify_before": null,
"notify_type": "hour",
"created_by": 1,
"created_at": "2021-01-06 17:04:54",
"updated_at": "2021-01-06 18:22:21"
}
}HTTP Request
PUT connector/api/crm/follow-ups/{follow_up}
PATCH connector/api/crm/follow-ups/{follow_up}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
follow_up |
required | id of the follow up to be updated |
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | Follow up title |
contact_id |
integer | required | Contact to be followed up |
description |
text | optional | Follow up description |
schedule_type |
string | required | Follow up type default get from getFollowUpResources->follow_up_types |
user_id |
array | required | Integer ID; Follow up to be assigned Ex: [2,3,8] |
notify_before |
integer | optional | Integer value will be used to send auto notification before follow up starts. |
notify_type |
string | optional | Notify type Ex: 'minute', 'hour', 'day'. default is hour |
status |
string | optional | Follow up status |
notify_via |
array | optional | Will be used to send notification Ex: ['sms' => 0 ,'mail' => 1] |
followup_additional_info |
array | optional | Follow up additional info Ex: ['call duration' => '1 hour'] |
start_datetime |
datetime | required | Follow up start datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 |
end_datetime |
datetime | required | Follow up end datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 |
allow_notification |
boolean | optional | 0/1 : If notification will be send before follow up starts. default is 1(true) |
Get follow up resources
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/crm/follow-up-resources" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/crm/follow-up-resources"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"statuses": {
"scheduled": "Scheduled",
"open": "Open",
"canceled": "Cancelled",
"completed": "Completed"
},
"follow_up_types": {
"call": "Call",
"sms": "Sms",
"meeting": "Meeting",
"email": "Email"
},
"notify_type": {
"minute": "Minute",
"hour": "Hour",
"day": "Day"
},
"notify_via": {
"sms": "Sms",
"mail": "Email"
}
}
}HTTP Request
GET connector/api/crm/follow-up-resources
List lead
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/crm/leads?assigned_to=1%2C2%2C3&name=distinctio&biz_name=ex&mobile_num=10&contact_id=dolores&order_by=nulla&direction=desc&per_page=10" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/crm/leads"
);
let params = {
"assigned_to": "1,2,3",
"name": "distinctio",
"biz_name": "ex",
"mobile_num": "10",
"contact_id": "dolores",
"order_by": "nulla",
"direction": "desc",
"per_page": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"contact_id": "CO0010",
"name": "mr Lead 3 kr kr 2",
"supplier_business_name": "POS",
"email": null,
"mobile": "9437638555",
"tax_number": null,
"created_at": "2020-12-15 23:14:30",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"alternate_number": null,
"landline": null,
"dob": null,
"contact_status": "active",
"type": "lead",
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"id": 49,
"business_id": 1,
"crm_source": "55",
"crm_life_stage": "60",
"address_line_1": null,
"address_line_2": null,
"city": null,
"state": null,
"country": null,
"zip_code": null,
"last_follow_up_id": 18,
"upcoming_follow_up_id": null,
"last_follow_up": "2021-01-07 10:26:00",
"upcoming_follow_up": null,
"last_follow_up_additional_info": "{\"test\":\"test done\",\"call_duration\":\"1.5 Hour\",\"rand\":1}",
"upcoming_follow_up_additional_info": null,
"source": {
"id": 55,
"name": "Facebook",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "source",
"description": "Facebook",
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2020-12-15 23:07:53",
"updated_at": "2020-12-15 23:07:53"
},
"life_stage": {
"id": 60,
"name": "Open Deal",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "life_stage",
"description": "Open Deal",
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2020-12-15 23:11:05",
"updated_at": "2020-12-15 23:11:05"
},
"lead_users": [
{
"id": 10,
"user_type": "user",
"surname": "Mr.",
"first_name": "WooCommerce",
"last_name": "User",
"username": "woocommerce_user",
"email": "woo@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-08-02 04:05:55",
"updated_at": "2018-08-02 04:05:55",
"pivot": {
"contact_id": 49,
"user_id": 10
}
}
]
},
{
"contact_id": "CO0011",
"name": " Lead 4 ",
"supplier_business_name": null,
"email": null,
"mobile": "234567",
"tax_number": null,
"created_at": "2020-12-15 23:14:48",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"alternate_number": null,
"landline": null,
"dob": null,
"contact_status": "active",
"type": "lead",
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"id": 50,
"business_id": 1,
"crm_source": "55",
"crm_life_stage": "62",
"address_line_1": null,
"address_line_2": null,
"city": null,
"state": null,
"country": null,
"zip_code": null,
"last_follow_up_id": 32,
"upcoming_follow_up_id": null,
"last_follow_up": "2021-01-08 16:06:00",
"upcoming_follow_up": null,
"last_follow_up_additional_info": "{\"call_durartion\":\"5 hour\"}",
"upcoming_follow_up_additional_info": null,
"source": {
"id": 55,
"name": "Facebook",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "source",
"description": "Facebook",
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2020-12-15 23:07:53",
"updated_at": "2020-12-15 23:07:53"
},
"life_stage": {
"id": 62,
"name": "New",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "life_stage",
"description": "New",
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2020-12-15 23:11:26",
"updated_at": "2020-12-15 23:11:26"
},
"lead_users": [
{
"id": 11,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin Essential",
"last_name": null,
"username": "admin-essentials",
"email": "admin_essentials@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19",
"pivot": {
"contact_id": 50,
"user_id": 11
}
}
]
},
{
"contact_id": "CO0015",
"name": " Lead kr ",
"supplier_business_name": null,
"email": null,
"mobile": "9437638555",
"tax_number": null,
"created_at": "2021-01-07 18:31:08",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"alternate_number": null,
"landline": null,
"dob": "2021-01-07",
"contact_status": "active",
"type": "lead",
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"id": 82,
"business_id": 1,
"crm_source": null,
"crm_life_stage": null,
"address_line_1": null,
"address_line_2": null,
"city": null,
"state": null,
"country": null,
"zip_code": null,
"last_follow_up_id": 36,
"upcoming_follow_up_id": null,
"last_follow_up": "2021-01-07 18:31:08",
"upcoming_follow_up": null,
"last_follow_up_additional_info": "{\"call duration\":\"1 hour\",\"call descr\":\"talked to him and all okay\"}",
"upcoming_follow_up_additional_info": null,
"source": null,
"life_stage": null,
"lead_users": [
{
"id": 11,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin Essential",
"last_name": null,
"username": "admin-essentials",
"email": "admin_essentials@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19",
"pivot": {
"contact_id": 82,
"user_id": 11
}
}
]
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/crm\/leads?page=1",
"last": "http:\/\/local.pos.com\/connector\/api\/crm\/leads?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/crm\/leads",
"per_page": "10",
"to": 3,
"total": 3
}
}HTTP Request
GET connector/api/crm/leads
Query Parameters
| Parameter | Status | Description |
|---|---|---|
assigned_to |
optional | comma separated ids of users to whom lead is assigned (Ex: 1,2,3) |
name |
optional | Search term for lead name |
biz_name |
optional | Search term for lead's business name |
mobile_num |
optional | Search term for lead's mobile number |
contact_id |
optional | Search term for lead's contact_id. Ex(CO0005) |
order_by |
optional | Column name to sort the result, Column: name, supplier_business_name |
direction |
optional | Direction to sort the result, Required if using 'order_by', direction: desc, asc |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Save Call Logs
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/crm/call-logs" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"call_logs":[{"mobile_number":"soluta","mobile_name":"sit","call_type":"call","start_time":"nesciunt","end_time":"aut","duration":"dicta"}]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/crm/call-logs"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"call_logs": [
{
"mobile_number": "soluta",
"mobile_name": "sit",
"call_type": "call",
"start_time": "nesciunt",
"end_time": "aut",
"duration": "dicta"
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));HTTP Request
POST connector/api/crm/call-logs
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
call_logs.*.mobile_number |
string | required | Mobile number of the customer or user |
call_logs.*.mobile_name |
string | optional | Name of the contact saved in the mobile |
call_logs.*.call_type |
string | optional | Call type (call, sms) |
call_logs.*.start_time |
string | optional | Start datetime of the call in "Y-m-d H:i:s" format |
call_logs.*.end_time |
string | optional | End datetime of the call in "Y-m-d H:i:s" format |
call_logs.*.duration |
string | optional | Duration of the call in seconds |
Cash register management
List Cash Registers
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/cash-register?status=open&user_id=10&start_date=2018-06-25&end_date=2018-06-25&location_id=1&per_page=15" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/cash-register"
);
let params = {
"status": "open",
"user_id": "10",
"start_date": "2018-06-25",
"end_date": "2018-06-25",
"location_id": "1",
"per_page": "15",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"location_id": 1,
"user_id": 9,
"status": "open",
"closed_at": null,
"closing_amount": "0.0000",
"total_card_slips": 0,
"total_cheques": 0,
"closing_note": null,
"created_at": "2020-07-02 12:03:00",
"updated_at": "2020-07-02 12:03:19",
"cash_register_transactions": [
{
"id": 1,
"cash_register_id": 1,
"amount": "0.0000",
"pay_method": "cash",
"type": "credit",
"transaction_type": "initial",
"transaction_id": null,
"created_at": "2018-07-13 07:39:34",
"updated_at": "2018-07-13 07:39:34"
},
{
"id": 2,
"cash_register_id": 1,
"amount": "42.5000",
"pay_method": "cash",
"type": "credit",
"transaction_type": "sell",
"transaction_id": 41,
"created_at": "2018-07-13 07:44:40",
"updated_at": "2018-07-13 07:44:40"
}
]
},
{
"id": 2,
"business_id": 1,
"location_id": 1,
"user_id": 1,
"status": "",
"closed_at": "2020-07-02 12:03:00",
"closing_amount": "0.0000",
"total_card_slips": 0,
"total_cheques": 0,
"closing_note": null,
"created_at": "2020-07-06 15:38:23",
"updated_at": "2020-07-06 15:38:23",
"cash_register_transactions": [
{
"id": 19,
"cash_register_id": 2,
"amount": "10.0000",
"pay_method": "cash",
"type": "credit",
"transaction_type": "initial",
"transaction_id": null,
"created_at": "2020-07-06 15:38:23",
"updated_at": "2020-07-06 15:38:23"
}
]
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/cash-register?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/cash-register",
"per_page": 10,
"to": 2
}
}HTTP Request
GET connector/api/cash-register
Query Parameters
| Parameter | Status | Description |
|---|---|---|
status |
optional | status of the register (open, close) |
user_id |
optional | id of the user |
start_date |
optional | format:Y-m-d |
end_date |
optional | format:Y-m-d |
location_id |
optional | id of the location |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Create Cash Register
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/cash-register" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"location_id":1,"initial_amount":1.0900000000000000799360577730112709105014801025390625,"created_at":"2020-5-7 15:20:22","closed_at":"2020-5-7 15:20:22","status":"close","closing_amount":0.242364999999999997104538351777591742575168609619140625,"total_card_slips":7,"total_cheques":8,"closing_note":"totam","transaction_ids":"1,2,3"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/cash-register"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"location_id": 1,
"initial_amount": 1.0900000000000000799360577730112709105014801025390625,
"created_at": "2020-5-7 15:20:22",
"closed_at": "2020-5-7 15:20:22",
"status": "close",
"closing_amount": 0.242364999999999997104538351777591742575168609619140625,
"total_card_slips": 7,
"total_cheques": 8,
"closing_note": "totam",
"transaction_ids": "1,2,3"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));HTTP Request
POST connector/api/cash-register
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
location_id |
integer | required | id of the business location |
initial_amount |
float | optional | Initial amount |
created_at |
string | optional | Register open datetime format:Y-m-d H:i:s, |
closed_at |
string | optional | Register closed datetime format:Y-m-d H:i:s, |
status |
register | optional | status (open, close) |
closing_amount |
float | optional | Closing amount |
total_card_slips |
integer | optional | total number of card slips |
total_cheques |
integer | optional | total number of checks |
closing_note |
string | optional | Closing note |
transaction_ids |
string | optional | Comma separated ids of sells associated with the register |
Get the specified Register
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/cash-register/59" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/cash-register/59"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"location_id": 1,
"user_id": 9,
"status": "open",
"closed_at": null,
"closing_amount": "0.0000",
"total_card_slips": 0,
"total_cheques": 0,
"closing_note": null,
"created_at": "2020-07-02 12:03:00",
"updated_at": "2020-07-02 12:03:19",
"cash_register_transactions": [
{
"id": 1,
"cash_register_id": 1,
"amount": "0.0000",
"pay_method": "cash",
"type": "credit",
"transaction_type": "initial",
"transaction_id": null,
"created_at": "2018-07-13 07:39:34",
"updated_at": "2018-07-13 07:39:34"
},
{
"id": 2,
"cash_register_id": 1,
"amount": "42.5000",
"pay_method": "cash",
"type": "credit",
"transaction_type": "sell",
"transaction_id": 41,
"created_at": "2018-07-13 07:44:40",
"updated_at": "2018-07-13 07:44:40"
}
]
}
]
}HTTP Request
GET connector/api/cash-register/{cash_register}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
cash_register |
required | comma separated ids of the cash registers |
Contact management
List contact
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/contactapi?type=modi&name=doloribus&biz_name=accusamus&mobile_num=4&contact_id=voluptate&order_by=esse&direction=assumenda&per_page=10" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/contactapi"
);
let params = {
"type": "modi",
"name": "doloribus",
"biz_name": "accusamus",
"mobile_num": "4",
"contact_id": "voluptate",
"order_by": "esse",
"direction": "assumenda",
"per_page": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 2,
"business_id": 1,
"type": "supplier",
"supplier_business_name": "Alpha Clothings",
"name": "Michael",
"prefix": null,
"first_name": "Michael",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CO0001",
"contact_status": "active",
"tax_number": "4590091535",
"city": "Phoenix",
"state": "Arizona",
"country": "USA",
"address_line_1": "Linking Street",
"address_line_2": null,
"zip_code": null,
"dob": null,
"mobile": "(378) 400-1234",
"landline": null,
"alternate_number": null,
"pay_term_number": 15,
"pay_term_type": "days",
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 0,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": null,
"crm_life_stage": null,
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"deleted_at": null,
"created_at": "2018-01-03 20:59:38",
"updated_at": "2018-06-11 22:21:03",
"remember_token": null,
"password": null
},
{
"id": 3,
"business_id": 1,
"type": "supplier",
"supplier_business_name": "Manhattan Clothing Ltd.",
"name": "Philip",
"prefix": null,
"first_name": "Philip",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CO0003",
"contact_status": "active",
"tax_number": "54869310093",
"city": "Phoenix",
"state": "Arizona",
"country": "USA",
"address_line_1": "Linking Street",
"address_line_2": null,
"zip_code": null,
"dob": null,
"mobile": "(378) 400-1234",
"landline": null,
"alternate_number": null,
"pay_term_number": 15,
"pay_term_type": "days",
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 0,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": null,
"crm_life_stage": null,
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"deleted_at": null,
"created_at": "2018-01-03 21:00:55",
"updated_at": "2018-06-11 22:21:36",
"remember_token": null,
"password": null
},
{
"id": 5,
"business_id": 1,
"type": "supplier",
"supplier_business_name": "Digital Ocean",
"name": "Mike McCubbin",
"prefix": null,
"first_name": "Mike McCubbin",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CN0004",
"contact_status": "active",
"tax_number": "52965489001",
"city": "Phoenix",
"state": "Arizona",
"country": "USA",
"address_line_1": "Linking Street",
"address_line_2": null,
"zip_code": null,
"dob": null,
"mobile": "(378) 400-1234",
"landline": null,
"alternate_number": null,
"pay_term_number": 30,
"pay_term_type": "days",
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 0,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": null,
"crm_life_stage": null,
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"deleted_at": null,
"created_at": "2018-01-06 06:53:22",
"updated_at": "2018-06-11 22:21:47",
"remember_token": null,
"password": null
},
{
"id": 6,
"business_id": 1,
"type": "supplier",
"supplier_business_name": "Univer Suppliers",
"name": "Jackson Hill",
"prefix": null,
"first_name": "Jackson Hill",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CO0002",
"contact_status": "active",
"tax_number": "5459000655",
"city": "Phoenix",
"state": "Arizona",
"country": "USA",
"address_line_1": "Linking Street",
"address_line_2": null,
"zip_code": null,
"dob": null,
"mobile": "(378) 400-1234",
"landline": null,
"alternate_number": null,
"pay_term_number": 45,
"pay_term_type": "days",
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 0,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": null,
"crm_life_stage": null,
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"custom_field5": null,
"custom_field6": null,
"custom_field7": null,
"custom_field8": null,
"custom_field9": null,
"custom_field10": null,
"deleted_at": null,
"created_at": "2018-01-06 06:55:09",
"updated_at": "2018-06-11 22:21:18",
"remember_token": null,
"password": null
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/contactapi?page=1",
"last": "http:\/\/local.pos.com\/connector\/api\/contactapi?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/contactapi",
"per_page": "10",
"to": 4,
"total": 4
}
}HTTP Request
GET connector/api/contactapi
Query Parameters
| Parameter | Status | Description |
|---|---|---|
type |
required | Type of contact (supplier, customer) |
name |
optional | Search term for contact name |
biz_name |
optional | Search term for contact's business name |
mobile_num |
optional | Search term for contact's mobile number |
contact_id |
optional | Search term for contact's contact_id. Ex(CO0005) |
order_by |
optional | Column name to sort the result, Column: name, supplier_business_name |
direction |
optional | Direction to sort the result, Direction: desc, asc |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Create contact
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/contactapi" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"customer","supplier_business_name":"et","prefix":"quidem","first_name":"sint","middle_name":"vero","last_name":"repellendus","tax_number":"8787fefef","pay_term_number":3,"pay_term_type":"months","mobile":"4578691009","landline":"5487-8454-4145","alternate_number":"841847541222","address_line_1":"inventore","address_line_2":"rerum","city":"maxime","state":"neque","country":"et","zip_code":"quo","customer_group_id":"sit","contact_id":"animi","dob":"2000-06-13","custom_field1":"error","custom_field2":"voluptas","custom_field3":"et","custom_field4":"commodi","email":"placeat","shipping_address":"a","position":"maiores","opening_balance":0,"source_id":1,"life_stage_id":8,"assigned_to":[]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/contactapi"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "customer",
"supplier_business_name": "et",
"prefix": "quidem",
"first_name": "sint",
"middle_name": "vero",
"last_name": "repellendus",
"tax_number": "8787fefef",
"pay_term_number": 3,
"pay_term_type": "months",
"mobile": "4578691009",
"landline": "5487-8454-4145",
"alternate_number": "841847541222",
"address_line_1": "inventore",
"address_line_2": "rerum",
"city": "maxime",
"state": "neque",
"country": "et",
"zip_code": "quo",
"customer_group_id": "sit",
"contact_id": "animi",
"dob": "2000-06-13",
"custom_field1": "error",
"custom_field2": "voluptas",
"custom_field3": "et",
"custom_field4": "commodi",
"email": "placeat",
"shipping_address": "a",
"position": "maiores",
"opening_balance": 0,
"source_id": 1,
"life_stage_id": 8,
"assigned_to": []
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"type": "customer",
"name": "test customer",
"tax_number": "75879BHF",
"mobile": "7878825008",
"business_id": 1,
"created_by": 9,
"credit_limit": null,
"contact_id": "CO0007",
"updated_at": "2020-06-04 21:59:21",
"created_at": "2020-06-04 21:59:21",
"id": 17
}
}HTTP Request
POST connector/api/contactapi
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
type |
string | required | Type of contact (supplier, customer, both, lead) |
supplier_business_name |
string | required | Required if type is supplier |
prefix |
string | optional | Prefix for the name of the contact |
first_name |
string | required | Name of the contact |
middle_name |
string | optional | |
last_name |
string | optional | |
tax_number |
string | optional | |
pay_term_number |
float | optional | |
pay_term_type |
string | optional | (months ,days) |
mobile |
string | required | |
landline |
string | optional | |
alternate_number |
string | optional | |
address_line_1 |
string | optional | |
address_line_2 |
string | optional | |
city |
string | optional | |
state |
string | optional | |
country |
string | optional | |
zip_code |
string | optional | |
customer_group_id |
string | optional | |
contact_id |
string | optional | |
dob |
string | optional | Fromat: Y-m-d |
custom_field1 |
string | optional | |
custom_field2 |
string | optional | |
custom_field3 |
string | optional | |
custom_field4 |
string | optional | |
email |
string | optional | |
shipping_address |
string | optional | |
position |
string | optional | |
opening_balance |
float | optional | |
source_id |
integer | optional | Id of the source. Applicable only if the type is lead |
life_stage_id |
integer | optional | Id of the Life stage. Applicable only if the type is lead |
assigned_to |
array | optional | Ids of the users the lead is assigned to. Applicable only if the type is lead |
Get the specified contact
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/contactapi/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/contactapi/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"type": "customer",
"supplier_business_name": null,
"name": " Walk-In Customer ",
"prefix": null,
"first_name": "Walk-In Customer",
"middle_name": null,
"last_name": null,
"email": "walkin@test.com",
"contact_id": "CO0005",
"contact_status": "active",
"tax_number": null,
"city": "Phoenix",
"state": "Arizona",
"country": "USA",
"address_line_1": "Linking Street",
"address_line_2": null,
"zip_code": "85001",
"dob": null,
"mobile": "(378) 400-1234",
"landline": null,
"alternate_number": null,
"pay_term_number": null,
"pay_term_type": null,
"credit_limit": "0.0000",
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 1,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": null,
"crm_life_stage": null,
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-03 20:45:20",
"updated_at": "2020-08-10 10:26:45",
"remember_token": null,
"password": null,
"customer_group": null,
"opening_balance": "0.0000",
"opening_balance_paid": "0.0000",
"total_purchase": "0.0000",
"purchase_paid": "0.0000",
"total_purchase_return": "0.0000",
"purchase_return_paid": "0.0000",
"total_invoice": "2050.0000",
"invoice_received": "1987.5000",
"total_sell_return": "0.0000",
"sell_return_paid": "0.0000",
"purchase_due": 0,
"sell_due": 62.5,
"purchase_return_due": 0,
"sell_return_due": 0
}
]
}HTTP Request
GET connector/api/contactapi/{contactapi}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
contact |
required | comma separated ids of contacts |
Update contact
Requires authentication
Example request:
curl -X PUT \
"https://dev.scalerp.com/public/connector/api/contactapi/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"customer","supplier_business_name":"voluptatem","prefix":"sed","first_name":"qui","middle_name":"qui","last_name":"quibusdam","tax_number":"488744dwd","pay_term_number":3,"pay_term_type":"months","mobile":"8795461009","landline":"65484-848-848","alternate_number":"9898795220","address_line_1":"ad","address_line_2":"et","city":"voluptatem","state":"omnis","country":"quis","zip_code":"nihil","customer_group_id":"aut","contact_id":"eos","dob":"2000-06-13","custom_field1":"voluptates","custom_field2":"sed","custom_field3":"et","custom_field4":"eveniet","email":"accusamus","shipping_address":"repellendus","position":"assumenda","opening_balance":10.300000000000000710542735760100185871124267578125,"source_id":20,"life_stage_id":6,"assigned_to":[]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/contactapi/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "customer",
"supplier_business_name": "voluptatem",
"prefix": "sed",
"first_name": "qui",
"middle_name": "qui",
"last_name": "quibusdam",
"tax_number": "488744dwd",
"pay_term_number": 3,
"pay_term_type": "months",
"mobile": "8795461009",
"landline": "65484-848-848",
"alternate_number": "9898795220",
"address_line_1": "ad",
"address_line_2": "et",
"city": "voluptatem",
"state": "omnis",
"country": "quis",
"zip_code": "nihil",
"customer_group_id": "aut",
"contact_id": "eos",
"dob": "2000-06-13",
"custom_field1": "voluptates",
"custom_field2": "sed",
"custom_field3": "et",
"custom_field4": "eveniet",
"email": "accusamus",
"shipping_address": "repellendus",
"position": "assumenda",
"opening_balance": 10.300000000000000710542735760100185871124267578125,
"source_id": 20,
"life_stage_id": 6,
"assigned_to": []
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 21,
"business_id": 1,
"type": "customer",
"supplier_business_name": null,
"name": "created from api",
"prefix": null,
"first_name": "created from api",
"middle_name": null,
"last_name": null,
"email": null,
"contact_id": "CO0009",
"contact_status": "active",
"tax_number": null,
"city": null,
"state": null,
"country": null,
"address_line_1": "test address",
"address_line_2": null,
"zip_code": "54878787",
"dob": "2000-06-13",
"mobile": "8754154872154",
"landline": null,
"alternate_number": null,
"pay_term_number": null,
"pay_term_type": null,
"credit_limit": null,
"created_by": 1,
"balance": "0.0000",
"total_rp": 0,
"total_rp_used": 0,
"total_rp_expired": 0,
"is_default": 0,
"shipping_address": null,
"position": null,
"customer_group_id": null,
"crm_source": null,
"crm_life_stage": null,
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2020-08-10 10:41:42",
"updated_at": "2020-08-10 10:41:42",
"remember_token": null,
"password": null
}
}HTTP Request
PUT connector/api/contactapi/{contactapi}
PATCH connector/api/contactapi/{contactapi}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
contact |
required | id of the contact to be updated |
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
type |
string | optional | Type of contact (supplier, customer, both) |
supplier_business_name |
string | optional | required* Required if type is supplier |
prefix |
string | optional | Prefix for the name of the contact |
first_name |
string | required | Name of the contact |
middle_name |
string | optional | |
last_name |
string | optional | |
tax_number |
string | optional | |
pay_term_number |
float | optional | |
pay_term_type |
string | optional | (months ,days) |
mobile |
string | required | |
landline |
string | optional | |
alternate_number |
string | optional | |
address_line_1 |
string | optional | |
address_line_2 |
string | optional | |
city |
string | optional | |
state |
string | optional | |
country |
string | optional | |
zip_code |
string | optional | |
customer_group_id |
string | optional | |
contact_id |
string | optional | |
dob |
string | optional | Fromat: Y-m-d |
custom_field1 |
string | optional | |
custom_field2 |
string | optional | |
custom_field3 |
string | optional | |
custom_field4 |
string | optional | |
email |
string | optional | |
shipping_address |
string | optional | |
position |
string | optional | |
opening_balance |
float | optional | |
source_id |
integer | optional | Id of the source. Applicable only if the type is lead |
life_stage_id |
integer | optional | Id of the Life stage. Applicable only if the type is lead |
assigned_to |
array | optional | Ids of the users the lead is assigned to. Applicable only if the type is lead |
Contact payment
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/contactapi-payment" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"contact_id":17,"amount":453.1299999999999954525264911353588104248046875,"method":"cash","paid_on":"2020-07-22 15:48:29","account_id":16,"card_number":"mollitia","card_holder_name":"veniam","card_transaction_number":"ipsa","card_type":"illum","card_month":"repellat","card_year":"aspernatur","card_security":"veritatis","transaction_no_1":"non","transaction_no_2":"quis","transaction_no_3":"aperiam","cheque_number":"non","bank_account_number":"et","note":"commodi"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/contactapi-payment"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"contact_id": 17,
"amount": 453.1299999999999954525264911353588104248046875,
"method": "cash",
"paid_on": "2020-07-22 15:48:29",
"account_id": 16,
"card_number": "mollitia",
"card_holder_name": "veniam",
"card_transaction_number": "ipsa",
"card_type": "illum",
"card_month": "repellat",
"card_year": "aspernatur",
"card_security": "veritatis",
"transaction_no_1": "non",
"transaction_no_2": "quis",
"transaction_no_3": "aperiam",
"cheque_number": "non",
"bank_account_number": "et",
"note": "commodi"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"amount": "20",
"method": "cash",
"paid_on": "2020-07-22 15:48:29",
"created_by": 1,
"payment_for": "19",
"business_id": 1,
"is_advance": 1,
"payment_ref_no": "SP2020\/0127",
"document": null,
"updated_at": "2020-07-22 15:48:29",
"created_at": "2020-07-22 15:48:29",
"id": 215
}
}HTTP Request
POST connector/api/contactapi-payment
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
contact_id |
integer | required | id of the contact |
amount |
float | required | amount of the payment |
method |
string | optional | payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') |
paid_on |
string | optional | transaction date format:Y-m-d H:i:s, |
account_id |
integer | optional | account id |
card_number |
string | optional | |
card_holder_name |
string | optional | |
card_transaction_number |
string | optional | |
card_type |
string | optional | |
card_month |
string | optional | |
card_year |
string | optional | |
card_security |
string | optional | |
transaction_no_1 |
string | optional | |
transaction_no_2 |
string | optional | |
transaction_no_3 |
string | optional | |
cheque_number |
string | optional | |
bank_account_number |
string | optional | |
note |
string | optional | payment note |
Expense management
List expenses
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/expense?location_id=1&payment_status=paid&start_date=2018-06-25&end_date=2018-06-25&expense_for=esse&per_page=15" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/expense"
);
let params = {
"location_id": "1",
"payment_status": "paid",
"start_date": "2018-06-25",
"end_date": "2018-06-25",
"expense_for": "esse",
"per_page": "15",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 59,
"business_id": 1,
"location_id": 1,
"payment_status": "due",
"ref_no": "EP2020\/0001",
"transaction_date": "2020-07-03 12:58:00",
"total_before_tax": "50.0000",
"tax_id": null,
"tax_amount": "0.0000",
"final_total": "50.0000",
"expense_category_id": null,
"document": null,
"created_by": 9,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-03 12:58:23",
"updated_at": "2020-07-03 12:58:24",
"transaction_for": {
"id": 1,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin",
"last_name": null,
"username": "admin",
"email": "admin@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19"
}
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/expense?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/expense",
"per_page": 10,
"to": 1
}
}HTTP Request
GET connector/api/expense
Query Parameters
| Parameter | Status | Description |
|---|---|---|
location_id |
optional | id of the location |
payment_status |
optional | payment status |
start_date |
optional | format:Y-m-d |
end_date |
optional | format:Y-m-d |
expense_for |
optional | id of the user for which expense is created |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Create expense / expense refund
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/expense" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"location_id":1,"final_total":277879314.199999988079071044921875,"transaction_date":"2020-5-7 15:20:22","tax_rate_id":9,"expense_for":3,"contact_id":13,"expense_category_id":4,"expense_sub_category_id":12,"additional_notes":"aut","is_refund":0,"is_recurring":0,"recur_interval":16,"recur_interval_type":"months","subscription_repeat_on":15,"subscription_no":"suscipit","recur_repetitions":6,"payment":[{"amount":453.1299999999999954525264911353588104248046875,"method":"cash","account_id":15,"card_number":"rem","card_holder_name":"laudantium","card_transaction_number":"accusamus","card_type":"dolores","card_month":"et","card_year":"dolores","card_security":"vero","transaction_no_1":"est","transaction_no_2":"tempore","transaction_no_3":"molestias","note":"est","cheque_number":"rerum"}]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/expense"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"location_id": 1,
"final_total": 277879314.199999988079071044921875,
"transaction_date": "2020-5-7 15:20:22",
"tax_rate_id": 9,
"expense_for": 3,
"contact_id": 13,
"expense_category_id": 4,
"expense_sub_category_id": 12,
"additional_notes": "aut",
"is_refund": 0,
"is_recurring": 0,
"recur_interval": 16,
"recur_interval_type": "months",
"subscription_repeat_on": 15,
"subscription_no": "suscipit",
"recur_repetitions": 6,
"payment": [
{
"amount": 453.1299999999999954525264911353588104248046875,
"method": "cash",
"account_id": 15,
"card_number": "rem",
"card_holder_name": "laudantium",
"card_transaction_number": "accusamus",
"card_type": "dolores",
"card_month": "et",
"card_year": "dolores",
"card_security": "vero",
"transaction_no_1": "est",
"transaction_no_2": "tempore",
"transaction_no_3": "molestias",
"note": "est",
"cheque_number": "rerum"
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 75,
"business_id": 1,
"location_id": "1",
"payment_status": "due",
"ref_no": "EP2020\/0013",
"transaction_date": "2020-07-06T05:31:29.480975Z",
"total_before_tax": "43",
"tax_id": null,
"tax_amount": 0,
"final_total": "43",
"expense_category_id": null,
"document": null,
"created_by": 1,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-06 11:01:29",
"updated_at": "2020-07-06 11:01:29",
"expense_for": []
}
}HTTP Request
POST connector/api/expense
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
location_id |
integer | required | id of the business location |
final_total |
float | required | Expense amount |
transaction_date |
string | optional | transaction date format:Y-m-d H:i:s, |
tax_rate_id |
integer | optional | id of the tax rate applicable to the expense |
expense_for |
integer | optional | id of the user for which expense is created |
contact_id |
integer | optional | id of the contact(customer or supplier) for which expense is created |
expense_category_id |
integer | optional | id of the expense category |
expense_sub_category_id |
integer | optional | id of the expense sub-category |
additional_notes |
string | optional | |
is_refund |
integer | optional | whether expense refund (0, 1) |
is_recurring |
integer | optional | whether expense is recurring (0, 1) |
recur_interval |
integer | optional | value of the interval expense will be regenerated |
recur_interval_type |
string | optional | type of the recur interval ('days', 'months', 'years') |
subscription_repeat_on |
integer | optional | day of the month on which expense will be generated if recur interval type is months (1-30) |
subscription_no |
string | optional | subscription number |
recur_repetitions |
integer | optional | total number of expense to be generated |
payment |
array | optional | payment lines for the expense |
payment.*.amount |
float | optional | amount of the payment |
payment.*.method |
string | optional | payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') |
payment.*.account_id |
integer | optional | account id |
payment.*.card_number |
string | optional | |
payment.*.card_holder_name |
string | optional | |
payment.*.card_transaction_number |
string | optional | |
payment.*.card_type |
string | optional | |
payment.*.card_month |
string | optional | |
payment.*.card_year |
string | optional | |
payment.*.card_security |
string | optional | |
payment.*.transaction_no_1 |
string | optional | |
payment.*.transaction_no_2 |
string | optional | |
payment.*.transaction_no_3 |
string | optional | |
payment.*.note |
string | optional | payment note |
payment.*.cheque_number |
string | optional |
Get the specified expense / expense refund
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/expense/59" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/expense/59"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 59,
"business_id": 1,
"location_id": 1,
"payment_status": "due",
"ref_no": "EP2020\/0001",
"transaction_date": "2020-07-03 12:58:00",
"total_before_tax": "50.0000",
"tax_id": null,
"tax_amount": "0.0000",
"final_total": "50.0000",
"expense_category_id": null,
"document": null,
"created_by": 9,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-03 12:58:23",
"updated_at": "2020-07-03 12:58:24",
"transaction_for": {
"id": 1,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin",
"last_name": null,
"username": "admin",
"email": "admin@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19"
}
}
]
}HTTP Request
GET connector/api/expense/{expense}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
expense |
required | comma separated ids of the expenses |
Update expense / expense refund
Requires authentication
Example request:
curl -X PUT \
"https://dev.scalerp.com/public/connector/api/expense/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"final_total":5.65992352000000042977490011253394186496734619140625,"transaction_date":"2020-5-7 15:20:22","tax_rate_id":6,"expense_for":18,"contact_id":17,"expense_category_id":13,"expense_sub_category_id":1,"additional_notes":"omnis","is_recurring":0,"recur_interval":4,"recur_interval_type":"months","subscription_repeat_on":15,"subscription_no":"et","recur_repetitions":19,"payment":[]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/expense/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"final_total": 5.65992352000000042977490011253394186496734619140625,
"transaction_date": "2020-5-7 15:20:22",
"tax_rate_id": 6,
"expense_for": 18,
"contact_id": 17,
"expense_category_id": 13,
"expense_sub_category_id": 1,
"additional_notes": "omnis",
"is_recurring": 0,
"recur_interval": 4,
"recur_interval_type": "months",
"subscription_repeat_on": 15,
"subscription_no": "et",
"recur_repetitions": 19,
"payment": []
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 75,
"business_id": 1,
"location_id": "1",
"payment_status": "due",
"ref_no": "EP2020\/0013",
"transaction_date": "2020-07-06T05:31:29.480975Z",
"total_before_tax": "43",
"tax_id": null,
"tax_amount": 0,
"final_total": "43",
"expense_category_id": null,
"document": null,
"created_by": 1,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"created_at": "2020-07-06 11:01:29",
"updated_at": "2020-07-06 11:01:29",
"expense_for": []
}
}HTTP Request
PUT connector/api/expense/{expense}
PATCH connector/api/expense/{expense}
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
final_total |
float | optional | Expense amount |
transaction_date |
string | optional | transaction date format:Y-m-d H:i:s, |
tax_rate_id |
integer | optional | id of the tax rate applicable to the expense |
expense_for |
integer | optional | id of the user for which expense is created |
contact_id |
integer | optional | id of the contact(customer or supplier) for which expense is created |
expense_category_id |
integer | optional | id of the expense category |
expense_sub_category_id |
integer | optional | id of the expense sub-category |
additional_notes |
string | optional | |
is_recurring |
integer | optional | whether expense is recurring (0, 1) |
recur_interval |
integer | optional | value of the interval expense will be regenerated |
recur_interval_type |
string | optional | type of the recur interval ('days', 'months', 'years') |
subscription_repeat_on |
integer | optional | day of the month on which expense will be generated if recur interval type is months (1-30) |
subscription_no |
string | optional | subscription number |
recur_repetitions |
integer | optional | total number of expense to be generated |
payment |
array | optional | payment lines for the expense |
List expense refunds
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/expense-refund?location_id=1&payment_status=paid&start_date=2018-06-25&end_date=2018-06-25&expense_for=quis&per_page=15" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/expense-refund"
);
let params = {
"location_id": "1",
"payment_status": "paid",
"start_date": "2018-06-25",
"end_date": "2018-06-25",
"expense_for": "quis",
"per_page": "15",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 230,
"business_id": 1,
"location_id": 1,
"payment_status": "partial",
"ref_no": "refund",
"transaction_date": "2020-12-15 11:16:00",
"total_before_tax": "65.0000",
"tax_id": null,
"tax_amount": "0.0000",
"final_total": "65.0000",
"expense_category_id": null,
"document": null,
"created_by": 9,
"created_at": "2020-12-15 11:46:56",
"updated_at": "2020-12-15 12:47:30",
"expense_for": []
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/expense-refund?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/expense-refund",
"per_page": 15,
"to": 1
}
}HTTP Request
GET connector/api/expense-refund
Query Parameters
| Parameter | Status | Description |
|---|---|---|
location_id |
optional | id of the location |
payment_status |
optional | payment status |
start_date |
optional | format:Y-m-d |
end_date |
optional | format:Y-m-d |
expense_for |
optional | id of the user for which expense is created |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
List expense categories
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/expense-categories" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/expense-categories"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "cat 1",
"business_id": 1,
"code": null,
"parent_id": null,
"deleted_at": null,
"created_at": "2021-12-16 17:54:40",
"updated_at": "2021-12-16 17:54:40",
"sub_categories": [
{
"id": 3,
"name": "sub cat 1",
"business_id": 1,
"code": null,
"parent_id": 1,
"deleted_at": null,
"created_at": "2021-12-16 18:12:07",
"updated_at": "2021-12-16 18:12:07"
}
]
},
{
"id": 7,
"name": "cat 2",
"business_id": 1,
"code": null,
"parent_id": null,
"deleted_at": null,
"created_at": "2021-12-17 10:36:13",
"updated_at": "2021-12-17 10:36:13",
"sub_categories": [
{
"id": 8,
"name": "sub cat 2",
"business_id": 1,
"code": null,
"parent_id": 7,
"deleted_at": null,
"created_at": "2021-12-17 10:36:44",
"updated_at": "2021-12-17 10:36:44"
}
]
}
]
}HTTP Request
GET connector/api/expense-categories
Field Force
List visits
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/field-force?contact_id=temporibus&assigned_to=sit&status=est&start_date=2018-06-25&end_date=2018-06-25&per_page=15&order_by_date=desc" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/field-force"
);
let params = {
"contact_id": "temporibus",
"assigned_to": "sit",
"status": "est",
"start_date": "2018-06-25",
"end_date": "2018-06-25",
"per_page": "15",
"order_by_date": "desc",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"error": "Unauthenticated."
}HTTP Request
GET connector/api/field-force
Query Parameters
| Parameter | Status | Description |
|---|---|---|
contact_id |
optional | id of the contact |
assigned_to |
optional | id of the assigned user |
status |
optional | status of the visit (assigned, finished) |
start_date |
optional | Start date filter for visit on format:Y-m-d |
end_date |
optional | End date filter for visit on format:Y-m-d |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
order_by_date |
optional | Sort visit by visit on date ('asc', 'desc') |
Create Visit
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/field-force/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"contact_id":19,"visit_to":"reprehenderit","visit_address":"deserunt","assigned_to":16,"visit_on":"2021-12-28 17:23:00","visit_for":"tempora"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/field-force/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"contact_id": 19,
"visit_to": "reprehenderit",
"visit_address": "deserunt",
"assigned_to": 16,
"visit_on": "2021-12-28 17:23:00",
"visit_for": "tempora"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"contact_id": "6",
"assigned_to": "9",
"visit_on": "2022-01-15 17:23:00",
"visit_for": "",
"meet_with": "",
"meet_with2": "",
"meet_with3": "",
"meet_with_mobileno": "",
"meet_with_mobileno2": "",
"meet_with_mobileno3": "",
"meet_with_designation": "",
"meet_with_designation2": "",
"meet_with_designation3": "",
"visit_id": "2021\/0031",
"status": "assigned",
"business_id": 1,
"updated_at": "2021-12-30 11:00:47",
"created_at": "2021-12-30 11:00:47",
"id": 3
}
}HTTP Request
POST connector/api/field-force/create
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
contact_id |
integer | optional | id of the contact |
visit_to |
string | optional | Name of the visiting person or company if contact_id is not given |
visit_address |
string | optional | Address of the visiting person or company if contact_id is not given |
assigned_to |
integer | required | id of the assigned user |
visit_on |
format:Y-m-d | optional | H:i:s |
visit_for |
string | optional | Purpose of visiting |
Update Visit status
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/field-force/update-visit-status/17" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"status":"finished","reason_to_not_meet_contact":"animi","visited_on":"2021-12-28 17:23:00","visited_address":"Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India","latitude":"41.40338","longitude":"2.17403","comments":"sunt","photo":"cum","meet_with":"id","meet_with_mobileno":"voluptates"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/field-force/update-visit-status/17"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"status": "finished",
"reason_to_not_meet_contact": "animi",
"visited_on": "2021-12-28 17:23:00",
"visited_address": "Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India",
"latitude": "41.40338",
"longitude": "2.17403",
"comments": "sunt",
"photo": "cum",
"meet_with": "id",
"meet_with_mobileno": "voluptates"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 10,
"business_id": 1,
"contact_id": 6,
"assigned_to": 9,
"latitude": "23.6101808",
"longitude": "85.2799354",
"visited_address": "New address",
"status": "finished",
"visit_on": "2021-12-28 17:23:00",
"visit_for": "assigned from api",
"meet_with": "Name",
"meet_with2": "Name",
"meet_with3": "Name",
"meet_with_mobileno": "123456789",
"meet_with_mobileno2": "123456789",
"meet_with_mobileno3": "123456789",
"meet_with_designation": "dr",
"meet_with_designation2": "dr",
"meet_with_designation3": "dr",
"comments": "Users comment",
"created_at": "2021-12-28 17:35:13",
"updated_at": "2021-12-28 18:06:03"
}
}HTTP Request
POST connector/api/field-force/update-visit-status/{id}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
id |
required | id of the visit to be updated |
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
status |
string | optional | Current status of the visit (assigned, finished, met_contact, did_not_meet_contact) |
reason_to_not_meet_contact |
string | optional | Reason if status is did_not_meet_contact |
visited_on |
format:Y-m-d | optional | H:i:s |
visited_address |
string | optional | Full address of the contact |
latitude |
decimal | optional | Lattitude of the user location if full address is not given |
longitude |
decimal | optional | Longitude of the user location if full address is not given |
comments |
string | optional | Extra comments |
photo |
file | optional | Upload Photo as a file of the visit if any or base64 encoded image |
meet_with |
required | optional | name of person field force meet with |
meet_with_mobileno |
required | optional | mobile number of the person field force meet with |
Product management
List products
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/product?order_by=eligendi&order_direction=voluptatem&brand_id=omnis&category_id=enim&sub_category_id=et&location_id=1&selling_price_group=aut&send_lot_detail=perspiciatis&name=rerum&sku=cumque&per_page=10" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/product"
);
let params = {
"order_by": "eligendi",
"order_direction": "voluptatem",
"brand_id": "omnis",
"category_id": "enim",
"sub_category_id": "et",
"location_id": "1",
"selling_price_group": "aut",
"send_lot_detail": "perspiciatis",
"name": "rerum",
"sku": "cumque",
"per_page": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Men's Reverse Fleece Crew",
"business_id": 1,
"type": "single",
"sub_unit_ids": null,
"enable_stock": 1,
"alert_quantity": "5.0000",
"sku": "AS0001",
"barcode_type": "C128",
"expiry_period": null,
"expiry_period_type": null,
"enable_sr_no": 0,
"weight": null,
"product_custom_field1": null,
"product_custom_field2": null,
"product_custom_field3": null,
"product_custom_field4": null,
"image": null,
"woocommerce_media_id": null,
"product_description": null,
"created_by": 1,
"warranty_id": null,
"is_inactive": 0,
"repair_model_id": null,
"not_for_selling": 0,
"ecom_shipping_class_id": null,
"ecom_active_in_store": 1,
"woocommerce_product_id": 356,
"woocommerce_disable_sync": 0,
"image_url": "http:\/\/local.pos.com\/img\/default.png",
"product_variations": [
{
"id": 1,
"variation_template_id": null,
"name": "DUMMY",
"product_id": 1,
"is_dummy": 1,
"created_at": "2018-01-03 21:29:08",
"updated_at": "2018-01-03 21:29:08",
"variations": [
{
"id": 1,
"name": "DUMMY",
"product_id": 1,
"sub_sku": "AS0001",
"product_variation_id": 1,
"woocommerce_variation_id": null,
"variation_value_id": null,
"default_purchase_price": "130.0000",
"dpp_inc_tax": "143.0000",
"profit_percent": "0.0000",
"default_sell_price": "130.0000",
"sell_price_inc_tax": "143.0000",
"created_at": "2018-01-03 21:29:08",
"updated_at": "2020-06-09 00:23:22",
"deleted_at": null,
"combo_variations": null,
"variation_location_details": [
{
"id": 56,
"product_id": 1,
"product_variation_id": 1,
"variation_id": 1,
"location_id": 1,
"qty_available": "20.0000",
"created_at": "2020-06-08 23:46:40",
"updated_at": "2020-06-08 23:46:40"
}
],
"media": [
{
"id": 1,
"business_id": 1,
"file_name": "1591686466_978227300_nn.jpeg",
"description": null,
"uploaded_by": 9,
"model_type": "App\\Variation",
"woocommerce_media_id": null,
"model_id": 1,
"created_at": "2020-06-09 00:07:46",
"updated_at": "2020-06-09 00:07:46",
"display_name": "nn.jpeg",
"display_url": "http:\/\/local.pos.com\/uploads\/media\/1591686466_978227300_nn.jpeg"
}
],
"discounts": [
{
"id": 2,
"name": "FLAT 10%",
"business_id": 1,
"brand_id": null,
"category_id": null,
"location_id": 1,
"priority": 2,
"discount_type": "fixed",
"discount_amount": "5.0000",
"starts_at": "2021-09-01 11:45:00",
"ends_at": "2021-09-30 11:45:00",
"is_active": 1,
"spg": null,
"applicable_in_cg": 1,
"created_at": "2021-09-01 11:46:00",
"updated_at": "2021-09-01 12:12:55",
"formated_starts_at": " 11:45",
"formated_ends_at": " 11:45"
}
],
"selling_price_group": [
{
"id": 2,
"variation_id": 1,
"price_group_id": 1,
"price_inc_tax": "140.0000",
"created_at": "2020-06-09 00:23:31",
"updated_at": "2020-06-09 00:23:31"
}
]
}
]
}
],
"brand": {
"id": 1,
"business_id": 1,
"name": "Levis",
"description": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 21:19:47",
"updated_at": "2018-01-03 21:19:47"
},
"unit": {
"id": 1,
"business_id": 1,
"actual_name": "Pieces",
"short_name": "Pc(s)",
"allow_decimal": 0,
"base_unit_id": null,
"base_unit_multiplier": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 15:15:20",
"updated_at": "2018-01-03 15:15:20"
},
"category": {
"id": 1,
"name": "Men's",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:06:34",
"updated_at": "2018-01-03 21:06:34"
},
"sub_category": {
"id": 5,
"name": "Shirts",
"business_id": 1,
"short_code": null,
"parent_id": 1,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:08:18",
"updated_at": "2018-01-03 21:08:18"
},
"product_tax": {
"id": 1,
"business_id": 1,
"name": "VAT@10%",
"amount": 10,
"is_tax_group": 0,
"created_by": 1,
"woocommerce_tax_rate_id": null,
"deleted_at": null,
"created_at": "2018-01-04 02:40:07",
"updated_at": "2018-01-04 02:40:07"
},
"product_locations": [
{
"id": 1,
"business_id": 1,
"location_id": null,
"name": "Awesome Shop",
"landmark": "Linking Street",
"country": "USA",
"state": "Arizona",
"city": "Phoenix",
"zip_code": "85001",
"invoice_scheme_id": 1,
"invoice_layout_id": 1,
"selling_price_group_id": null,
"print_receipt_on_invoice": 1,
"receipt_printer_type": "browser",
"printer_id": null,
"mobile": null,
"alternate_number": null,
"email": null,
"website": null,
"featured_products": [
"5",
"71"
],
"is_active": 1,
"default_payment_accounts": "{\"cash\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"card\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"cheque\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"bank_transfer\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"other\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"custom_pay_1\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"custom_pay_2\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"custom_pay_3\":{\"is_enabled\":\"1\",\"account\":\"3\"}}",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:20",
"updated_at": "2020-06-09 01:07:05",
"pivot": {
"product_id": 2,
"location_id": 1
}
}
]
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/product?page=1",
"last": "http:\/\/local.pos.com\/connector\/api\/product?page=32",
"prev": null,
"next": "http:\/\/local.pos.com\/connector\/api\/product?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/product",
"per_page": 10,
"to": 10
}
}HTTP Request
GET connector/api/product
Query Parameters
| Parameter | Status | Description |
|---|---|---|
order_by |
optional | Values: product_name or newest |
order_direction |
optional | Values: asc or desc |
brand_id |
optional | comma separated ids of one or multiple brands |
category_id |
optional | comma separated ids of one or multiple category |
sub_category_id |
optional | comma separated ids of one or multiple sub-category |
location_id |
optional | |
selling_price_group |
optional | (1, 0) |
send_lot_detail |
optional | Send lot details in each variation location details(1, 0) |
name |
optional | Search term for product name |
sku |
optional | Search term for product sku |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Get the specified product
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/product/1?selling_price_group=officia&send_lot_detail=eius" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/product/1"
);
let params = {
"selling_price_group": "officia",
"send_lot_detail": "eius",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Men's Reverse Fleece Crew",
"business_id": 1,
"type": "single",
"sub_unit_ids": null,
"enable_stock": 1,
"alert_quantity": "5.0000",
"sku": "AS0001",
"barcode_type": "C128",
"expiry_period": null,
"expiry_period_type": null,
"enable_sr_no": 0,
"weight": null,
"product_custom_field1": null,
"product_custom_field2": null,
"product_custom_field3": null,
"product_custom_field4": null,
"image": null,
"woocommerce_media_id": null,
"product_description": null,
"created_by": 1,
"warranty_id": null,
"is_inactive": 0,
"repair_model_id": null,
"not_for_selling": 0,
"ecom_shipping_class_id": null,
"ecom_active_in_store": 1,
"woocommerce_product_id": 356,
"woocommerce_disable_sync": 0,
"image_url": "http:\/\/local.pos.com\/img\/default.png",
"product_variations": [
{
"id": 1,
"variation_template_id": null,
"name": "DUMMY",
"product_id": 1,
"is_dummy": 1,
"created_at": "2018-01-03 21:29:08",
"updated_at": "2018-01-03 21:29:08",
"variations": [
{
"id": 1,
"name": "DUMMY",
"product_id": 1,
"sub_sku": "AS0001",
"product_variation_id": 1,
"woocommerce_variation_id": null,
"variation_value_id": null,
"default_purchase_price": "130.0000",
"dpp_inc_tax": "143.0000",
"profit_percent": "0.0000",
"default_sell_price": "130.0000",
"sell_price_inc_tax": "143.0000",
"created_at": "2018-01-03 21:29:08",
"updated_at": "2020-06-09 00:23:22",
"deleted_at": null,
"combo_variations": null,
"variation_location_details": [
{
"id": 56,
"product_id": 1,
"product_variation_id": 1,
"variation_id": 1,
"location_id": 1,
"qty_available": "20.0000",
"created_at": "2020-06-08 23:46:40",
"updated_at": "2020-06-08 23:46:40"
}
],
"media": [
{
"id": 1,
"business_id": 1,
"file_name": "1591686466_978227300_nn.jpeg",
"description": null,
"uploaded_by": 9,
"model_type": "App\\Variation",
"woocommerce_media_id": null,
"model_id": 1,
"created_at": "2020-06-09 00:07:46",
"updated_at": "2020-06-09 00:07:46",
"display_name": "nn.jpeg",
"display_url": "http:\/\/local.pos.com\/uploads\/media\/1591686466_978227300_nn.jpeg"
}
],
"discounts": [
{
"id": 2,
"name": "FLAT 10%",
"business_id": 1,
"brand_id": null,
"category_id": null,
"location_id": 1,
"priority": 2,
"discount_type": "fixed",
"discount_amount": "5.0000",
"starts_at": "2021-09-01 11:45:00",
"ends_at": "2021-09-30 11:45:00",
"is_active": 1,
"spg": null,
"applicable_in_cg": 1,
"created_at": "2021-09-01 11:46:00",
"updated_at": "2021-09-01 12:12:55",
"formated_starts_at": " 11:45",
"formated_ends_at": " 11:45"
}
],
"selling_price_group": [
{
"id": 2,
"variation_id": 1,
"price_group_id": 1,
"price_inc_tax": "140.0000",
"created_at": "2020-06-09 00:23:31",
"updated_at": "2020-06-09 00:23:31"
}
]
}
]
}
],
"brand": {
"id": 1,
"business_id": 1,
"name": "Levis",
"description": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 21:19:47",
"updated_at": "2018-01-03 21:19:47"
},
"unit": {
"id": 1,
"business_id": 1,
"actual_name": "Pieces",
"short_name": "Pc(s)",
"allow_decimal": 0,
"base_unit_id": null,
"base_unit_multiplier": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 15:15:20",
"updated_at": "2018-01-03 15:15:20"
},
"category": {
"id": 1,
"name": "Men's",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:06:34",
"updated_at": "2018-01-03 21:06:34"
},
"sub_category": {
"id": 5,
"name": "Shirts",
"business_id": 1,
"short_code": null,
"parent_id": 1,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:08:18",
"updated_at": "2018-01-03 21:08:18"
},
"product_tax": {
"id": 1,
"business_id": 1,
"name": "VAT@10%",
"amount": 10,
"is_tax_group": 0,
"created_by": 1,
"woocommerce_tax_rate_id": null,
"deleted_at": null,
"created_at": "2018-01-04 02:40:07",
"updated_at": "2018-01-04 02:40:07"
},
"product_locations": [
{
"id": 1,
"business_id": 1,
"location_id": null,
"name": "Awesome Shop",
"landmark": "Linking Street",
"country": "USA",
"state": "Arizona",
"city": "Phoenix",
"zip_code": "85001",
"invoice_scheme_id": 1,
"invoice_layout_id": 1,
"selling_price_group_id": null,
"print_receipt_on_invoice": 1,
"receipt_printer_type": "browser",
"printer_id": null,
"mobile": null,
"alternate_number": null,
"email": null,
"website": null,
"featured_products": [
"5",
"71"
],
"is_active": 1,
"default_payment_accounts": "{\"cash\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"card\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"cheque\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"bank_transfer\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"other\":{\"is_enabled\":\"1\",\"account\":\"3\"},\"custom_pay_1\":{\"is_enabled\":\"1\",\"account\":\"1\"},\"custom_pay_2\":{\"is_enabled\":\"1\",\"account\":\"2\"},\"custom_pay_3\":{\"is_enabled\":\"1\",\"account\":\"3\"}}",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:20",
"updated_at": "2020-06-09 01:07:05",
"pivot": {
"product_id": 2,
"location_id": 1
}
}
]
}
]
}HTTP Request
GET connector/api/product/{product}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
product |
required | comma separated ids of products |
Query Parameters
| Parameter | Status | Description |
|---|---|---|
selling_price_group |
optional | (1, 0) |
send_lot_detail |
optional | Send lot details in each variation location details(1, 0) |
List Selling Price Group
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/selling-price-group" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/selling-price-group"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Retail",
"description": null,
"business_id": 1,
"is_active": 1,
"deleted_at": null,
"created_at": "2020-10-21 04:30:06",
"updated_at": "2020-11-16 18:23:15"
},
{
"id": 2,
"name": "Wholesale",
"description": null,
"business_id": 1,
"is_active": 1,
"deleted_at": null,
"created_at": "2020-10-21 04:30:21",
"updated_at": "2020-11-16 18:23:00"
}
]
}HTTP Request
GET connector/api/selling-price-group
List Variations
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/variation/2?product_id=aut&location_id=1&brand_id=sed&category_id=exercitationem&sub_category_id=voluptatum¬_for_selling=hic&name=maiores&sku=ut&per_page=10" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/variation/2"
);
let params = {
"product_id": "aut",
"location_id": "1",
"brand_id": "sed",
"category_id": "exercitationem",
"sub_category_id": "voluptatum",
"not_for_selling": "hic",
"name": "maiores",
"sku": "ut",
"per_page": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"variation_id": 1,
"variation_name": "",
"sub_sku": "AS0001",
"product_id": 1,
"product_name": "Men's Reverse Fleece Crew",
"sku": "AS0001",
"type": "single",
"business_id": 1,
"barcode_type": "C128",
"expiry_period": null,
"expiry_period_type": null,
"enable_sr_no": 0,
"weight": null,
"product_custom_field1": null,
"product_custom_field2": null,
"product_custom_field3": null,
"product_custom_field4": null,
"product_image": "1528728059_fleece_crew.jpg",
"product_description": null,
"warranty_id": null,
"brand_id": 1,
"brand_name": "Levis",
"unit_id": 1,
"enable_stock": 1,
"not_for_selling": 0,
"unit_name": "Pc(s)",
"unit_allow_decimal": 0,
"category_id": 1,
"category": "Men's",
"sub_category_id": 5,
"sub_category": "Shirts",
"tax_id": 1,
"tax_type": "exclusive",
"tax_name": "VAT@10%",
"tax_amount": 10,
"product_variation_id": 1,
"default_purchase_price": "130.0000",
"dpp_inc_tax": "143.0000",
"profit_percent": "0.0000",
"default_sell_price": "130.0000",
"sell_price_inc_tax": "143.0000",
"product_variation_name": "",
"variation_location_details": [],
"media": [],
"selling_price_group": [],
"product_image_url": "http:\/\/local.pos.com\/uploads\/img\/1528728059_fleece_crew.jpg",
"product_locations": [
{
"id": 1,
"business_id": 1,
"location_id": null,
"name": "Awesome Shop",
"landmark": "Linking Street",
"country": "USA",
"state": "Arizona",
"city": "Phoenix",
"zip_code": "85001",
"invoice_scheme_id": 1,
"invoice_layout_id": 1,
"selling_price_group_id": null,
"print_receipt_on_invoice": 1,
"receipt_printer_type": "browser",
"printer_id": null,
"mobile": null,
"alternate_number": null,
"email": null,
"website": null,
"featured_products": null,
"is_active": 1,
"default_payment_accounts": "",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:20",
"updated_at": "2019-12-11 04:53:39",
"pivot": {
"product_id": 1,
"location_id": 1
}
}
]
},
{
"variation_id": 2,
"variation_name": "28",
"sub_sku": "AS0002-1",
"product_id": 2,
"product_name": "Levis Men's Slimmy Fit Jeans",
"sku": "AS0002",
"type": "variable",
"business_id": 1,
"barcode_type": "C128",
"expiry_period": null,
"expiry_period_type": null,
"enable_sr_no": 0,
"weight": null,
"product_custom_field1": null,
"product_custom_field2": null,
"product_custom_field3": null,
"product_custom_field4": null,
"product_image": "1528727964_levis_jeans.jpg",
"product_description": null,
"warranty_id": null,
"brand_id": 1,
"brand_name": "Levis",
"unit_id": 1,
"enable_stock": 1,
"not_for_selling": 0,
"unit_name": "Pc(s)",
"unit_allow_decimal": 0,
"category_id": 1,
"category": "Men's",
"sub_category_id": 4,
"sub_category": "Jeans",
"tax_id": 1,
"tax_type": "exclusive",
"tax_name": "VAT@10%",
"tax_amount": 10,
"product_variation_id": 2,
"default_purchase_price": "70.0000",
"dpp_inc_tax": "77.0000",
"profit_percent": "0.0000",
"default_sell_price": "70.0000",
"sell_price_inc_tax": "77.0000",
"product_variation_name": "Waist Size",
"variation_location_details": [
{
"id": 1,
"product_id": 2,
"product_variation_id": 2,
"variation_id": 2,
"location_id": 1,
"qty_available": "50.0000",
"created_at": "2018-01-06 06:57:11",
"updated_at": "2020-08-04 04:11:27"
}
],
"media": [
{
"id": 1,
"business_id": 1,
"file_name": "1596701997_743693452_test.jpg",
"description": null,
"uploaded_by": 9,
"model_type": "App\\Variation",
"woocommerce_media_id": null,
"model_id": 2,
"created_at": "2020-08-06 13:49:57",
"updated_at": "2020-08-06 13:49:57",
"display_name": "test.jpg",
"display_url": "http:\/\/local.pos.com\/uploads\/media\/1596701997_743693452_test.jpg"
}
],
"selling_price_group": [],
"product_image_url": "http:\/\/local.pos.com\/uploads\/img\/1528727964_levis_jeans.jpg",
"product_locations": [
{
"id": 1,
"business_id": 1,
"location_id": null,
"name": "Awesome Shop",
"landmark": "Linking Street",
"country": "USA",
"state": "Arizona",
"city": "Phoenix",
"zip_code": "85001",
"invoice_scheme_id": 1,
"invoice_layout_id": 1,
"selling_price_group_id": null,
"print_receipt_on_invoice": 1,
"receipt_printer_type": "browser",
"printer_id": null,
"mobile": null,
"alternate_number": null,
"email": null,
"website": null,
"featured_products": null,
"is_active": 1,
"default_payment_accounts": "",
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:20",
"updated_at": "2019-12-11 04:53:39",
"pivot": {
"product_id": 2,
"location_id": 1
}
}
],
"discounts": [
{
"id": 2,
"name": "FLAT 10%",
"business_id": 1,
"brand_id": null,
"category_id": null,
"location_id": 1,
"priority": 2,
"discount_type": "fixed",
"discount_amount": "5.0000",
"starts_at": "2021-09-01 11:45:00",
"ends_at": "2021-09-30 11:45:00",
"is_active": 1,
"spg": null,
"applicable_in_cg": 1,
"created_at": "2021-09-01 11:46:00",
"updated_at": "2021-09-01 12:12:55",
"formated_starts_at": " 11:45",
"formated_ends_at": " 11:45"
}
]
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/variation?page=1",
"last": null,
"prev": null,
"next": "http:\/\/local.pos.com\/connector\/api\/variation?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/variation",
"per_page": "2",
"to": 2
}
}HTTP Request
GET connector/api/variation/{id?}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
id |
optional | comma separated ids of variations |
Query Parameters
| Parameter | Status | Description |
|---|---|---|
product_id |
optional | Filter by comma separated products ids |
location_id |
optional | |
brand_id |
optional | |
category_id |
optional | |
sub_category_id |
optional | |
not_for_selling |
optional | Values: 0 or 1 |
name |
optional | Search term for product name |
sku |
optional | Search term for product sku |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Sales management
List sells
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/sell?location_id=1&contact_id=sunt&status=final&payment_status=due%2Cpartial&start_date=2018-06-25&end_date=2018-06-25&user_id=enim&res_waiter_id=cumque&shipping_status=ordered&source=repudiandae&only_subscriptions=asperiores&send_purchase_details=a&order_by_date=desc&per_page=10" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/sell"
);
let params = {
"location_id": "1",
"contact_id": "sunt",
"status": "final",
"payment_status": "due,partial",
"start_date": "2018-06-25",
"end_date": "2018-06-25",
"user_id": "enim",
"res_waiter_id": "cumque",
"shipping_status": "ordered",
"source": "repudiandae",
"only_subscriptions": "asperiores",
"send_purchase_details": "a",
"order_by_date": "desc",
"per_page": "10",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 6,
"business_id": 1,
"location_id": 1,
"res_table_id": null,
"res_waiter_id": null,
"res_order_status": null,
"type": "sell",
"sub_type": null,
"status": "final",
"is_quotation": 0,
"payment_status": "paid",
"adjustment_type": null,
"contact_id": 4,
"customer_group_id": null,
"invoice_no": "AS0001",
"ref_no": "",
"source": null,
"subscription_no": null,
"subscription_repeat_on": null,
"transaction_date": "2018-04-10 13:23:21",
"total_before_tax": "770.0000",
"tax_id": null,
"tax_amount": "0.0000",
"discount_type": "percentage",
"discount_amount": "0.0000",
"rp_redeemed": 0,
"rp_redeemed_amount": "0.0000",
"shipping_details": null,
"shipping_address": null,
"shipping_status": null,
"delivered_to": null,
"shipping_charges": "0.0000",
"additional_notes": null,
"staff_note": null,
"round_off_amount": "0.0000",
"final_total": "770.0000",
"expense_category_id": null,
"expense_for": null,
"commission_agent": null,
"document": null,
"is_direct_sale": 0,
"is_suspend": 0,
"exchange_rate": "1.000",
"total_amount_recovered": null,
"transfer_parent_id": null,
"return_parent_id": null,
"opening_stock_product_id": null,
"created_by": 1,
"import_batch": null,
"import_time": null,
"types_of_service_id": null,
"packing_charge": null,
"packing_charge_type": null,
"service_custom_field_1": null,
"service_custom_field_2": null,
"service_custom_field_3": null,
"service_custom_field_4": null,
"mfg_parent_production_purchase_id": null,
"mfg_wasted_units": null,
"mfg_production_cost": "0.0000",
"mfg_is_final": 0,
"is_created_from_api": 0,
"essentials_duration": "0.00",
"essentials_duration_unit": null,
"essentials_amount_per_unit_duration": "0.0000",
"essentials_allowances": null,
"essentials_deductions": null,
"rp_earned": 0,
"repair_completed_on": null,
"repair_warranty_id": null,
"repair_brand_id": null,
"repair_status_id": null,
"repair_model_id": null,
"repair_defects": null,
"repair_serial_no": null,
"repair_updates_email": 0,
"repair_updates_sms": 0,
"repair_checklist": null,
"repair_security_pwd": null,
"repair_security_pattern": null,
"repair_due_date": null,
"repair_device_id": null,
"order_addresses": null,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"invoice_token": null,
"pay_term_number": null,
"pay_term_type": null,
"pjt_project_id": null,
"pjt_title": null,
"woocommerce_order_id": null,
"selling_price_group_id": null,
"created_at": "2018-01-06 07:06:11",
"updated_at": "2018-01-06 07:06:11",
"sell_lines": [
{
"id": 1,
"transaction_id": 6,
"product_id": 2,
"variation_id": 3,
"quantity": 10,
"mfg_waste_percent": "0.0000",
"quantity_returned": "0.0000",
"unit_price_before_discount": "70.0000",
"unit_price": "70.0000",
"line_discount_type": null,
"line_discount_amount": "0.0000",
"unit_price_inc_tax": "77.0000",
"item_tax": "7.0000",
"tax_id": 1,
"discount_id": null,
"lot_no_line_id": null,
"sell_line_note": null,
"res_service_staff_id": null,
"res_line_order_status": null,
"woocommerce_line_items_id": null,
"parent_sell_line_id": null,
"children_type": "",
"sub_unit_id": null,
"created_at": "2018-01-06 07:06:11",
"updated_at": "2018-01-06 07:06:11"
}
],
"payment_lines": [
{
"id": 1,
"transaction_id": 6,
"business_id": null,
"is_return": 0,
"amount": "770.0000",
"method": "cash",
"transaction_no": null,
"card_transaction_number": null,
"card_number": null,
"card_type": "visa",
"card_holder_name": null,
"card_month": null,
"card_year": null,
"card_security": null,
"cheque_number": null,
"bank_account_number": null,
"paid_on": "2018-01-09 17:30:35",
"created_by": 1,
"payment_for": null,
"parent_id": null,
"note": null,
"document": null,
"payment_ref_no": null,
"account_id": null,
"created_at": "2018-01-06 01:36:11",
"updated_at": "2018-01-06 01:36:11"
}
],
"invoice_url": "http:\/\/local.pos.com\/invoice\/6dfd77eb80f4976b456128e7f1311c9f",
"payment_link": "http:\/\/local.pos.com\/pay\/6dfd77eb80f4976b456128e7f1311c9f"
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/sell?page=1",
"last": "http:\/\/local.pos.com\/connector\/api\/sell?page=6",
"prev": null,
"next": "http:\/\/local.pos.com\/connector\/api\/sell?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/sell",
"per_page": 10,
"to": 10
}
}HTTP Request
GET connector/api/sell
Query Parameters
| Parameter | Status | Description |
|---|---|---|
location_id |
optional | id of the location |
contact_id |
optional | id of the customer |
status |
optional | Sell status. Available values final, draft, quotation, proforma |
payment_status |
optional | Comma separated values of payment statuses. Available values due, partial, paid, overdue |
start_date |
optional | format:Y-m-d |
end_date |
optional | format:Y-m-d |
user_id |
optional | id of the user who created the sale |
res_waiter_id |
optional | id of the service staff assigned with the sale |
shipping_status |
optional | Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled') |
source |
optional | Source of the sale |
only_subscriptions |
optional | Filter only subcription invoices (1, 0) |
send_purchase_details |
optional | Get purchase details of each sell line (1, 0) |
order_by_date |
optional | Sort sell list by date ('asc', 'desc') |
per_page |
optional | Total records per page. default: 10, Set -1 for no pagination |
Create sell
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/sell" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"sells":[{"location_id":1,"contact_id":2,"transaction_date":"2020-07-22 15:48:29","invoice_no":"quia","source":"api, phone, woocommerce","status":"final","sub_status":"null","is_quotation":true,"tax_rate_id":11,"discount_amount":10,"discount_type":"fixed","sale_note":"dolore","staff_note":"illo","commission_agent":8,"shipping_details":"Express Delivery","shipping_address":"at","shipping_status":"ordered","delivered_to":"'Mr robin'","shipping_charges":10,"packing_charge":10,"exchange_rate":1,"selling_price_group_id":1,"pay_term_number":3,"pay_term_type":"months","is_suspend":false,"is_recurring":0,"recur_interval":6,"recur_interval_type":"months","subscription_repeat_on":15,"subscription_no":"quidem","recur_repetitions":2,"rp_redeemed":16,"rp_redeemed_amount":13.5,"types_of_service_id":4,"service_custom_field_1":"aliquid","service_custom_field_2":"adipisci","service_custom_field_3":"et","service_custom_field_4":"ut","service_custom_field_5":"quod","service_custom_field_6":"vel","round_off_amount":1.897149600000000102539843283011578023433685302734375,"table_id":1,"res_waiter_id":15,"change_return":0,"products":[{"product_id":17,"variation_id":58,"quantity":1,"unit_price":437.5,"tax_rate_id":0,"discount_amount":0,"discount_type":"percentage","sub_unit_id":10,"note":"necessitatibus"}],"payments":[{"amount":453.1299999999999954525264911353588104248046875,"method":"cash","account_id":14,"card_number":"labore","card_holder_name":"neque","card_transaction_number":"impedit","card_type":"aut","card_month":"sapiente","card_year":"eaque","card_security":"blanditiis","transaction_no_1":"ipsa","transaction_no_2":"rerum","transaction_no_3":"omnis","bank_account_number":"qui","note":"quo","cheque_number":"sequi"}]}]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/sell"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"sells": [
{
"location_id": 1,
"contact_id": 2,
"transaction_date": "2020-07-22 15:48:29",
"invoice_no": "quia",
"source": "api, phone, woocommerce",
"status": "final",
"sub_status": "null",
"is_quotation": true,
"tax_rate_id": 11,
"discount_amount": 10,
"discount_type": "fixed",
"sale_note": "dolore",
"staff_note": "illo",
"commission_agent": 8,
"shipping_details": "Express Delivery",
"shipping_address": "at",
"shipping_status": "ordered",
"delivered_to": "'Mr robin'",
"shipping_charges": 10,
"packing_charge": 10,
"exchange_rate": 1,
"selling_price_group_id": 1,
"pay_term_number": 3,
"pay_term_type": "months",
"is_suspend": false,
"is_recurring": 0,
"recur_interval": 6,
"recur_interval_type": "months",
"subscription_repeat_on": 15,
"subscription_no": "quidem",
"recur_repetitions": 2,
"rp_redeemed": 16,
"rp_redeemed_amount": 13.5,
"types_of_service_id": 4,
"service_custom_field_1": "aliquid",
"service_custom_field_2": "adipisci",
"service_custom_field_3": "et",
"service_custom_field_4": "ut",
"service_custom_field_5": "quod",
"service_custom_field_6": "vel",
"round_off_amount": 1.897149600000000102539843283011578023433685302734375,
"table_id": 1,
"res_waiter_id": 15,
"change_return": 0,
"products": [
{
"product_id": 17,
"variation_id": 58,
"quantity": 1,
"unit_price": 437.5,
"tax_rate_id": 0,
"discount_amount": 0,
"discount_type": "percentage",
"sub_unit_id": 10,
"note": "necessitatibus"
}
],
"payments": [
{
"amount": 453.1299999999999954525264911353588104248046875,
"method": "cash",
"account_id": 14,
"card_number": "labore",
"card_holder_name": "neque",
"card_transaction_number": "impedit",
"card_type": "aut",
"card_month": "sapiente",
"card_year": "eaque",
"card_security": "blanditiis",
"transaction_no_1": "ipsa",
"transaction_no_2": "rerum",
"transaction_no_3": "omnis",
"bank_account_number": "qui",
"note": "quo",
"cheque_number": "sequi"
}
]
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 6,
"business_id": 1,
"location_id": 1,
"res_table_id": null,
"res_waiter_id": null,
"res_order_status": null,
"type": "sell",
"sub_type": null,
"status": "final",
"is_quotation": 0,
"payment_status": "paid",
"adjustment_type": null,
"contact_id": 4,
"customer_group_id": null,
"invoice_no": "AS0001",
"ref_no": "",
"source": null,
"subscription_no": null,
"subscription_repeat_on": null,
"transaction_date": "2018-04-10 13:23:21",
"total_before_tax": "770.0000",
"tax_id": null,
"tax_amount": "0.0000",
"discount_type": "percentage",
"discount_amount": "0.0000",
"rp_redeemed": 0,
"rp_redeemed_amount": "0.0000",
"shipping_details": null,
"shipping_address": null,
"shipping_status": null,
"delivered_to": null,
"shipping_charges": "0.0000",
"additional_notes": null,
"staff_note": null,
"round_off_amount": "0.0000",
"final_total": "770.0000",
"expense_category_id": null,
"expense_for": null,
"commission_agent": null,
"document": null,
"is_direct_sale": 0,
"is_suspend": 0,
"exchange_rate": "1.000",
"total_amount_recovered": null,
"transfer_parent_id": null,
"return_parent_id": null,
"opening_stock_product_id": null,
"created_by": 1,
"import_batch": null,
"import_time": null,
"types_of_service_id": null,
"packing_charge": null,
"packing_charge_type": null,
"service_custom_field_1": null,
"service_custom_field_2": null,
"service_custom_field_3": null,
"service_custom_field_4": null,
"mfg_parent_production_purchase_id": null,
"mfg_wasted_units": null,
"mfg_production_cost": "0.0000",
"mfg_is_final": 0,
"is_created_from_api": 0,
"essentials_duration": "0.00",
"essentials_duration_unit": null,
"essentials_amount_per_unit_duration": "0.0000",
"essentials_allowances": null,
"essentials_deductions": null,
"rp_earned": 0,
"repair_completed_on": null,
"repair_warranty_id": null,
"repair_brand_id": null,
"repair_status_id": null,
"repair_model_id": null,
"repair_defects": null,
"repair_serial_no": null,
"repair_updates_email": 0,
"repair_updates_sms": 0,
"repair_checklist": null,
"repair_security_pwd": null,
"repair_security_pattern": null,
"repair_due_date": null,
"repair_device_id": null,
"order_addresses": null,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"invoice_token": null,
"pay_term_number": null,
"pay_term_type": null,
"pjt_project_id": null,
"pjt_title": null,
"woocommerce_order_id": null,
"selling_price_group_id": null,
"created_at": "2018-01-06 07:06:11",
"updated_at": "2018-01-06 07:06:11",
"invoice_url": "http:\/\/local.pos.com\/invoice\/6dfd77eb80f4976b456128e7f1311c9f",
"payment_link": "http:\/\/local.pos.com\/pay\/6dfd77eb80f4976b456128e7f1311c9f",
"sell_lines": [
{
"id": 1,
"transaction_id": 6,
"product_id": 2,
"variation_id": 3,
"quantity": 10,
"mfg_waste_percent": "0.0000",
"quantity_returned": "0.0000",
"unit_price_before_discount": "70.0000",
"unit_price": "70.0000",
"line_discount_type": null,
"line_discount_amount": "0.0000",
"unit_price_inc_tax": "77.0000",
"item_tax": "7.0000",
"tax_id": 1,
"discount_id": null,
"lot_no_line_id": null,
"sell_line_note": null,
"res_service_staff_id": null,
"res_line_order_status": null,
"woocommerce_line_items_id": null,
"parent_sell_line_id": null,
"children_type": "",
"sub_unit_id": null,
"created_at": "2018-01-06 07:06:11",
"updated_at": "2018-01-06 07:06:11"
}
],
"payment_lines": [
{
"id": 1,
"transaction_id": 6,
"business_id": null,
"is_return": 0,
"amount": "770.0000",
"method": "cash",
"transaction_no": null,
"card_transaction_number": null,
"card_number": null,
"card_type": "visa",
"card_holder_name": null,
"card_month": null,
"card_year": null,
"card_security": null,
"cheque_number": null,
"bank_account_number": null,
"paid_on": "2018-01-09 17:30:35",
"created_by": 1,
"payment_for": null,
"parent_id": null,
"note": null,
"document": null,
"payment_ref_no": null,
"account_id": null,
"created_at": "2018-01-06 01:36:11",
"updated_at": "2018-01-06 01:36:11"
}
]
}
]
}HTTP Request
POST connector/api/sell
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
sells.*.location_id |
integer | required | id of the business location |
sells.*.contact_id |
integer | required | id of the customer |
sells.*.transaction_date |
string | optional | transaction date format:Y-m-d H:i:s, |
sells.*.invoice_no |
string | optional | Invoice number |
sells.*.source |
string | optional | Source of the invoice |
sells.*.status |
string | optional | sale status (final, draft) |
sells.*.sub_status |
string | optional | sale sub status ("quotation" for quotation and "proforma" for proforma invoice) |
sells.*.is_quotation |
boolean | optional | Is sell quotation (0, 1), If 1 status should be draft |
sells.*.tax_rate_id |
integer | optional | id of the tax rate applicable to the sale |
sells.*.discount_amount |
float | optional | discount amount applicable to the sale |
sells.*.discount_type |
string | optional | type of the discount amount (fixed, percentage) |
sells.*.sale_note |
string | optional | |
sells.*.staff_note |
string | optional | |
sells.*.commission_agent |
integer | optional | commission agent id |
sells.*.shipping_details |
string | optional | shipping details |
sells.*.shipping_address |
string | optional | shipping address |
sells.*.shipping_status |
string | optional | ('ordered', 'packed', 'shipped', 'delivered', 'cancelled') |
sells.*.delivered_to |
string | optional | Name of the person recieved the consignment |
sells.*.shipping_charges |
float | optional | shipping amount |
sells.*.packing_charge |
float | optional | packing charge |
sells.*.exchange_rate |
float | optional | exchange rate for the currency used |
sells.*.selling_price_group_id |
integer | optional | id of the selling price group |
sells.*.pay_term_number |
integer | optional | pay term value |
sells.*.pay_term_type |
string | optional | type of the pay term value ('days', 'months') |
sells.*.is_suspend |
boolean | optional | Is suspended sale (0, 1) |
sells.*.is_recurring |
integer | optional | whether the invoice is recurring (0, 1) |
sells.*.recur_interval |
integer | optional | value of the interval invoice will be regenerated |
sells.*.recur_interval_type |
string | optional | type of the recur interval ('days', 'months', 'years') |
sells.*.subscription_repeat_on |
integer | optional | day of the month on which invoice will be generated if recur interval type is months (1-30) |
sells.*.subscription_no |
string | optional | subscription number |
sells.*.recur_repetitions |
integer | optional | total number of invoices to be generated |
sells.*.rp_redeemed |
integer | optional | reward points redeemed |
sells.*.rp_redeemed_amount |
float | optional | reward point redeemed amount after conversion |
sells.*.types_of_service_id |
integer | optional | types of service id |
sells.*.service_custom_field_1 |
string | optional | types of service custom field 1 |
sells.*.service_custom_field_2 |
string | optional | types of service custom field 2 |
sells.*.service_custom_field_3 |
string | optional | types of service custom field 3 |
sells.*.service_custom_field_4 |
string | optional | types of service custom field 4 |
sells.*.service_custom_field_5 |
string | optional | types of service custom field 5 |
sells.*.service_custom_field_6 |
string | optional | types of service custom field 6 |
sells.*.round_off_amount |
float | optional | round off amount on total payable |
sells.*.table_id |
integer | optional | id of the table |
sells.*.res_waiter_id |
integer | optional | id of the service staff assigned to the sale |
sells.*.change_return |
float | optional | Excess paid amount |
sells.*.products |
array | required | array of the products for the sale |
sells.*.payments |
array | optional | payment lines for the sale |
sells.*.products.*.product_id |
integer | required | product id |
sells.*.products.*.variation_id |
integer | required | variation id |
sells.*.products.*.quantity |
float | required | quantity |
sells.*.products.*.unit_price |
float | optional | unit selling price |
sells.*.products.*.tax_rate_id |
integer | optional | tax rate id applicable on the product |
sells.*.products.*.discount_amount |
float | optional | discount amount applicable on the product |
sells.*.products.*.discount_type |
string | optional | type of discount amount ('fixed', 'percentage') |
sells.*.products.*.sub_unit_id |
integer | optional | sub unit id |
sells.*.products.*.note |
string | optional | note for the product |
sells.*.payments.*.amount |
float | required | amount of the payment |
sells.*.payments.*.method |
string | optional | payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') |
sells.*.payments.*.account_id |
integer | optional | account id |
sells.*.payments.*.card_number |
string | optional | |
sells.*.payments.*.card_holder_name |
string | optional | |
sells.*.payments.*.card_transaction_number |
string | optional | |
sells.*.payments.*.card_type |
string | optional | |
sells.*.payments.*.card_month |
string | optional | |
sells.*.payments.*.card_year |
string | optional | |
sells.*.payments.*.card_security |
string | optional | |
sells.*.payments.*.transaction_no_1 |
string | optional | |
sells.*.payments.*.transaction_no_2 |
string | optional | |
sells.*.payments.*.transaction_no_3 |
string | optional | |
sells.*.payments.*.bank_account_number |
string | optional | |
sells.*.payments.*.note |
string | optional | payment note |
sells.*.payments.*.cheque_number |
string | optional |
Get the specified sell
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/sell/55?send_purchase_details=fugiat" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/sell/55"
);
let params = {
"send_purchase_details": "fugiat",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 55,
"business_id": 1,
"location_id": 1,
"res_table_id": 5,
"res_waiter_id": null,
"res_order_status": null,
"type": "sell",
"sub_type": null,
"status": "final",
"is_quotation": 0,
"payment_status": "paid",
"adjustment_type": null,
"contact_id": 1,
"customer_group_id": null,
"invoice_no": "AS0007",
"ref_no": "",
"source": null,
"subscription_no": null,
"subscription_repeat_on": null,
"transaction_date": "2020-06-04 23:29:36",
"total_before_tax": "437.5000",
"tax_id": 1,
"tax_amount": "39.3750",
"discount_type": "percentage",
"discount_amount": "10.0000",
"rp_redeemed": 0,
"rp_redeemed_amount": "0.0000",
"shipping_details": "Express Delivery",
"shipping_address": null,
"shipping_status": "ordered",
"delivered_to": "Mr Robin",
"shipping_charges": "10.0000",
"additional_notes": null,
"staff_note": null,
"round_off_amount": "0.0000",
"final_total": "453.1300",
"expense_category_id": null,
"expense_for": null,
"commission_agent": null,
"document": null,
"is_direct_sale": 0,
"is_suspend": 0,
"exchange_rate": "1.000",
"total_amount_recovered": null,
"transfer_parent_id": null,
"return_parent_id": null,
"opening_stock_product_id": null,
"created_by": 9,
"import_batch": null,
"import_time": null,
"types_of_service_id": 1,
"packing_charge": "10.0000",
"packing_charge_type": "fixed",
"service_custom_field_1": null,
"service_custom_field_2": null,
"service_custom_field_3": null,
"service_custom_field_4": null,
"mfg_parent_production_purchase_id": null,
"mfg_wasted_units": null,
"mfg_production_cost": "0.0000",
"mfg_is_final": 0,
"is_created_from_api": 0,
"essentials_duration": "0.00",
"essentials_duration_unit": null,
"essentials_amount_per_unit_duration": "0.0000",
"essentials_allowances": null,
"essentials_deductions": null,
"rp_earned": 0,
"repair_completed_on": null,
"repair_warranty_id": null,
"repair_brand_id": null,
"repair_status_id": null,
"repair_model_id": null,
"repair_defects": null,
"repair_serial_no": null,
"repair_updates_email": 0,
"repair_updates_sms": 0,
"repair_checklist": null,
"repair_security_pwd": null,
"repair_security_pattern": null,
"repair_due_date": null,
"repair_device_id": null,
"order_addresses": null,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": "days",
"recur_repetitions": 0,
"recur_stopped_on": null,
"recur_parent_id": null,
"invoice_token": null,
"pay_term_number": null,
"pay_term_type": null,
"pjt_project_id": null,
"pjt_title": null,
"woocommerce_order_id": null,
"selling_price_group_id": 0,
"created_at": "2020-06-04 23:29:36",
"updated_at": "2020-06-04 23:29:36",
"sell_lines": [
{
"id": 38,
"transaction_id": 55,
"product_id": 17,
"variation_id": 58,
"quantity": 1,
"mfg_waste_percent": "0.0000",
"quantity_returned": "0.0000",
"unit_price_before_discount": "437.5000",
"unit_price": "437.5000",
"line_discount_type": "fixed",
"line_discount_amount": "0.0000",
"unit_price_inc_tax": "437.5000",
"item_tax": "0.0000",
"tax_id": null,
"discount_id": null,
"lot_no_line_id": null,
"sell_line_note": "",
"res_service_staff_id": null,
"res_line_order_status": null,
"woocommerce_line_items_id": null,
"parent_sell_line_id": null,
"children_type": "",
"sub_unit_id": null,
"created_at": "2020-06-04 23:29:36",
"updated_at": "2020-06-04 23:29:36"
}
],
"payment_lines": [
{
"id": 37,
"transaction_id": 55,
"business_id": 1,
"is_return": 0,
"amount": "453.1300",
"method": "cash",
"transaction_no": null,
"card_transaction_number": null,
"card_number": null,
"card_type": "credit",
"card_holder_name": null,
"card_month": null,
"card_year": null,
"card_security": null,
"cheque_number": null,
"bank_account_number": null,
"paid_on": "2020-06-04 23:29:36",
"created_by": 9,
"payment_for": 1,
"parent_id": null,
"note": null,
"document": null,
"payment_ref_no": "SP2020\/0002",
"account_id": null,
"created_at": "2020-06-04 23:29:36",
"updated_at": "2020-06-04 23:29:36"
}
],
"invoice_url": "http:\/\/local.pos.com\/invoice\/6dfd77eb80f4976b456128e7f1311c9f",
"payment_link": "http:\/\/local.pos.com\/pay\/6dfd77eb80f4976b456128e7f1311c9f"
}
]
}HTTP Request
GET connector/api/sell/{sell}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
sell |
required | comma separated ids of the sells |
Query Parameters
| Parameter | Status | Description |
|---|---|---|
send_purchase_details |
optional | Get purchase details of each sell line (1, 0) |
Update sell
Requires authentication
Example request:
curl -X PUT \
"https://dev.scalerp.com/public/connector/api/sell/6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"contact_id":6,"transaction_date":"2020-5-7 15:20:22","status":"final","sub_status":"null","is_quotation":true,"tax_rate_id":18,"discount_amount":10,"discount_type":"fixed","sale_note":"ducimus","source":"tempora","staff_note":"voluptate","is_suspend":false,"commission_agent":10,"shipping_details":"Express Delivery","shipping_address":"excepturi","shipping_status":"ordered","delivered_to":"Mr Robin","shipping_charges":10,"packing_charge":10,"exchange_rate":1,"selling_price_group_id":19,"pay_term_number":3,"pay_term_type":"months","is_recurring":0,"recur_interval":15,"recur_interval_type":"days","subscription_repeat_on":7,"subscription_no":"et","recur_repetitions":14,"rp_redeemed":2,"rp_redeemed_amount":13.5,"types_of_service_id":16,"service_custom_field_1":"non","service_custom_field_2":"non","service_custom_field_3":"qui","service_custom_field_4":"corrupti","service_custom_field_5":"amet","service_custom_field_6":"repellat","round_off_amount":16398327.00007593445479869842529296875,"table_id":4,"res_waiter_id":6,"change_return":0,"change_return_id":5,"products":[{"sell_line_id":9,"product_id":17,"variation_id":58,"quantity":1,"unit_price":437.5,"tax_rate_id":3,"discount_amount":0,"discount_type":"percentage","sub_unit_id":12,"note":"autem"}],"payments":[{"payment_id":6,"amount":453.1299999999999954525264911353588104248046875,"method":"cash","account_id":6,"card_number":"consectetur","card_holder_name":"minima","card_transaction_number":"reiciendis","card_type":"delectus","card_month":"quis","card_year":"provident","card_security":"tempora","transaction_no_1":"debitis","transaction_no_2":"quibusdam","transaction_no_3":"possimus","note":"maiores","cheque_number":"aperiam","bank_account_number":"dolores"}]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/sell/6"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"contact_id": 6,
"transaction_date": "2020-5-7 15:20:22",
"status": "final",
"sub_status": "null",
"is_quotation": true,
"tax_rate_id": 18,
"discount_amount": 10,
"discount_type": "fixed",
"sale_note": "ducimus",
"source": "tempora",
"staff_note": "voluptate",
"is_suspend": false,
"commission_agent": 10,
"shipping_details": "Express Delivery",
"shipping_address": "excepturi",
"shipping_status": "ordered",
"delivered_to": "Mr Robin",
"shipping_charges": 10,
"packing_charge": 10,
"exchange_rate": 1,
"selling_price_group_id": 19,
"pay_term_number": 3,
"pay_term_type": "months",
"is_recurring": 0,
"recur_interval": 15,
"recur_interval_type": "days",
"subscription_repeat_on": 7,
"subscription_no": "et",
"recur_repetitions": 14,
"rp_redeemed": 2,
"rp_redeemed_amount": 13.5,
"types_of_service_id": 16,
"service_custom_field_1": "non",
"service_custom_field_2": "non",
"service_custom_field_3": "qui",
"service_custom_field_4": "corrupti",
"service_custom_field_5": "amet",
"service_custom_field_6": "repellat",
"round_off_amount": 16398327.00007593445479869842529296875,
"table_id": 4,
"res_waiter_id": 6,
"change_return": 0,
"change_return_id": 5,
"products": [
{
"sell_line_id": 9,
"product_id": 17,
"variation_id": 58,
"quantity": 1,
"unit_price": 437.5,
"tax_rate_id": 3,
"discount_amount": 0,
"discount_type": "percentage",
"sub_unit_id": 12,
"note": "autem"
}
],
"payments": [
{
"payment_id": 6,
"amount": 453.1299999999999954525264911353588104248046875,
"method": "cash",
"account_id": 6,
"card_number": "consectetur",
"card_holder_name": "minima",
"card_transaction_number": "reiciendis",
"card_type": "delectus",
"card_month": "quis",
"card_year": "provident",
"card_security": "tempora",
"transaction_no_1": "debitis",
"transaction_no_2": "quibusdam",
"transaction_no_3": "possimus",
"note": "maiores",
"cheque_number": "aperiam",
"bank_account_number": "dolores"
}
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 91,
"business_id": 1,
"location_id": 1,
"res_table_id": null,
"res_waiter_id": null,
"res_order_status": null,
"type": "sell",
"sub_type": null,
"status": "final",
"is_quotation": 0,
"payment_status": "paid",
"adjustment_type": null,
"contact_id": 1,
"customer_group_id": 1,
"invoice_no": "AS0020",
"ref_no": "",
"source": null,
"subscription_no": null,
"subscription_repeat_on": null,
"transaction_date": "25-09-2020 15:22",
"total_before_tax": 962.5,
"tax_id": null,
"tax_amount": 0,
"discount_type": "fixed",
"discount_amount": "19.5000",
"rp_redeemed": 0,
"rp_redeemed_amount": "0.0000",
"shipping_details": null,
"shipping_address": null,
"shipping_status": null,
"delivered_to": null,
"shipping_charges": "0.0000",
"additional_notes": null,
"staff_note": null,
"round_off_amount": "0.0000",
"final_total": 943,
"expense_category_id": null,
"expense_for": null,
"commission_agent": null,
"document": null,
"is_direct_sale": 0,
"is_suspend": 0,
"exchange_rate": "1.000",
"total_amount_recovered": null,
"transfer_parent_id": null,
"return_parent_id": null,
"opening_stock_product_id": null,
"created_by": 9,
"import_batch": null,
"import_time": null,
"types_of_service_id": null,
"packing_charge": "0.0000",
"packing_charge_type": null,
"service_custom_field_1": null,
"service_custom_field_2": null,
"service_custom_field_3": null,
"service_custom_field_4": null,
"mfg_parent_production_purchase_id": null,
"mfg_wasted_units": null,
"mfg_production_cost": "0.0000",
"mfg_production_cost_type": "percentage",
"mfg_is_final": 0,
"is_created_from_api": 0,
"essentials_duration": "0.00",
"essentials_duration_unit": null,
"essentials_amount_per_unit_duration": "0.0000",
"essentials_allowances": null,
"essentials_deductions": null,
"rp_earned": 0,
"repair_completed_on": null,
"repair_warranty_id": null,
"repair_brand_id": null,
"repair_status_id": null,
"repair_model_id": null,
"repair_job_sheet_id": null,
"repair_defects": null,
"repair_serial_no": null,
"repair_checklist": null,
"repair_security_pwd": null,
"repair_security_pattern": null,
"repair_due_date": null,
"repair_device_id": null,
"repair_updates_notif": 0,
"order_addresses": null,
"is_recurring": 0,
"recur_interval": 1,
"recur_interval_type": "days",
"recur_repetitions": 0,
"recur_stopped_on": null,
"recur_parent_id": null,
"invoice_token": null,
"pay_term_number": null,
"pay_term_type": null,
"pjt_project_id": null,
"pjt_title": null,
"woocommerce_order_id": null,
"selling_price_group_id": 0,
"created_at": "2020-09-23 20:16:19",
"updated_at": "2020-09-25 17:57:08",
"payment_lines": [
{
"id": 55,
"transaction_id": 91,
"business_id": 1,
"is_return": 0,
"amount": "461.7500",
"method": "cash",
"transaction_no": null,
"card_transaction_number": null,
"card_number": null,
"card_type": "credit",
"card_holder_name": null,
"card_month": null,
"card_year": null,
"card_security": null,
"cheque_number": null,
"bank_account_number": null,
"paid_on": "2020-09-23 20:16:19",
"created_by": 9,
"is_advance": 0,
"payment_for": 1,
"parent_id": null,
"note": null,
"document": null,
"payment_ref_no": "SP2020\/0018",
"account_id": null,
"created_at": "2020-09-23 20:16:19",
"updated_at": "2020-09-23 20:16:19"
}
],
"invoice_url": "http:\/\/local.pos.com\/invoice\/6dfd77eb80f4976b456128e7f1311c9f",
"payment_link": "http:\/\/local.pos.com\/pay\/6dfd77eb80f4976b456128e7f1311c9f"
}HTTP Request
PUT connector/api/sell/{sell}
PATCH connector/api/sell/{sell}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
sell |
required | id of sell to update |
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
contact_id |
integer | optional | id of the customer |
transaction_date |
string | optional | transaction date format:Y-m-d H:i:s, |
status |
string | optional | sale status (final, draft) |
sub_status |
string | optional | sale sub status ("quotation" for quotation and "proforma" for proforma invoice) |
is_quotation |
boolean | optional | Is sell quotation (0, 1), If 1 status should be draft |
tax_rate_id |
integer | optional | id of the tax rate applicable to the sale |
discount_amount |
float | optional | discount amount applicable to the sale |
discount_type |
string | optional | type of the discount amount (fixed, percentage) |
sale_note |
string | optional | |
source |
string | optional | Source of the invoice |
staff_note |
string | optional | |
is_suspend |
boolean | optional | Is suspended sale (0, 1) |
commission_agent |
integer | optional | commission agent id |
shipping_details |
string | optional | shipping details |
shipping_address |
string | optional | shipping address |
shipping_status |
string | optional | ('ordered', 'packed', 'shipped', 'delivered', 'cancelled') |
delivered_to |
string | optional | Name of the person recieved the consignment |
shipping_charges |
float | optional | shipping amount |
packing_charge |
float | optional | packing charge |
exchange_rate |
float | optional | exchange rate for the currency used |
selling_price_group_id |
integer | optional | id of the selling price group |
pay_term_number |
integer | optional | pay term value |
pay_term_type |
string | optional | type of the pay term value ('days', 'months') |
is_recurring |
integer | optional | whether the invoice is recurring (0, 1) |
recur_interval |
integer | optional | value of the interval invoice will be regenerated |
recur_interval_type |
string | optional | type of the recur interval ('days', 'months', 'years') |
subscription_repeat_on |
integer | optional | day of the month on which invoice will be generated if recur interval type is months (1-30) |
subscription_no |
string | optional | subscription number |
recur_repetitions |
integer | optional | total number of invoices to be generated |
rp_redeemed |
integer | optional | reward points redeemed |
rp_redeemed_amount |
float | optional | reward point redeemed amount after conversion |
types_of_service_id |
integer | optional | types of service id |
service_custom_field_1 |
string | optional | types of service custom field 1 |
service_custom_field_2 |
string | optional | types of service custom field 2 |
service_custom_field_3 |
string | optional | types of service custom field 3 |
service_custom_field_4 |
string | optional | types of service custom field 4 |
service_custom_field_5 |
string | optional | types of service custom field 5 |
service_custom_field_6 |
string | optional | types of service custom field 6 |
round_off_amount |
float | optional | round off amount on total payable |
table_id |
integer | optional | id of the table |
res_waiter_id |
integer | optional | id of the service staff assigned to the sale |
change_return |
float | optional | Excess paid amount |
change_return_id |
integer | optional | id of the change return payment if exists |
products |
array | required | array of the products for the sale |
payments |
array | optional | payment lines for the sale |
products.*.sell_line_id |
integer | optional | sell line id for existing item only |
products.*.product_id |
integer | optional | product id |
products.*.variation_id |
integer | optional | variation id |
products.*.quantity |
float | optional | quantity |
products.*.unit_price |
float | optional | unit selling price |
products.*.tax_rate_id |
integer | optional | tax rate id applicable on the product |
products.*.discount_amount |
float | optional | discount amount applicable on the product |
products.*.discount_type |
string | optional | type of discount amount ('fixed', 'percentage') |
products.*.sub_unit_id |
integer | optional | sub unit id |
products.*.note |
string | optional | note for the product |
payments.*.payment_id |
integer | optional | payment id for existing payment line |
payments.*.amount |
float | optional | amount of the payment |
payments.*.method |
string | optional | payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') |
payments.*.account_id |
integer | optional | account id |
payments.*.card_number |
string | optional | |
payments.*.card_holder_name |
string | optional | |
payments.*.card_transaction_number |
string | optional | |
payments.*.card_type |
string | optional | |
payments.*.card_month |
string | optional | |
payments.*.card_year |
string | optional | |
payments.*.card_security |
string | optional | |
payments.*.transaction_no_1 |
string | optional | |
payments.*.transaction_no_2 |
string | optional | |
payments.*.transaction_no_3 |
string | optional | |
payments.*.note |
string | optional | payment note |
payments.*.cheque_number |
string | optional | |
payments.*.bank_account_number |
string | optional |
Delete Sell
Requires authentication
Example request:
curl -X DELETE \
"https://dev.scalerp.com/public/connector/api/sell/voluptas" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/sell/voluptas"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));HTTP Request
DELETE connector/api/sell/{sell}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
sell |
required | id of the sell to be deleted |
Add Sell Return
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/sell-return" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"transaction_id":1,"transaction_date":"2020-5-7 15:20:22","invoice_no":"laborum","discount_amount":10,"discount_type":"fixed","products":[{"sell_line_id":13,"quantity":1,"unit_price_inc_tax":437.5}]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/sell-return"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"transaction_id": 1,
"transaction_date": "2020-5-7 15:20:22",
"invoice_no": "laborum",
"discount_amount": 10,
"discount_type": "fixed",
"products": [
{
"sell_line_id": 13,
"quantity": 1,
"unit_price_inc_tax": 437.5
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 159,
"business_id": 1,
"location_id": 1,
"res_table_id": null,
"res_waiter_id": null,
"res_order_status": null,
"type": "sell_return",
"sub_type": null,
"status": "final",
"is_quotation": 0,
"payment_status": "paid",
"adjustment_type": null,
"contact_id": 1,
"customer_group_id": null,
"invoice_no": "CN2020\/0005",
"ref_no": null,
"subscription_no": null,
"subscription_repeat_on": null,
"transaction_date": "2020-11-17 00:00:00",
"total_before_tax": 3,
"tax_id": null,
"tax_amount": 0,
"discount_type": "percentage",
"discount_amount": 12,
"rp_redeemed": 0,
"rp_redeemed_amount": "0.0000",
"shipping_details": null,
"shipping_address": null,
"shipping_status": null,
"delivered_to": null,
"shipping_charges": "0.0000",
"additional_notes": null,
"staff_note": null,
"round_off_amount": "0.0000",
"final_total": 2.640000000000000124344978758017532527446746826171875,
"expense_category_id": null,
"expense_for": null,
"commission_agent": null,
"document": null,
"is_direct_sale": 0,
"is_suspend": 0,
"exchange_rate": "1.000",
"total_amount_recovered": null,
"transfer_parent_id": null,
"return_parent_id": 157,
"opening_stock_product_id": null,
"created_by": 9,
"import_batch": null,
"import_time": null,
"types_of_service_id": null,
"packing_charge": null,
"packing_charge_type": null,
"service_custom_field_1": null,
"service_custom_field_2": null,
"service_custom_field_3": null,
"service_custom_field_4": null,
"mfg_parent_production_purchase_id": null,
"mfg_wasted_units": null,
"mfg_production_cost": "0.0000",
"mfg_production_cost_type": "percentage",
"mfg_is_final": 0,
"is_created_from_api": 0,
"essentials_duration": "0.00",
"essentials_duration_unit": null,
"essentials_amount_per_unit_duration": "0.0000",
"essentials_allowances": null,
"essentials_deductions": null,
"rp_earned": 0,
"repair_completed_on": null,
"repair_warranty_id": null,
"repair_brand_id": null,
"repair_status_id": null,
"repair_model_id": null,
"repair_job_sheet_id": null,
"repair_defects": null,
"repair_serial_no": null,
"repair_checklist": null,
"repair_security_pwd": null,
"repair_security_pattern": null,
"repair_due_date": null,
"repair_device_id": null,
"repair_updates_notif": 0,
"order_addresses": null,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"invoice_token": null,
"pay_term_number": null,
"pay_term_type": null,
"pjt_project_id": null,
"pjt_title": null,
"woocommerce_order_id": null,
"selling_price_group_id": null,
"created_at": "2020-11-17 12:05:11",
"updated_at": "2020-11-17 13:22:09"
}HTTP Request
POST connector/api/sell-return
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
transaction_id |
integer | required | Id of the sell |
transaction_date |
string | optional | transaction date format:Y-m-d H:i:s, |
invoice_no |
string | optional | Invoice number of the return |
discount_amount |
float | optional | discount amount applicable to the sale |
discount_type |
string | optional | type of the discount amount (fixed, percentage) |
products |
array | required | array of the products for the sale |
products.*.sell_line_id |
integer | required | sell line id |
products.*.quantity |
float | required | quantity to be returned from the sell line |
products.*.unit_price_inc_tax |
float | required | unit selling price of the returning item |
List Sell Return
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/list-sell-return" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/list-sell-return"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 159,
"business_id": 1,
"location_id": 1,
"res_table_id": null,
"res_waiter_id": null,
"res_order_status": null,
"type": "sell_return",
"sub_type": null,
"status": "final",
"is_quotation": 0,
"payment_status": "partial",
"adjustment_type": null,
"contact_id": 1,
"customer_group_id": null,
"invoice_no": "CN2020\/0005",
"ref_no": null,
"subscription_no": null,
"subscription_repeat_on": null,
"transaction_date": "2020-11-17 00:00:00",
"total_before_tax": "3.0000",
"tax_id": null,
"tax_amount": "0.0000",
"discount_type": "percentage",
"discount_amount": "12.0000",
"rp_redeemed": 0,
"rp_redeemed_amount": "0.0000",
"shipping_details": null,
"shipping_address": null,
"shipping_status": null,
"delivered_to": null,
"shipping_charges": "0.0000",
"additional_notes": null,
"staff_note": null,
"round_off_amount": "0.0000",
"final_total": "2.6400",
"expense_category_id": null,
"expense_for": null,
"commission_agent": null,
"document": null,
"is_direct_sale": 0,
"is_suspend": 0,
"exchange_rate": "1.000",
"total_amount_recovered": null,
"transfer_parent_id": null,
"return_parent_id": 157,
"opening_stock_product_id": null,
"created_by": 9,
"import_batch": null,
"import_time": null,
"types_of_service_id": null,
"packing_charge": null,
"packing_charge_type": null,
"service_custom_field_1": null,
"service_custom_field_2": null,
"service_custom_field_3": null,
"service_custom_field_4": null,
"mfg_parent_production_purchase_id": null,
"mfg_wasted_units": null,
"mfg_production_cost": "0.0000",
"mfg_production_cost_type": "percentage",
"mfg_is_final": 0,
"is_created_from_api": 0,
"essentials_duration": "0.00",
"essentials_duration_unit": null,
"essentials_amount_per_unit_duration": "0.0000",
"essentials_allowances": null,
"essentials_deductions": null,
"rp_earned": 0,
"repair_completed_on": null,
"repair_warranty_id": null,
"repair_brand_id": null,
"repair_status_id": null,
"repair_model_id": null,
"repair_job_sheet_id": null,
"repair_defects": null,
"repair_serial_no": null,
"repair_checklist": null,
"repair_security_pwd": null,
"repair_security_pattern": null,
"repair_due_date": null,
"repair_device_id": null,
"repair_updates_notif": 0,
"order_addresses": null,
"is_recurring": 0,
"recur_interval": null,
"recur_interval_type": null,
"recur_repetitions": null,
"recur_stopped_on": null,
"recur_parent_id": null,
"invoice_token": null,
"pay_term_number": null,
"pay_term_type": null,
"pjt_project_id": null,
"pjt_title": null,
"woocommerce_order_id": null,
"selling_price_group_id": null,
"created_at": "2020-11-17 12:05:11",
"updated_at": "2020-11-17 13:22:09",
"payment_lines": [
{
"id": 126,
"transaction_id": 159,
"business_id": 1,
"is_return": 0,
"amount": "1.8000",
"method": "cash",
"transaction_no": null,
"card_transaction_number": null,
"card_number": null,
"card_type": "credit",
"card_holder_name": null,
"card_month": null,
"card_year": null,
"card_security": null,
"cheque_number": null,
"bank_account_number": null,
"paid_on": "2020-11-17 12:05:00",
"created_by": 9,
"is_advance": 0,
"payment_for": 1,
"parent_id": null,
"note": null,
"document": null,
"payment_ref_no": "SP2020\/0078",
"account_id": null,
"created_at": "2020-11-17 12:05:58",
"updated_at": "2020-11-17 12:05:58"
}
],
"return_parent_sell": {
"id": 157,
"business_id": 1,
"location_id": 1,
"res_table_id": null,
"res_waiter_id": null,
"res_order_status": null,
"type": "sell",
"sub_type": null,
"status": "final",
"is_quotation": 0,
"payment_status": "paid",
"adjustment_type": null,
"contact_id": 1,
"customer_group_id": null,
"invoice_no": "AS0073",
"ref_no": "",
"subscription_no": null,
"subscription_repeat_on": null,
"transaction_date": "2020-11-13 12:42:17",
"total_before_tax": "6.2500",
"tax_id": null,
"tax_amount": "0.0000",
"discount_type": "percentage",
"discount_amount": "10.0000",
"rp_redeemed": 0,
"rp_redeemed_amount": "0.0000",
"shipping_details": null,
"shipping_address": null,
"shipping_status": null,
"delivered_to": null,
"shipping_charges": "0.0000",
"additional_notes": null,
"staff_note": null,
"round_off_amount": "0.0000",
"final_total": "5.6300",
"expense_category_id": null,
"expense_for": null,
"commission_agent": null,
"document": null,
"is_direct_sale": 0,
"is_suspend": 0,
"exchange_rate": "1.000",
"total_amount_recovered": null,
"transfer_parent_id": null,
"return_parent_id": null,
"opening_stock_product_id": null,
"created_by": 9,
"import_batch": null,
"import_time": null,
"types_of_service_id": null,
"packing_charge": "0.0000",
"packing_charge_type": null,
"service_custom_field_1": null,
"service_custom_field_2": null,
"service_custom_field_3": null,
"service_custom_field_4": null,
"mfg_parent_production_purchase_id": null,
"mfg_wasted_units": null,
"mfg_production_cost": "0.0000",
"mfg_production_cost_type": "percentage",
"mfg_is_final": 0,
"is_created_from_api": 0,
"essentials_duration": "0.00",
"essentials_duration_unit": null,
"essentials_amount_per_unit_duration": "0.0000",
"essentials_allowances": null,
"essentials_deductions": null,
"rp_earned": 0,
"repair_completed_on": null,
"repair_warranty_id": null,
"repair_brand_id": null,
"repair_status_id": null,
"repair_model_id": null,
"repair_job_sheet_id": null,
"repair_defects": null,
"repair_serial_no": null,
"repair_checklist": null,
"repair_security_pwd": null,
"repair_security_pattern": null,
"repair_due_date": null,
"repair_device_id": null,
"repair_updates_notif": 0,
"order_addresses": null,
"is_recurring": 0,
"recur_interval": 1,
"recur_interval_type": "days",
"recur_repetitions": 0,
"recur_stopped_on": null,
"recur_parent_id": null,
"invoice_token": null,
"pay_term_number": null,
"pay_term_type": null,
"pjt_project_id": null,
"pjt_title": null,
"woocommerce_order_id": null,
"selling_price_group_id": 0,
"created_at": "2020-11-13 12:42:17",
"updated_at": "2020-11-13 12:42:18",
"sell_lines": [
{
"id": 139,
"transaction_id": 157,
"product_id": 157,
"variation_id": 205,
"quantity": 5,
"mfg_waste_percent": "0.0000",
"quantity_returned": "3.0000",
"unit_price_before_discount": "1.2500",
"unit_price": "1.2500",
"line_discount_type": "fixed",
"line_discount_amount": "0.0000",
"unit_price_inc_tax": "1.2500",
"item_tax": "0.0000",
"tax_id": null,
"discount_id": null,
"lot_no_line_id": null,
"sell_line_note": "",
"res_service_staff_id": null,
"res_line_order_status": null,
"woocommerce_line_items_id": null,
"parent_sell_line_id": null,
"children_type": "",
"sub_unit_id": null,
"created_at": "2020-11-13 12:42:17",
"updated_at": "2020-11-17 13:22:09"
}
]
}
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/list-sell-return?sell_id=157&page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "http:\/\/local.pos.com\/connector\/api\/list-sell-return",
"per_page": 10,
"to": 1
}
}HTTP Request
GET connector/api/list-sell-return
URL Parameters
| Parameter | Status | Description |
|---|---|---|
sell_id |
optional | Id of the sell for which return is added |
Update shipping status
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/update-shipping-status" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"id":18,"shipping_status":"ordered","delivered_to":"facilis"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/update-shipping-status"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"id": 18,
"shipping_status": "ordered",
"delivered_to": "facilis"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));HTTP Request
POST connector/api/update-shipping-status
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
id |
integer | required | id of the sale |
shipping_status |
string | optional | ('ordered', 'packed', 'shipped', 'delivered', 'cancelled') |
delivered_to |
string | optional | Name of the consignee |
Superadmin
If SaaS installed get active subscription details, else return the enabled modules details in package_details
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/active-subscription" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/active-subscription"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 1,
"business_id": 1,
"package_id": 3,
"start_date": "2020-09-05 00:00:00",
"trial_end_date": "2020-09-15",
"end_date": "2020-10-05 00:00:00",
"package_price": "599.9900",
"package_details": {
"location_count": 0,
"user_count": 0,
"product_count": 0,
"invoice_count": 0,
"name": "Unlimited",
"woocommerce_module": 1,
"essentials_module": 1
},
"created_id": 1,
"paid_via": "stripe",
"payment_transaction_id": "ch_1CuLdQAhokBpT93LVZNg2At6",
"status": "approved",
"deleted_at": null,
"created_at": "2018-08-01 07:49:09",
"updated_at": "2018-08-01 07:49:09",
"locations_created": 1,
"users_created": 6,
"products_created": 2,
"invoices_created": 1
}
}HTTP Request
GET connector/api/active-subscription
Get Superadmin Package List
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/packages" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/packages"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Starter - Free",
"description": "Give it a test drive...",
"location_count": 0,
"user_count": 0,
"product_count": 0,
"bookings": 0,
"kitchen": 0,
"order_screen": 0,
"tables": 0,
"invoice_count": 0,
"interval": "months",
"interval_count": 1,
"trial_days": 10,
"price": "0.0000",
"custom_permissions": {
"assetmanagement_module": "1",
"connector_module": "1",
"crm_module": "1",
"essentials_module": "1",
"manufacturing_module": "1",
"productcatalogue_module": "1",
"project_module": "1",
"repair_module": "1",
"woocommerce_module": "1"
},
"created_by": 1,
"sort_order": 0,
"is_active": 1,
"is_private": 0,
"is_one_time": 0,
"enable_custom_link": 0,
"custom_link": "",
"custom_link_text": "",
"deleted_at": null,
"created_at": "2020-10-09 16:38:02",
"updated_at": "2020-11-11 12:19:17"
},
{
"id": 2,
"name": "Regular",
"description": "For Small Shops",
"location_count": 0,
"user_count": 0,
"product_count": 0,
"bookings": 0,
"kitchen": 0,
"order_screen": 0,
"tables": 0,
"invoice_count": 0,
"interval": "months",
"interval_count": 1,
"trial_days": 10,
"price": "199.9900",
"custom_permissions": {
"repair_module": "1"
},
"created_by": 1,
"sort_order": 1,
"is_active": 1,
"is_private": 0,
"is_one_time": 0,
"enable_custom_link": 0,
"custom_link": null,
"custom_link_text": null,
"deleted_at": null,
"created_at": "2020-10-09 16:38:02",
"updated_at": "2020-10-09 16:38:02"
},
{
"id": 3,
"name": "Unlimited",
"description": "For Large Business",
"location_count": 0,
"user_count": 0,
"product_count": 0,
"bookings": 0,
"kitchen": 0,
"order_screen": 0,
"tables": 0,
"invoice_count": 0,
"interval": "months",
"interval_count": 1,
"trial_days": 10,
"price": "599.9900",
"custom_permissions": {
"assetmanagement_module": "1",
"connector_module": "1",
"crm_module": "1",
"essentials_module": "1",
"manufacturing_module": "1",
"productcatalogue_module": "1",
"project_module": "1",
"repair_module": "1",
"woocommerce_module": "1"
},
"created_by": 1,
"sort_order": 1,
"is_active": 1,
"is_private": 0,
"is_one_time": 0,
"enable_custom_link": 0,
"custom_link": "",
"custom_link_text": "",
"deleted_at": null,
"created_at": "2020-10-09 16:38:02",
"updated_at": "2020-11-02 12:09:19"
}
]
}HTTP Request
GET connector/api/packages
Table management
List tables
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/table?location_id=1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/table"
);
let params = {
"location_id": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 5,
"business_id": 1,
"location_id": 1,
"name": "Table 1",
"description": null,
"created_by": 9,
"deleted_at": null,
"created_at": "2020-06-04 22:36:37",
"updated_at": "2020-06-04 22:36:37"
}
]
}HTTP Request
GET connector/api/table
Query Parameters
| Parameter | Status | Description |
|---|---|---|
location_id |
optional | int id of the location |
Show the specified table
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/table/5" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/table/5"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 5,
"business_id": 1,
"location_id": 1,
"name": "Table 1",
"description": null,
"created_by": 9,
"deleted_at": null,
"created_at": "2020-06-04 22:36:37",
"updated_at": "2020-06-04 22:36:37"
}
]
}HTTP Request
GET connector/api/table/{table}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
table |
required | comma separated ids of required tables |
Tax management
List taxes
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/tax" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/tax"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"name": "VAT@10%",
"amount": 10,
"is_tax_group": 0,
"created_by": 1,
"woocommerce_tax_rate_id": null,
"deleted_at": null,
"created_at": "2018-01-04 02:40:07",
"updated_at": "2018-01-04 02:40:07"
},
{
"id": 2,
"business_id": 1,
"name": "CGST@10%",
"amount": 10,
"is_tax_group": 0,
"created_by": 1,
"woocommerce_tax_rate_id": null,
"deleted_at": null,
"created_at": "2018-01-04 02:40:55",
"updated_at": "2018-01-04 02:40:55"
},
{
"id": 3,
"business_id": 1,
"name": "SGST@8%",
"amount": 8,
"is_tax_group": 0,
"created_by": 1,
"woocommerce_tax_rate_id": null,
"deleted_at": null,
"created_at": "2018-01-04 02:41:13",
"updated_at": "2018-01-04 02:41:13"
},
{
"id": 4,
"business_id": 1,
"name": "GST@18%",
"amount": 18,
"is_tax_group": 1,
"created_by": 1,
"woocommerce_tax_rate_id": null,
"deleted_at": null,
"created_at": "2018-01-04 02:42:19",
"updated_at": "2018-01-04 02:42:19"
}
]
}HTTP Request
GET connector/api/tax
Get the specified tax
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/tax/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/tax/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"name": "VAT@10%",
"amount": 10,
"is_tax_group": 0,
"created_by": 1,
"woocommerce_tax_rate_id": null,
"deleted_at": null,
"created_at": "2018-01-04 02:40:07",
"updated_at": "2018-01-04 02:40:07"
}
]
}HTTP Request
GET connector/api/tax/{tax}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
tax |
required | comma separated ids of required taxes |
Taxonomy management
List taxonomy
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/taxonomy?type=molestias" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/taxonomy"
);
let params = {
"type": "molestias",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Men's",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:06:34",
"updated_at": "2018-01-03 21:06:34",
"sub_categories": [
{
"id": 4,
"name": "Jeans",
"business_id": 1,
"short_code": null,
"parent_id": 1,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:07:34",
"updated_at": "2018-01-03 21:07:34"
},
{
"id": 5,
"name": "Shirts",
"business_id": 1,
"short_code": null,
"parent_id": 1,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:08:18",
"updated_at": "2018-01-03 21:08:18"
}
]
},
{
"id": 21,
"name": "Food & Grocery",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-06 05:31:35",
"updated_at": "2018-01-06 05:31:35",
"sub_categories": []
}
]
}HTTP Request
GET connector/api/taxonomy
Query Parameters
| Parameter | Status | Description |
|---|---|---|
type |
optional | Type of taxonomy (product, device, hrm_department) |
Get the specified taxonomy
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/taxonomy/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/taxonomy/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Men's",
"business_id": 1,
"short_code": null,
"parent_id": 0,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:06:34",
"updated_at": "2018-01-03 21:06:34",
"sub_categories": [
{
"id": 4,
"name": "Jeans",
"business_id": 1,
"short_code": null,
"parent_id": 1,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:07:34",
"updated_at": "2018-01-03 21:07:34"
},
{
"id": 5,
"name": "Shirts",
"business_id": 1,
"short_code": null,
"parent_id": 1,
"created_by": 1,
"category_type": "product",
"description": null,
"slug": null,
"woocommerce_cat_id": null,
"deleted_at": null,
"created_at": "2018-01-03 21:08:18",
"updated_at": "2018-01-03 21:08:18"
}
]
}
]
}HTTP Request
GET connector/api/taxonomy/{taxonomy}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
taxonomy |
required | comma separated ids of product categories |
Types of service management
List types of service
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/types-of-service" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/types-of-service"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Home Delivery",
"description": null,
"business_id": 1,
"location_price_group": {
"1": "0"
},
"packing_charge": "10.0000",
"packing_charge_type": "fixed",
"enable_custom_fields": 0,
"created_at": "2020-06-04 22:41:13",
"updated_at": "2020-06-04 22:41:13"
}
]
}HTTP Request
GET connector/api/types-of-service
Get the specified types of service
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/types-of-service/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/types-of-service/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"name": "Home Delivery",
"description": null,
"business_id": 1,
"location_price_group": {
"1": "0"
},
"packing_charge": "10.0000",
"packing_charge_type": "fixed",
"enable_custom_fields": 0,
"created_at": "2020-06-04 22:41:13",
"updated_at": "2020-06-04 22:41:13"
}
]
}HTTP Request
GET connector/api/types-of-service/{types_of_service}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
types_of_service |
required | comma separated ids of required types of services |
Unit management
List units
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/unit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/unit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"actual_name": "Pieces",
"short_name": "Pc(s)",
"allow_decimal": 0,
"base_unit_id": null,
"base_unit_multiplier": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 15:15:20",
"updated_at": "2018-01-03 15:15:20",
"base_unit": null
},
{
"id": 2,
"business_id": 1,
"actual_name": "Packets",
"short_name": "packets",
"allow_decimal": 0,
"base_unit_id": null,
"base_unit_multiplier": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-06 01:07:01",
"updated_at": "2018-01-06 01:08:36",
"base_unit": null
},
{
"id": 15,
"business_id": 1,
"actual_name": "Dozen",
"short_name": "dz",
"allow_decimal": 0,
"base_unit_id": 1,
"base_unit_multiplier": "12.0000",
"created_by": 9,
"deleted_at": null,
"created_at": "2020-07-20 13:11:09",
"updated_at": "2020-07-20 13:11:09",
"base_unit": {
"id": 1,
"business_id": 1,
"actual_name": "Pieces",
"short_name": "Pc(s)",
"allow_decimal": 0,
"base_unit_id": null,
"base_unit_multiplier": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 15:15:20",
"updated_at": "2018-01-03 15:15:20"
}
}
]
}HTTP Request
GET connector/api/unit
Get the specified unit
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/unit/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/unit/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"actual_name": "Pieces",
"short_name": "Pc(s)",
"allow_decimal": 0,
"base_unit_id": null,
"base_unit_multiplier": null,
"created_by": 1,
"deleted_at": null,
"created_at": "2018-01-03 15:15:20",
"updated_at": "2018-01-03 15:15:20",
"base_unit": null
}
]
}HTTP Request
GET connector/api/unit/{unit}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
unit |
required | comma separated ids of the units |
User management
Get the loggedin user details.
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/user/loggedin" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/user/loggedin"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 1,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin",
"last_name": null,
"username": "admin",
"email": "admin@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19"
}
}HTTP Request
GET connector/api/user/loggedin
Register User
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/user-registration" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"surname":"porro","first_name":"dolores","last_name":"ut","email":"aut","is_active":"odit","user_type":"rerum","crm_contact_id":8,"allow_login":false,"username":"debitis","password":"voluptatem","role":16,"access_all_locations":true,"location_permissions":[],"cmmsn_percent":"sunt","max_sales_discount_percent":"qui","selected_contacts":false,"selected_contact_ids":[],"dob":"unde","gender":"sit","marital_status":"harum","blood_group":"delectus","contact_number":"error","alt_number":"amet","family_number":"ut","fb_link":"a","twitter_link":"adipisci","social_media_1":"non","social_media_2":"dolorem","custom_field_1":"accusamus","custom_field_2":"quasi","custom_field_3":"ullam","custom_field_4":"quis","guardian_name":"id","id_proof_name":"repellat","id_proof_number":"quibusdam","permanent_address":"omnis","current_address":"ut","bank_details":[{"account_holder_name":"laborum","account_number":"ducimus","bank_name":"laboriosam","bank_code":"expedita","branch":"ratione","tax_payer_id":"nulla"}]}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/user-registration"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"surname": "porro",
"first_name": "dolores",
"last_name": "ut",
"email": "aut",
"is_active": "odit",
"user_type": "rerum",
"crm_contact_id": 8,
"allow_login": false,
"username": "debitis",
"password": "voluptatem",
"role": 16,
"access_all_locations": true,
"location_permissions": [],
"cmmsn_percent": "sunt",
"max_sales_discount_percent": "qui",
"selected_contacts": false,
"selected_contact_ids": [],
"dob": "unde",
"gender": "sit",
"marital_status": "harum",
"blood_group": "delectus",
"contact_number": "error",
"alt_number": "amet",
"family_number": "ut",
"fb_link": "a",
"twitter_link": "adipisci",
"social_media_1": "non",
"social_media_2": "dolorem",
"custom_field_1": "accusamus",
"custom_field_2": "quasi",
"custom_field_3": "ullam",
"custom_field_4": "quis",
"guardian_name": "id",
"id_proof_name": "repellat",
"id_proof_number": "quibusdam",
"permanent_address": "omnis",
"current_address": "ut",
"bank_details": [
{
"account_holder_name": "laborum",
"account_number": "ducimus",
"bank_name": "laboriosam",
"bank_code": "expedita",
"branch": "ratione",
"tax_payer_id": "nulla"
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"success": 1,
"msg": "User added successfully",
"user": {
"surname": "Mr",
"first_name": "Test",
"last_name": "kumar",
"email": "test@example.com",
"user_type": "user_customer",
"crm_contact_id": "2",
"allow_login": 1,
"username": "0017",
"cmmsn_percent": "25",
"max_sales_discount_percent": "52",
"dob": "1997-10-12",
"gender": "male",
"marital_status": "unmarried",
"blood_group": "0+",
"contact_number": "4578451245",
"alt_number": "7474747474",
"family_number": "7474147414",
"fb_link": "fb.com\/username",
"twitter_link": "twitter.com\/username",
"social_media_1": "test",
"social_media_2": "test",
"custom_field_1": "test",
"custom_field_2": "test",
"custom_field_3": "test",
"custom_field_4": "test",
"guardian_name": "test",
"id_proof_name": "uid",
"id_proof_number": "747845120124",
"permanent_address": "test permanent adrress",
"current_address": "test current address",
"bank_details": "{\"account_holder_name\":\"test\",\"account_number\":\"test\",\"bank_name\":\"test\",\"bank_code\":\"test\",\"branch\":\"test\",\"tax_payer_id\":\"test\"}",
"selected_contacts": "1",
"status": "active",
"business_id": 1,
"updated_at": "2021-08-12 18:03:58",
"created_at": "2021-08-12 18:03:58",
"id": 140
}
}HTTP Request
POST connector/api/user-registration
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
surname |
string | optional | prefix like Mr, Mrs,Dr |
first_name |
string | required | |
last_name |
string | optional | |
email |
string | required | |
is_active |
string | required | 'active', 'inactive', 'terminated' |
user_type |
string | required | 'user_customer' for contact/customer login & 'user' for general user |
crm_contact_id |
integer | optional | if user_type is 'user_customer' then required |
allow_login |
boolean | optional | 1 to allow login & 0 to disable login |
username |
string | optional | minimum 5 characters |
password |
string | optional | minimum 6 characters & required if 'allow_login' is 1 |
role |
integer | optional | id of role to be assigned to user & required if user_type is 'user' |
access_all_locations |
boolean | optional | 1 if user has access all location else 0 & required if user_type is 'user' |
location_permissions |
array | optional | array of location ids to be assigned to user & required if user_type is 'user' and 'access_all_locations' is 0 |
cmmsn_percent |
decimal | optional | |
max_sales_discount_percent |
decimal | optional | |
selected_contacts |
boolean | optional | 1 or 0 |
selected_contact_ids |
array | optional | array of contact ids & required if 'selected_contacts' is 1 |
dob |
date | optional | dob of user in "Y-m-d" format Ex: 1997-10-29 |
gender |
string | optional | if user is 'male', 'female', 'others' |
marital_status |
string | optional | if user is 'married', 'unmarried', 'divorced' |
blood_group |
string | optional | |
contact_number |
string | optional | |
alt_number |
string | optional | |
family_number |
string | optional | |
fb_link |
string | optional | |
twitter_link |
string | optional | |
social_media_1 |
string | optional | |
social_media_2 |
string | optional | |
custom_field_1 |
string | optional | |
custom_field_2 |
string | optional | |
custom_field_3 |
string | optional | |
custom_field_4 |
string | optional | |
guardian_name |
string | optional | |
id_proof_name |
string | optional | ID proof of user like Adhar No. |
id_proof_number |
string | optional | Id Number like adhar number |
permanent_address |
string | optional | |
current_address |
string | optional | |
bank_details.*.account_holder_name |
string | optional | |
bank_details.*.account_number |
string | optional | |
bank_details.*.bank_name |
string | optional | |
bank_details.*.bank_code |
string | optional | |
bank_details.*.branch |
string | optional | |
bank_details.*.tax_payer_id |
string | optional |
List users
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/user?service_staff=dignissimos" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/user"
);
let params = {
"service_staff": "dignissimos",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin",
"last_name": null,
"username": "admin",
"email": "admin@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19"
}
]
}HTTP Request
GET connector/api/user
Query Parameters
| Parameter | Status | Description |
|---|---|---|
service_staff |
optional | boolean Filter service staffs from users list (0, 1) |
Get the specified user
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/user/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/user/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"user_type": "user",
"surname": "Mr",
"first_name": "Admin",
"last_name": null,
"username": "admin",
"email": "admin@example.com",
"language": "en",
"contact_no": null,
"address": null,
"business_id": 1,
"max_sales_discount_percent": null,
"allow_login": 1,
"essentials_department_id": null,
"essentials_designation_id": null,
"status": "active",
"crm_contact_id": null,
"is_cmmsn_agnt": 0,
"cmmsn_percent": "0.00",
"selected_contacts": 0,
"dob": null,
"gender": null,
"marital_status": null,
"blood_group": null,
"contact_number": null,
"fb_link": null,
"twitter_link": null,
"social_media_1": null,
"social_media_2": null,
"permanent_address": null,
"current_address": null,
"guardian_name": null,
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null,
"bank_details": null,
"id_proof_name": null,
"id_proof_number": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2018-01-04 02:15:19"
}
]
}HTTP Request
GET connector/api/user/{user}
URL Parameters
| Parameter | Status | Description |
|---|---|---|
user |
required | comma separated ids of the required users |
Update user password.
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/update-password" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"current_password":"aut","new_password":"est"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/update-password"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"current_password": "aut",
"new_password": "est"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"success": 1,
"msg": "Password updated successfully"
}HTTP Request
POST connector/api/update-password
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
current_password |
string | required | Current password of the user |
new_password |
string | required | New password of the user |
Recover forgotten password.
Requires authentication
Example request:
curl -X POST \
"https://dev.scalerp.com/public/connector/api/forget-password" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"email":"quos"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/forget-password"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"email": "quos"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"success": 1,
"msg": "New password sent to user@example.com successfully"
}HTTP Request
POST connector/api/forget-password
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
string | required | Users email id |
general
List payment accounts
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/payment-accounts" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/payment-accounts"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"id": 1,
"business_id": 1,
"name": "Test Account",
"account_number": "8746888847455",
"account_type_id": 0,
"note": null,
"created_by": 9,
"is_closed": 0,
"deleted_at": null,
"created_at": "2020-06-04 21:34:21",
"updated_at": "2020-06-04 21:34:21"
}
]
}HTTP Request
GET connector/api/payment-accounts
List payment methods
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/payment-methods" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/payment-methods"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"cash": "Cash",
"card": "Card",
"cheque": "Cheque",
"bank_transfer": "Bank Transfer",
"other": "Other",
"custom_pay_1": "Custom Payment 1",
"custom_pay_2": "Custom Payment 2",
"custom_pay_3": "Custom Payment 3"
}HTTP Request
GET connector/api/payment-methods
Get business details
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/business-details" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/business-details"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"id": 1,
"name": "Awesome Shop",
"currency_id": 2,
"start_date": "2018-01-01",
"tax_number_1": "3412569900",
"tax_label_1": "GSTIN",
"tax_number_2": null,
"tax_label_2": null,
"default_sales_tax": null,
"default_profit_percent": 25,
"owner_id": 1,
"time_zone": "America\/Phoenix",
"fy_start_month": 1,
"accounting_method": "fifo",
"default_sales_discount": "10.00",
"sell_price_tax": "includes",
"logo": null,
"sku_prefix": "AS",
"enable_product_expiry": 0,
"expiry_type": "add_expiry",
"on_product_expiry": "keep_selling",
"stop_selling_before": 0,
"enable_tooltip": 1,
"purchase_in_diff_currency": 0,
"purchase_currency_id": null,
"p_exchange_rate": "1.000",
"transaction_edit_days": 30,
"stock_expiry_alert_days": 30,
"keyboard_shortcuts": {
"pos": {
"express_checkout": "shift+e",
"pay_n_ckeckout": "shift+p",
"draft": "shift+d",
"cancel": "shift+c",
"recent_product_quantity": "f2",
"weighing_scale": null,
"edit_discount": "shift+i",
"edit_order_tax": "shift+t",
"add_payment_row": "shift+r",
"finalize_payment": "shift+f",
"add_new_product": "f4"
}
},
"pos_settings": {
"amount_rounding_method": null,
"disable_pay_checkout": 0,
"disable_draft": 0,
"disable_express_checkout": 0,
"hide_product_suggestion": 0,
"hide_recent_trans": 0,
"disable_discount": 0,
"disable_order_tax": 0,
"is_pos_subtotal_editable": 0
},
"weighing_scale_setting": {
"label_prefix": null,
"product_sku_length": "4",
"qty_length": "3",
"qty_length_decimal": "2"
},
"manufacturing_settings": null,
"essentials_settings": null,
"ecom_settings": null,
"woocommerce_wh_oc_secret": null,
"woocommerce_wh_ou_secret": null,
"woocommerce_wh_od_secret": null,
"woocommerce_wh_or_secret": null,
"enable_brand": 1,
"enable_category": 1,
"enable_sub_category": 1,
"enable_price_tax": 1,
"enable_purchase_status": 1,
"enable_lot_number": 0,
"default_unit": null,
"enable_sub_units": 0,
"enable_racks": 0,
"enable_row": 0,
"enable_position": 0,
"enable_editing_product_from_purchase": 1,
"sales_cmsn_agnt": null,
"item_addition_method": 1,
"enable_inline_tax": 1,
"currency_symbol_placement": "before",
"enabled_modules": [
"purchases",
"add_sale",
"pos_sale",
"stock_transfers",
"stock_adjustment",
"expenses",
"account",
"tables",
"modifiers",
"service_staff",
"booking",
"kitchen",
"subscription",
"types_of_service"
],
"date_format": "m\/d\/Y",
"time_format": "24",
"ref_no_prefixes": {
"purchase": "PO",
"purchase_return": null,
"stock_transfer": "ST",
"stock_adjustment": "SA",
"sell_return": "CN",
"expense": "EP",
"contacts": "CO",
"purchase_payment": "PP",
"sell_payment": "SP",
"expense_payment": null,
"business_location": "BL",
"username": null,
"subscription": null
},
"theme_color": null,
"created_by": null,
"enable_rp": 0,
"rp_name": null,
"amount_for_unit_rp": "1.0000",
"min_order_total_for_rp": "1.0000",
"max_rp_per_order": null,
"redeem_amount_per_unit_rp": "1.0000",
"min_order_total_for_redeem": "1.0000",
"min_redeem_point": null,
"max_redeem_point": null,
"rp_expiry_period": null,
"rp_expiry_type": "year",
"repair_settings": null,
"email_settings": {
"mail_driver": "smtp",
"mail_host": null,
"mail_port": null,
"mail_username": null,
"mail_password": null,
"mail_encryption": null,
"mail_from_address": null,
"mail_from_name": null
},
"sms_settings": {
"url": null,
"send_to_param_name": "to",
"msg_param_name": "text",
"request_method": "post",
"param_1": null,
"param_val_1": null,
"param_2": null,
"param_val_2": null,
"param_3": null,
"param_val_3": null,
"param_4": null,
"param_val_4": null,
"param_5": null,
"param_val_5": null,
"param_6": null,
"param_val_6": null,
"param_7": null,
"param_val_7": null,
"param_8": null,
"param_val_8": null,
"param_9": null,
"param_val_9": null,
"param_10": null,
"param_val_10": null
},
"custom_labels": {
"payments": {
"custom_pay_1": null,
"custom_pay_2": null,
"custom_pay_3": null
},
"contact": {
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null
},
"product": {
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null
},
"location": {
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null
},
"user": {
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null
},
"purchase": {
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null
},
"sell": {
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null
},
"types_of_service": {
"custom_field_1": null,
"custom_field_2": null,
"custom_field_3": null,
"custom_field_4": null
}
},
"common_settings": {
"default_datatable_page_entries": "25"
},
"is_active": 1,
"created_at": "2018-01-04 02:15:19",
"updated_at": "2020-06-04 22:33:01",
"locations": [
{
"id": 1,
"business_id": 1,
"location_id": null,
"name": "Awesome Shop",
"landmark": "Linking Street",
"country": "USA",
"state": "Arizona",
"city": "Phoenix",
"zip_code": "85001",
"invoice_scheme_id": 1,
"invoice_layout_id": 1,
"selling_price_group_id": null,
"print_receipt_on_invoice": 1,
"receipt_printer_type": "browser",
"printer_id": null,
"mobile": null,
"alternate_number": null,
"email": null,
"website": null,
"featured_products": [
"5",
"71"
],
"is_active": 1,
"default_payment_accounts": {
"cash": {
"is_enabled": "1",
"account": null
},
"card": {
"is_enabled": "1",
"account": null
},
"cheque": {
"is_enabled": "1",
"account": null
},
"bank_transfer": {
"is_enabled": "1",
"account": null
},
"other": {
"is_enabled": "1",
"account": null
},
"custom_pay_1": {
"is_enabled": "1",
"account": null
},
"custom_pay_2": {
"is_enabled": "1",
"account": null
},
"custom_pay_3": {
"is_enabled": "1",
"account": null
}
},
"custom_field1": null,
"custom_field2": null,
"custom_field3": null,
"custom_field4": null,
"deleted_at": null,
"created_at": "2018-01-04 02:15:20",
"updated_at": "2020-06-05 00:56:54"
}
],
"currency": {
"id": 2,
"country": "America",
"currency": "Dollars",
"code": "USD",
"symbol": "$",
"thousand_separator": ",",
"decimal_separator": ".",
"created_at": null,
"updated_at": null
},
"printers": [],
"currency_precision": 2,
"quantity_precision": 2
}
}HTTP Request
GET connector/api/business-details
Get profit and loss report
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/profit-loss-report?location_id=1&start_date=2018-06-25&end_date=2018-06-25&user_id=1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/profit-loss-report"
);
let params = {
"location_id": "1",
"start_date": "2018-06-25",
"end_date": "2018-06-25",
"user_id": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": {
"total_purchase_shipping_charge": 0,
"total_sell_shipping_charge": 0,
"total_transfer_shipping_charges": "0.0000",
"opening_stock": 0,
"closing_stock": "386859.00000000",
"total_purchase": 386936,
"total_purchase_discount": "0.000000000000",
"total_purchase_return": "0.0000",
"total_sell": 9764.5,
"total_sell_discount": "11.550000000000",
"total_sell_return": "0.0000",
"total_sell_round_off": "0.0000",
"total_expense": "0.0000",
"total_adjustment": "0.0000",
"total_recovered": "0.0000",
"total_reward_amount": "0.0000",
"left_side_module_data": [
{
"value": "0.0000",
"label": "Total Payroll",
"add_to_net_profit": true
},
{
"value": 0,
"label": "Total Production Cost",
"add_to_net_profit": true
}
],
"right_side_module_data": [],
"net_profit": 9675.95000000000072759576141834259033203125,
"gross_profit": -11.550000000000000710542735760100185871124267578125,
"total_sell_by_subtype": []
}
}HTTP Request
GET connector/api/profit-loss-report
Query Parameters
| Parameter | Status | Description |
|---|---|---|
location_id |
optional | optional id of the location |
start_date |
optional | optional format:Y-m-d |
end_date |
optional | optional format:Y-m-d |
user_id |
optional | optional id of the user |
Get product current stock
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/product-stock-report" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/product-stock-report"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"total_sold": null,
"total_transfered": null,
"total_adjusted": null,
"stock_price": null,
"stock": null,
"sku": "AS0001",
"product": "Men's Reverse Fleece Crew",
"type": "single",
"product_id": 1,
"unit": "Pc(s)",
"enable_stock": 1,
"unit_price": "143.0000",
"product_variation": "DUMMY",
"variation_name": "DUMMY",
"location_name": null,
"location_id": null,
"variation_id": 1
},
{
"total_sold": "50.0000",
"total_transfered": null,
"total_adjusted": null,
"stock_price": "3850.00000000",
"stock": "50.0000",
"sku": "AS0002-1",
"product": "Levis Men's Slimmy Fit Jeans",
"type": "variable",
"product_id": 2,
"unit": "Pc(s)",
"enable_stock": 1,
"unit_price": "77.0000",
"product_variation": "Waist Size",
"variation_name": "28",
"location_name": "Awesome Shop",
"location_id": 1,
"variation_id": 2
},
{
"total_sold": "60.0000",
"total_transfered": null,
"total_adjusted": null,
"stock_price": "6930.00000000",
"stock": "90.0000",
"sku": "AS0002-2",
"product": "Levis Men's Slimmy Fit Jeans",
"type": "variable",
"product_id": 2,
"unit": "Pc(s)",
"enable_stock": 1,
"unit_price": "77.0000",
"product_variation": "Waist Size",
"variation_name": "30",
"location_name": "Awesome Shop",
"location_id": 1,
"variation_id": 3
}
],
"links": {
"first": "http:\/\/local.pos.com\/connector\/api\/product-stock-report?page=1",
"last": "http:\/\/local.pos.com\/connector\/api\/product-stock-report?page=22",
"prev": null,
"next": "http:\/\/local.pos.com\/connector\/api\/product-stock-report?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 22,
"path": "http:\/\/local.pos.com\/connector\/api\/product-stock-report",
"per_page": 3,
"to": 3,
"total": 66
}
}HTTP Request
GET connector/api/product-stock-report
Get notifications
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/notifications" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://dev.scalerp.com/public/connector/api/notifications"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"data": [
{
"msg": "Payroll for August\/2020 added by Mr. Super Admin. Reference No. 2020\/0002",
"icon_class": "fas fa-money-bill-alt bg-green",
"link": "http:\/\/local.pos.com\/hrm\/payroll",
"read_at": null,
"created_at": "3 hours ago"
}
]
}HTTP Request
GET connector/api/notifications
Get location details from coordinates
Requires authentication
Example request:
curl -X GET \
-G "https://dev.scalerp.com/public/connector/api/get-location" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"lat":"41.40338","lon":"2.17403"}'
const url = new URL(
"https://dev.scalerp.com/public/connector/api/get-location"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"lat": "41.40338",
"lon": "2.17403"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"address": "Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India"
}HTTP Request
GET connector/api/get-location
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
lat |
decimal | required | Lattitude of the location |
lon |
decimal | required | Longitude of the location |