Gulf POS API Documentation
Postman OpenAPI

Last updated: May 3, 2026

Powered by Scribe

Introduction

Briskbase POS API Documentation

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {access_token}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Getting your access token

  1. Navigate to the Connector section in your dashboard
  2. Click on Clients to view your API clients
  3. Create a new API client or use an existing one
  4. Use the Client ID and Client Secret to request an access token via the /oauth/token endpoint
  5. Include the access token in the Authorization header as Bearer {access_token}

Attendance management

GET connector/api/get-attendance/{user_id}

Get Attendance

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
user_id string required id of the user
Example: 1

Example request

Example response

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"
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/clock-in

Clock In

REQUIRES AUTHENTICATION

[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock in]

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

user_id   integer     

id of the user Example: 1

clock_in_time   string     

Clock in time.If not given current date time will be used Fromat: Y-m-d H:i:s Example: 2000-06-13 13:13:00

clock_in_note   string     

Clock in note. Example: architecto

ip_address   string     

IP address. Example: architecto

latitude   string     

Latitude of the clock in location. Example: architecto

longitude   string     

Longitude of the clock in location. Example: architecto

Example request

Example response

Response 200

{
    "success": true,
    "msg": "Clocked In successfully",
    "type": "clock_in"
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/clock-out

Clock Out

REQUIRES AUTHENTICATION

[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock out]

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

user_id   integer     

id of the user Example: 1

clock_out_time   string     

Clock out time.If not given current date time will be used Fromat: Y-m-d H:i:s Example: 2000-06-13 13:13:00

clock_out_note   string     

Clock out note. Example: architecto

latitude   string     

Latitude of the clock out location. Example: architecto

longitude   string     

Longitude of the clock out location. Example: architecto

Example request

Example response

Response 200

{
    "success": true,
    "msg": "Clocked Out successfully",
    "type": "clock_out"
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/holidays

List Holidays

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
location_id string optional id of the location
Example: 1
start_date string optional format:Y-m-d
Example: 2020-06-25
end_date string optional format:Y-m-d
Example: 2020-06-25

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Brand management

GET connector/api/brand

List brands

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/brand/{id}

Get the specified brand

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the brand.
Example: architecto
brand string required comma separated ids of the brands
Example: 1

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Business Location management

GET connector/api/business-location

List business locations

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/business-location/{id}

Get the specified business location

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the business location.
Example: architecto
location string required comma separated ids of the business location
Example: 1

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

CRM

GET connector/api/crm/follow-ups

List Follow ups

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
start_date string optional format: Y-m-d (Ex: 2020-12-16)
Example: 2020-12-16
end_date string optional format: Y-m-d (Ex: 2020-12-16)
Example: 2020-12-16
status string optional filter the result through status, get status from getFollowUpResources->statuses
Example: architecto
follow_up_type string optional filter the result through follow_up_type, get follow_up_type from getFollowUpResources->follow_up_types
Example: architecto
followup_category_id string optional filter the result through followup_category_id
Example: architecto
order_by string optional Column name to sort the result, Column: start_datetime
Example: start_datetime
direction string optional Direction to sort the result, Required if using 'order_by', direction: desc, asc
Example: desc
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/crm/follow-ups

Add follow up

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

title   string     

Follow up title Example: Meeting with client

contact_id   integer     

Contact to be followed up Example: 2

description   text     

Follow up description Example: Eius et animi quos velit et.

schedule_type   string     

Follow up type default get from getFollowUpResources->follow_up_types Example: architecto

user_id   string[]     

Integer ID; Follow up to be assigned Ex: [2,3,8]

notify_before   integer     

Integer value will be used to send auto notification before follow up starts. Example: 5

notify_type   string     

Notify type Ex: 'minute', 'hour', 'day'. default is hour Example: minute

status   string     

Follow up status Example: open

notify_via   string[]     

Will be used to send notification Ex: ['sms' => 0 ,'mail' => 1]

start_datetime   datetime     

Follow up start datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 Example: 2021-01-06 13:05:00

end_datetime   datetime     

Follow up end datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 Example: 2021-01-06 13:05:00

followup_additional_info   string[]     

Follow up additional info Ex: ['call duration' => '1 hour']

allow_notification   boolean     

0/1 : If notification will be send before follow up starts. default is 1(true) Example: true

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/crm/follow-ups/{id}

Get the specified followup

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the follow up.
Example: architecto
follow_up string required comma separated ids of the follow_ups
Example: 1,2

Example request

Example response

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
                    }
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

PUT PATCH connector/api/crm/follow-ups/{id}

Update follow up

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the follow up.
Example: architecto
follow_up string required id of the follow up to be updated
Example: 20

Body Parameters

title   string     

Follow up title Example: Meeting with client

contact_id   integer     

Contact to be followed up Example: 2

description   text     

Follow up description Example: Eius et animi quos velit et.

schedule_type   string     

Follow up type default get from getFollowUpResources->follow_up_types Example: architecto

user_id   string[]     

Integer ID; Follow up to be assigned Ex: [2,3,8]

notify_before   integer     

Integer value will be used to send auto notification before follow up starts. Example: 5

notify_type   string     

Notify type Ex: 'minute', 'hour', 'day'. default is hour Example: minute

status   string     

Follow up status Example: open

notify_via   string[]     

Will be used to send notification Ex: ['sms' => 0 ,'mail' => 1]

followup_additional_info   string[]     

Follow up additional info Ex: ['call duration' => '1 hour']

start_datetime   datetime     

Follow up start datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 Example: 2021-01-06 13:05:00

end_datetime   datetime     

Follow up end datetime format: Y-m-d H:i:s Ex: 2020-12-16 03:15:23 Example: 2021-01-06 13:05:00

allow_notification   boolean     

0/1 : If notification will be send before follow up starts. default is 1(true) Example: true

Example request

Example response

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"
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/crm/follow-up-resources

Get follow up resources

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/crm/leads

List lead

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
assigned_to string optional comma separated ids of users to whom lead is assigned (Ex: 1,2,3)
Example: 1,2,3
name string optional Search term for lead name
Example: architecto
biz_name string optional Search term for lead's business name
Example: architecto
mobile_num integer optional Search term for lead's mobile number
Example: 16
contact_id string optional Search term for lead's contact_id. Ex(CO0005)
Example: architecto
order_by string optional Column name to sort the result, Column: name, supplier_business_name
Example: architecto
direction string optional Direction to sort the result, Required if using 'order_by', direction: desc, asc
Example: desc
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/crm/call-logs

Save Call Logs

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

call_logs   object     
*   object     
mobile_number   string     

Mobile number of the customer or user Example: architecto

mobile_name   string     

Name of the contact saved in the mobile Example: architecto

call_type   string     

Call type (call, sms) Example: call

start_time   string     

Start datetime of the call in "Y-m-d H:i:s" format Example: architecto

end_time   string     

End datetime of the call in "Y-m-d H:i:s" format Example: architecto

duration   string     

Duration of the call in seconds Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

Cash register management

GET connector/api/cash-register

List Cash Registers

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
status string optional status of the register (open, close)
Example: open
user_id string optional id of the user
Example: 10
start_date string optional format:Y-m-d
Example: 2018-06-25
end_date string optional format:Y-m-d
Example: 2018-06-25
location_id string optional id of the location
Example: 1
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 15

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/cash-register

Create Cash Register

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

location_id   integer     

id of the business location Example: 1

initial_amount   number     

Initial amount Example: 4326.41688

created_at   string     

Register open datetime format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

closed_at   string     

Register closed datetime format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

status   register     

status (open, close) Example: close

closing_amount   number     

Closing amount Example: 4326.41688

total_card_slips   integer     

total number of card slips Example: 16

total_cheques   integer     

total number of checks Example: 16

closing_note   string     

Closing note Example: architecto

transaction_ids   string     

Comma separated ids of sells associated with the register Example: `1,2,3

response { "data": { "status": "closed", "location_id": "1", "closed_at": "2020-07-02 12:03:00", "business_id": 1, "user_id": 1, "updated_at": "2020-07-06 16:28:42", "created_at": "2020-07-06 16:28:42", "id": 3 } }`

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/cash-register/{id}

Get the specified Register

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the cash register.
Example: architecto
cash_register string required comma separated ids of the cash registers
Example: 59

Example request

Example response

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"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Contact management

GET connector/api/contactapi

List contact

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
type string required Type of contact (supplier, customer)
Example: architecto
name string optional Search term for contact name
Example: architecto
biz_name string optional Search term for contact's business name
Example: architecto
mobile_num integer optional Search term for contact's mobile number
Example: 16
contact_id string optional Search term for contact's contact_id. Ex(CO0005)
Example: architecto
order_by string optional Column name to sort the result, Column: name, supplier_business_name
Example: architecto
direction string optional Direction to sort the result, Direction: desc, asc
Example: architecto
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/contactapi

Create contact

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

type   string     

Type of contact (supplier, customer, both, lead) Example: customer

supplier_business_name   string     

Required if type is supplier Example: architecto

prefix   string     

Prefix for the name of the contact Example: architecto

first_name   string     

Name of the contact Example: architecto

middle_name   string     

Example: architecto

last_name   string     

Example: architecto

tax_number   string     

Example: 8787fefef

pay_term_number   number     

Example: 3

pay_term_type   string     

(months ,days) Example: months

mobile   string     

Example: 4578691009

landline   string     

Example: 5487-8454-4145

alternate_number   string     

Example: 841847541222

address_line_1   string     

Example: architecto

address_line_2   string     

Example: architecto

city   string     

Example: architecto

state   string     

Example: architecto

country   string     

Example: architecto

zip_code   string     

Example: architecto

customer_group_id   string     

Example: architecto

contact_id   string     

Example: architecto

dob   string     

Fromat: Y-m-d Example: 2000-06-13

custom_field1   string     

Example: architecto

custom_field2   string     

Example: architecto

custom_field3   string     

Example: architecto

custom_field4   string     

Example: architecto

email   string     

Example: gbailey@example.net

shipping_address   string     

Example: architecto

position   string     

Example: architecto

opening_balance   number     

Example: 0

source_id   integer     

Id of the source. Applicable only if the type is lead Example: 16

life_stage_id   integer     

Id of the Life stage. Applicable only if the type is lead Example: 16

assigned_to   string[]     

Ids of the users the lead is assigned to. Applicable only if the type is lead

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/contactapi/{id}

Get the specified contact

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the contactapi.
Example: architecto
contact string required comma separated ids of contacts
Example: 2

Example request

Example response

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
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

PUT PATCH connector/api/contactapi/{id}

Update contact

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the contactapi.
Example: architecto
contact string required id of the contact to be updated
Example: 17

Body Parameters

type   string     

Type of contact (supplier, customer, both) Example: customer

supplier_business_name   string     

required* Required if type is supplier Example: architecto

prefix   string     

Prefix for the name of the contact Example: architecto

first_name   string     

Name of the contact Example: architecto

middle_name   string     

Example: architecto

last_name   string     

Example: architecto

tax_number   string     

Example: 488744dwd

pay_term_number   number     

Example: 3

pay_term_type   string     

(months ,days) Example: months

mobile   string     

Example: 8795461009

landline   string     

Example: 65484-848-848

alternate_number   string     

Example: 9898795220

address_line_1   string     

Example: architecto

address_line_2   string     

Example: architecto

city   string     

Example: architecto

state   string     

Example: architecto

country   string     

Example: architecto

zip_code   string     

Example: architecto

customer_group_id   string     

Example: architecto

contact_id   string     

Example: architecto

dob   string     

Fromat: Y-m-d Example: 2000-06-13

custom_field1   string     

Example: architecto

custom_field2   string     

Example: architecto

custom_field3   string     

Example: architecto

custom_field4   string     

Example: architecto

email   string     

Example: gbailey@example.net

shipping_address   string     

Example: architecto

position   string     

Example: architecto

opening_balance   number     

Example: 10.3

source_id   integer     

Id of the source. Applicable only if the type is lead Example: 16

life_stage_id   integer     

Id of the Life stage. Applicable only if the type is lead Example: 16

assigned_to   string[]     

Ids of the users the lead is assigned to. Applicable only if the type is lead

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/contactapi-payment

Contact payment

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

contact_id   integer     

id of the contact Example: 17

amount   number     

amount of the payment Example: 453.13

method   string     

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

paid_on   string     

transaction date format:Y-m-d H:i:s, Example: 2020-07-22 15:48:29

account_id   integer     

account id Example: 16

card_number   string     

Example: architecto

card_holder_name   string     

Example: architecto

card_transaction_number   string     

Example: architecto

card_type   string     

Example: architecto

card_month   string     

Example: architecto

card_year   string     

Example: architecto

card_security   string     

Example: architecto

transaction_no_1   string     

Example: architecto

transaction_no_2   string     

Example: architecto

transaction_no_3   string     

Example: architecto

cheque_number   string     

Example: architecto

bank_account_number   string     

Example: architecto

note   string     

payment note Example: architecto

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Endpoints

POST oauth/token

Authorize a client to access the user's account.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET oauth/authorize

Authorize a client to access the user's account.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 400

Show Response Headers
content-type: application/json
cache-control: no-cache, private
set-cookie: XSRF-TOKEN=eyJpdiI6IjdReXdEVExnWXZqNldDcTBrTjJqRlE9PSIsInZhbHVlIjoiZ3lvVmo5OUJGTTJBMVJEQmw2eFNPNEFiSmpHNUVsbnBDb2gvM3kxcUhXZVU0K0VLU3M2N1Z5b2Ivc3p5WHZCTnRESEFMNVR0ZkQ0WUx2UVlFeDMwc0N6bUV3ZWovUUJteTVjbWdVVlh4WmdKMTRLMkYyczQwUno5NlloU1dVRy8iLCJtYWMiOiI4MjJlZTYzYWUwNjI0MDYwNzM0ZTYzNWJiYWEwYjdjNDA0MWZmMTVlNzIxMGFjMzA4NTdkZWRhMTk0NGZlNTAyIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6Ik1UNFNlWDlxdmgyUVFMUk5WeDBTcVE9PSIsInZhbHVlIjoiZ3Z3SW5HSWZkcnhQdXJJM3JqSUhzM0tsSVNnTDN1SUVGUEFqWmZJRUczYStweWtxRlA5TzRQMEJwZThQQ05iNDVLelZPMTNHUjQzVjRMeEZzWHhzODBCYjc0ZEhjNnZzQS9Fd2xVenNDM3hqMWQzS0FQQTJoUjZXaVBqTjFkNk0iLCJtYWMiOiIyZGE3MjI5YzBjMjNhZWFiMWM5ZmNmMTE0MjAzOGY3YWVjMDc2ODYyOTJiNDQxZjc0MmFmYzI0NWExNzJhMDI5IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "error": "unsupported_grant_type",
    "error_description": "The authorization grant type is not supported by the authorization server.",
    "hint": "Check that all required parameters have been provided",
    "message": "The authorization grant type is not supported by the authorization server."
}

Interactive API Testing

Test this endpoint directly from your browser

POST oauth/token/refresh

Get a fresh transient token cookie for the authenticated user.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

POST oauth/authorize

Approve the authorization request.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

DELETE oauth/authorize

Deny the authorization request.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET oauth/tokens

Get all of the authorized tokens for the authenticated user.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6InVRZjRiUTV2enhnZlNVL3VydnpPL3c9PSIsInZhbHVlIjoiOS9wWlNQaUJZZ2VVa3AydDBWeHEwRmlVVDVCM21qZXlZdk5JZFIzUmRROTYwSUIzSWxTdzgvcVhXaGJpOHZJUHg5QVFVcjlQQ0V3eFU2cFRBdzhraXF6NVI5NFVzNE9kdjQyd2V1SUFlSTRHWnpFWEx2T3lMSHFkbFJmeVlHd0oiLCJtYWMiOiIyOTI1NTQxMWE0YzBjMTFkY2E0YTI1ODk2MDMzNmUwM2E5MmI3NmQ5YzgxMmY3MDU1ZGM5YjA4MDNjZDJmNWJlIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IlFBUFhsTE9NR3MxdEo2TkNSQVNrdUE9PSIsInZhbHVlIjoibk00eWMwMnAwTWFZRDR0bllHdGU5Ym5kM1pqRDlMNXpkQVJWSlBCMm53VUVPcHF1TENmSVFGMHJFU21Gci9QMnZUSEVicmN1QmRpbnU5WVQ4cUNyZ3h2b1RibTdwaWJ0b0RGSlBmTWtudGNIamtreVkzRER5eFFjSW05cHNtUEkiLCJtYWMiOiIxMGY1NDJiNzYxYWUwOTNjZWU4OWQ2N2Y4YmI3MTIzNTUwMGZkYjc5MGIxMzI1NWY0OWE0ZTljYTdkZWY5M2JmIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

DELETE oauth/tokens/{token_id}

Delete the given token.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
token_id string required The ID of the token.
Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET oauth/clients

Get all of the clients for the authenticated user.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6ImVtZG0wdXliU2Y3emhvamZUYXhuRnc9PSIsInZhbHVlIjoiSkVLMWx4YzlMQm5MRU15N1lKS2IxMnh4SkxBenFCV1REcnBibGd3eVJuWHlxTXpXN1ZuWVBZeGVZOW02dDdORkZ1NjU2bG4xVXFpb2ZJbDdzVHIzeld4UkRKcmoyQkFWNnZ2SjVsRFhwN3VMTjgyRkNLNkY2NHZKbkthaE9GSkkiLCJtYWMiOiIwODA0MGRhMTE5ZDQ3ZTg0YzhhMzg3MDU1NmU5ZDY5YWRhOGZhY2E4OWRmOTU3YWE1OWI2YjNiYTAxNWE2YzI2IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6ImkwMDBKcVM0Mm5rZmlCTm0vb1JOeXc9PSIsInZhbHVlIjoiS2kxUC8rbVNvditNeFZtTk1DcDNHNzJLVUptdFBXVnYvaFZiMUk3ckNxb0tNSnN3dmFncUZNWnlzeUg5S3RKTzg4R3VmeTQ1MEY5L3ZDZlBoMndKVEtZS1EvTjRaSlozOXpzYklmLzRLS0g5WFJHVUhWRko2ZnJueUhXZkEyWUoiLCJtYWMiOiIxOTVhYmQ2MmNiMTQ5ZmM1ZDU1ZTI4YTUxZWU2NjgwODgxYjBlNzNmYmZhMzk1YTk5ZjIzY2E0YTNiZmFkODBkIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

POST oauth/clients

Store a new client.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

PUT oauth/clients/{client_id}

Update the given client.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
client_id string required The ID of the client.
Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

DELETE oauth/clients/{client_id}

Delete the given client.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
client_id string required The ID of the client.
Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET oauth/scopes

Get all of the available scopes for the application.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6ImlIMmxMZ3VUUjdTeWpLTHBJODFGZVE9PSIsInZhbHVlIjoiNVBlYnpsSEQxdEgvNDZDYW9OMGFMVTJGU09FU25xL3JIUnlLN3N1T3NucnhQVU9yY3l0K1o0b2NrZG9XLyt3TENyUzdkRHVtUEcwVWdBNTBnMmtvNGhsMm56ajZZYWs5MmE3Q1Z0ZHdMK1c5RXJPNDJsWXB4U21KZEFGQmRGcU0iLCJtYWMiOiIxZTA5OTMwZjhlNzdjYzFmNTM5YTUwYmNmZDA0M2Y1N2I3YTYzYWRiZWY2NjA5Mjc5NTJiODAyYTUwOGVmMTI1IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IjVtdk1hQ3hiNll6blFXTGxJOTYzaGc9PSIsInZhbHVlIjoidHZMS2pOY3EzZytCSy9LT2hBcmNndjNieUV1QjdTY2gzaWE4SkRTY1RBbm5uTDk1cktTek1ndkU5b3FQc0g4c0lyNkFvcnQ1T1pvL3g5czkzbFhsd3pISG9jS0Nwci9KUXhZVGJOeDdod0pEaU5GOXRVWnhGaGxFMnNicG9Ja3MiLCJtYWMiOiJlZjNiMGZlMDFmY2Y4YWVkZmUwZjVhZTkxNmE4OWVjYzMzMjFkZTI3NjZhMGEwZTRkMjZiOGVhMDM4MTk3Y2QwIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

GET oauth/personal-access-tokens

Get all of the personal access tokens for the authenticated user.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6IkFaSWZFNHBwZlNuc3g4dWtFWUlBc2c9PSIsInZhbHVlIjoiUlowb1NQNit5ckI2SzRNOXFqblRqT2p5UVZPQWFxaTRsZDhyaEVCdFhQdlpKbWFHWmd2VkxCalFTZCtmWXFvM2VHRk9XWDNIYncyWUlsVmp5RlRZR2doZDZGRXVoMk15d1R3cFY5UjV4UmVFeVF4dkNETDArcHNYSXV2R0pEL1giLCJtYWMiOiI1YjE4OTgwODIxNDA2NDQyNjI3YWI1NzAwMTMxYmNiZDlhMzliMWJlMjA2MmViMDkxMDk0ODZiZDUyN2IyZjQzIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IjZ5RHdKS3pSZ1JiSytYbVZMaHlac0E9PSIsInZhbHVlIjoiaWNJbjRIMEJIVE9pc1B2czdaelhQTnJXbklpQzdPaUlwdWNyd0lBTXo1aGVKelNNN2pXVmVpYkY1eWNKWDgvL3c3RTRCQ0RzRVRnbG1mSDB6Ny9qaVZpYXdleXhUZEplSmRseFZGL2lyZlpKc1NZM3NOYmlSVWtncGVRaVp4U0kiLCJtYWMiOiJiOTdiMWI4ZGQ1NDQ1ZGFhYTg2MGVlNTJmZTBiMzk1OWQzM2U4YjAwZDNjYmNlN2VkNWVkOTJjZWU2NzRlNTZkIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

POST oauth/personal-access-tokens

Create a new personal access token for the user.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

DELETE oauth/personal-access-tokens/{token_id}

Delete the given token.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
token_id string required The ID of the token.
Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/payment-accounts

List payment accounts

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/payment-methods

List payment methods

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/business-details

Get business details

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/profit-loss-report

Get profit and loss report

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
location_id string optional optional id of the location
Example: 1
start_date string optional optional format:Y-m-d
Example: 2018-06-25
end_date string optional optional format:Y-m-d
Example: 2018-06-25
user_id string optional optional id of the user
Example: 1

Example request

Example response

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.95,
        "gross_profit": -11.55,
        "total_sell_by_subtype": []
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/product-stock-report

Get product current stock

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/notifications

Get notifications

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/get-location

Get location details from coordinates

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

lat   decimal     

Lattitude of the location Example: 41.40338

lon   decimal     

Longitude of the location Example: 2.17403

Example request

Example response

Response 200

{
    "address": "Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India"
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/install

Install

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6IlVFbDJIWDdNYzRpaWlMSFdSaGZ4cnc9PSIsInZhbHVlIjoiVlFRdnc5ck0zOEtueTRiRXovTlNmMGNaUHd2V1ZTWDhHUTNhbnFxRFZUQ2l3ekd5eTVPR3p3dFNmbkJ3V3o3Q3RWYy9NMXREWFlQTEZETkxvTEkvTGZ0aGIxOTJEK3RrakFiSHhjdXA0dUI1NHhzeVJUTkU5bk03bmF5UC9hR2YiLCJtYWMiOiJlOTRlZDBhMGIyYTFmM2YyNGQzMWM4YzkwZGFkZjFlNjZkZGM4NmQzNTA0ZmY4ODk5ZTBjMGZlZWMxM2E2YzJmIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IjFqWU9sbTNkR1A0MjFwTWRZay8wUFE9PSIsInZhbHVlIjoiQ25IMVByQ1pyNVBnTFpUNHI4ZjFMcjQrTjRxRjU0SnFOeVljaUlpZTYrUGVzY1UyM3MyT0RCSlpaelFsUlFwQlhGSkpsazNGOS9ZemxacXV4eFlxeWQxeHp0K1FRbEVNWTk3RVczd1BXNGNmbitBZVI0dXMvdFhqVncyY2FCczIiLCJtYWMiOiJjOTA1ZmFhZWEwNmVjZDY5ZTlmMjliZjI4ZGE1YzRiYjdhYjdlNzAxYTc1MWZkYjAzZGE3NTBlMTEyZWZlN2EzIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/install

Installing Connector Module

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET connector/install/uninstall

Uninstall

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6IklDVDl1bzF4ZTVVbXBrK1g2U3hOYlE9PSIsInZhbHVlIjoiaVVEc1U1YWRJMksrMVVOUzc3b0NyTmlJK2gwcWQvcEJuajZkWG1kSzRCZHFvU1ROMkpQZFRqQXI3WCtpMlZyL0t5dWNod1JiNFcrRnhaSEs1MUdQSlkwNkowNEtSeDJSVWQzVnNacmkrWVc1c1JWR3MzaDVva08yZmNPeVVVeUQiLCJtYWMiOiI0NDdmNTZmMWY5MTUyMTA2MTExMDQ5OTQyZDk4ZTRiNDQ5MDQ0M2U4NDMwNThmZGJjMDM1MDMzN2JmNTBjNDZmIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IkdIcTNmS29Ba0ZPRU1YMFhZT0RwOUE9PSIsInZhbHVlIjoiYVorZnFQeHRPaHBqcURUckMvMGVlOVcvck44ZEoxTGFiQWFzRDZ1R3FMRjdRajhHTVhwUkhXekdRVS9Jc3hjR05PNVh0eEZSSW0wd2FRNDBUc3J3aisyL0VEd0pZdlNBdUcrY1Zwck1TczdQYWFxRW1yclh5dHFPSTU1K0s3VTAiLCJtYWMiOiJkYzliZTVlYjVlNTdkNzQzNjgzZmE4ZWNjODE2YjZiZTU2MWFiN2ViYjYwNmYzZTRkNjVhYWZmMDNkMzdmNWZiIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/install/update

update module

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6Iml5RDhBZHJ2a3N3RHRicWJFcXpyT3c9PSIsInZhbHVlIjoiRU1yTHFwNElWM3BZTXJkbXhYT0gwcDVVa016dmU4ak1hVDB1cHNUZFNhWVlEV2FCRlpBam9JdHhpUElCSTVrS2UwSkx5YndubWg4Yng5N2Z2RHcybFA2TDYxSTUyUGM2clVzOVVjbHJSeGt0elVUVlFWYTRkelN5S1I4RWlnaHYiLCJtYWMiOiI2MTc4MTU2ZDVlNmYzN2VlYTQ5NjQ0ZDY3NWRhNjFjY2Q4M2Q2Mjk5MGFkZTEwMjQxOWY0MGFlNzZjNTg0NmEzIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IlJzTGN2eUd0STlCQUxiZzNDUUVTZlE9PSIsInZhbHVlIjoiM0FpWGgzVmVoaVMybE1vc1prdnZXQUZ5bkJ5SFN3ZkNDcTNJV3NSQXBXTFRpaDRjbzBaaHZ6VDJvTm41ZGZOWTNjN2IyTVMzTVc1NnUzNHhQNGpMRUFadGRVQ3NndmgxMERSTnhWNEtqWDZvYTlLNGhpVkRsem1CbjlhVjlVYVciLCJtYWMiOiJkYTE4ZDkxMTNhMWE3OTQ5OWM4MDFjNjY5MmU1NTU0NzZlMzJjYzVlNWUxM2UxNmIwZjljNGRhMGM5ZTVjNDg0IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api

Display a listing of the resource.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6IkU4eGRFNkJGSUhkZ3E5anRtWnloM3c9PSIsInZhbHVlIjoiM1RCc2Zydmo0ejZsMms0MUFKMG10TW9DekZ5cmlVVGNmdTdxLzlWU2hJd1M1dzhxbkJGYTgrcEIzZnZPYnBCVzZ5NW5sb1pWMEhmYW9CSzhDRDhSeXZ3amVRY0NRT1gwbzUwSWtSWCtvZjQ5WWxnVFNLTGcxT1ZIS3RIQWJDL3QiLCJtYWMiOiJkZmM1ZmEwMmEwN2I4OTEwZDkxYWI2NmU0MTdmNGY2Mzc3ZDJmNTcxOTY2NTU0YWY2NmMyNTk2YzQwMjBhZWZkIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IllGSW9UUTZpV1RtMDBldmNwTjkxd0E9PSIsInZhbHVlIjoiK3BhdU1Yd3N6cGcvUFcyL095SktrRDhvRmVNY29vbTlMT3lOYlhvdXp4TmV3ZmtDblVJcy90S2NHVGo2N2prZndiUS9iclFwMzY4SE1xMUFkQ0N3UGFTTVJtQ2dRejE1YWl6MUdHdUhydXd4MXQ4ZXhuRFhSdm92RHhDckoxQzkiLCJtYWMiOiIxZmVmMTVlZjNiZDhmMTUwMmVhM2EzODExMWI1ZWJjZTY2OWMxN2MwNmY4NDUxYjAwYzJjNTRiN2MzYTUwZmRkIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/client

Display a listing of the resource.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6Im1SMHJGTzVVdWRRdlp1NTRrWFR4ZGc9PSIsInZhbHVlIjoiZEdYQmEzdG5GM0tHSThqUUJjSXppQm9qYVFJd0JVeTZVZkxqSjZwZXh5aHFQTDI1ZXV4aTd1ZnhnczdVSVpKR2FaeVIrU3UyS0NMaTRIRmt3VmVFbktsSkc5V0xwckUvZExydXppYUQxUnFJSm1xYkVvU1FmK1FjZ252T3QvaGwiLCJtYWMiOiI1NDJhNDg4MTQ2Njk1OGJhNmRkZmRmMTJkMzk5MzU0MjMxYTE0YWQwOTVhNDI1YzY3NTA4ODZlYTc3OGY0Y2I1IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IlVza2RTTmxoazd2TUUzRnpxR3d0bnc9PSIsInZhbHVlIjoiVDZUQXhYcXExRzAyWWRXZUl4eGNuNWxFSDlkSEwrcUFWaEc5TmFmME1zbkJqY1l0L3FlblgyU3FRN25oK2Ercng0ay8xNmRlbzJLSk1BbmR4WVU2blIwdCtla2tHc1Q1aDgrWTJCdVk4cHVnd1I3eENEenA3eXpQMEs4RjFadjUiLCJtYWMiOiIxMDRhMzA1YmJkMWM4NWJjYjVhZTQwNGRhNDlmZDE1N2ZjMzFiNzVhYzk4MDBmYmM1NThkNGZjMWVjMWVkNGQ2IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/client/create

Show the form for creating a new resource.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6IjlkeFpRSDJmZUp0MytYcVN3ZHVrMmc9PSIsInZhbHVlIjoiV25pcHAyZy9pSHZuZEpTZW8xVW14ZWlXYWdwNTdIb2RFL2tlTm9YRWRYWDhzejNCMm1pbk1CTVpCTnpCR2Rhc1JGVGFHTmVINm1MaDQ4ZUdud3piTFgzK3J3ZkFVT0FuZlJEZ2xhL2tzck05MjA2RHorODg3cGlNeC9QT21GajQiLCJtYWMiOiJhMjM1NWUwMDdhZGI2MTdmMWI2YzQ4YmMwZmU4ZDE0OTA1Yjk4OWMxYmZlZjEzNWNiYTllODEzMjNmZjMwMTI1IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6InNaNHhPQzBZUHBtWHpyRk9MWEh2cWc9PSIsInZhbHVlIjoiYld6OFhNVXh0UXkrSzNvcUlFMmhCdWZrcmpRTzIxN3ZwQWZiMVFLQjBLQmNWTTZhTjNNSUNCRWFJcXN4QlBHdVk5aFpMMWZNcURBVGZ1S1lxdWNUaHJ3R2MzZ0t4VnFMdTVYc2tMRXh3U1QvcE45MmF6SythTG9TZ3VtRG15a0UiLCJtYWMiOiI2YmIwOTU3Yzg3ODgwMGYyZDk1YjE2YjE1ODc0MDk2NWFlZmQ5OGNhYzMxMTBiZjJiYzEzNGVlNDJlNThkMTM4IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/client

Store a newly created resource in storage.

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET connector/client/{id}

Show the specified resource.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the client.
Example: architecto

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6IjNlL2wwY2N3aExvb2sxOHVYOHcwbmc9PSIsInZhbHVlIjoiMHppWlArUFhmSWZjTWRkL0tEaWJ0UTYzMVU4VU1XT3ZXMlFLUVZNeGcxNzY5cGtCRzJGQUVCbmlsN3BSblFtMXQvaHhBbithbStHR0lZQmpNQlJqdHQ0cVFIYjF6a3pUS3FrMXFjQTIzbEE1YjBsMVpvTklNcWRaOUptZ2doaHYiLCJtYWMiOiJjZmE4N2MzY2U0ODE4NTFjMmY2NWFhZTE4YWJhYjZlNGViZTBhODM0ZjFmYzgwYTMzMjQ5YmNmZWQ0YzYyYjI4IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IklzVC9RYmtIZThUM1FHbzg4ZUpZb0E9PSIsInZhbHVlIjoiWGhGaEdoQ1NDQUd6MjZreEtCTFlpTndnbmxzUHI1S2JyM0RHT2pQaE1XS3ZINml2M0tLMFpJRXZHQXlqQlZWeGhtU3MrZFVwcVgwcHd1b3RTVVVienV6S3FMYStiOEJhSk9jOUUzOWNRV3JOZ1RleVVTb1ZlM2oxUmsrR2hqRTkiLCJtYWMiOiJkODc2YzI3N2VlNWZjYTVmMTMyMDBiNTQ2NTFhZWEwOGJlNzU2Y2QxMzQxOGE2MWMyZmU4YTMxZWViODY2ZDdhIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:13 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/client/{client}/edit

Show the form for editing the specified resource.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
client string required The client.
Example: architecto

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6Im1yL09ncHJzUWlBSlkxd0UrL3hvNEE9PSIsInZhbHVlIjoiZmRWd3ErNEp3Q0NoYk1tNlJ5UjNqSzJ5alNoZnJGdUtwOWswMnJOVmRtdk9PaE5qZy9ySEJNd0F2c2VDaG1wQ0hRYkd1L284MU81cFhqdkdGd2E4WGJLSFdJOW1OcGNxVVFMckN2Z28veHB4ekJLVFpUcUd6ZExQczg1blpHMXciLCJtYWMiOiJkYmMzMTdjMDM1OWNiMjRlZGY0YjU3OTg5ZWQyZjg4YjEwMjgxMTIwNTI5YTJkZDAxYzBlNjJjY2EzNzhiNjc1IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:14 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IlJKM3FQOTVBUE5aU04weXdSNk5wQUE9PSIsInZhbHVlIjoia3RjRGhEaDZ4VTF2T1JJU2s0U1J3VXJHZUhRQmFLNlhZY3VQUFdoQks4WUZOZzhXOWVSL1lIQmllcms5WDBscXgrdDB5V1BiRzlRZWxrb0U1djVMNk42N2kwRCtXN0pwR2EwN2MvQm15RHhVZWtJREZHZXY1VkpLLzA2UCtYNUwiLCJtYWMiOiJkZTliOGU2NzJkNzJjOGFiYmU4ZTU2OGRjOGFlOTNjYzU2NWMwYjQ3OTZiZmZlODg5MDVlY2FkNjI3NzJhN2Q4IiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:14 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

PUT PATCH connector/client/{id}

Update the specified resource in storage.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the client.
Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

DELETE connector/client/{id}

Remove the specified resource from storage.

Headers

Name Value
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the client.
Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

GET connector/regenerate

GET connector/regenerate

Headers

Name Value
Content-Type application/json
Accept application/json

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
set-cookie: XSRF-TOKEN=eyJpdiI6Ikk5R3NNdjNDTEU1bGQ2MkRhZ1ZYaGc9PSIsInZhbHVlIjoiS2l2YXZUOGhVM3JkbFcxd3RuMWR4WUZVY09TN3N5OUNpbWhQZmwydTFZY3FaektUVWlJVTNRc3pwYkRNdmNVMnJ5cXZMMXd6VzhDYVh4eit3VEJFVHpsVzgvb0pPNUZzUG1wT25xckl4ZVJINUpIMGhwSGYwaDJSSGVnR1dwb3UiLCJtYWMiOiIzZWZhZDYzNTI2ZGE4ZmEzNWY4MmRhZjg3OGY3ZGJhOWQwNjE3NWExYWNlZmRlMjNmZTQ3NjVmNzZkZTZlMGIwIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:14 GMT; Max-Age=86400; path=/; samesite=lax; briskbasepos_session=eyJpdiI6IkpZdGlEb2FIdmxlSUN3QXNhdks4cFE9PSIsInZhbHVlIjoiT3JpR1J1Wkt5MjVrZi9ucERRcnYrby9rbVhOd3VpWmZIMGxKbW1YazFPNHkxdWZWT3lIVkdTVWt6eU54L3ZIdkVQaUZOL2g3eDd1c0N4VWRTZU1VNkJUMEtVUjhxdHY5S1poNjhqWWtrVW85K0RaSXpIb05ydyszS2NQWG9KdW0iLCJtYWMiOiJmYTE3N2ViNzJkYWQ3YjYzYTFmMzc4ZGRjMDI5N2Y3ZTE0MTAxMTQ3ZGUxMGYwMTcwMzllZmM0ZTM0ZWE2NGVlIiwidGFnIjoiIn0%3D; expires=Sun, 03 May 2026 23:19:14 GMT; Max-Age=86400; path=/; httponly; samesite=lax
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

Expense management

GET connector/api/expense

List expenses

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
location_id string optional id of the location
Example: 1
payment_status string optional payment status
Example: paid
start_date string optional format:Y-m-d
Example: 2018-06-25
end_date string optional format:Y-m-d
Example: 2018-06-25
expense_for string optional id of the user for which expense is created
Example: architecto
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 15

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/expense

Create expense / expense refund

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

location_id   integer     

id of the business location Example: 1

final_total   number     

Expense amount Example: 4326.41688

transaction_date   string     

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

tax_rate_id   integer     

id of the tax rate applicable to the expense Example: 16

expense_for   integer     

id of the user for which expense is created Example: 16

contact_id   integer     

id of the contact(customer or supplier) for which expense is created Example: 16

expense_category_id   integer     

id of the expense category Example: 16

expense_sub_category_id   integer     

id of the expense sub-category Example: 16

additional_notes   string     

Example: architecto

is_refund   integer     

whether expense refund (0, 1) Example: 0

is_recurring   integer     

whether expense is recurring (0, 1) Example: 0

recur_interval   integer     

value of the interval expense will be regenerated Example: 16

recur_interval_type   string     

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on   integer     

day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15

subscription_no   string     

subscription number Example: architecto

recur_repetitions   integer     

total number of expense to be generated Example: 16

payment   string[]     

payment lines for the expense

*   object     
amount   number     

amount of the payment Example: 453.13

method   string     

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id   integer     

account id Example: 16

card_number   string     

Example: architecto

card_holder_name   string     

Example: architecto

card_transaction_number   string     

Example: architecto

card_type   string     

Example: architecto

card_month   string     

Example: architecto

card_year   string     

Example: architecto

card_security   string     

Example: architecto

transaction_no_1   string     

Example: architecto

transaction_no_2   string     

Example: architecto

transaction_no_3   string     

Example: architecto

note   string     

payment note Example: architecto

cheque_number   string     

Example: architecto

Example request

Example response

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": []
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/expense/{id}

Get the specified expense / expense refund

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the expense.
Example: architecto
expense string required comma separated ids of the expenses
Example: 59

Example request

Example response

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"
            }
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

PUT PATCH connector/api/expense/{id}

Update expense / expense refund

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the expense.
Example: architecto

Body Parameters

final_total   number     

Expense amount Example: 4326.41688

transaction_date   string     

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

tax_rate_id   integer     

id of the tax rate applicable to the expense Example: 16

expense_for   integer     

id of the user for which expense is created Example: 16

contact_id   integer     

id of the contact(customer or supplier) for which expense is created Example: 16

expense_category_id   integer     

id of the expense category Example: 16

expense_sub_category_id   integer     

id of the expense sub-category Example: 16

additional_notes   string     

Example: architecto

is_recurring   integer     

whether expense is recurring (0, 1) Example: 0

recur_interval   integer     

value of the interval expense will be regenerated Example: 16

recur_interval_type   string     

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on   integer     

day of the month on which expense will be generated if recur interval type is months (1-30) Example: 15

subscription_no   string     

subscription number Example: architecto

recur_repetitions   integer     

total number of expense to be generated Example: 16

payment   string[]     

payment lines for the expense

Example request

Example response

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": []
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/expense-refund

List expense refunds

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
location_id string optional id of the location
Example: 1
payment_status string optional payment status
Example: paid
start_date string optional format:Y-m-d
Example: 2018-06-25
end_date string optional format:Y-m-d
Example: 2018-06-25
expense_for string optional id of the user for which expense is created
Example: architecto
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 15

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/expense-categories

List expense categories

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Field Force

GET connector/api/field-force

List visits

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
contact_id string optional id of the contact
Example: architecto
assigned_to string optional id of the assigned user
Example: architecto
status string optional status of the visit (assigned, finished)
Example: architecto
start_date string optional Start date filter for visit on format:Y-m-d
Example: 2018-06-25
end_date string optional End date filter for visit on format:Y-m-d
Example: 2018-06-25
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 15
order_by_date integer optional Sort visit by visit on date ('asc', 'desc')

Example request

Example response

Response 401

Show Response Headers
cache-control: no-cache, private
content-type: application/json
{
    "message": "Unauthenticated."
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/field-force/create

Create Visit

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

contact_id   integer     

id of the contact Example: 16

visit_to   string     

Name of the visiting person or company if contact_id is not given Example: architecto

visit_address   string     

Address of the visiting person or company if contact_id is not given Example: architecto

assigned_to   integer     

id of the assigned user Example: 16

visit_on   format:Y-m-d     

H:i:s Example: 2021-12-28 17:23:00

visit_for   string     

Purpose of visiting Example: architecto

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/field-force/update-visit-status/{id}

Update Visit status

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type multipart/form-data
Accept application/json

URL Parameters

Name Type Status Description
id string required id of the visit to be updated
Example: 17

Body Parameters

status   string     

Current status of the visit (assigned, finished, met_contact, did_not_meet_contact) Example: finished

reason_to_not_meet_contact   string     

Reason if status is did_not_meet_contact Example: architecto

visited_on   format:Y-m-d     

H:i:s Example: 2021-12-28 17:23:00

visited_address   string     

Full address of the contact Example: Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India

latitude   decimal     

Lattitude of the user location if full address is not given Example: 41.40338

longitude   decimal     

Longitude of the user location if full address is not given Example: 2.17403

comments   string     

Extra comments Example: architecto

photo   file     

Upload Photo as a file of the visit if any or base64 encoded image Example: /tmp/phpn0bc9hblo29o3ZOypNP

meet_with   required     

name of person field force meet with Example: architecto

meet_with_mobileno   required     

mobile number of the person field force meet with Example: architecto

Example request

Example response

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"
    }
}

Interactive API Testing

Test this endpoint directly from your browser

New end points

GET connector/api/new_product

New List products

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
order_by string optional Values: product_name or newest
Example: architecto
order_direction string optional Values: asc or desc
Example: architecto
location_custom_field_1 string optional Custom field 1 of the location
Example: architecto
category_id string optional comma separated ids of one or multiple category
Example: architecto
sub_category_id string optional comma separated ids of one or multiple sub-category
Example: architecto
location_id string optional
Example: 1
not_for_sell string optional (1, 0)
Example: architecto
send_lot_detail string optional Send lot details in each variation location details(1, 0)
Example: architecto
name string optional Search term for product name
Example: architecto
sku string optional Search term for product sku
Example: architecto
product_ids string optional comma separated ids of products
Example: 1,2
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

Response 200

{
    "data": [
        {
            "id": 2,
            "name": "Levis Men's Slimmy Fit Jeans",
            "business_id": 1,
            "type": "variable",
            "exemption_type_id": null,
            "enable_stock": 1,
            "sku": "AS0002",
            "product_custom_field1": null,
            "product_custom_field2": null,
            "product_custom_field3": null,
            "product_custom_field4": null,
            "woocommerce_media_id": null,
            "product_description": 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": 627,
            "woocommerce_disable_sync": 0,
            "image_url": "http://local.pos.com/uploads/img/1528727964_levis_jeans.jpg",
            "product_variations": [
                {
                    "id": 2,
                    "variation_template_id": 5,
                    "name": "Waist Size",
                    "product_id": 2,
                    "is_dummy": 0,
                    "variations": [
                        {
                            "id": 2,
                            "name": "28",
                            "product_id": 2,
                            "sub_sku": "AS0002-1",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 658,
                            "default_purchase_price": "70.0000",
                            "dpp_inc_tax": "77.0000",
                            "default_sell_price": "70.0000",
                            "sell_price_inc_tax": "77.0000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 1,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 2,
                                    "location_id": 1,
                                    "qty_available": "71.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 3,
                            "name": "30",
                            "product_id": 2,
                            "sub_sku": "AS0002-2",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 659,
                            "default_purchase_price": "70.0000",
                            "dpp_inc_tax": "77.0000",
                            "default_sell_price": "70.0000",
                            "sell_price_inc_tax": "77.0000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 2,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 3,
                                    "location_id": 1,
                                    "qty_available": "89.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 4,
                            "name": "32",
                            "product_id": 2,
                            "sub_sku": "AS0002-3",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 660,
                            "default_purchase_price": "70.0000",
                            "dpp_inc_tax": "77.0000",
                            "default_sell_price": "70.0000",
                            "sell_price_inc_tax": "77.0000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 3,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 4,
                                    "location_id": 1,
                                    "qty_available": "127.0000"
                                },
                                {
                                    "id": 1371,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 4,
                                    "location_id": 7,
                                    "qty_available": "-1.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 5,
                            "name": "34",
                            "product_id": 2,
                            "sub_sku": "AS0002-4",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 661,
                            "default_purchase_price": "72.0000",
                            "dpp_inc_tax": "79.2000",
                            "default_sell_price": "72.0000",
                            "sell_price_inc_tax": "79.2000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 4,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 5,
                                    "location_id": 1,
                                    "qty_available": "128.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        },
                        {
                            "id": 6,
                            "name": "36",
                            "product_id": 2,
                            "sub_sku": "AS0002-5",
                            "product_variation_id": 2,
                            "woocommerce_variation_id": 662,
                            "default_purchase_price": "72.0000",
                            "dpp_inc_tax": "79.2000",
                            "default_sell_price": "72.0000",
                            "sell_price_inc_tax": "79.2000",
                            "combo_variations": null,
                            "variation_location_details": [
                                {
                                    "id": 5,
                                    "product_id": 2,
                                    "product_variation_id": 2,
                                    "variation_id": 6,
                                    "location_id": 1,
                                    "qty_available": "99.0000"
                                }
                            ],
                            "media": [],
                            "discounts": []
                        }
                    ]
                }
            ],
            "brand": {
                "id": 1,
                "business_id": 1,
                "name": "Levis",
                "description": null,
                "created_by": 1,
                "use_for_repair": 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
            },
            "category": {
                "id": 1,
                "name": "Men's",
                "business_id": 1,
                "short_code": "sfefef",
                "parent_id": 0,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null
            },
            "sub_category": {
                "id": 4,
                "name": "Jeans",
                "business_id": 1,
                "short_code": null,
                "parent_id": 1,
                "category_type": "product",
                "description": null,
                "slug": null,
                "woocommerce_cat_id": null
            },
            "product_tax": {
                "id": 1,
                "business_id": 1,
                "name": "VAT@10%",
                "amount": 10,
                "is_tax_group": 0,
                "for_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,
                    "name": "Location 1",
                    "custom_field1": "gdgdgd88",
                    "custom_field2": null,
                    "custom_field3": null,
                    "custom_field4": null
                }
            ]
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/new_product?per_page=1&page=1",
        "last": "http://local.pos.com/connector/api/new_product?per_page=1&page=1088",
        "prev": null,
        "next": "http://local.pos.com/connector/api/new_product?per_page=1&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1088,
        "path": "http://local.pos.com/connector/api/new_product",
        "per_page": "1",
        "to": 1,
        "total": 1088
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/new_sell

New List sells

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
location_id string optional id of the location
Example: 1
contact_id string optional id of the customer
Example: architecto
payment_status string optional Comma separated values of payment statuses. Available values due, partial, paid, overdue
Example: due,partial
start_date string optional format:Y-m-d
Example: 2018-06-25
end_date string optional format:Y-m-d
Example: 2018-06-25
user_id string optional id of the user who created the sale
Example: architecto
service_staff_id string optional id of the service staff assigned with the sale
Example: architecto
shipping_status string optional Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')
Example: ordered
source string optional Source of the sale
Example: architecto
customer_group_id string optional id of the customer group
Example: architecto
product_name string optional name of the product
Example: architecto
product_sku string optional sku of the product or variation
Example: architecto
product_custom_field_1 string optional custome field 1 of the product
Example: architecto
location_custom_field_1 string optional custome field 1 of the location
Example: architecto
location_invoice_scheme_prefix string optional Invoice scheme prefix of the location
Example: architecto
product_category_id string optional category id of the product
Example: architecto
product_sub_category_id string optional Sub category id of the product
Example: architecto
sell_ids string optional comma separated ids of the sells
Example: 55,64
only_subscriptions string optional Filter only subcription invoices (1, 0)
Example: architecto
send_purchase_details string optional Get purchase details of each sell line (1, 0)
Example: architecto
order_by_date string optional Sort sell list by date ('asc', 'desc')
Example: desc
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

Response 200

{
    "data": [
        {
            "id": 6,
            "business_id": 1,
            "location_id": 1,
            "res_table_id": null,
            "type": "sell",
            "status": "final",
            "is_quotation": 0,
            "payment_status": "paid",
            "contact_id": 4,
            "customer_group_id": null,
            "invoice_no": "AS0001",
            "ref_no": "",
            "source": null,
            "unique_hash": null,
            "hash_control": 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,
            "additional_notes": null,
            "staff_note": null,
            "round_off_amount": "0.0000",
            "final_total": "770.0000",
            "expense_sub_category_id": null,
            "is_direct_sale": 0,
            "is_suspend": 0,
            "total_amount_recovered": null,
            "crm_is_order_request": 0,
            "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,
            "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,
            "invoice_token": "00f79f7fd292225e8c303a6bf8626d06",
            "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": "2021-10-23 11:42:13",
            "location_name": "Location 1",
            "location_custom_field1": "gdgdgd88",
            "location_invoice_scheme_prefix": "AS",
            "table_name": null,
            "table_description": null,
            "contact": "Harry",
            "customer_group_name": "grp 2",
            "sell_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "product_id": 2,
                    "quantity": 10,
                    "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,
                    "woocommerce_line_items_id": null,
                    "children_type": "",
                    "created_at": "2018-01-06 07:06:11",
                    "updated_at": "2018-01-06 07:06:11",
                    "product_name": "Levis Men's Slimmy Fit Jeans",
                    "product_custom_field_1": null,
                    "product_type": "variable",
                    "product_sku": "AS0002",
                    "category": {
                        "id": 1,
                        "name": "Men's",
                        "business_id": 1,
                        "short_code": "sfefef",
                        "parent_id": 0,
                        "created_by": 1,
                        "category_type": "product",
                        "description": null,
                        "slug": null,
                        "woocommerce_cat_id": null
                    },
                    "sub_category": {
                        "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
                    },
                    "product_variations": {
                        "id": 3,
                        "name": "30",
                        "product_id": 2,
                        "sub_sku": "AS0002-2",
                        "product_variation_id": 2,
                        "default_purchase_price": "70.0000",
                        "dpp_inc_tax": "77.0000",
                        "default_sell_price": "70.0000",
                        "sell_price_inc_tax": "77.0000"
                    }
                }
            ],
            "payment_lines": [
                {
                    "id": 1,
                    "transaction_id": 6,
                    "business_id": null,
                    "is_return": 0,
                    "amount": "770.0000",
                    "method": "cash",
                    "card_type": "visa",
                    "paid_on": "2018-01-09 17:30:35",
                    "payment_ref_no": null
                }
            ],
            "invoice_url": "http://local.pos.com/invoice/00f79f7fd292225e8c303a6bf8626d06",
            "payment_link": ""
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/new_sell?per_page=1&page=1",
        "last": "http://local.pos.com/connector/api/new_sell?per_page=1&page=213",
        "prev": null,
        "next": "http://local.pos.com/connector/api/new_sell?per_page=1&page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 213,
        "path": "http://local.pos.com/connector/api/new_sell",
        "per_page": "1",
        "to": 1,
        "total": 213
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/new_contactapi

New List contact

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
type string required Type of contact (supplier, customer)
Example: architecto
customer_group_id string optional id of the customer group
Example: architecto
custom_field_1 string optional Custom field 1 of the contact
Example: architecto
contact_ids string optional comma separated ids of contacts
Example: 2,3
name string optional Search term for contact name
Example: architecto
biz_name string optional Search term for contact's business name
Example: architecto
mobile_num integer optional Search term for contact's mobile number
Example: 16
contact_id string optional Search term for contact's contact_id. Ex(CO0005)
Example: architecto
order_by string optional Column name to sort the result, Column: name, supplier_business_name
Example: architecto
direction string optional Direction to sort the result, Direction: desc, asc
Example: architecto
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

Response 200

{
    "data": [
        {
            "id": 18,
            "business_id": 1,
            "type": "customer",
            "name": "Mr. Rohit Kumar Agrawalla",
            "prefix": "Mr.",
            "first_name": "Rohit",
            "middle_name": "Kumar",
            "last_name": "Agrawalla",
            "email": null,
            "contact_status": "active",
            "mobile": "8596859647",
            "credit_limit": null,
            "converted_by": null,
            "converted_on": null,
            "balance": "40.0000",
            "total_rp": 0,
            "total_rp_used": 0,
            "total_rp_expired": 0,
            "customer_group_id": 1,
            "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,
            "remember_token": null,
            "password": null
        }
    ],
    "links": {
        "first": "http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1",
        "last": "http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://local.pos.com/connector/api/new_contactapi",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Product management

GET connector/api/product

List products

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
order_by string optional Values: product_name or newest
Example: architecto
order_direction string optional Values: asc or desc
Example: architecto
brand_id string optional comma separated ids of one or multiple brands
Example: architecto
category_id string optional comma separated ids of one or multiple category
Example: architecto
sub_category_id string optional comma separated ids of one or multiple sub-category
Example: architecto
location_id string optional
Example: 1
selling_price_group string optional (1, 0)
Example: architecto
send_lot_detail string optional Send lot details in each variation location details(1, 0)
Example: architecto
name string optional Search term for product name
Example: architecto
sku string optional Search term for product sku
Example: architecto
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/product/{id}

Get the specified product

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the product.
Example: architecto
product string required comma separated ids of products
Example: 1

Query Parameters

Name Type Status Description
selling_price_group string optional (1, 0)
Example: architecto
send_lot_detail string optional Send lot details in each variation location details(1, 0)
Example: architecto

Example request

Example response

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
                    }
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/selling-price-group

List Selling Price Group

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/variation/{id?}

List Variations

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string optional comma separated ids of variations
Example: 2

Query Parameters

Name Type Status Description
product_id string optional Filter by comma separated products ids
Example: architecto
location_id string optional
Example: 1
brand_id string optional
Example: architecto
category_id string optional
Example: architecto
sub_category_id string optional
Example: architecto
not_for_selling string optional Values: 0 or 1
Example: architecto
name string optional Search term for product name
Example: architecto
sku string optional Search term for product sku
Example: architecto
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

Sales management

GET connector/api/sell

List sells

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
location_id string optional id of the location
Example: 1
contact_id string optional id of the customer
Example: architecto
status string optional Sell status. Available values final, draft, quotation, proforma
Example: final
payment_status string optional Comma separated values of payment statuses. Available values due, partial, paid, overdue
Example: due,partial
start_date string optional format:Y-m-d
Example: 2018-06-25
end_date string optional format:Y-m-d
Example: 2018-06-25
user_id string optional id of the user who created the sale
Example: architecto
service_staff_id string optional id of the service staff assigned with the sale
Example: architecto
shipping_status string optional Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')
Example: ordered
source string optional Source of the sale
Example: architecto
only_subscriptions string optional Filter only subcription invoices (1, 0)
Example: architecto
send_purchase_details string optional Get purchase details of each sell line (1, 0)
Example: architecto
order_by_date string optional Sort sell list by date ('asc', 'desc')
Example: desc
per_page integer optional Total records per page. default: 10, Set -1 for no pagination
Example: 10

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/sell

Create sell

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

sells   object     
*   object     
location_id   integer     

id of the business location Example: 1

contact_id   integer     

id of the customer Example: 16

transaction_date   string     

transaction date format:Y-m-d H:i:s, Example: 2020-07-22 15:48:29

invoice_no   string     

Invoice number Example: architecto

source   string     

Source of the invoice Example: api, phone, woocommerce

status   string     

sale status (final, draft) Example: final

sub_status   string     

sale sub status ("quotation" for quotation and "proforma" for proforma invoice)

is_quotation   boolean     

Is sell quotation (0, 1), If 1 status should be draft Example: true

tax_rate_id   integer     

id of the tax rate applicable to the sale Example: 16

discount_amount   number     

discount amount applicable to the sale Example: 10

discount_type   string     

type of the discount amount (fixed, percentage) Example: fixed

sale_note   string     

Example: architecto

staff_note   string     

Example: architecto

commission_agent   integer     

commission agent id Example: 16

shipping_details   string     

shipping details Example: Express Delivery

shipping_address   string     

shipping address Example: architecto

shipping_status   string     

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to   string     

Name of the person recieved the consignment Example: 'Mr robin'

shipping_charges   number     

shipping amount Example: 10

packing_charge   number     

packing charge Example: 10

exchange_rate   number     

exchange rate for the currency used Example: 1

selling_price_group_id   integer     

id of the selling price group Example: 16

pay_term_number   integer     

pay term value Example: 3

pay_term_type   string     

type of the pay term value ('days', 'months') Example: months

is_suspend   boolean     

Is suspended sale (0, 1) Example: false

is_recurring   integer     

whether the invoice is recurring (0, 1) Example: 0

recur_interval   integer     

value of the interval invoice will be regenerated Example: 16

recur_interval_type   string     

type of the recur interval ('days', 'months', 'years') Example: months

subscription_repeat_on   integer     

day of the month on which invoice will be generated if recur interval type is months (1-30) Example: 15

subscription_no   string     

subscription number Example: architecto

recur_repetitions   integer     

total number of invoices to be generated Example: 16

rp_redeemed   integer     

reward points redeemed Example: 16

rp_redeemed_amount   number     

reward point redeemed amount after conversion Example: 13.5

types_of_service_id   integer     

types of service id Example: 16

service_custom_field_1   string     

types of service custom field 1 Example: architecto

service_custom_field_2   string     

types of service custom field 2 Example: architecto

service_custom_field_3   string     

types of service custom field 3 Example: architecto

service_custom_field_4   string     

types of service custom field 4 Example: architecto

service_custom_field_5   string     

types of service custom field 5 Example: architecto

service_custom_field_6   string     

types of service custom field 6 Example: architecto

round_off_amount   number     

round off amount on total payable Example: 4326.41688

table_id   integer     

id of the table Example: 16

service_staff_id   integer     

id of the service staff assigned to the sale Example: 16

change_return   number     

Excess paid amount Example: 0

products   string[]     

array of the products for the sale

*   object     
product_id   integer     

product id Example: 17

variation_id   integer     

variation id Example: 58

quantity   number     

quantity Example: 1

unit_price   number     

unit selling price Example: 437.5

tax_rate_id   integer     

tax rate id applicable on the product

discount_amount   number     

discount amount applicable on the product Example: 0

discount_type   string     

type of discount amount ('fixed', 'percentage') Example: percentage

sub_unit_id   integer     

sub unit id Example: 16

note   string     

note for the product Example: architecto

payments   string[]     

payment lines for the sale

*   object     
amount   number     

amount of the payment Example: 453.13

method   string     

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id   integer     

account id Example: 16

card_number   string     

Example: architecto

card_holder_name   string     

Example: architecto

card_transaction_number   string     

Example: architecto

card_type   string     

Example: architecto

card_month   string     

Example: architecto

card_year   string     

Example: architecto

card_security   string     

Example: architecto

transaction_no_1   string     

Example: architecto

transaction_no_2   string     

Example: architecto

transaction_no_3   string     

Example: architecto

bank_account_number   string     

Example: architecto

note   string     

payment note Example: architecto

cheque_number   string     

Example: architecto

Example request

Example response

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"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/sell/{id}

Get the specified sell

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the sell.
Example: architecto
sell string required comma separated ids of the sells
Example: 55

Query Parameters

Name Type Status Description
send_purchase_details string optional Get purchase details of each sell line (1, 0)
Example: architecto

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

PUT PATCH connector/api/sell/{id}

Update sell

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the sell.
Example: architecto
sell string required id of sell to update
Example: 6

Body Parameters

contact_id   integer     

id of the customer Example: 16

transaction_date   string     

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

status   string     

sale status (final, draft) Example: final

sub_status   string     

sale sub status ("quotation" for quotation and "proforma" for proforma invoice)

is_quotation   boolean     

Is sell quotation (0, 1), If 1 status should be draft Example: true

tax_rate_id   integer     

id of the tax rate applicable to the sale Example: 16

discount_amount   number     

discount amount applicable to the sale Example: 10

discount_type   string     

type of the discount amount (fixed, percentage) Example: fixed

sale_note   string     

Example: architecto

source   string     

Source of the invoice Example: architecto

staff_note   string     

Example: architecto

is_suspend   boolean     

Is suspended sale (0, 1) Example: false

commission_agent   integer     

commission agent id Example: 16

shipping_details   string     

shipping details Example: Express Delivery

shipping_address   string     

shipping address Example: architecto

shipping_status   string     

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to   string     

Name of the person recieved the consignment Example: Mr Robin

shipping_charges   number     

shipping amount Example: 10

packing_charge   number     

packing charge Example: 10

exchange_rate   number     

exchange rate for the currency used Example: 1

selling_price_group_id   integer     

id of the selling price group Example: 16

pay_term_number   integer     

pay term value Example: 16

pay_term_type   string     

type of the pay term value ('days', 'months') Example: months

is_recurring   integer     

whether the invoice is recurring (0, 1) Example: 0

recur_interval   integer     

value of the interval invoice will be regenerated Example: 16

recur_interval_type   string     

type of the recur interval ('days', 'months', 'years') Example: days

subscription_repeat_on   integer     

day of the month on which invoice will be generated if recur interval type is months (1-30) Example: 7

subscription_no   string     

subscription number Example: architecto

recur_repetitions   integer     

total number of invoices to be generated Example: 16

rp_redeemed   integer     

reward points redeemed Example: 16

rp_redeemed_amount   number     

reward point redeemed amount after conversion Example: 13.5

types_of_service_id   integer     

types of service id Example: 16

service_custom_field_1   string     

types of service custom field 1 Example: architecto

service_custom_field_2   string     

types of service custom field 2 Example: architecto

service_custom_field_3   string     

types of service custom field 3 Example: architecto

service_custom_field_4   string     

types of service custom field 4 Example: architecto

service_custom_field_5   string     

types of service custom field 5 Example: architecto

service_custom_field_6   string     

types of service custom field 6 Example: architecto

round_off_amount   number     

round off amount on total payable Example: 4326.41688

table_id   integer     

id of the table Example: 16

service_staff_id   integer     

id of the service staff assigned to the sale Example: 16

change_return   number     

Excess paid amount Example: 0

change_return_id   integer     

id of the change return payment if exists Example: 16

products   string[]     

array of the products for the sale

*   object     
sell_line_id   integer     

sell line id for existing item only Example: 16

product_id   integer     

product id Example: 17

variation_id   integer     

variation id Example: 58

quantity   number     

quantity Example: 1

unit_price   number     

unit selling price Example: 437.5

tax_rate_id   integer     

tax rate id applicable on the product Example: 16

discount_amount   number     

discount amount applicable on the product Example: 0

discount_type   string     

type of discount amount ('fixed', 'percentage') Example: percentage

sub_unit_id   integer     

sub unit id Example: 16

note   string     

note for the product Example: architecto

payments   string[]     

payment lines for the sale

*   object     
payment_id   integer     

payment id for existing payment line Example: 16

amount   number     

amount of the payment Example: 453.13

method   string     

payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3') Example: cash

account_id   integer     

account id Example: 16

card_number   string     

Example: architecto

card_holder_name   string     

Example: architecto

card_transaction_number   string     

Example: architecto

card_type   string     

Example: architecto

card_month   string     

Example: architecto

card_year   string     

Example: architecto

card_security   string     

Example: architecto

transaction_no_1   string     

Example: architecto

transaction_no_2   string     

Example: architecto

transaction_no_3   string     

Example: architecto

note   string     

payment note Example: architecto

cheque_number   string     

Example: architecto

bank_account_number   string     

Example: architecto

Example request

Example response

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"
}

Interactive API Testing

Test this endpoint directly from your browser

DELETE connector/api/sell/{id}

Delete Sell

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the sell.
Example: architecto
sell string required id of the sell to be deleted
Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/sell-return

Add Sell Return

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

transaction_id   integer     

Id of the sell Example: 16

transaction_date   string     

transaction date format:Y-m-d H:i:s, Example: 2020-5-7 15:20:22

invoice_no   string     

Invoice number of the return Example: architecto

discount_amount   number     

discount amount applicable to the sale Example: 10

discount_type   string     

type of the discount amount (fixed, percentage) Example: fixed

products   string[]     

array of the products for the sale

*   object     
sell_line_id   integer     

sell line id Example: 16

quantity   number     

quantity to be returned from the sell line Example: 1

unit_price_inc_tax   number     

unit selling price of the returning item Example: 437.5

Example request

Example response

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.64,
    "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"
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/list-sell-return

List Sell Return

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
sell_id string optional Id of the sell for which return is added
Example: architecto

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/update-shipping-status

Update shipping status

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

id   integer     

id of the sale Example: 16

shipping_status   string     

('ordered', 'packed', 'shipped', 'delivered', 'cancelled') Example: ordered

delivered_to   string     

Name of the consignee Example: architecto

Example request

Interactive API Testing

Test this endpoint directly from your browser

Superadmin

GET connector/api/active-subscription

If SaaS installed get active subscription details, else return the enabled modules details in package_details

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/packages

Get Superadmin Package List

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Table management

GET connector/api/table

List tables

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
location_id integer optional id of the location
Example: 1

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/table/{id}

Show the specified table

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the table.
Example: architecto
table string required comma separated ids of required tables
Example: 5

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Tax management

GET connector/api/tax

List taxes

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/tax/{id}

Get the specified tax

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the tax.
Example: architecto
tax string required comma separated ids of required taxes
Example: 1

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Taxonomy management

GET connector/api/taxonomy

List taxonomy

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
type string optional Type of taxonomy (product, device, hrm_department)
Example: architecto

Example request

Example response

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": []
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/taxonomy/{id}

Get the specified taxonomy

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the taxonomy.
Example: architecto
taxonomy string required comma separated ids of product categories
Example: 1

Example request

Example response

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"
                }
            ]
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Types of service management

GET connector/api/types-of-service

List types of service

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/types-of-service/{id}

Get the specified types of service

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the types of service.
Example: architecto
types_of_service string required comma separated ids of required types of services
Example: 1

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

Unit management

GET connector/api/unit

List units

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
            }
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/unit/{id}

Get the specified unit

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the unit.
Example: architecto
unit string required comma separated ids of the units
Example: 1

Example request

Example response

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
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

User management

GET connector/api/user/loggedin

Get the loggedin user details.

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Example request

Example response

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"
    }
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/user-registration

Register User

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

username   string     

minimum 5 characters Example: architecto

email   string     

Example: gbailey@example.net

user_type   string     

'user_customer' for contact/customer login & 'user' for general user Example: architecto

surname   string     

prefix like Mr, Mrs,Dr Example: architecto

first_name   string     

Example: architecto

last_name   string     

Example: architecto

is_active   string     

'active', 'inactive', 'terminated' Example: architecto

crm_contact_id   integer     

if user_type is 'user_customer' then required Example: 16

allow_login   boolean     

1 to allow login & 0 to disable login Example: false

password   string     

minimum 6 characters & required if 'allow_login' is 1 Example: |]|{+-

role   integer     

id of role to be assigned to user & required if user_type is 'user' Example: 16

access_all_locations   boolean     

1 if user has access all location else 0 & required if user_type is 'user' Example: false

location_permissions   string[]     

array of location ids to be assigned to user & required if user_type is 'user' and 'access_all_locations' is 0

cmmsn_percent   decimal     

Example: architecto

max_sales_discount_percent   decimal     

Example: architecto

selected_contacts   boolean     

1 or 0 Example: false

selected_contact_ids   string[]     

array of contact ids & required if 'selected_contacts' is 1

dob   date     

dob of user in "Y-m-d" format Ex: 1997-10-29 Example: architecto

gender   string     

if user is 'male', 'female', 'others' Example: architecto

marital_status   string     

if user is 'married', 'unmarried', 'divorced' Example: architecto

blood_group   string     

Example: architecto

contact_number   string     

Example: architecto

alt_number   string     

Example: architecto

family_number   string     

Example: architecto

fb_link   string     

Example: architecto

twitter_link   string     

Example: architecto

social_media_1   string     

Example: architecto

social_media_2   string     

Example: architecto

custom_field_1   string     

Example: architecto

custom_field_2   string     

Example: architecto

custom_field_3   string     

Example: architecto

custom_field_4   string     

Example: architecto

guardian_name   string     

Example: architecto

id_proof_name   string     

ID proof of user like Adhar No. Example: architecto

id_proof_number   string     

Id Number like adhar number Example: architecto

permanent_address   string     

Example: architecto

current_address   string     

Example: architecto

bank_details   object     
*   object     
account_holder_name   string     

Example: architecto

account_number   string     

Example: architecto

bank_name   string     

Example: architecto

bank_code   string     

Example: architecto

branch   string     

Example: architecto

tax_payer_id   string     

Example: architecto

Example request

Example response

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
    }
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/user

List users

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Query Parameters

Name Type Status Description
service_staff boolean optional Filter service staffs from users list (0, 1)

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

GET connector/api/user/{id}

Get the specified user

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

URL Parameters

Name Type Status Description
id string required The ID of the user.
Example: architecto
user string required comma separated ids of the required users
Example: 1

Example request

Example response

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"
        }
    ]
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/update-password

Update user password.

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

current_password   string     

Current password of the user Example: architecto

new_password   string     

New password of the user Example: architecto

Example request

Example response

Response 200

{
    "success": 1,
    "msg": "Password updated successfully"
}

Interactive API Testing

Test this endpoint directly from your browser

POST connector/api/forget-password

Recover forgotten password.

REQUIRES AUTHENTICATION

Headers

Name Value
Authorization Bearer {access_token}
Content-Type application/json
Accept application/json

Body Parameters

email   string     

Users email id Example: gbailey@example.net

Example request

Example response

Response 200

{
    "success": 1,
    "msg": "New password sent to user@example.com successfully"
}

Interactive API Testing

Test this endpoint directly from your browser