openapi: 3.0.3 info: title: 'AC POS API' description: 'AC POS Connector API' version: 1.0.0 servers: - url: 'https://bqf.ai' paths: '/connector/api/get-attendance/{user_id}': get: summary: 'Latest attendance record' operationId: latestAttendanceRecord description: "The employee's most recent day record and whether they are clocked in now (kept for\napps that used the older Essentials-shaped endpoint)." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: user_id: 12 business_id: 1 attendance_date: '2026-09-24' clock_in_time: '2026-09-24 09:02:11' clock_out_time: null status: present late_minutes: 0 worked_minutes: 0 overtime_minutes: 0 state: in: true since: '2026-09-24 09:02:11' properties: data: type: object properties: user_id: type: integer example: 12 business_id: type: integer example: 1 attendance_date: type: string example: '2026-09-24' clock_in_time: type: string example: '2026-09-24 09:02:11' clock_out_time: type: string example: null status: type: string example: present late_minutes: type: integer example: 0 worked_minutes: type: integer example: 0 overtime_minutes: type: integer example: 0 state: type: object properties: in: type: boolean example: true since: type: string example: '2026-09-24 09:02:11' tags: - 'Attendance (HRM)' parameters: - in: path name: user_id description: "The employee's user id (yourself, or another employee for attendance managers)." example: '12' required: true schema: type: string /connector/api/clock-in: post: summary: 'Clock in' operationId: clockIn description: "Records the clock-in at the server's time. With the phone's position the branch geofence\nis applied: in `warn` mode an outside punch is recorded and flagged, in `block` mode it is\nrefused (422 `outside_geofence`), and a punch with no position is refused (422\n`location_required`) unless the phone is on the branch's own network." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true msg: 'Clocked in at 09:02' type: clock_in punch: id: 5 type: in at: '2026-09-24 09:02:11' source: mobile within_geofence: true distance_m: 34 state: in: true since: '2026-09-24 09:02:11' properties: success: type: boolean example: true msg: type: string example: 'Clocked in at 09:02' type: type: string example: clock_in punch: type: object properties: id: type: integer example: 5 type: type: string example: in at: type: string example: '2026-09-24 09:02:11' source: type: string example: mobile within_geofence: type: boolean example: true distance_m: type: integer example: 34 state: type: object properties: in: type: boolean example: true since: type: string example: '2026-09-24 09:02:11' tags: - 'Attendance (HRM)' requestBody: required: false content: application/json: schema: type: object properties: latitude: type: number description: 'Phone latitude.' example: 24.7136 longitude: type: number description: 'Phone longitude.' example: 46.6753 accuracy_m: type: integer description: 'GPS accuracy in metres.' example: 12 clock_in_note: type: string description: 'A note (max 255).' example: 'from the app' user_id: type: integer description: 'Another employee (attendance managers only).' example: 12 /connector/api/clock-out: post: summary: 'Clock out' operationId: clockOut description: "Same rules as clock in. The day record (late, early leave, worked and overtime minutes)\nis recomputed from the day's punches and the shift." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true msg: 'Clocked out at 17:31' type: clock_out punch: id: 6 type: out at: '2026-09-24 17:31:40' source: mobile within_geofence: true distance_m: 20 state: in: false since: '2026-09-24 17:31:40' log: status: present clock_in: '09:02:11' clock_out: '17:31:40' late_minutes: 0 early_leave_minutes: 0 worked_minutes: 449 overtime_minutes: 31 properties: success: type: boolean example: true msg: type: string example: 'Clocked out at 17:31' type: type: string example: clock_out punch: type: object properties: id: type: integer example: 6 type: type: string example: out at: type: string example: '2026-09-24 17:31:40' source: type: string example: mobile within_geofence: type: boolean example: true distance_m: type: integer example: 20 state: type: object properties: in: type: boolean example: false since: type: string example: '2026-09-24 17:31:40' log: type: object properties: status: type: string example: present clock_in: type: string example: '09:02:11' clock_out: type: string example: '17:31:40' late_minutes: type: integer example: 0 early_leave_minutes: type: integer example: 0 worked_minutes: type: integer example: 449 overtime_minutes: type: integer example: 31 tags: - 'Attendance (HRM)' requestBody: required: false content: application/json: schema: type: object properties: latitude: type: number description: 'Phone latitude.' example: 24.7136 longitude: type: number description: 'Phone longitude.' example: 46.6753 accuracy_m: type: integer description: 'GPS accuracy in metres.' example: 12 clock_out_note: type: string description: 'A note (max 255).' example: done user_id: type: integer description: 'Another employee (attendance managers only).' example: 12 /connector/api/attendance/me: get: summary: 'My attendance today' operationId: myAttendanceToday description: "The employee, their shift for today, whether they are clocked in, today's punches and\nday record, the month so far, and the branch geofence the app should show (mode `off`,\n`warn` or `block`; `lat`/`lng`/`radius_m` when the branch has one)." parameters: - in: query name: user_id description: 'Another employee (attendance managers only).' example: 12 required: false schema: type: integer description: 'Another employee (attendance managers only).' example: 12 - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: employee: user_id: 12 name: Sami employee_code: E-7 location: id: 1 name: Main state: in: true since: '2026-09-24 09:02:11' shift: name: Morning start: '09:00' end: '17:00' is_rest_day: false is_holiday: false today: punches: - id: 5 type: in at: '2026-09-24 09:02:11' source: mobile within_geofence: true distance_m: 34 log: status: present clock_in: '09:02:11' clock_out: null late_minutes: 0 early_leave_minutes: 0 worked_minutes: 0 overtime_minutes: 0 month: present: 17 late: 2 absent: 0 worked_hours: 136.5 overtime_hours: 3.5 geofence: mode: warn has_fence: true lat: 24.7136 lng: 46.6753 radius_m: 150 properties: data: type: object properties: employee: type: object properties: user_id: type: integer example: 12 name: type: string example: Sami employee_code: type: string example: E-7 location: type: object properties: id: type: integer example: 1 name: type: string example: Main state: type: object properties: in: type: boolean example: true since: type: string example: '2026-09-24 09:02:11' shift: type: object properties: name: type: string example: Morning start: type: string example: '09:00' end: type: string example: '17:00' is_rest_day: type: boolean example: false is_holiday: type: boolean example: false today: type: object properties: punches: type: array example: - id: 5 type: in at: '2026-09-24 09:02:11' source: mobile within_geofence: true distance_m: 34 items: type: object properties: id: type: integer example: 5 type: type: string example: in at: type: string example: '2026-09-24 09:02:11' source: type: string example: mobile within_geofence: type: boolean example: true distance_m: type: integer example: 34 log: type: object properties: status: type: string example: present clock_in: type: string example: '09:02:11' clock_out: type: string example: null late_minutes: type: integer example: 0 early_leave_minutes: type: integer example: 0 worked_minutes: type: integer example: 0 overtime_minutes: type: integer example: 0 month: type: object properties: present: type: integer example: 17 late: type: integer example: 2 absent: type: integer example: 0 worked_hours: type: number example: 136.5 overtime_hours: type: number example: 3.5 geofence: type: object properties: mode: type: string example: warn has_fence: type: boolean example: true lat: type: number example: 24.7136 lng: type: number example: 46.6753 radius_m: type: integer example: 150 tags: - 'Attendance (HRM)' /connector/api/attendance/history: get: summary: 'Attendance history' operationId: attendanceHistory description: 'Day records between two dates (at most 92 days), newest first.' parameters: - in: query name: from description: 'date Start date.' example: '2026-09-01' required: false schema: type: string description: 'date Start date.' example: '2026-09-01' - in: query name: to description: 'date End date.' example: '2026-09-30' required: false schema: type: string description: 'date End date.' example: '2026-09-30' - in: query name: user_id description: 'Another employee (attendance managers only).' example: 12 required: false schema: type: integer description: 'Another employee (attendance managers only).' example: 12 - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - date: '2026-09-24' status: late clock_in: '09:25:00' clock_out: '18:15:00' late_minutes: 15 early_leave_minutes: 0 worked_minutes: 470 overtime_minutes: 75 source: mobile properties: data: type: array example: - date: '2026-09-24' status: late clock_in: '09:25:00' clock_out: '18:15:00' late_minutes: 15 early_leave_minutes: 0 worked_minutes: 470 overtime_minutes: 75 source: mobile items: type: object properties: date: type: string example: '2026-09-24' status: type: string example: late clock_in: type: string example: '09:25:00' clock_out: type: string example: '18:15:00' late_minutes: type: integer example: 15 early_leave_minutes: type: integer example: 0 worked_minutes: type: integer example: 470 overtime_minutes: type: integer example: 75 source: type: string example: mobile tags: - 'Attendance (HRM)' requestBody: required: false content: application/json: schema: type: object properties: from: type: string description: 'الحقل value ليس تاريخًا صالحًا.' example: '2026-09-24T21:24:58' to: type: string description: 'الحقل value ليس تاريخًا صالحًا.' example: '2026-09-24T21:24:58' user_id: type: integer description: '' example: 3 /connector/api/attendance/violations: get: summary: 'My attendance violations' operationId: myAttendanceViolations description: "Open and recently decided violations (lateness, early leave, absence) with their status,\nso the employee can explain from the app." parameters: - in: query name: user_id description: 'Another employee (attendance managers only).' example: 12 required: false schema: type: integer description: 'Another employee (attendance managers only).' example: 12 - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 3 date: '2026-09-22' type: late minutes: 20 occurrence: 2 penalty_fraction: 0.15 status: justification_requested justification: null properties: data: type: array example: - id: 3 date: '2026-09-22' type: late minutes: 20 occurrence: 2 penalty_fraction: 0.15 status: justification_requested justification: null items: type: object properties: id: type: integer example: 3 date: type: string example: '2026-09-22' type: type: string example: late minutes: type: integer example: 20 occurrence: type: integer example: 2 penalty_fraction: type: number example: 0.15 status: type: string example: justification_requested justification: type: string example: null tags: - 'Attendance (HRM)' '/connector/api/attendance/violations/{id}/justify': post: summary: 'Explain a violation' operationId: explainAViolation description: "The employee's own explanation for one of their violations that is still open." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true msg: 'Your explanation was sent.' status: justified properties: success: type: boolean example: true msg: type: string example: 'Your explanation was sent.' status: type: string example: justified tags: - 'Attendance (HRM)' requestBody: required: true content: application/json: schema: type: object properties: justification: type: string description: 'The explanation (max 2000).' example: 'traffic accident on the ring road' required: - justification parameters: - in: path name: id description: 'The violation id.' example: '3' required: true schema: type: string /connector/api/holidays: get: summary: 'Public holidays' operationId: publicHolidays description: "The business's public holidays as HRM has them (no lateness or absence on those days;\nwork on them is overtime), for the app's calendar." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: data: - date: '2026-03-20' - date: '2026-03-21' - date: '2026-09-23' properties: data: type: array example: - date: '2026-03-20' - date: '2026-03-21' - date: '2026-09-23' items: type: object properties: date: type: string example: '2026-03-20' tags: - 'Attendance (HRM)' /connector/api/logout: post: summary: 'Log out' operationId: logOut description: "Revokes the access token used for this request and its refresh token.\nOther devices of the same user stay logged in." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: success: true properties: success: type: boolean example: true tags: - Authentication /connector/api/brand: get: summary: 'List brands' operationId: listBrands description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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' properties: data: type: array example: - 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' items: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 name: type: string example: Levis description: type: string example: null created_by: type: integer example: 1 deleted_at: type: string example: null created_at: type: string example: '2018-01-03 21:19:47' updated_at: type: string example: '2018-01-03 21:19:47' tags: - 'Brand management' '/connector/api/brand/{id}': get: summary: 'Get the specified brand' operationId: getTheSpecifiedBrand description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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' properties: data: type: array example: - 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' items: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 name: type: string example: Levis description: type: string example: null created_by: type: integer example: 1 deleted_at: type: string example: null created_at: type: string example: '2018-01-03 21:19:47' updated_at: type: string example: '2018-01-03 21:19:47' tags: - 'Brand management' parameters: - in: path name: id description: 'The ID of the brand.' example: eius required: true schema: type: string - in: path name: brand description: 'comma separated ids of the brands' example: '1' required: true schema: type: string /connector/api/business-location: get: summary: 'List business locations' operationId: listBusinessLocations description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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' properties: data: type: array example: - 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' items: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 location_id: type: string example: null name: type: string example: 'Awesome Shop' landmark: type: string example: 'Linking Street' country: type: string example: USA state: type: string example: Arizona city: type: string example: Phoenix zip_code: type: string example: '85001' invoice_scheme_id: type: integer example: 1 invoice_layout_id: type: integer example: 1 selling_price_group_id: type: string example: null print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null mobile: type: string example: null alternate_number: type: string example: null email: type: string example: null website: type: string example: null featured_products: type: array example: - '5' - '71' items: type: string is_active: type: integer example: 1 payment_methods: type: array example: - 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 items: type: object properties: name: type: string example: cash label: type: string example: Cash account_id: type: string example: '1' custom_field1: type: string example: null custom_field2: type: string example: null custom_field3: type: string example: null custom_field4: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2018-01-04 02:15:20' updated_at: type: string example: '2020-06-05 00:56:54' tags: - 'Business Location management' '/connector/api/business-location/{id}': get: summary: 'Get the specified business location' operationId: getTheSpecifiedBusinessLocation description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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' properties: data: type: array example: - 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' items: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 location_id: type: string example: null name: type: string example: 'Awesome Shop' landmark: type: string example: 'Linking Street' country: type: string example: USA state: type: string example: Arizona city: type: string example: Phoenix zip_code: type: string example: '85001' invoice_scheme_id: type: integer example: 1 invoice_layout_id: type: integer example: 1 selling_price_group_id: type: string example: null print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null mobile: type: string example: null alternate_number: type: string example: null email: type: string example: null website: type: string example: null featured_products: type: array example: - '5' - '71' items: type: string is_active: type: integer example: 1 payment_methods: type: array example: - 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 items: type: object properties: name: type: string example: cash label: type: string example: Cash account_id: type: string example: '1' custom_field1: type: string example: null custom_field2: type: string example: null custom_field3: type: string example: null custom_field4: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2018-01-04 02:15:20' updated_at: type: string example: '2020-06-05 00:56:54' tags: - 'Business Location management' parameters: - in: path name: id description: 'The ID of the business location.' example: sed required: true schema: type: string - in: path name: location description: 'comma separated ids of the business location' example: '1' required: true schema: type: string /connector/api/crm/follow-ups: get: summary: 'List Follow ups' operationId: listFollowUps description: '' parameters: - in: query name: start_date description: 'format: Y-m-d (Ex: 2020-12-16)' example: '2020-12-16' required: false schema: type: string description: 'format: Y-m-d (Ex: 2020-12-16)' example: '2020-12-16' - in: query name: end_date description: 'format: Y-m-d (Ex: 2020-12-16)' example: '2020-12-16' required: false schema: type: string description: 'format: Y-m-d (Ex: 2020-12-16)' example: '2020-12-16' - in: query name: status description: 'filter the result through status, get status from getFollowUpResources->statuses' example: fuga required: false schema: type: string description: 'filter the result through status, get status from getFollowUpResources->statuses' example: fuga - in: query name: follow_up_type description: 'filter the result through follow_up_type, get follow_up_type from getFollowUpResources->follow_up_types' example: atque required: false schema: type: string description: 'filter the result through follow_up_type, get follow_up_type from getFollowUpResources->follow_up_types' example: atque - in: query name: followup_category_id description: 'filter the result through followup_category_id' example: doloremque required: false schema: type: string description: 'filter the result through followup_category_id' example: doloremque - in: query name: order_by description: 'Column name to sort the result, Column: start_datetime' example: start_datetime required: false schema: type: string description: 'Column name to sort the result, Column: start_datetime' example: start_datetime - in: query name: direction description: "Direction to sort the result, Required if using 'order_by', direction: desc, asc" example: desc required: false schema: type: string description: "Direction to sort the result, Required if using 'order_by', direction: desc, asc" example: desc - in: query name: per_page description: 'Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)' example: 15 required: false schema: type: integer description: 'Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)' example: 15 - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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: '
tst
' 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: 'Test Follow up
' 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: 'https://bqf.ai/connector/api/crm/follow-ups?page=1' last: 'https://bqf.ai/connector/api/crm/follow-ups?page=21' prev: null next: 'https://bqf.ai/connector/api/crm/follow-ups?page=2' meta: current_page: 1 from: 1 last_page: 21 path: 'https://bqf.ai/connector/api/crm/follow-ups' per_page: '2' to: 2 total: 42 properties: data: type: array example: - 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: 'tst
' 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: 'Test Follow up
' 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 items: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 contact_id: type: integer example: 50 title: type: string example: 'Test Follow up' status: type: string example: scheduled start_datetime: type: string example: '2020-12-16 15:15:00' end_datetime: type: string example: '2020-12-16 15:15:00' description: type: string example: 'tst
' schedule_type: type: string example: call allow_notification: type: integer example: 0 notify_via: type: object properties: sms: type: integer example: 0 mail: type: integer example: 1 notify_before: type: string example: null notify_type: type: string example: minute created_by: type: integer example: 1 followup_additional_info: type: string example: null created_at: type: string example: '2020-12-16 03:15:23' updated_at: type: string example: '2020-12-16 15:46:34' customer: type: object properties: id: type: integer example: 50 business_id: type: integer example: 1 type: type: string example: lead supplier_business_name: type: string example: null name: type: string example: ' Lead 4 ' prefix: type: string example: null first_name: type: string example: 'Lead 4' middle_name: type: string example: null last_name: type: string example: null email: type: string example: null contact_id: type: string example: CO0011 contact_status: type: string example: active tax_number: type: string example: null city: type: string example: null state: type: string example: null country: type: string example: null address_line_1: type: string example: null address_line_2: type: string example: null zip_code: type: string example: null dob: type: string example: null mobile: type: string example: '234567' landline: type: string example: null alternate_number: type: string example: null pay_term_number: type: string example: null pay_term_type: type: string example: null credit_limit: type: string example: null created_by: type: integer example: 1 balance: type: string example: '0.0000' total_rp: type: integer example: 0 total_rp_used: type: integer example: 0 total_rp_expired: type: integer example: 0 is_default: type: integer example: 0 shipping_address: type: string example: null position: type: string example: null customer_group_id: type: string example: null crm_source: type: string example: '55' crm_life_stage: type: string example: '62' custom_field1: type: string example: null custom_field2: type: string example: null custom_field3: type: string example: null custom_field4: type: string example: null custom_field5: type: string example: null custom_field6: type: string example: null custom_field7: type: string example: null custom_field8: type: string example: null custom_field9: type: string example: null custom_field10: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2020-12-15 23:14:48' updated_at: type: string example: '2021-01-07 15:32:52' remember_token: type: string example: null password: type: string example: null links: type: object properties: first: type: string example: 'https://bqf.ai/connector/api/crm/follow-ups?page=1' last: type: string example: 'https://bqf.ai/connector/api/crm/follow-ups?page=21' prev: type: string example: null next: type: string example: 'https://bqf.ai/connector/api/crm/follow-ups?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 21 path: type: string example: 'https://bqf.ai/connector/api/crm/follow-ups' per_page: type: string example: '2' to: type: integer example: 2 total: type: integer example: 42 tags: - CRM post: summary: 'Add follow up' operationId: addFollowUp description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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 properties: data: type: object properties: title: type: string example: test contact_id: type: string example: '1' description: type: string example: null schedule_type: type: string example: call followup_category_id: type: string example: '1' notify_before: type: string example: null status: type: string example: null start_datetime: type: string example: '2021-01-06 15:27:00' end_datetime: type: string example: '2021-01-06 15:27:00' allow_notification: type: integer example: 0 notify_via: type: object properties: sms: type: integer example: 1 mail: type: integer example: 1 notify_type: type: string example: hour business_id: type: integer example: 1 created_by: type: integer example: 1 updated_at: type: string example: '2021-01-06 17:04:54' created_at: type: string example: '2021-01-06 17:04:54' id: type: integer example: 20 tags: - CRM requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: 'Follow up title' example: 'Meeting with client' contact_id: type: integer description: 'Contact to be followed up' example: 2 description: type: text description: 'Follow up description' example: 'Non ullam excepturi repudiandae.' schedule_type: type: string description: 'Follow up type default get from getFollowUpResources->follow_up_types' example: quo user_id: type: array description: 'Integer ID; Follow up to be assigned Ex: [2,3,8]' example: - 2 - 3 - 5 items: type: string notify_before: type: integer description: 'Integer value will be used to send auto notification before follow up starts.' example: 5 notify_type: type: string description: "Notify type Ex: 'minute', 'hour', 'day'. default is hour" example: minute status: type: string description: 'Follow up status' example: open notify_via: type: array description: "Will be used to send notification Ex: ['sms' => 0 ,'mail' => 1]" example: - et items: type: string start_datetime: type: datetime description: '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: type: datetime description: '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: type: array description: "Follow up additional info Ex: ['call duration' => '1 hour']" example: - quaerat items: type: string allow_notification: type: boolean description: '0/1 : If notification will be send before follow up starts. default is 1(true)' example: true required: - title - contact_id - schedule_type - user_id - start_datetime - end_datetime '/connector/api/crm/follow-ups/{id}': get: summary: 'Get the specified followup' operationId: getTheSpecifiedFollowup description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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 properties: data: type: array example: - 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 items: type: object properties: id: type: integer example: 20 business_id: type: integer example: 1 contact_id: type: integer example: 1 title: type: string example: 'Meeting with client' status: type: string example: null start_datetime: type: string example: '2021-01-06 15:27:00' end_datetime: type: string example: '2021-01-06 15:27:00' description: type: string example: null schedule_type: type: string example: call allow_notification: type: integer example: 0 notify_via: type: object properties: sms: type: integer example: 1 mail: type: integer example: 1 notify_before: type: string example: null notify_type: type: string example: hour created_by: type: integer example: 1 created_at: type: string example: '2021-01-06 17:04:54' updated_at: type: string example: '2021-01-06 17:04:54' customer: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 type: type: string example: customer supplier_business_name: type: string example: null name: type: string example: 'Walk-In Customer' prefix: type: string example: null first_name: type: string example: 'Walk-In Customer' middle_name: type: string example: null last_name: type: string example: null email: type: string example: null contact_id: type: string example: CO0005 contact_status: type: string example: active tax_number: type: string example: null city: type: string example: Phoenix state: type: string example: Arizona country: type: string example: USA address_line_1: type: string example: 'Linking Street' address_line_2: type: string example: null zip_code: type: string example: null dob: type: string example: null mobile: type: string example: '(378) 400-1234' landline: type: string example: null alternate_number: type: string example: null pay_term_number: type: string example: null pay_term_type: type: string example: null credit_limit: type: string example: null created_by: type: integer example: 1 balance: type: string example: '0.0000' total_rp: type: integer example: 0 total_rp_used: type: integer example: 0 total_rp_expired: type: integer example: 0 is_default: type: integer example: 1 shipping_address: type: string example: null position: type: string example: null customer_group_id: type: string example: null crm_source: type: string example: null crm_life_stage: type: string example: null custom_field1: type: string example: null custom_field2: type: string example: null custom_field3: type: string example: null custom_field4: type: string example: null custom_field5: type: string example: null custom_field6: type: string example: null custom_field7: type: string example: null custom_field8: type: string example: null custom_field9: type: string example: null custom_field10: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2018-01-03 20:45:20' updated_at: type: string example: '2018-06-11 22:22:05' remember_token: type: string example: null password: type: string example: null users: type: array example: - 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 items: type: object properties: id: type: integer example: 2 user_type: type: string example: user surname: type: string example: Mr first_name: type: string example: Demo last_name: type: string example: Cashier username: type: string example: cashier email: type: string example: cashier@example.com language: type: string example: en contact_no: type: string example: null address: type: string example: null business_id: type: integer example: 1 max_sales_discount_percent: type: string example: null allow_login: type: integer example: 1 essentials_department_id: type: string example: null essentials_designation_id: type: string example: null status: type: string example: active crm_contact_id: type: string example: null is_cmmsn_agnt: type: integer example: 0 cmmsn_percent: type: string example: '0.00' selected_contacts: type: integer example: 0 dob: type: string example: null gender: type: string example: null marital_status: type: string example: null blood_group: type: string example: null contact_number: type: string example: null fb_link: type: string example: null twitter_link: type: string example: null social_media_1: type: string example: null social_media_2: type: string example: null permanent_address: type: string example: null current_address: type: string example: null guardian_name: type: string example: null custom_field_1: type: string example: null custom_field_2: type: string example: null custom_field_3: type: string example: null custom_field_4: type: string example: null bank_details: type: string example: null id_proof_name: type: string example: null id_proof_number: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2018-01-04 02:20:58' updated_at: type: string example: '2018-01-04 02:20:58' pivot: type: object properties: schedule_id: type: integer example: 20 user_id: type: integer example: 2 tags: - CRM put: summary: 'Update follow up' operationId: updateFollowUp description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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' properties: data: type: object properties: id: type: integer example: 20 business_id: type: integer example: 1 contact_id: type: string example: '1' title: type: string example: 'Meeting with client' status: type: string example: null start_datetime: type: string example: '2021-01-06 15:27:00' end_datetime: type: string example: '2021-01-06 15:27:00' description: type: string example: null schedule_type: type: string example: call allow_notification: type: integer example: 0 notify_via: type: object properties: sms: type: integer example: 1 mail: type: integer example: 0 notify_before: type: string example: null notify_type: type: string example: hour created_by: type: integer example: 1 created_at: type: string example: '2021-01-06 17:04:54' updated_at: type: string example: '2021-01-06 18:22:21' tags: - CRM requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: 'Follow up title' example: 'Meeting with client' contact_id: type: integer description: 'Contact to be followed up' example: 2 description: type: text description: 'Follow up description' example: 'Facere id esse est modi quis.' schedule_type: type: string description: 'Follow up type default get from getFollowUpResources->follow_up_types' example: aperiam user_id: type: array description: 'Integer ID; Follow up to be assigned Ex: [2,3,8]' example: - 2 - 3 - 5 items: type: string notify_before: type: integer description: 'Integer value will be used to send auto notification before follow up starts.' example: 5 notify_type: type: string description: "Notify type Ex: 'minute', 'hour', 'day'. default is hour" example: minute status: type: string description: 'Follow up status' example: open notify_via: type: array description: "Will be used to send notification Ex: ['sms' => 0 ,'mail' => 1]" example: - non items: type: string followup_additional_info: type: array description: "Follow up additional info Ex: ['call duration' => '1 hour']" example: - deleniti items: type: string start_datetime: type: datetime description: '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: type: datetime description: '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: type: boolean description: '0/1 : If notification will be send before follow up starts. default is 1(true)' example: true required: - title - contact_id - schedule_type - user_id - start_datetime - end_datetime parameters: - in: path name: id description: 'The ID of the follow up.' example: rerum required: true schema: type: string - in: path name: follow_up description: 'comma separated ids of the follow_ups' example: '1,2' required: true schema: type: string /connector/api/crm/follow-up-resources: get: summary: 'Get follow up resources' operationId: getFollowUpResources description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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 properties: data: type: object properties: statuses: type: object properties: scheduled: type: string example: Scheduled open: type: string example: Open canceled: type: string example: Cancelled completed: type: string example: Completed follow_up_types: type: object properties: call: type: string example: Call sms: type: string example: Sms meeting: type: string example: Meeting email: type: string example: Email notify_type: type: object properties: minute: type: string example: Minute hour: type: string example: Hour day: type: string example: Day notify_via: type: object properties: sms: type: string example: Sms mail: type: string example: Email tags: - CRM /connector/api/crm/leads: get: summary: 'List lead' operationId: listLead description: '' parameters: - in: query name: assigned_to description: 'comma separated ids of users to whom lead is assigned (Ex: 1,2,3)' example: '1,2,3' required: false schema: type: string description: 'comma separated ids of users to whom lead is assigned (Ex: 1,2,3)' example: '1,2,3' - in: query name: name description: 'Search term for lead name' example: et required: false schema: type: string description: 'Search term for lead name' example: et - in: query name: biz_name description: "Search term for lead's business name" example: autem required: false schema: type: string description: "Search term for lead's business name" example: autem - in: query name: mobile_num description: "Search term for lead's mobile number" example: 8 required: false schema: type: integer description: "Search term for lead's mobile number" example: 8 - in: query name: contact_id description: "Search term for lead's contact_id. Ex(CO0005)" example: dolor required: false schema: type: string description: "Search term for lead's contact_id. Ex(CO0005)" example: dolor - in: query name: order_by description: 'Column name to sort the result, Column: name, supplier_business_name' example: aut required: false schema: type: string description: 'Column name to sort the result, Column: name, supplier_business_name' example: aut - in: query name: direction description: "Direction to sort the result, Required if using 'order_by', direction: desc, asc" example: desc required: false schema: type: string description: "Direction to sort the result, Required if using 'order_by', direction: desc, asc" example: desc - in: query name: per_page description: 'Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)' example: 15 required: false schema: type: integer description: 'Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)' example: 15 - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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: 'https://bqf.ai/connector/api/crm/leads?page=1' last: 'https://bqf.ai/connector/api/crm/leads?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 path: 'https://bqf.ai/connector/api/crm/leads' per_page: '10' to: 3 total: 3 properties: data: type: array example: - 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 items: type: object properties: contact_id: type: string example: CO0010 name: type: string example: 'mr Lead 3 kr kr 2' supplier_business_name: type: string example: POS email: type: string example: null mobile: type: string example: '9437638555' tax_number: type: string example: null created_at: type: string example: '2020-12-15 23:14:30' custom_field1: type: string example: null custom_field2: type: string example: null custom_field3: type: string example: null custom_field4: type: string example: null custom_field5: type: string example: null custom_field6: type: string example: null alternate_number: type: string example: null landline: type: string example: null dob: type: string example: null contact_status: type: string example: active type: type: string example: lead custom_field7: type: string example: null custom_field8: type: string example: null custom_field9: type: string example: null custom_field10: type: string example: null id: type: integer example: 49 business_id: type: integer example: 1 crm_source: type: string example: '55' crm_life_stage: type: string example: '60' address_line_1: type: string example: null address_line_2: type: string example: null city: type: string example: null state: type: string example: null country: type: string example: null zip_code: type: string example: null last_follow_up_id: type: integer example: 18 upcoming_follow_up_id: type: string example: null last_follow_up: type: string example: '2021-01-07 10:26:00' upcoming_follow_up: type: string example: null last_follow_up_additional_info: type: string example: '{"test":"test done","call_duration":"1.5 Hour","rand":1}' upcoming_follow_up_additional_info: type: string example: null source: type: object properties: id: type: integer example: 55 name: type: string example: Facebook business_id: type: integer example: 1 short_code: type: string example: null parent_id: type: integer example: 0 created_by: type: integer example: 1 category_type: type: string example: source description: type: string example: Facebook slug: type: string example: null woocommerce_cat_id: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2020-12-15 23:07:53' updated_at: type: string example: '2020-12-15 23:07:53' life_stage: type: object properties: id: type: integer example: 60 name: type: string example: 'Open Deal' business_id: type: integer example: 1 short_code: type: string example: null parent_id: type: integer example: 0 created_by: type: integer example: 1 category_type: type: string example: life_stage description: type: string example: 'Open Deal' slug: type: string example: null woocommerce_cat_id: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2020-12-15 23:11:05' updated_at: type: string example: '2020-12-15 23:11:05' lead_users: type: array example: - 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 items: type: object properties: id: type: integer example: 10 user_type: type: string example: user surname: type: string example: Mr. first_name: type: string example: WooCommerce last_name: type: string example: User username: type: string example: woocommerce_user email: type: string example: woo@example.com language: type: string example: en contact_no: type: string example: null address: type: string example: null business_id: type: integer example: 1 max_sales_discount_percent: type: string example: null allow_login: type: integer example: 1 essentials_department_id: type: string example: null essentials_designation_id: type: string example: null status: type: string example: active crm_contact_id: type: string example: null is_cmmsn_agnt: type: integer example: 0 cmmsn_percent: type: string example: '0.00' selected_contacts: type: integer example: 0 dob: type: string example: null gender: type: string example: null marital_status: type: string example: null blood_group: type: string example: null contact_number: type: string example: null fb_link: type: string example: null twitter_link: type: string example: null social_media_1: type: string example: null social_media_2: type: string example: null permanent_address: type: string example: null current_address: type: string example: null guardian_name: type: string example: null custom_field_1: type: string example: null custom_field_2: type: string example: null custom_field_3: type: string example: null custom_field_4: type: string example: null bank_details: type: string example: null id_proof_name: type: string example: null id_proof_number: type: string example: null deleted_at: type: string example: null created_at: type: string example: '2018-08-02 04:05:55' updated_at: type: string example: '2018-08-02 04:05:55' pivot: type: object properties: contact_id: type: integer example: 49 user_id: type: integer example: 10 links: type: object properties: first: type: string example: 'https://bqf.ai/connector/api/crm/leads?page=1' last: type: string example: 'https://bqf.ai/connector/api/crm/leads?page=1' prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 last_page: type: integer example: 1 path: type: string example: 'https://bqf.ai/connector/api/crm/leads' per_page: type: string example: '10' to: type: integer example: 3 total: type: integer example: 3 tags: - CRM post: summary: '' operationId: postConnectorApiCrmLeads description: '' parameters: [] responses: { } tags: - 'Other endpoints · واجهات أخرى' requestBody: required: true content: application/json: schema: type: object properties: first_name: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).' example: wsqkzqiknzharef last_name: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).' example: buzsoskhsonwswse prefix: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 20 حرف (أحرف).' example: sb business_name: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).' example: wd mobile: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 50 حرف (أحرف).' example: hrrvqw email: type: string description: 'يجب أن يكون الحقل value عنوان بريد إلكتروني صالحًا. لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).' example: sam56@example.org contact_id: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 50 حرف (أحرف).' example: ugqt source_id: type: integer description: '' example: 20 life_stage_id: type: integer description: '' example: 3 city: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).' example: vmhxmykauxobkczwnxkoftoe address: type: string description: 'لا يمكن أن يحتوي النص value على أكثر من 500 حرف (أحرف).' example: ztydbiaugkbdgnulfzfmooo expected_value: type: number description: 'يجب أن تكون قيمة value أكبر من أو تساوي 0.' example: 58 probability: type: integer description: 'يجب أن تكون قيمة value أكبر من أو تساوي 0. لا يمكن أن تكون قيمة value أكبر من 100.' example: 3 expected_close_date: type: string description: 'الحقل value ليس تاريخًا صالحًا.' example: '2026-09-24T21:24:58' assigned_user_ids: type: array description: '' example: - 4 items: type: integer required: - first_name security: [] /connector/api/crm/call-logs: post: summary: 'Save Call Logs' operationId: saveCallLogs description: "Entries that cannot be read (no number, no or unreadable times) are skipped\nand counted in `skipped`; the rest are saved. An entry already saved (same\ntype, number and start time in this business) is not saved twice." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: { } tags: - CRM requestBody: required: false content: application/json: schema: type: object properties: call_logs: type: object description: '' example: '*': mobile_number: consequatur properties: '*': type: object description: '' example: mobile_number: consequatur properties: mobile_number: type: string description: 'Mobile number of the customer or user' example: consequatur mobile_name: type: string description: 'Name of the contact saved in the mobile' example: omnis call_type: type: string description: 'Call type (call, sms)' example: call start_time: type: string description: 'Start datetime of the call in "Y-m-d H:i:s" format' example: voluptatibus end_time: type: string description: 'End datetime of the call in "Y-m-d H:i:s" format' example: deleniti duration: type: string description: 'Duration of the call in seconds' example: sapiente /connector/api/cash-register: get: summary: 'List Cash Registers' operationId: listCashRegisters description: '' parameters: - in: query name: status description: 'status of the register (open, close)' example: open required: false schema: type: string description: 'status of the register (open, close)' example: open - in: query name: user_id description: 'id of the user' example: '10' required: false schema: type: string description: 'id of the user' example: '10' - in: query name: start_date description: 'format:Y-m-d' example: '2018-06-25' required: false schema: type: string description: 'format:Y-m-d' example: '2018-06-25' - in: query name: end_date description: 'format:Y-m-d' example: '2018-06-25' required: false schema: type: string description: 'format:Y-m-d' example: '2018-06-25' - in: query name: location_id description: 'id of the location' example: '1' required: false schema: type: string description: 'id of the location' example: '1' - in: query name: per_page description: 'Total records per page (up to 500). default: 10, Set -1 for all (up to 1000)' example: 15 required: false schema: type: integer description: 'Total records per page (up to 500). default: 10, Set -1 for all (up to 1000)' example: 15 - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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: 'https://bqf.ai/connector/api/cash-register?page=1' last: null prev: null next: null meta: current_page: 1 from: 1 path: 'https://bqf.ai/connector/api/cash-register' per_page: 10 to: 2 properties: data: type: array example: - 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' items: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 location_id: type: integer example: 1 user_id: type: integer example: 9 status: type: string example: open closed_at: type: string example: null closing_amount: type: string example: '0.0000' total_card_slips: type: integer example: 0 total_cheques: type: integer example: 0 closing_note: type: string example: null created_at: type: string example: '2020-07-02 12:03:00' updated_at: type: string example: '2020-07-02 12:03:19' cash_register_transactions: type: array example: - 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' items: type: object properties: id: type: integer example: 1 cash_register_id: type: integer example: 1 amount: type: string example: '0.0000' pay_method: type: string example: cash type: type: string example: credit transaction_type: type: string example: initial transaction_id: type: string example: null created_at: type: string example: '2018-07-13 07:39:34' updated_at: type: string example: '2018-07-13 07:39:34' links: type: object properties: first: type: string example: 'https://bqf.ai/connector/api/cash-register?page=1' last: type: string example: null prev: type: string example: null next: type: string example: null meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'https://bqf.ai/connector/api/cash-register' per_page: type: integer example: 10 to: type: integer example: 2 tags: - 'Cash register management' post: summary: 'Create Cash Register' operationId: createCashRegister description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: { } tags: - 'Cash register management' requestBody: required: true content: application/json: schema: type: object properties: location_id: type: integer description: 'id of the business location' example: 1 status: type: register description: 'status (open, close)' example: close initial_amount: type: number description: 'Initial amount' example: 61887607.11 created_at: type: string description: 'Register open datetime format:Y-m-d H:i:s,' example: '2020-5-7 15:20:22' closed_at: type: string description: 'Register closed datetime format:Y-m-d H:i:s,' example: '2020-5-7 15:20:22' closing_amount: type: number description: 'Closing amount' example: 21.618234719 total_card_slips: type: integer description: 'total number of card slips' example: 12 total_cheques: type: integer description: 'total number of checks' example: 7 closing_note: type: string description: 'Closing note' example: ea transaction_ids: type: string description: 'Comma separated ids of sells associated with the register' example: "1,2,3\n\nOpening while the user already has an open register answers 200 with that\nregister when it is at the requested branch, and 409 (error.code\nregister_open_elsewhere, the open register in data) when it is elsewhere.\n\nresponse {\n\"data\": {\n\"status\": \"closed\",\n\"location_id\": \"1\",\n\"closed_at\": \"2020-07-02 12:03:00\",\n\"business_id\": 1,\n\"user_id\": 1,\n\"updated_at\": \"2020-07-06 16:28:42\",\n\"created_at\": \"2020-07-06 16:28:42\",\n\"id\": 3\n}\n}" required: - location_id '/connector/api/cash-register/{id}': get: summary: 'Get the specified Register' operationId: getTheSpecifiedRegister description: '' parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: 200: description: '' content: application/json: schema: type: object example: 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' properties: data: type: array example: - 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' items: type: object properties: id: type: integer example: 1 business_id: type: integer example: 1 location_id: type: integer example: 1 user_id: type: integer example: 9 status: type: string example: open closed_at: type: string example: null closing_amount: type: string example: '0.0000' total_card_slips: type: integer example: 0 total_cheques: type: integer example: 0 closing_note: type: string example: null created_at: type: string example: '2020-07-02 12:03:00' updated_at: type: string example: '2020-07-02 12:03:19' cash_register_transactions: type: array example: - 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' items: type: object properties: id: type: integer example: 1 cash_register_id: type: integer example: 1 amount: type: string example: '0.0000' pay_method: type: string example: cash type: type: string example: credit transaction_type: type: string example: initial transaction_id: type: string example: null created_at: type: string example: '2018-07-13 07:39:34' updated_at: type: string example: '2018-07-13 07:39:34' tags: - 'Cash register management' put: summary: 'Close a cash register' operationId: closeACashRegister description: "Closes an open register as the web \"close register\" does: the counted\namounts are recorded, the cash over/short is posted to the ledger and the\nclosing reports are sent. Your own register, or — with the same\npermission — another user's register at a branch you may act on." parameters: - in: header name: Authorization description: '' example: 'Bearer {access_token}' schema: type: string responses: { } tags: - 'Cash register management' requestBody: required: true content: application/json: schema: type: object properties: status: type: string description: 'Must be one ofclose.'
example: close
closing_amount:
type: number
description: 'Counted cash in the drawer'
example: 51713676.276982
total_card_slips:
type: integer
description: 'total number of card slips'
example: 14
total_cheques:
type: integer
description: 'total number of cheques'
example: 2
closing_note:
type: string
description: 'Closing note'
example: dignissimos
denominations:
type: object
description: 'counted notes/coins, e.g. {"100": 2}'
example: []
properties: []
required:
- closing_amount
parameters:
-
in: path
name: id
description: 'The ID of the cash register.'
example: aliquam
required: true
schema:
type: string
-
in: path
name: cash_register
description: 'comma separated ids of the cash registers'
example: '59'
required: true
schema:
type: string
/connector/api/contactapi:
get:
summary: 'List contact'
operationId: listContact
description: ''
parameters:
-
in: query
name: type
description: 'Type of contact (supplier, customer)'
example: inventore
required: true
schema:
type: string
description: 'Type of contact (supplier, customer)'
example: inventore
-
in: query
name: name
description: 'Search term for contact name'
example: placeat
required: false
schema:
type: string
description: 'Search term for contact name'
example: placeat
-
in: query
name: biz_name
description: "Search term for contact's business name"
example: et
required: false
schema:
type: string
description: "Search term for contact's business name"
example: et
-
in: query
name: mobile_num
description: "Search term for contact's mobile number"
example: 7
required: false
schema:
type: integer
description: "Search term for contact's mobile number"
example: 7
-
in: query
name: contact_id
description: "Search term for contact's contact_id. Ex(CO0005)"
example: aspernatur
required: false
schema:
type: string
description: "Search term for contact's contact_id. Ex(CO0005)"
example: aspernatur
-
in: query
name: order_by
description: 'Column name to sort the result, Column: name, supplier_business_name'
example: aut
required: false
schema:
type: string
description: 'Column name to sort the result, Column: name, supplier_business_name'
example: aut
-
in: query
name: direction
description: 'Direction to sort the result, Direction: desc, asc'
example: laboriosam
required: false
schema:
type: string
description: 'Direction to sort the result, Direction: desc, asc'
example: laboriosam
-
in: query
name: per_page
description: 'Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)'
example: 15
required: false
schema:
type: integer
description: 'Total records per page (up to 500). default: 15, Set -1 for no pagination (up to 1000 records)'
example: 15
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/connector/api/contactapi?page=1'
last: 'https://bqf.ai/connector/api/contactapi?page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
path: 'https://bqf.ai/connector/api/contactapi'
per_page: '10'
to: 4
total: 4
properties:
data:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 2
business_id:
type: integer
example: 1
type:
type: string
example: supplier
supplier_business_name:
type: string
example: 'Alpha Clothings'
name:
type: string
example: Michael
prefix:
type: string
example: null
first_name:
type: string
example: Michael
middle_name:
type: string
example: null
last_name:
type: string
example: null
email:
type: string
example: null
contact_id:
type: string
example: CO0001
contact_status:
type: string
example: active
tax_number:
type: string
example: '4590091535'
city:
type: string
example: Phoenix
state:
type: string
example: Arizona
country:
type: string
example: USA
address_line_1:
type: string
example: 'Linking Street'
address_line_2:
type: string
example: null
zip_code:
type: string
example: null
dob:
type: string
example: null
mobile:
type: string
example: '(378) 400-1234'
landline:
type: string
example: null
alternate_number:
type: string
example: null
pay_term_number:
type: integer
example: 15
pay_term_type:
type: string
example: days
credit_limit:
type: string
example: null
created_by:
type: integer
example: 1
balance:
type: string
example: '0.0000'
total_rp:
type: integer
example: 0
total_rp_used:
type: integer
example: 0
total_rp_expired:
type: integer
example: 0
is_default:
type: integer
example: 0
shipping_address:
type: string
example: null
position:
type: string
example: null
customer_group_id:
type: string
example: null
crm_source:
type: string
example: null
crm_life_stage:
type: string
example: null
custom_field1:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
custom_field5:
type: string
example: null
custom_field6:
type: string
example: null
custom_field7:
type: string
example: null
custom_field8:
type: string
example: null
custom_field9:
type: string
example: null
custom_field10:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 20:59:38'
updated_at:
type: string
example: '2018-06-11 22:21:03'
remember_token:
type: string
example: null
password:
type: string
example: null
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/contactapi?page=1'
last:
type: string
example: 'https://bqf.ai/connector/api/contactapi?page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/contactapi'
per_page:
type: string
example: '10'
to:
type: integer
example: 4
total:
type: integer
example: 4
tags:
- 'Contact management'
post:
summary: 'Create contact'
operationId: createContact
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
type:
type: string
example: customer
name:
type: string
example: 'test customer'
tax_number:
type: string
example: 75879BHF
mobile:
type: string
example: '7878825008'
business_id:
type: integer
example: 1
created_by:
type: integer
example: 9
credit_limit:
type: string
example: null
contact_id:
type: string
example: CO0007
updated_at:
type: string
example: '2020-06-04 21:59:21'
created_at:
type: string
example: '2020-06-04 21:59:21'
id:
type: integer
example: 17
tags:
- 'Contact management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'Type of contact (supplier, customer, both, lead)'
example: customer
supplier_business_name:
type: string
description: 'Required if type is supplier'
example: incidunt
prefix:
type: string
description: 'Prefix for the name of the contact'
example: nihil
first_name:
type: string
description: 'Name of the contact'
example: sint
middle_name:
type: string
description: ''
example: ut
last_name:
type: string
description: ''
example: laboriosam
tax_number:
type: string
description: ''
example: 8787fefef
pay_term_number:
type: number
description: ''
example: 3.0
pay_term_type:
type: string
description: '(months ,days)'
example: months
mobile:
type: string
description: ''
example: '4578691009'
landline:
type: string
description: ''
example: 5487-8454-4145
alternate_number:
type: string
description: ''
example: '841847541222'
address_line_1:
type: string
description: ''
example: iste
address_line_2:
type: string
description: ''
example: est
city:
type: string
description: ''
example: fugit
state:
type: string
description: ''
example: laboriosam
country:
type: string
description: ''
example: porro
zip_code:
type: string
description: ''
example: sit
customer_group_id:
type: string
description: ''
example: inventore
contact_id:
type: string
description: ''
example: esse
dob:
type: string
description: 'Fromat: Y-m-d'
example: '2000-06-13'
custom_field1:
type: string
description: ''
example: commodi
custom_field2:
type: string
description: ''
example: quo
custom_field3:
type: string
description: ''
example: sit
custom_field4:
type: string
description: ''
example: nobis
email:
type: string
description: ''
example: hoyt.howe@example.com
shipping_address:
type: string
description: ''
example: non
position:
type: string
description: ''
example: excepturi
opening_balance:
type: number
description: ''
example: 0.0
source_id:
type: integer
description: 'Id of the source. Applicable only if the type is lead'
example: 13
life_stage_id:
type: integer
description: 'Id of the Life stage. Applicable only if the type is lead'
example: 17
assigned_to:
type: array
description: 'Ids of the users the lead is assigned to. Applicable only if the type is lead'
example:
- eius
items:
type: string
required:
- type
- supplier_business_name
- first_name
- mobile
'/connector/api/contactapi/{id}':
get:
summary: 'Get the specified contact'
operationId: getTheSpecifiedContact
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
type:
type: string
example: customer
supplier_business_name:
type: string
example: null
name:
type: string
example: ' Walk-In Customer '
prefix:
type: string
example: null
first_name:
type: string
example: 'Walk-In Customer'
middle_name:
type: string
example: null
last_name:
type: string
example: null
email:
type: string
example: walkin@test.com
contact_id:
type: string
example: CO0005
contact_status:
type: string
example: active
tax_number:
type: string
example: null
city:
type: string
example: Phoenix
state:
type: string
example: Arizona
country:
type: string
example: USA
address_line_1:
type: string
example: 'Linking Street'
address_line_2:
type: string
example: null
zip_code:
type: string
example: '85001'
dob:
type: string
example: null
mobile:
type: string
example: '(378) 400-1234'
landline:
type: string
example: null
alternate_number:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
credit_limit:
type: string
example: '0.0000'
created_by:
type: integer
example: 1
balance:
type: string
example: '0.0000'
total_rp:
type: integer
example: 0
total_rp_used:
type: integer
example: 0
total_rp_expired:
type: integer
example: 0
is_default:
type: integer
example: 1
shipping_address:
type: string
example: null
position:
type: string
example: null
customer_group_id:
type: string
example: null
crm_source:
type: string
example: null
crm_life_stage:
type: string
example: null
custom_field1:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 20:45:20'
updated_at:
type: string
example: '2020-08-10 10:26:45'
remember_token:
type: string
example: null
password:
type: string
example: null
customer_group:
type: string
example: null
opening_balance:
type: string
example: '0.0000'
opening_balance_paid:
type: string
example: '0.0000'
total_purchase:
type: string
example: '0.0000'
purchase_paid:
type: string
example: '0.0000'
total_purchase_return:
type: string
example: '0.0000'
purchase_return_paid:
type: string
example: '0.0000'
total_invoice:
type: string
example: '2050.0000'
invoice_received:
type: string
example: '1987.5000'
total_sell_return:
type: string
example: '0.0000'
sell_return_paid:
type: string
example: '0.0000'
purchase_due:
type: integer
example: 0
sell_due:
type: number
example: 62.5
purchase_return_due:
type: integer
example: 0
sell_return_due:
type: integer
example: 0
tags:
- 'Contact management'
put:
summary: 'Update contact'
operationId: updateContact
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
id:
type: integer
example: 21
business_id:
type: integer
example: 1
type:
type: string
example: customer
supplier_business_name:
type: string
example: null
name:
type: string
example: 'created from api'
prefix:
type: string
example: null
first_name:
type: string
example: 'created from api'
middle_name:
type: string
example: null
last_name:
type: string
example: null
email:
type: string
example: null
contact_id:
type: string
example: CO0009
contact_status:
type: string
example: active
tax_number:
type: string
example: null
city:
type: string
example: null
state:
type: string
example: null
country:
type: string
example: null
address_line_1:
type: string
example: 'test address'
address_line_2:
type: string
example: null
zip_code:
type: string
example: '54878787'
dob:
type: string
example: '2000-06-13'
mobile:
type: string
example: '8754154872154'
landline:
type: string
example: null
alternate_number:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
credit_limit:
type: string
example: null
created_by:
type: integer
example: 1
balance:
type: string
example: '0.0000'
total_rp:
type: integer
example: 0
total_rp_used:
type: integer
example: 0
total_rp_expired:
type: integer
example: 0
is_default:
type: integer
example: 0
shipping_address:
type: string
example: null
position:
type: string
example: null
customer_group_id:
type: string
example: null
crm_source:
type: string
example: null
crm_life_stage:
type: string
example: null
custom_field1:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2020-08-10 10:41:42'
updated_at:
type: string
example: '2020-08-10 10:41:42'
remember_token:
type: string
example: null
password:
type: string
example: null
tags:
- 'Contact management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: 'Type of contact (supplier, customer, both)'
example: customer
supplier_business_name:
type: string
description: 'required* Required if type is supplier'
example: aut
prefix:
type: string
description: 'Prefix for the name of the contact'
example: autem
first_name:
type: string
description: 'Name of the contact'
example: voluptatem
middle_name:
type: string
description: ''
example: voluptas
last_name:
type: string
description: ''
example: rem
tax_number:
type: string
description: ''
example: 488744dwd
pay_term_number:
type: number
description: ''
example: 3.0
pay_term_type:
type: string
description: '(months ,days)'
example: months
mobile:
type: string
description: ''
example: '8795461009'
landline:
type: string
description: ''
example: 65484-848-848
alternate_number:
type: string
description: ''
example: '9898795220'
address_line_1:
type: string
description: ''
example: fugiat
address_line_2:
type: string
description: ''
example: nulla
city:
type: string
description: ''
example: esse
state:
type: string
description: ''
example: labore
country:
type: string
description: ''
example: fuga
zip_code:
type: string
description: ''
example: dolores
customer_group_id:
type: string
description: ''
example: odit
contact_id:
type: string
description: ''
example: iusto
dob:
type: string
description: 'Fromat: Y-m-d'
example: '2000-06-13'
custom_field1:
type: string
description: ''
example: nihil
custom_field2:
type: string
description: ''
example: error
custom_field3:
type: string
description: ''
example: asperiores
custom_field4:
type: string
description: ''
example: repellendus
email:
type: string
description: ''
example: lila.hettinger@example.net
shipping_address:
type: string
description: ''
example: et
position:
type: string
description: ''
example: soluta
opening_balance:
type: number
description: 'Not changed through this endpoint (ignored); edit it on the web'
example: 2764.841
source_id:
type: integer
description: 'Id of the source. Applicable only if the type is lead'
example: 14
life_stage_id:
type: integer
description: 'Id of the Life stage. Applicable only if the type is lead'
example: 1
assigned_to:
type: array
description: 'Ids of the users the lead is assigned to. Applicable only if the type is lead'
example:
- nisi
items:
type: string
required:
- first_name
- mobile
parameters:
-
in: path
name: id
description: 'The ID of the contactapi.'
example: inventore
required: true
schema:
type: string
-
in: path
name: contact
description: 'comma separated ids of contacts'
example: '2'
required: true
schema:
type: string
/connector/api/contactapi-payment:
post:
summary: 'Contact payment'
operationId: contactPayment
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
amount:
type: string
example: '20'
method:
type: string
example: cash
paid_on:
type: string
example: '2020-07-22 15:48:29'
created_by:
type: integer
example: 1
payment_for:
type: string
example: '19'
business_id:
type: integer
example: 1
is_advance:
type: integer
example: 1
payment_ref_no:
type: string
example: SP2020/0127
document:
type: string
example: null
updated_at:
type: string
example: '2020-07-22 15:48:29'
created_at:
type: string
example: '2020-07-22 15:48:29'
id:
type: integer
example: 215
tags:
- 'Contact management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
contact_id:
type: integer
description: 'id of the contact'
example: 17
amount:
type: number
description: 'amount of the payment, more than 0'
example: 453.13
method:
type: string
description: "payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1' … 'custom_pay_7'); 'advance' is not accepted here"
example: cash
due_payment_type:
type: string
description: 'sell, sell_return (customers) or purchase, purchase_return (suppliers); default: purchase for a supplier, sell otherwise'
example: sell
paid_on:
type: string
description: 'transaction date format:Y-m-d H:i:s (the payment is dated by its day),'
example: '2020-07-22 15:48:29'
account_id:
type: integer
description: "ledger account id when chart_of_account_id is not sent, or a payment account id (payment-accounts); another business's id is a 422"
example: 8
chart_of_account_id:
type: integer
description: "ledger (chart of accounts) account id of the business; another business's id is a 422"
example: 17
card_number:
type: string
description: 'Last four digits only.'
maxLength: 4
example: '1234'
card_holder_name:
type: string
description: ''
example: earum
card_transaction_number:
type: string
description: ''
example: nostrum
card_type:
type: string
description: ''
example: nisi
card_month:
type: string
description: ''
example: dignissimos
card_year:
type: string
description: ''
example: impedit
transaction_no_1:
type: string
description: ''
example: quis
transaction_no_2:
type: string
description: ''
example: excepturi
transaction_no_3:
type: string
description: ''
example: similique
cheque_number:
type: string
description: ''
example: blanditiis
bank_account_number:
type: string
description: ''
example: rerum
note:
type: string
description: 'payment note'
example: sint
required:
- contact_id
- amount
- method
/connector/api/expense:
get:
summary: 'List expenses'
operationId: listExpenses
description: ''
parameters:
-
in: query
name: location_id
description: 'id of the location'
example: '1'
required: false
schema:
type: string
description: 'id of the location'
example: '1'
-
in: query
name: payment_status
description: 'payment status'
example: paid
required: false
schema:
type: string
description: 'payment status'
example: paid
-
in: query
name: start_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: end_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: expense_for
description: 'id of the user for which expense is created'
example: laborum
required: false
schema:
type: string
description: 'id of the user for which expense is created'
example: laborum
-
in: query
name: per_page
description: 'Total records per page (up to 500). default: 15, Set -1 for all (up to 1000)'
example: 15
required: false
schema:
type: integer
description: 'Total records per page (up to 500). default: 15, Set -1 for all (up to 1000)'
example: 15
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/connector/api/expense?page=1'
last: null
prev: null
next: null
meta:
current_page: 1
from: 1
path: 'https://bqf.ai/connector/api/expense'
per_page: 10
to: 1
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 59
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
payment_status:
type: string
example: due
ref_no:
type: string
example: EP2020/0001
transaction_date:
type: string
example: '2020-07-03 12:58:00'
total_before_tax:
type: string
example: '50.0000'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '50.0000'
expense_category_id:
type: string
example: null
document:
type: string
example: null
created_by:
type: integer
example: 9
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
created_at:
type: string
example: '2020-07-03 12:58:23'
updated_at:
type: string
example: '2020-07-03 12:58:24'
transaction_for:
type: object
properties:
id:
type: integer
example: 1
user_type:
type: string
example: user
surname:
type: string
example: Mr
first_name:
type: string
example: Admin
last_name:
type: string
example: null
username:
type: string
example: admin
email:
type: string
example: admin@example.com
language:
type: string
example: en
contact_no:
type: string
example: null
address:
type: string
example: null
business_id:
type: integer
example: 1
max_sales_discount_percent:
type: string
example: null
allow_login:
type: integer
example: 1
essentials_department_id:
type: string
example: null
essentials_designation_id:
type: string
example: null
status:
type: string
example: active
crm_contact_id:
type: string
example: null
is_cmmsn_agnt:
type: integer
example: 0
cmmsn_percent:
type: string
example: '0.00'
selected_contacts:
type: integer
example: 0
dob:
type: string
example: null
gender:
type: string
example: null
marital_status:
type: string
example: null
blood_group:
type: string
example: null
contact_number:
type: string
example: null
fb_link:
type: string
example: null
twitter_link:
type: string
example: null
social_media_1:
type: string
example: null
social_media_2:
type: string
example: null
permanent_address:
type: string
example: null
current_address:
type: string
example: null
guardian_name:
type: string
example: null
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
bank_details:
type: string
example: null
id_proof_name:
type: string
example: null
id_proof_number:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:19'
updated_at:
type: string
example: '2018-01-04 02:15:19'
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/expense?page=1'
last:
type: string
example: null
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/expense'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
tags:
- 'Expense management'
post:
summary: 'Create expense / expense refund'
operationId: createExpenseExpenseRefund
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: []
properties:
data:
type: object
properties:
id:
type: integer
example: 75
business_id:
type: integer
example: 1
location_id:
type: string
example: '1'
payment_status:
type: string
example: due
ref_no:
type: string
example: EP2020/0013
transaction_date:
type: string
example: '2020-07-06T05:31:29.480975Z'
total_before_tax:
type: string
example: '43'
tax_id:
type: string
example: null
tax_amount:
type: integer
example: 0
final_total:
type: string
example: '43'
expense_category_id:
type: string
example: null
document:
type: string
example: null
created_by:
type: integer
example: 1
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
created_at:
type: string
example: '2020-07-06 11:01:29'
updated_at:
type: string
example: '2020-07-06 11:01:29'
expense_for:
type: array
example: []
tags:
- 'Expense management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
location_id:
type: integer
description: 'id of the business location'
example: 1
final_total:
type: number
description: 'Expense amount'
example: 225922.479344
transaction_date:
type: string
description: 'transaction date format:Y-m-d H:i:s,'
example: '2020-5-7 15:20:22'
tax_rate_id:
type: integer
description: 'id of the tax rate applicable to the expense'
example: 12
expense_for:
type: integer
description: 'id of the user for which expense is created'
example: 4
contact_id:
type: integer
description: 'id of the contact(customer or supplier) for which expense is created'
example: 20
expense_category_id:
type: integer
description: 'id of the expense category'
example: 1
expense_sub_category_id:
type: integer
description: 'id of the expense sub-category'
example: 2
additional_notes:
type: string
description: ''
example: maxime
is_refund:
type: integer
description: 'whether expense refund (0, 1)'
example: 0
is_recurring:
type: integer
description: 'whether expense is recurring (0, 1)'
example: 0
recur_interval:
type: integer
description: 'value of the interval expense will be regenerated'
example: 14
recur_interval_type:
type: string
description: "type of the recur interval ('days', 'months', 'years')"
example: months
subscription_repeat_on:
type: integer
description: 'day of the month on which expense will be generated if recur interval type is months (1-30)'
example: 15
subscription_no:
type: string
description: 'subscription number'
example: unde
recur_repetitions:
type: integer
description: 'total number of expense to be generated'
example: 16
payment:
type: array
description: 'payment lines for the expense'
example:
- est
items:
type: string
required:
- location_id
- final_total
'/connector/api/expense/{id}':
get:
summary: 'Get the specified expense / expense refund'
operationId: getTheSpecifiedExpenseExpenseRefund
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 59
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
payment_status:
type: string
example: due
ref_no:
type: string
example: EP2020/0001
transaction_date:
type: string
example: '2020-07-03 12:58:00'
total_before_tax:
type: string
example: '50.0000'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '50.0000'
expense_category_id:
type: string
example: null
document:
type: string
example: null
created_by:
type: integer
example: 9
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
created_at:
type: string
example: '2020-07-03 12:58:23'
updated_at:
type: string
example: '2020-07-03 12:58:24'
transaction_for:
type: object
properties:
id:
type: integer
example: 1
user_type:
type: string
example: user
surname:
type: string
example: Mr
first_name:
type: string
example: Admin
last_name:
type: string
example: null
username:
type: string
example: admin
email:
type: string
example: admin@example.com
language:
type: string
example: en
contact_no:
type: string
example: null
address:
type: string
example: null
business_id:
type: integer
example: 1
max_sales_discount_percent:
type: string
example: null
allow_login:
type: integer
example: 1
essentials_department_id:
type: string
example: null
essentials_designation_id:
type: string
example: null
status:
type: string
example: active
crm_contact_id:
type: string
example: null
is_cmmsn_agnt:
type: integer
example: 0
cmmsn_percent:
type: string
example: '0.00'
selected_contacts:
type: integer
example: 0
dob:
type: string
example: null
gender:
type: string
example: null
marital_status:
type: string
example: null
blood_group:
type: string
example: null
contact_number:
type: string
example: null
fb_link:
type: string
example: null
twitter_link:
type: string
example: null
social_media_1:
type: string
example: null
social_media_2:
type: string
example: null
permanent_address:
type: string
example: null
current_address:
type: string
example: null
guardian_name:
type: string
example: null
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
bank_details:
type: string
example: null
id_proof_name:
type: string
example: null
id_proof_number:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:19'
updated_at:
type: string
example: '2018-01-04 02:15:19'
tags:
- 'Expense management'
put:
summary: 'Update expense / expense refund'
operationId: updateExpenseExpenseRefund
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: []
properties:
data:
type: object
properties:
id:
type: integer
example: 75
business_id:
type: integer
example: 1
location_id:
type: string
example: '1'
payment_status:
type: string
example: due
ref_no:
type: string
example: EP2020/0013
transaction_date:
type: string
example: '2020-07-06T05:31:29.480975Z'
total_before_tax:
type: string
example: '43'
tax_id:
type: string
example: null
tax_amount:
type: integer
example: 0
final_total:
type: string
example: '43'
expense_category_id:
type: string
example: null
document:
type: string
example: null
created_by:
type: integer
example: 1
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
created_at:
type: string
example: '2020-07-06 11:01:29'
updated_at:
type: string
example: '2020-07-06 11:01:29'
expense_for:
type: array
example: []
tags:
- 'Expense management'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
final_total:
type: number
description: 'Expense amount'
example: 39.71398
transaction_date:
type: string
description: 'transaction date format:Y-m-d H:i:s,'
example: '2020-5-7 15:20:22'
tax_rate_id:
type: integer
description: 'id of the tax rate applicable to the expense'
example: 20
expense_for:
type: integer
description: 'id of the user for which expense is created'
example: 9
contact_id:
type: integer
description: 'id of the contact(customer or supplier) for which expense is created'
example: 15
expense_category_id:
type: integer
description: 'id of the expense category'
example: 6
expense_sub_category_id:
type: integer
description: 'id of the expense sub-category'
example: 4
additional_notes:
type: string
description: ''
example: ea
is_recurring:
type: integer
description: 'whether expense is recurring (0, 1)'
example: 0
recur_interval:
type: integer
description: 'value of the interval expense will be regenerated'
example: 8
recur_interval_type:
type: string
description: "type of the recur interval ('days', 'months', 'years')"
example: months
subscription_repeat_on:
type: integer
description: 'day of the month on which expense will be generated if recur interval type is months (1-30)'
example: 15
subscription_no:
type: string
description: 'subscription number'
example: sit
recur_repetitions:
type: integer
description: 'total number of expense to be generated'
example: 18
payment:
type: array
description: 'payment lines for the expense'
example:
- molestiae
items:
type: string
parameters:
-
in: path
name: id
description: 'The ID of the expense.'
example: illum
required: true
schema:
type: string
-
in: path
name: expense
description: 'comma separated ids of the expenses'
example: '59'
required: true
schema:
type: string
/connector/api/expense-refund:
get:
summary: 'List expense refunds'
operationId: listExpenseRefunds
description: ''
parameters:
-
in: query
name: location_id
description: 'id of the location'
example: '1'
required: false
schema:
type: string
description: 'id of the location'
example: '1'
-
in: query
name: payment_status
description: 'payment status'
example: paid
required: false
schema:
type: string
description: 'payment status'
example: paid
-
in: query
name: start_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: end_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: expense_for
description: 'id of the user for which expense is created'
example: beatae
required: false
schema:
type: string
description: 'id of the user for which expense is created'
example: beatae
-
in: query
name: per_page
description: 'Total records per page (up to 500). default: 15, Set -1 for all (up to 1000)'
example: 15
required: false
schema:
type: integer
description: 'Total records per page (up to 500). default: 15, Set -1 for all (up to 1000)'
example: 15
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/connector/api/expense-refund?page=1'
last: null
prev: null
next: null
meta:
current_page: 1
from: 1
path: 'https://bqf.ai/connector/api/expense-refund'
per_page: 15
to: 1
properties:
data:
type: array
example:
-
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: []
items:
type: object
properties:
id:
type: integer
example: 230
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
payment_status:
type: string
example: partial
ref_no:
type: string
example: refund
transaction_date:
type: string
example: '2020-12-15 11:16:00'
total_before_tax:
type: string
example: '65.0000'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '65.0000'
expense_category_id:
type: string
example: null
document:
type: string
example: null
created_by:
type: integer
example: 9
created_at:
type: string
example: '2020-12-15 11:46:56'
updated_at:
type: string
example: '2020-12-15 12:47:30'
expense_for:
type: array
example: []
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/expense-refund?page=1'
last:
type: string
example: null
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/expense-refund'
per_page:
type: integer
example: 15
to:
type: integer
example: 1
tags:
- 'Expense management'
/connector/api/expense-categories:
get:
summary: 'List expense categories'
operationId: listExpenseCategories
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'cat 1'
business_id:
type: integer
example: 1
code:
type: string
example: null
parent_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2021-12-16 17:54:40'
updated_at:
type: string
example: '2021-12-16 17:54:40'
sub_categories:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 3
name:
type: string
example: 'sub cat 1'
business_id:
type: integer
example: 1
code:
type: string
example: null
parent_id:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2021-12-16 18:12:07'
updated_at:
type: string
example: '2021-12-16 18:12:07'
tags:
- 'Expense management'
/connector/api/field-force:
get:
summary: 'List visits'
operationId: listVisits
description: ''
parameters:
-
in: query
name: contact_id
description: 'id of the contact'
example: dicta
required: false
schema:
type: string
description: 'id of the contact'
example: dicta
-
in: query
name: assigned_to
description: 'id of the assigned user'
example: non
required: false
schema:
type: string
description: 'id of the assigned user'
example: non
-
in: query
name: status
description: 'status of the visit (assigned, finished)'
example: repellat
required: false
schema:
type: string
description: 'status of the visit (assigned, finished)'
example: repellat
-
in: query
name: start_date
description: 'Start date filter for visit on format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'Start date filter for visit on format:Y-m-d'
example: '2018-06-25'
-
in: query
name: end_date
description: 'End date filter for visit on format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'End date filter for visit on format:Y-m-d'
example: '2018-06-25'
-
in: query
name: per_page
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 15
required: false
schema:
type: integer
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 15
-
in: query
name: order_by_date
description: "Sort visit by visit on date ('asc', 'desc')"
example: 0
required: false
schema:
type: integer
description: "Sort visit by visit on date ('asc', 'desc')"
example: 0
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses: { }
tags:
- 'Field Force'
/connector/api/field-force/create:
post:
summary: 'Create Visit'
operationId: createVisit
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
contact_id:
type: string
example: '6'
assigned_to:
type: string
example: '9'
visit_on:
type: string
example: '2022-01-15 17:23:00'
visit_for:
type: string
example: ''
meet_with:
type: string
example: ''
meet_with2:
type: string
example: ''
meet_with3:
type: string
example: ''
meet_with_mobileno:
type: string
example: ''
meet_with_mobileno2:
type: string
example: ''
meet_with_mobileno3:
type: string
example: ''
meet_with_designation:
type: string
example: ''
meet_with_designation2:
type: string
example: ''
meet_with_designation3:
type: string
example: ''
visit_id:
type: string
example: 2021/0031
status:
type: string
example: assigned
business_id:
type: integer
example: 1
updated_at:
type: string
example: '2021-12-30 11:00:47'
created_at:
type: string
example: '2021-12-30 11:00:47'
id:
type: integer
example: 3
tags:
- 'Field Force'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
contact_id:
type: integer
description: 'id of the contact'
example: 10
visit_to:
type: string
description: 'Name of the visiting person or company if contact_id is not given'
example: omnis
visit_address:
type: string
description: 'Address of the visiting person or company if contact_id is not given'
example: est
assigned_to:
type: integer
description: 'id of the assigned user'
example: 1
visit_on:
type: 'format:Y-m-d'
description: 'H:i:s'
example: '2021-12-28 17:23:00'
visit_for:
type: string
description: 'Purpose of visiting'
example: aut
required:
- assigned_to
'/connector/api/field-force/update-visit-status/{id}':
post:
summary: 'Update Visit status'
operationId: updateVisitStatus
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: object
properties:
id:
type: integer
example: 10
business_id:
type: integer
example: 1
contact_id:
type: integer
example: 6
assigned_to:
type: integer
example: 9
latitude:
type: string
example: '23.6101808'
longitude:
type: string
example: '85.2799354'
visited_address:
type: string
example: 'New address'
status:
type: string
example: finished
visit_on:
type: string
example: '2021-12-28 17:23:00'
visit_for:
type: string
example: 'assigned from api'
meet_with:
type: string
example: Name
meet_with2:
type: string
example: Name
meet_with3:
type: string
example: Name
meet_with_mobileno:
type: string
example: '123456789'
meet_with_mobileno2:
type: string
example: '123456789'
meet_with_mobileno3:
type: string
example: '123456789'
meet_with_designation:
type: string
example: dr
meet_with_designation2:
type: string
example: dr
meet_with_designation3:
type: string
example: dr
comments:
type: string
example: 'Users comment'
created_at:
type: string
example: '2021-12-28 17:35:13'
updated_at:
type: string
example: '2021-12-28 18:06:03'
tags:
- 'Field Force'
requestBody:
required: false
content:
multipart/form-data:
schema:
type: object
properties:
status:
type: string
description: 'Current status of the visit (assigned, finished, met_contact, did_not_meet_contact)'
example: finished
reason_to_not_meet_contact:
type: string
description: 'Reason if status is did_not_meet_contact'
example: expedita
visited_on:
type: 'format:Y-m-d'
description: 'H:i:s'
example: '2021-12-28 17:23:00'
visited_address:
type: string
description: 'Full address of the contact'
example: 'Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India'
latitude:
type: decimal
description: 'Lattitude of the user location if full address is not given'
example: '41.40338'
longitude:
type: decimal
description: 'Longitude of the user location if full address is not given'
example: '2.17403'
comments:
type: string
description: 'Extra comments'
example: quas
photo:
type: string
format: binary
description: 'Upload Photo as a file of the visit if any or base64 encoded image'
meet_with:
type: required
description: 'name of person field force meet with'
example: maxime
meet_with_mobileno:
type: required
description: 'mobile number of the person field force meet with'
example: tempore
parameters:
-
in: path
name: id
description: 'id of the visit to be updated'
example: '17'
required: true
schema:
type: string
/connector/api/new_product:
get:
summary: 'New List products'
operationId: newListProducts
description: ''
parameters:
-
in: query
name: order_by
description: 'Values: product_name or newest'
example: consequuntur
required: false
schema:
type: string
description: 'Values: product_name or newest'
example: consequuntur
-
in: query
name: order_direction
description: 'Values: asc or desc'
example: libero
required: false
schema:
type: string
description: 'Values: asc or desc'
example: libero
-
in: query
name: location_custom_field_1
description: 'Custom field 1 of the location'
example: eos
required: false
schema:
type: string
description: 'Custom field 1 of the location'
example: eos
-
in: query
name: category_id
description: 'comma separated ids of one or multiple category'
example: amet
required: false
schema:
type: string
description: 'comma separated ids of one or multiple category'
example: amet
-
in: query
name: sub_category_id
description: 'comma separated ids of one or multiple sub-category'
example: vero
required: false
schema:
type: string
description: 'comma separated ids of one or multiple sub-category'
example: vero
-
in: query
name: location_id
description: ''
example: '1'
required: false
schema:
type: string
description: ''
example: '1'
-
in: query
name: not_for_sell
description: '(1, 0)'
example: nihil
required: false
schema:
type: string
description: '(1, 0)'
example: nihil
-
in: query
name: send_lot_detail
description: 'Send lot details in each variation location details(1, 0)'
example: quas
required: false
schema:
type: string
description: 'Send lot details in each variation location details(1, 0)'
example: quas
-
in: query
name: name
description: 'Search term for product name'
example: aut
required: false
schema:
type: string
description: 'Search term for product name'
example: aut
-
in: query
name: sku
description: 'Search term for product sku'
example: inventore
required: false
schema:
type: string
description: 'Search term for product sku'
example: inventore
-
in: query
name: product_ids
description: 'comma separated ids of products'
example: '1,2'
required: false
schema:
type: string
description: 'comma separated ids of products'
example: '1,2'
-
in: query
name: per_page
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
required: false
schema:
type: integer
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/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: 'https://bqf.ai/connector/api/new_product?per_page=1&page=1'
last: 'https://bqf.ai/connector/api/new_product?per_page=1&page=1088'
prev: null
next: 'https://bqf.ai/connector/api/new_product?per_page=1&page=2'
meta:
current_page: 1
from: 1
last_page: 1088
path: 'https://bqf.ai/connector/api/new_product'
per_page: '1'
to: 1
total: 1088
properties:
data:
type: array
example:
-
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: 'https://bqf.ai/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
items:
type: object
properties:
id:
type: integer
example: 2
name:
type: string
example: "Levis Men's Slimmy Fit Jeans"
business_id:
type: integer
example: 1
type:
type: string
example: variable
exemption_type_id:
type: string
example: null
enable_stock:
type: integer
example: 1
sku:
type: string
example: AS0002
product_custom_field1:
type: string
example: null
product_custom_field2:
type: string
example: null
product_custom_field3:
type: string
example: null
product_custom_field4:
type: string
example: null
woocommerce_media_id:
type: string
example: null
product_description:
type: string
example: null
is_inactive:
type: integer
example: 0
repair_model_id:
type: string
example: null
not_for_selling:
type: integer
example: 0
ecom_shipping_class_id:
type: string
example: null
ecom_active_in_store:
type: integer
example: 1
woocommerce_product_id:
type: integer
example: 627
woocommerce_disable_sync:
type: integer
example: 0
image_url:
type: string
example: 'https://bqf.ai/uploads/img/1528727964_levis_jeans.jpg'
product_variations:
type: array
example:
-
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: []
items:
type: object
properties:
id:
type: integer
example: 2
variation_template_id:
type: integer
example: 5
name:
type: string
example: 'Waist Size'
product_id:
type: integer
example: 2
is_dummy:
type: integer
example: 0
variations:
type: array
example:
-
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: []
items:
type: object
properties:
id:
type: integer
example: 2
name:
type: string
example: '28'
product_id:
type: integer
example: 2
sub_sku:
type: string
example: AS0002-1
product_variation_id:
type: integer
example: 2
woocommerce_variation_id:
type: integer
example: 658
default_purchase_price:
type: string
example: '70.0000'
dpp_inc_tax:
type: string
example: '77.0000'
default_sell_price:
type: string
example: '70.0000'
sell_price_inc_tax:
type: string
example: '77.0000'
combo_variations:
type: string
example: null
variation_location_details:
type: array
example: [{ id: 1, product_id: 2, product_variation_id: 2, variation_id: 2, location_id: 1, qty_available: '71.0000' }]
items: { type: object, properties: { id: { type: integer, example: 1 }, product_id: { type: integer, example: 2 }, product_variation_id: { type: integer, example: 2 }, variation_id: { type: integer, example: 2 }, location_id: { type: integer, example: 1 }, qty_available: { type: string, example: '71.0000' } } }
media:
type: array
example: []
discounts:
type: array
example: []
brand:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: Levis
description:
type: string
example: null
created_by:
type: integer
example: 1
use_for_repair:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:19:47'
updated_at:
type: string
example: '2018-01-03 21:19:47'
unit:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
actual_name:
type: string
example: Pieces
short_name:
type: string
example: Pc(s)
allow_decimal:
type: integer
example: 0
base_unit_id:
type: string
example: null
base_unit_multiplier:
type: string
example: null
category:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's"
business_id:
type: integer
example: 1
short_code:
type: string
example: sfefef
parent_id:
type: integer
example: 0
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
sub_category:
type: object
properties:
id:
type: integer
example: 4
name:
type: string
example: Jeans
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
product_tax:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: VAT@10%
amount:
type: integer
example: 10
is_tax_group:
type: integer
example: 0
for_tax_group:
type: integer
example: 0
created_by:
type: integer
example: 1
woocommerce_tax_rate_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:40:07'
updated_at:
type: string
example: '2018-01-04 02:40:07'
product_locations:
type: array
example:
-
id: 1
business_id: 1
name: 'Location 1'
custom_field1: gdgdgd88
custom_field2: null
custom_field3: null
custom_field4: null
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: 'Location 1'
custom_field1:
type: string
example: gdgdgd88
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/new_product?per_page=1&page=1'
last:
type: string
example: 'https://bqf.ai/connector/api/new_product?per_page=1&page=1088'
prev:
type: string
example: null
next:
type: string
example: 'https://bqf.ai/connector/api/new_product?per_page=1&page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1088
path:
type: string
example: 'https://bqf.ai/connector/api/new_product'
per_page:
type: string
example: '1'
to:
type: integer
example: 1
total:
type: integer
example: 1088
tags:
- 'New end points'
/connector/api/new_sell:
get:
summary: 'New List sells'
operationId: newListSells
description: ''
parameters:
-
in: query
name: location_id
description: 'id of the location'
example: '1'
required: false
schema:
type: string
description: 'id of the location'
example: '1'
-
in: query
name: contact_id
description: 'id of the customer'
example: dolorem
required: false
schema:
type: string
description: 'id of the customer'
example: dolorem
-
in: query
name: payment_status
description: 'Comma separated values of payment statuses. Available values due, partial, paid, overdue'
example: 'due,partial'
required: false
schema:
type: string
description: 'Comma separated values of payment statuses. Available values due, partial, paid, overdue'
example: 'due,partial'
-
in: query
name: start_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: end_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: user_id
description: 'id of the user who created the sale'
example: maxime
required: false
schema:
type: string
description: 'id of the user who created the sale'
example: maxime
-
in: query
name: service_staff_id
description: 'id of the service staff assigned with the sale'
example: architecto
required: false
schema:
type: string
description: 'id of the service staff assigned with the sale'
example: architecto
-
in: query
name: shipping_status
description: "Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')"
example: ordered
required: false
schema:
type: string
description: "Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')"
example: ordered
-
in: query
name: source
description: 'Source of the sale'
example: provident
required: false
schema:
type: string
description: 'Source of the sale'
example: provident
-
in: query
name: customer_group_id
description: 'id of the customer group'
example: molestiae
required: false
schema:
type: string
description: 'id of the customer group'
example: molestiae
-
in: query
name: product_name
description: 'name of the product'
example: non
required: false
schema:
type: string
description: 'name of the product'
example: non
-
in: query
name: product_sku
description: 'sku of the product or variation'
example: iure
required: false
schema:
type: string
description: 'sku of the product or variation'
example: iure
-
in: query
name: product_custom_field_1
description: 'custome field 1 of the product'
example: ea
required: false
schema:
type: string
description: 'custome field 1 of the product'
example: ea
-
in: query
name: location_custom_field_1
description: 'custome field 1 of the location'
example: alias
required: false
schema:
type: string
description: 'custome field 1 of the location'
example: alias
-
in: query
name: location_invoice_scheme_prefix
description: 'Invoice scheme prefix of the location'
example: earum
required: false
schema:
type: string
description: 'Invoice scheme prefix of the location'
example: earum
-
in: query
name: product_category_id
description: 'category id of the product'
example: est
required: false
schema:
type: string
description: 'category id of the product'
example: est
-
in: query
name: product_sub_category_id
description: 'Sub category id of the product'
example: sint
required: false
schema:
type: string
description: 'Sub category id of the product'
example: sint
-
in: query
name: sell_ids
description: 'comma separated ids of the sells'
example: '55,64'
required: false
schema:
type: string
description: 'comma separated ids of the sells'
example: '55,64'
-
in: query
name: only_subscriptions
description: 'Filter only subcription invoices (1, 0)'
example: recusandae
required: false
schema:
type: string
description: 'Filter only subcription invoices (1, 0)'
example: recusandae
-
in: query
name: send_purchase_details
description: 'Get purchase details of each sell line (1, 0)'
example: necessitatibus
required: false
schema:
type: string
description: 'Get purchase details of each sell line (1, 0)'
example: necessitatibus
-
in: query
name: order_by_date
description: "Sort sell list by date ('asc', 'desc')"
example: desc
required: false
schema:
type: string
description: "Sort sell list by date ('asc', 'desc')"
example: desc
-
in: query
name: per_page
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
required: false
schema:
type: integer
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/invoice/00f79f7fd292225e8c303a6bf8626d06'
payment_link: ''
links:
first: 'https://bqf.ai/connector/api/new_sell?per_page=1&page=1'
last: 'https://bqf.ai/connector/api/new_sell?per_page=1&page=213'
prev: null
next: 'https://bqf.ai/connector/api/new_sell?per_page=1&page=2'
meta:
current_page: 1
from: 1
last_page: 213
path: 'https://bqf.ai/connector/api/new_sell'
per_page: '1'
to: 1
total: 213
properties:
data:
type: array
example:
-
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: 'https://bqf.ai/invoice/00f79f7fd292225e8c303a6bf8626d06'
payment_link: ''
items:
type: object
properties:
id:
type: integer
example: 6
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: string
example: null
type:
type: string
example: sell
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: paid
contact_id:
type: integer
example: 4
customer_group_id:
type: string
example: null
invoice_no:
type: string
example: AS0001
ref_no:
type: string
example: ''
source:
type: string
example: null
unique_hash:
type: string
example: null
hash_control:
type: string
example: null
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '2018-04-10 13:23:21'
total_before_tax:
type: string
example: '770.0000'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
discount_type:
type: string
example: percentage
discount_amount:
type: string
example: '0.0000'
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: null
shipping_address:
type: string
example: null
shipping_status:
type: string
example: null
delivered_to:
type: string
example: null
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '770.0000'
expense_sub_category_id:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
total_amount_recovered:
type: string
example: null
crm_is_order_request:
type: integer
example: 0
mfg_production_cost:
type: string
example: '0.0000'
mfg_production_cost_type:
type: string
example: percentage
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_job_sheet_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
repair_updates_notif:
type: integer
example: 0
invoice_token:
type: string
example: 00f79f7fd292225e8c303a6bf8626d06
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: string
example: null
created_at:
type: string
example: '2018-01-06 07:06:11'
updated_at:
type: string
example: '2021-10-23 11:42:13'
location_name:
type: string
example: 'Location 1'
location_custom_field1:
type: string
example: gdgdgd88
location_invoice_scheme_prefix:
type: string
example: AS
table_name:
type: string
example: null
table_description:
type: string
example: null
contact:
type: string
example: Harry
customer_group_name:
type: string
example: 'grp 2'
sell_lines:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
transaction_id:
type: integer
example: 6
product_id:
type: integer
example: 2
quantity:
type: integer
example: 10
quantity_returned:
type: string
example: '0.0000'
unit_price_before_discount:
type: string
example: '70.0000'
unit_price:
type: string
example: '70.0000'
line_discount_type:
type: string
example: null
line_discount_amount:
type: string
example: '0.0000'
unit_price_inc_tax:
type: string
example: '77.0000'
item_tax:
type: string
example: '7.0000'
tax_id:
type: integer
example: 1
discount_id:
type: string
example: null
lot_no_line_id:
type: string
example: null
sell_line_note:
type: string
example: null
woocommerce_line_items_id:
type: string
example: null
children_type:
type: string
example: ''
created_at:
type: string
example: '2018-01-06 07:06:11'
updated_at:
type: string
example: '2018-01-06 07:06:11'
product_name:
type: string
example: "Levis Men's Slimmy Fit Jeans"
product_custom_field_1:
type: string
example: null
product_type:
type: string
example: variable
product_sku:
type: string
example: AS0002
category:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's"
business_id:
type: integer
example: 1
short_code:
type: string
example: sfefef
parent_id:
type: integer
example: 0
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
sub_category:
type: object
properties:
id:
type: integer
example: 4
name:
type: string
example: Jeans
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 1
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
product_variations:
type: object
properties:
id:
type: integer
example: 3
name:
type: string
example: '30'
product_id:
type: integer
example: 2
sub_sku:
type: string
example: AS0002-2
product_variation_id:
type: integer
example: 2
default_purchase_price:
type: string
example: '70.0000'
dpp_inc_tax:
type: string
example: '77.0000'
default_sell_price:
type: string
example: '70.0000'
sell_price_inc_tax:
type: string
example: '77.0000'
payment_lines:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 1
transaction_id:
type: integer
example: 6
business_id:
type: string
example: null
is_return:
type: integer
example: 0
amount:
type: string
example: '770.0000'
method:
type: string
example: cash
card_type:
type: string
example: visa
paid_on:
type: string
example: '2018-01-09 17:30:35'
payment_ref_no:
type: string
example: null
invoice_url:
type: string
example: 'https://bqf.ai/invoice/00f79f7fd292225e8c303a6bf8626d06'
payment_link:
type: string
example: ''
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/new_sell?per_page=1&page=1'
last:
type: string
example: 'https://bqf.ai/connector/api/new_sell?per_page=1&page=213'
prev:
type: string
example: null
next:
type: string
example: 'https://bqf.ai/connector/api/new_sell?per_page=1&page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 213
path:
type: string
example: 'https://bqf.ai/connector/api/new_sell'
per_page:
type: string
example: '1'
to:
type: integer
example: 1
total:
type: integer
example: 213
tags:
- 'New end points'
/connector/api/new_contactapi:
get:
summary: 'New List contact'
operationId: newListContact
description: ''
parameters:
-
in: query
name: type
description: 'Type of contact (supplier, customer)'
example: non
required: true
schema:
type: string
description: 'Type of contact (supplier, customer)'
example: non
-
in: query
name: customer_group_id
description: 'id of the customer group'
example: consequatur
required: false
schema:
type: string
description: 'id of the customer group'
example: consequatur
-
in: query
name: custom_field_1
description: 'Custom field 1 of the contact'
example: eos
required: false
schema:
type: string
description: 'Custom field 1 of the contact'
example: eos
-
in: query
name: contact_ids
description: 'comma separated ids of contacts'
example: '2,3'
required: false
schema:
type: string
description: 'comma separated ids of contacts'
example: '2,3'
-
in: query
name: name
description: 'Search term for contact name'
example: hic
required: false
schema:
type: string
description: 'Search term for contact name'
example: hic
-
in: query
name: biz_name
description: "Search term for contact's business name"
example: maxime
required: false
schema:
type: string
description: "Search term for contact's business name"
example: maxime
-
in: query
name: mobile_num
description: "Search term for contact's mobile number"
example: 2
required: false
schema:
type: integer
description: "Search term for contact's mobile number"
example: 2
-
in: query
name: contact_id
description: "Search term for contact's contact_id. Ex(CO0005)"
example: optio
required: false
schema:
type: string
description: "Search term for contact's contact_id. Ex(CO0005)"
example: optio
-
in: query
name: order_by
description: 'Column name to sort the result, Column: name, supplier_business_name'
example: est
required: false
schema:
type: string
description: 'Column name to sort the result, Column: name, supplier_business_name'
example: est
-
in: query
name: direction
description: 'Direction to sort the result, Direction: desc, asc'
example: optio
required: false
schema:
type: string
description: 'Direction to sort the result, Direction: desc, asc'
example: optio
-
in: query
name: per_page
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
required: false
schema:
type: integer
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/connector/api/new_contactapi?customer_group_id=1&page=1'
last: 'https://bqf.ai/connector/api/new_contactapi?customer_group_id=1&page=1'
prev: null
next: null
meta:
current_page: 1
from: 1
last_page: 1
path: 'https://bqf.ai/connector/api/new_contactapi'
per_page: 10
to: 1
total: 1
properties:
data:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 18
business_id:
type: integer
example: 1
type:
type: string
example: customer
name:
type: string
example: 'Mr. Rohit Kumar Agrawalla'
prefix:
type: string
example: Mr.
first_name:
type: string
example: Rohit
middle_name:
type: string
example: Kumar
last_name:
type: string
example: Agrawalla
email:
type: string
example: null
contact_status:
type: string
example: active
mobile:
type: string
example: '8596859647'
credit_limit:
type: string
example: null
converted_by:
type: string
example: null
converted_on:
type: string
example: null
balance:
type: string
example: '40.0000'
total_rp:
type: integer
example: 0
total_rp_used:
type: integer
example: 0
total_rp_expired:
type: integer
example: 0
customer_group_id:
type: integer
example: 1
crm_source:
type: string
example: null
crm_life_stage:
type: string
example: null
custom_field1:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
custom_field5:
type: string
example: null
custom_field6:
type: string
example: null
custom_field7:
type: string
example: null
custom_field8:
type: string
example: null
custom_field9:
type: string
example: null
custom_field10:
type: string
example: null
remember_token:
type: string
example: null
password:
type: string
example: null
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/new_contactapi?customer_group_id=1&page=1'
last:
type: string
example: 'https://bqf.ai/connector/api/new_contactapi?customer_group_id=1&page=1'
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/new_contactapi'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
total:
type: integer
example: 1
tags:
- 'New end points'
/connector/api/ecommerce/branches:
get:
summary: 'Store branches'
operationId: storeBranches
description: "The branches of the business as the store sees them, limited to the ones the user may\nwork with: which sell online, the default fulfilment branch, and which offer pickup."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 1
name: Riyadh
public_name: 'Riyadh — Olaya'
city: Riyadh
is_enabled: true
is_default: true
allow_pickup: true
properties:
data:
type: array
example:
-
id: 1
name: Riyadh
public_name: 'Riyadh — Olaya'
city: Riyadh
is_enabled: true
is_default: true
allow_pickup: true
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Riyadh
public_name:
type: string
example: 'Riyadh — Olaya'
city:
type: string
example: Riyadh
is_enabled:
type: boolean
example: true
is_default:
type: boolean
example: true
allow_pickup:
type: boolean
example: true
tags:
- 'Online store (Ecommerce)'
/connector/api/ecommerce/orders:
get:
summary: 'List online orders'
operationId: listOnlineOrders
description: 'Newest first, only the branches the user may see. Filters are optional.'
parameters:
-
in: query
name: status
description: 'One order status (awaiting_confirmation, confirmed, processing, shipped, delivered, completed, cancelled, refunded, on_hold).'
example: awaiting_confirmation
required: false
schema:
type: string
description: 'One order status (awaiting_confirmation, confirmed, processing, shipped, delivered, completed, cancelled, refunded, on_hold).'
example: awaiting_confirmation
-
in: query
name: payment_status
description: 'pending, paid, partially_refunded or refunded.'
example: pending
required: false
schema:
type: string
description: 'pending, paid, partially_refunded or refunded.'
example: pending
-
in: query
name: fulfilment_type
description: 'delivery or pickup.'
example: pickup
required: false
schema:
type: string
description: 'delivery or pickup.'
example: pickup
-
in: query
name: location_id
description: 'One branch (must be permitted).'
example: 1
required: false
schema:
type: integer
description: 'One branch (must be permitted).'
example: 1
-
in: query
name: from
description: 'date Placed on or after (Y-m-d).'
example: '2026-09-01'
required: false
schema:
type: string
description: 'date Placed on or after (Y-m-d).'
example: '2026-09-01'
-
in: query
name: to
description: 'date Placed on or before (Y-m-d).'
example: '2026-09-30'
required: false
schema:
type: string
description: 'date Placed on or before (Y-m-d).'
example: '2026-09-30'
-
in: query
name: q
description: 'Order number, customer name or phone.'
example: EC-000123
required: false
schema:
type: string
description: 'Order number, customer name or phone.'
example: EC-000123
-
in: query
name: per_page
description: '1..100, default 25.'
example: 25
required: false
schema:
type: integer
description: '1..100, default 25.'
example: 25
-
in: query
name: page
description: ''
example: 1
required: false
schema:
type: integer
description: ''
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 12
number: EC-000012
status: confirmed
status_label: مؤكّد
payment_status: pending
payment_gateway: cod
fulfilment_type: delivery
branch:
id: 1
name: Riyadh
customer:
name: Sara
phone: '0551234567'
total: 165.0
currency: SAR
items_count: 2
invoiced: true
placed_at: '2026-09-24 10:15:00'
meta:
current_page: 1
per_page: 25
total: 1
last_page: 1
properties:
data:
type: array
example:
-
id: 12
number: EC-000012
status: confirmed
status_label: مؤكّد
payment_status: pending
payment_gateway: cod
fulfilment_type: delivery
branch:
id: 1
name: Riyadh
customer:
name: Sara
phone: '0551234567'
total: 165
currency: SAR
items_count: 2
invoiced: true
placed_at: '2026-09-24 10:15:00'
items:
type: object
properties:
id:
type: integer
example: 12
number:
type: string
example: EC-000012
status:
type: string
example: confirmed
status_label:
type: string
example: مؤكّد
payment_status:
type: string
example: pending
payment_gateway:
type: string
example: cod
fulfilment_type:
type: string
example: delivery
branch:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Riyadh
customer:
type: object
properties:
name:
type: string
example: Sara
phone:
type: string
example: '0551234567'
total:
type: number
example: 165.0
currency:
type: string
example: SAR
items_count:
type: integer
example: 2
invoiced:
type: boolean
example: true
placed_at:
type: string
example: '2026-09-24 10:15:00'
meta:
type: object
properties:
current_page:
type: integer
example: 1
per_page:
type: integer
example: 25
total:
type: integer
example: 1
last_page:
type: integer
example: 1
tags:
- 'Online store (Ecommerce)'
'/connector/api/ecommerce/orders/{id}':
get:
summary: 'Order details'
operationId: orderDetails
description: 'The order with its lines, branch, customer, latest shipment, and status history.'
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 12
number: EC-000012
status: processing
status_label: 'قيد التجهيز'
fulfilment_type: pickup
branch:
id: 2
name: Jeddah
city: Jeddah
mobile: 0126...
customer:
name: Sara
phone: '0551234567'
email: null
address: ''
totals:
subtotal: 150.0
shipping_fee: 0.0
total: 150.0
currency: SAR
items:
-
product_id: 3
variation_id: 3
name: Item
sku: A1
qty: 2
unit_price: 75.0
line_total: 150.0
shipment: null
next_statuses:
- shipped
- cancelled
- refunded
- on_hold
history:
-
to: confirmed
at: '2026-09-24 10:20:00'
note: 'admin confirmed'
properties:
data:
type: object
properties:
id:
type: integer
example: 12
number:
type: string
example: EC-000012
status:
type: string
example: processing
status_label:
type: string
example: 'قيد التجهيز'
fulfilment_type:
type: string
example: pickup
branch:
type: object
properties:
id:
type: integer
example: 2
name:
type: string
example: Jeddah
city:
type: string
example: Jeddah
mobile:
type: string
example: 0126...
customer:
type: object
properties:
name:
type: string
example: Sara
phone:
type: string
example: '0551234567'
email:
type: string
example: null
address:
type: string
example: ''
totals:
type: object
properties:
subtotal:
type: number
example: 150.0
shipping_fee:
type: number
example: 0.0
total:
type: number
example: 150.0
currency:
type: string
example: SAR
items:
type: array
example:
-
product_id: 3
variation_id: 3
name: Item
sku: A1
qty: 2
unit_price: 75
line_total: 150
items:
type: object
properties:
product_id:
type: integer
example: 3
variation_id:
type: integer
example: 3
name:
type: string
example: Item
sku:
type: string
example: A1
qty:
type: integer
example: 2
unit_price:
type: number
example: 75.0
line_total:
type: number
example: 150.0
shipment:
type: string
example: null
next_statuses:
type: array
example:
- shipped
- cancelled
- refunded
- on_hold
items:
type: string
history:
type: array
example:
-
to: confirmed
at: '2026-09-24 10:20:00'
note: 'admin confirmed'
items:
type: object
properties:
to:
type: string
example: confirmed
at:
type: string
example: '2026-09-24 10:20:00'
note:
type: string
example: 'admin confirmed'
tags:
- 'Online store (Ecommerce)'
parameters:
-
in: path
name: id
description: ''
example: 12
required: true
schema:
type: integer
'/connector/api/ecommerce/orders/{id}/transition':
post:
summary: "Change an order's status"
operationId: changeAnOrdersStatus
description: "Moves the order along its lifecycle exactly as the back office does (the Core sale is\ncreated at the configured stage, stock returns on cancel). Only the transitions the\nstate machine allows from the current status are accepted (422 `transition_failed`)."
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
id: 12
status: confirmed
status_label: مؤكّد
next_statuses:
- processing
- cancelled
- refunded
properties:
success:
type: boolean
example: true
data:
type: object
properties:
id:
type: integer
example: 12
status:
type: string
example: confirmed
status_label:
type: string
example: مؤكّد
next_statuses:
type: array
example:
- processing
- cancelled
- refunded
items:
type: string
tags:
- 'Online store (Ecommerce)'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
to:
type: string
description: 'confirmed, processing, shipped, delivered, completed, cancelled, on_hold or awaiting_confirmation.'
example: confirmed
required:
- to
parameters:
-
in: path
name: id
description: ''
example: 12
required: true
schema:
type: integer
/connector/api/payment-accounts:
get:
summary: 'List payment accounts'
operationId: listPaymentAccounts
description: "Open accounts. Without the account.access permission the account number\nis masked to its last four digits and account_details is null."
parameters:
-
in: query
name: include_closed
description: 'optional 1 to include closed accounts (needs account.access)'
example: 1
required: false
schema:
type: integer
description: 'optional 1 to include closed accounts (needs account.access)'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: 'Test Account'
account_number:
type: string
example: '8746888847455'
account_type_id:
type: integer
example: 0
note:
type: string
example: null
created_by:
type: integer
example: 9
is_closed:
type: integer
example: 0
deleted_at:
type: string
example: null
created_at:
type: string
example: '2020-06-04 21:34:21'
updated_at:
type: string
example: '2020-06-04 21:34:21'
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/payment-methods:
get:
summary: 'List payment methods'
operationId: listPaymentMethods
description: "With the business's own labels for the custom methods."
parameters:
-
in: query
name: location_id
description: 'optional id of a branch: only the methods enabled for it'
example: '1'
required: false
schema:
type: string
description: 'optional id of a branch: only the methods enabled for it'
example: '1'
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
cash:
type: string
example: Cash
card:
type: string
example: Card
cheque:
type: string
example: Cheque
bank_transfer:
type: string
example: 'Bank Transfer'
other:
type: string
example: Other
custom_pay_1:
type: string
example: 'Custom Payment 1'
custom_pay_2:
type: string
example: 'Custom Payment 2'
custom_pay_3:
type: string
example: 'Custom Payment 3'
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/business-details:
get:
summary: 'Get business details'
operationId: getBusinessDetails
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Awesome Shop'
currency_id:
type: integer
example: 2
start_date:
type: string
example: '2018-01-01'
tax_number_1:
type: string
example: '3412569900'
tax_label_1:
type: string
example: GSTIN
tax_number_2:
type: string
example: null
tax_label_2:
type: string
example: null
default_sales_tax:
type: string
example: null
default_profit_percent:
type: integer
example: 25
owner_id:
type: integer
example: 1
time_zone:
type: string
example: America/Phoenix
fy_start_month:
type: integer
example: 1
accounting_method:
type: string
example: fifo
default_sales_discount:
type: string
example: '10.00'
sell_price_tax:
type: string
example: includes
logo:
type: string
example: null
sku_prefix:
type: string
example: AS
enable_product_expiry:
type: integer
example: 0
expiry_type:
type: string
example: add_expiry
on_product_expiry:
type: string
example: keep_selling
stop_selling_before:
type: integer
example: 0
enable_tooltip:
type: integer
example: 1
purchase_in_diff_currency:
type: integer
example: 0
purchase_currency_id:
type: string
example: null
p_exchange_rate:
type: string
example: '1.000'
transaction_edit_days:
type: integer
example: 30
stock_expiry_alert_days:
type: integer
example: 30
keyboard_shortcuts:
type: object
properties:
pos:
type: object
properties:
express_checkout:
type: string
example: shift+e
pay_n_ckeckout:
type: string
example: shift+p
draft:
type: string
example: shift+d
cancel:
type: string
example: shift+c
recent_product_quantity:
type: string
example: f2
weighing_scale:
type: string
example: null
edit_discount:
type: string
example: shift+i
edit_order_tax:
type: string
example: shift+t
add_payment_row:
type: string
example: shift+r
finalize_payment:
type: string
example: shift+f
add_new_product:
type: string
example: f4
pos_settings:
type: object
properties:
amount_rounding_method:
type: string
example: null
disable_pay_checkout:
type: integer
example: 0
disable_draft:
type: integer
example: 0
disable_express_checkout:
type: integer
example: 0
hide_product_suggestion:
type: integer
example: 0
hide_recent_trans:
type: integer
example: 0
disable_discount:
type: integer
example: 0
disable_order_tax:
type: integer
example: 0
is_pos_subtotal_editable:
type: integer
example: 0
weighing_scale_setting:
type: object
properties:
label_prefix:
type: string
example: null
product_sku_length:
type: string
example: '4'
qty_length:
type: string
example: '3'
qty_length_decimal:
type: string
example: '2'
manufacturing_settings:
type: string
example: null
essentials_settings:
type: string
example: null
ecom_settings:
type: string
example: null
woocommerce_wh_oc_secret:
type: string
example: null
woocommerce_wh_ou_secret:
type: string
example: null
woocommerce_wh_od_secret:
type: string
example: null
woocommerce_wh_or_secret:
type: string
example: null
enable_brand:
type: integer
example: 1
enable_category:
type: integer
example: 1
enable_sub_category:
type: integer
example: 1
enable_price_tax:
type: integer
example: 1
enable_purchase_status:
type: integer
example: 1
enable_lot_number:
type: integer
example: 0
default_unit:
type: string
example: null
enable_sub_units:
type: integer
example: 0
enable_racks:
type: integer
example: 0
enable_row:
type: integer
example: 0
enable_position:
type: integer
example: 0
enable_editing_product_from_purchase:
type: integer
example: 1
sales_cmsn_agnt:
type: string
example: null
item_addition_method:
type: integer
example: 1
enable_inline_tax:
type: integer
example: 1
currency_symbol_placement:
type: string
example: before
enabled_modules:
type: array
example:
- purchases
- add_sale
- pos_sale
- stock_transfers
- stock_adjustment
- expenses
- account
- tables
- modifiers
- service_staff
- booking
- kitchen
- subscription
- types_of_service
items:
type: string
date_format:
type: string
example: m/d/Y
time_format:
type: string
example: '24'
ref_no_prefixes:
type: object
properties:
purchase:
type: string
example: PO
purchase_return:
type: string
example: null
stock_transfer:
type: string
example: ST
stock_adjustment:
type: string
example: SA
sell_return:
type: string
example: CN
expense:
type: string
example: EP
contacts:
type: string
example: CO
purchase_payment:
type: string
example: PP
sell_payment:
type: string
example: SP
expense_payment:
type: string
example: null
business_location:
type: string
example: BL
username:
type: string
example: null
subscription:
type: string
example: null
theme_color:
type: string
example: null
created_by:
type: string
example: null
enable_rp:
type: integer
example: 0
rp_name:
type: string
example: null
amount_for_unit_rp:
type: string
example: '1.0000'
min_order_total_for_rp:
type: string
example: '1.0000'
max_rp_per_order:
type: string
example: null
redeem_amount_per_unit_rp:
type: string
example: '1.0000'
min_order_total_for_redeem:
type: string
example: '1.0000'
min_redeem_point:
type: string
example: null
max_redeem_point:
type: string
example: null
rp_expiry_period:
type: string
example: null
rp_expiry_type:
type: string
example: year
repair_settings:
type: string
example: null
email_settings:
type: object
properties:
mail_driver:
type: string
example: smtp
mail_host:
type: string
example: null
mail_port:
type: string
example: null
mail_username:
type: string
example: null
mail_password:
type: string
example: null
mail_encryption:
type: string
example: null
mail_from_address:
type: string
example: null
mail_from_name:
type: string
example: null
sms_settings:
type: object
properties:
url:
type: string
example: null
send_to_param_name:
type: string
example: to
msg_param_name:
type: string
example: text
request_method:
type: string
example: post
param_1:
type: string
example: null
param_val_1:
type: string
example: null
param_2:
type: string
example: null
param_val_2:
type: string
example: null
param_3:
type: string
example: null
param_val_3:
type: string
example: null
param_4:
type: string
example: null
param_val_4:
type: string
example: null
param_5:
type: string
example: null
param_val_5:
type: string
example: null
param_6:
type: string
example: null
param_val_6:
type: string
example: null
param_7:
type: string
example: null
param_val_7:
type: string
example: null
param_8:
type: string
example: null
param_val_8:
type: string
example: null
param_9:
type: string
example: null
param_val_9:
type: string
example: null
param_10:
type: string
example: null
param_val_10:
type: string
example: null
custom_labels:
type: object
properties:
payments:
type: object
properties:
custom_pay_1:
type: string
example: null
custom_pay_2:
type: string
example: null
custom_pay_3:
type: string
example: null
contact:
type: object
properties:
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
product:
type: object
properties:
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
location:
type: object
properties:
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
user:
type: object
properties:
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
purchase:
type: object
properties:
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
sell:
type: object
properties:
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
types_of_service:
type: object
properties:
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
common_settings:
type: object
properties:
default_datatable_page_entries:
type: string
example: '25'
is_active:
type: integer
example: 1
created_at:
type: string
example: '2018-01-04 02:15:19'
updated_at:
type: string
example: '2020-06-04 22:33:01'
locations:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
location_id:
type: string
example: null
name:
type: string
example: 'Awesome Shop'
landmark:
type: string
example: 'Linking Street'
country:
type: string
example: USA
state:
type: string
example: Arizona
city:
type: string
example: Phoenix
zip_code:
type: string
example: '85001'
invoice_scheme_id:
type: integer
example: 1
invoice_layout_id:
type: integer
example: 1
selling_price_group_id:
type: string
example: null
print_receipt_on_invoice:
type: integer
example: 1
receipt_printer_type:
type: string
example: browser
printer_id:
type: string
example: null
mobile:
type: string
example: null
alternate_number:
type: string
example: null
email:
type: string
example: null
website:
type: string
example: null
featured_products:
type: array
example:
- '5'
- '71'
items:
type: string
is_active:
type: integer
example: 1
default_payment_accounts:
type: object
properties:
cash:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
card:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
cheque:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
bank_transfer:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
other:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
custom_pay_1:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
custom_pay_2:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
custom_pay_3:
type: object
properties:
is_enabled:
type: string
example: '1'
account:
type: string
example: null
custom_field1:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:20'
updated_at:
type: string
example: '2020-06-05 00:56:54'
currency:
type: object
properties:
id:
type: integer
example: 2
country:
type: string
example: America
currency:
type: string
example: Dollars
code:
type: string
example: USD
symbol:
type: string
example: $
thousand_separator:
type: string
example: ','
decimal_separator:
type: string
example: .
created_at:
type: string
example: null
updated_at:
type: string
example: null
printers:
type: array
example: []
currency_precision:
type: integer
example: 2
quantity_precision:
type: integer
example: 2
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/profit-loss-report:
get:
summary: 'Get profit and loss report'
operationId: getProfitAndLossReport
description: ''
parameters:
-
in: query
name: location_id
description: 'optional id of the location'
example: '1'
required: false
schema:
type: string
description: 'optional id of the location'
example: '1'
-
in: query
name: start_date
description: 'optional format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'optional format:Y-m-d'
example: '2018-06-25'
-
in: query
name: end_date
description: 'optional format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'optional format:Y-m-d'
example: '2018-06-25'
-
in: query
name: user_id
description: 'optional id of the user'
example: '1'
required: false
schema:
type: string
description: 'optional id of the user'
example: '1'
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: []
properties:
data:
type: object
properties:
total_purchase_shipping_charge:
type: integer
example: 0
total_sell_shipping_charge:
type: integer
example: 0
total_transfer_shipping_charges:
type: string
example: '0.0000'
opening_stock:
type: integer
example: 0
closing_stock:
type: string
example: '386859.00000000'
total_purchase:
type: integer
example: 386936
total_purchase_discount:
type: string
example: '0.000000000000'
total_purchase_return:
type: string
example: '0.0000'
total_sell:
type: number
example: 9764.5
total_sell_discount:
type: string
example: '11.550000000000'
total_sell_return:
type: string
example: '0.0000'
total_sell_round_off:
type: string
example: '0.0000'
total_expense:
type: string
example: '0.0000'
total_adjustment:
type: string
example: '0.0000'
total_recovered:
type: string
example: '0.0000'
total_reward_amount:
type: string
example: '0.0000'
left_side_module_data:
type: array
example:
-
value: '0.0000'
label: 'Total Payroll'
add_to_net_profit: true
-
value: 0
label: 'Total Production Cost'
add_to_net_profit: true
items:
type: object
properties:
value:
type: string
example: '0.0000'
label:
type: string
example: 'Total Payroll'
add_to_net_profit:
type: boolean
example: true
right_side_module_data:
type: array
example: []
net_profit:
type: number
example: 9675.95
gross_profit:
type: number
example: -11.55
total_sell_by_subtype:
type: array
example: []
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/pos-dashboard-stats:
get:
summary: 'Aggregated POS home stats (one SQL round-trip, not a full sell list).'
operationId: aggregatedPOSHomeStatsoneSQLRoundTripNotAFullSellList
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/pos-customer-search:
get:
summary: 'Search customers at the till'
operationId: searchCustomersAtTheTill
description: "Active customers the user may pick, as the web POS customer picker lists\nthem. A customer.view_own user finds only their own customers. A\nbranch-limited user finds another branch's customer only by the full mobile\nnumber (to sell to it, send that number as the sale's customer_mobile).\n\ndue: what the customer owes (final sales net of payments, ledger discounts and\nreturns, plus the unpaid opening balance). advance_balance: the customer's credit\n(advance paid). Until 2026-09 'due' carried the advance balance."
parameters:
-
in: query
name: search
description: 'optional name, mobile or customer number (part of)'
example: 55
required: false
schema:
type: integer
description: 'optional name, mobile or customer number (part of)'
example: 55
-
in: query
name: per_page
description: 'optional Most rows to return (1-30). default: 20'
example: '20'
required: false
schema:
type: string
description: 'optional Most rows to return (1-30). default: 20'
example: '20'
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
-
id: 12
name: 'Walk-In Customer'
mobile: '0550000000'
customer_no: CO0001
due: 150.5
advance_balance: 20
invoices: 7
last_sale: '2026-09-01 10:15:00'
properties:
data:
type: array
example:
-
id: 12
name: 'Walk-In Customer'
mobile: '0550000000'
customer_no: CO0001
due: 150.5
advance_balance: 20
invoices: 7
last_sale: '2026-09-01 10:15:00'
items:
type: object
properties:
id:
type: integer
example: 12
name:
type: string
example: 'Walk-In Customer'
mobile:
type: string
example: '0550000000'
customer_no:
type: string
example: CO0001
due:
type: number
example: 150.5
advance_balance:
type: integer
example: 20
invoices:
type: integer
example: 7
last_sale:
type: string
example: '2026-09-01 10:15:00'
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/product-stock-report:
get:
summary: 'Get product current stock'
operationId: getProductCurrentStock
description: 'Needs the stock_report.view permission.'
parameters:
-
in: query
name: location_id
description: 'optional id of the location'
example: '1'
required: false
schema:
type: string
description: 'optional id of the location'
example: '1'
-
in: query
name: per_page
description: 'optional Total records per page (up to 500). default: 15, -1 for the largest page'
example: 15
required: false
schema:
type: integer
description: 'optional Total records per page (up to 500). default: 15, -1 for the largest page'
example: 15
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/connector/api/product-stock-report?page=1'
last: 'https://bqf.ai/connector/api/product-stock-report?page=22'
prev: null
next: 'https://bqf.ai/connector/api/product-stock-report?page=2'
meta:
current_page: 1
from: 1
last_page: 22
path: 'https://bqf.ai/connector/api/product-stock-report'
per_page: 3
to: 3
total: 66
properties:
data:
type: array
example:
-
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
items:
type: object
properties:
total_sold:
type: string
example: null
total_transfered:
type: string
example: null
total_adjusted:
type: string
example: null
stock_price:
type: string
example: null
stock:
type: string
example: null
sku:
type: string
example: AS0001
product:
type: string
example: "Men's Reverse Fleece Crew"
type:
type: string
example: single
product_id:
type: integer
example: 1
unit:
type: string
example: Pc(s)
enable_stock:
type: integer
example: 1
unit_price:
type: string
example: '143.0000'
product_variation:
type: string
example: DUMMY
variation_name:
type: string
example: DUMMY
location_name:
type: string
example: null
location_id:
type: string
example: null
variation_id:
type: integer
example: 1
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/product-stock-report?page=1'
last:
type: string
example: 'https://bqf.ai/connector/api/product-stock-report?page=22'
prev:
type: string
example: null
next:
type: string
example: 'https://bqf.ai/connector/api/product-stock-report?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
last_page:
type: integer
example: 22
path:
type: string
example: 'https://bqf.ai/connector/api/product-stock-report'
per_page:
type: integer
example: 3
to:
type: integer
example: 3
total:
type: integer
example: 66
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/notifications:
get:
summary: 'Get notifications'
operationId: getNotifications
description: 'Newest first.'
parameters:
-
in: query
name: limit
description: 'optional Most notifications to return (1-500). default: 500'
example: '50'
required: false
schema:
type: string
description: 'optional Most notifications to return (1-500). default: 500'
example: '50'
-
in: query
name: unread_only
description: 'optional 1 for unread notifications only'
example: '1'
required: false
schema:
type: string
description: 'optional 1 for unread notifications only'
example: '1'
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/hrm/payroll'
read_at: null
created_at: '3 hours ago'
properties:
data:
type: array
example:
-
msg: 'Payroll for August/2020 added by Mr. Super Admin. Reference No. 2020/0002'
icon_class: 'fas fa-money-bill-alt bg-green'
link: 'https://bqf.ai/hrm/payroll'
read_at: null
created_at: '3 hours ago'
items:
type: object
properties:
msg:
type: string
example: 'Payroll for August/2020 added by Mr. Super Admin. Reference No. 2020/0002'
icon_class:
type: string
example: 'fas fa-money-bill-alt bg-green'
link:
type: string
example: 'https://bqf.ai/hrm/payroll'
read_at:
type: string
example: null
created_at:
type: string
example: '3 hours ago'
tags:
- 'Other endpoints · واجهات أخرى'
/connector/api/get-location:
get:
summary: 'Get location details from coordinates'
operationId: getLocationDetailsFromCoordinates
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
address: 'Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India'
properties:
address:
type: string
example: 'Radhanath Mullick Ln, Tiretta Bazaar, Bow Bazaar, Kolkata, West Bengal, 700 073, India'
tags:
- 'Other endpoints · واجهات أخرى'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
lat:
type: decimal
description: 'Lattitude of the location'
example: '41.40338'
lon:
type: decimal
description: 'Longitude of the location'
example: '2.17403'
required:
- lat
- lon
/connector/api/crm/pipeline:
get:
summary: ''
operationId: getConnectorApiCrmPipeline
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
/connector/api/crm/segments:
get:
summary: ''
operationId: getConnectorApiCrmSegments
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
'/connector/api/crm/segments/{segment}/contacts':
get:
summary: ''
operationId: getConnectorApiCrmSegmentsSegmentContacts
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
parameters:
-
in: path
name: segment
description: 'The segment.'
example: adipisci
required: true
schema:
type: string
'/connector/api/crm/contacts/{id}/metrics':
get:
summary: ''
operationId: getConnectorApiCrmContactsIdMetrics
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
parameters:
-
in: path
name: id
description: 'The ID of the contact.'
example: magnam
required: true
schema:
type: string
/connector/api/crm/leads-list:
get:
summary: ''
operationId: getConnectorApiCrmLeadsList
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
'/connector/api/crm/leads/{id}':
get:
summary: ''
operationId: getConnectorApiCrmLeadsId
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
put:
summary: ''
operationId: putConnectorApiCrmLeadsId
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
first_name:
type: string
description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).'
example: meheewfhniiayvbwsusps
last_name:
type: string
description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).'
example: yxet
business_name:
type: string
description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).'
example: vlwsbyqpolvbos
mobile:
type: string
description: 'لا يمكن أن يحتوي النص value على أكثر من 50 حرف (أحرف).'
example: mepdnvafjjljx
email:
type: string
description: 'يجب أن يكون الحقل value عنوان بريد إلكتروني صالحًا. لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).'
example: johnpaul.eichmann@example.com
source_id:
type: integer
description: ''
example: 14
life_stage_id:
type: integer
description: ''
example: 3
city:
type: string
description: 'لا يمكن أن يحتوي النص value على أكثر من 255 حرف (أحرف).'
example: mmcrzbcfvqmrpfco
expected_value:
type: number
description: 'يجب أن تكون قيمة value أكبر من أو تساوي 0.'
example: 23
probability:
type: integer
description: 'يجب أن تكون قيمة value أكبر من أو تساوي 0. لا يمكن أن تكون قيمة value أكبر من 100.'
example: 15
expected_close_date:
type: string
description: 'الحقل value ليس تاريخًا صالحًا.'
example: '2026-09-24T21:24:58'
assigned_user_ids:
type: array
description: ''
example:
- 6
items:
type: integer
security: []
parameters:
-
in: path
name: id
description: 'The ID of the lead.'
example: molestiae
required: true
schema:
type: string
'/connector/api/crm/leads/{id}/convert':
post:
summary: ''
operationId: postConnectorApiCrmLeadsIdConvert
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
parameters:
-
in: path
name: id
description: 'The ID of the lead.'
example: illum
required: true
schema:
type: string
/connector/api/crm/webhook-events:
get:
summary: ''
operationId: getConnectorApiCrmWebhookEvents
description: ''
parameters: []
responses: { }
tags:
- 'Other endpoints · واجهات أخرى'
security: []
/connector/api/product:
get:
summary: 'List products'
operationId: listProducts
description: ''
parameters:
-
in: query
name: order_by
description: 'Values: product_name or newest'
example: beatae
required: false
schema:
type: string
description: 'Values: product_name or newest'
example: beatae
-
in: query
name: order_direction
description: 'Values: asc or desc'
example: earum
required: false
schema:
type: string
description: 'Values: asc or desc'
example: earum
-
in: query
name: brand_id
description: 'comma separated ids of one or multiple brands'
example: quia
required: false
schema:
type: string
description: 'comma separated ids of one or multiple brands'
example: quia
-
in: query
name: category_id
description: 'comma separated ids of one or multiple category'
example: quis
required: false
schema:
type: string
description: 'comma separated ids of one or multiple category'
example: quis
-
in: query
name: sub_category_id
description: 'comma separated ids of one or multiple sub-category'
example: et
required: false
schema:
type: string
description: 'comma separated ids of one or multiple sub-category'
example: et
-
in: query
name: location_id
description: ''
example: '1'
required: false
schema:
type: string
description: ''
example: '1'
-
in: query
name: selling_price_group
description: '(1, 0)'
example: in
required: false
schema:
type: string
description: '(1, 0)'
example: in
-
in: query
name: send_lot_detail
description: 'Send lot details in each variation location details(1, 0)'
example: tempore
required: false
schema:
type: string
description: 'Send lot details in each variation location details(1, 0)'
example: tempore
-
in: query
name: name
description: 'Search term for product name'
example: nobis
required: false
schema:
type: string
description: 'Search term for product name'
example: nobis
-
in: query
name: sku
description: 'Search term for product sku'
example: quia
required: false
schema:
type: string
description: 'Search term for product sku'
example: quia
-
in: query
name: per_page
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
required: false
schema:
type: integer
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/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: 'https://bqf.ai/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: 'https://bqf.ai/connector/api/product?page=1'
last: 'https://bqf.ai/connector/api/product?page=32'
prev: null
next: 'https://bqf.ai/connector/api/product?page=2'
meta:
current_page: 1
from: 1
path: 'https://bqf.ai/connector/api/product'
per_page: 10
to: 10
properties:
data:
type: array
example:
-
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: 'https://bqf.ai/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: 'https://bqf.ai/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
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's Reverse Fleece Crew"
business_id:
type: integer
example: 1
type:
type: string
example: single
sub_unit_ids:
type: string
example: null
enable_stock:
type: integer
example: 1
alert_quantity:
type: string
example: '5.0000'
sku:
type: string
example: AS0001
barcode_type:
type: string
example: C128
expiry_period:
type: string
example: null
expiry_period_type:
type: string
example: null
enable_sr_no:
type: integer
example: 0
weight:
type: string
example: null
product_custom_field1:
type: string
example: null
product_custom_field2:
type: string
example: null
product_custom_field3:
type: string
example: null
product_custom_field4:
type: string
example: null
image:
type: string
example: null
woocommerce_media_id:
type: string
example: null
product_description:
type: string
example: null
created_by:
type: integer
example: 1
warranty_id:
type: string
example: null
is_inactive:
type: integer
example: 0
repair_model_id:
type: string
example: null
not_for_selling:
type: integer
example: 0
ecom_shipping_class_id:
type: string
example: null
ecom_active_in_store:
type: integer
example: 1
woocommerce_product_id:
type: integer
example: 356
woocommerce_disable_sync:
type: integer
example: 0
image_url:
type: string
example: 'https://bqf.ai/img/default.png'
product_variations:
type: array
example:
-
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: 'https://bqf.ai/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'
items:
type: object
properties:
id:
type: integer
example: 1
variation_template_id:
type: string
example: null
name:
type: string
example: DUMMY
product_id:
type: integer
example: 1
is_dummy:
type: integer
example: 1
created_at:
type: string
example: '2018-01-03 21:29:08'
updated_at:
type: string
example: '2018-01-03 21:29:08'
variations:
type: array
example:
-
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: 'https://bqf.ai/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' }
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: DUMMY
product_id:
type: integer
example: 1
sub_sku:
type: string
example: AS0001
product_variation_id:
type: integer
example: 1
woocommerce_variation_id:
type: string
example: null
variation_value_id:
type: string
example: null
default_purchase_price:
type: string
example: '130.0000'
dpp_inc_tax:
type: string
example: '143.0000'
profit_percent:
type: string
example: '0.0000'
default_sell_price:
type: string
example: '130.0000'
sell_price_inc_tax:
type: string
example: '143.0000'
created_at:
type: string
example: '2018-01-03 21:29:08'
updated_at:
type: string
example: '2020-06-09 00:23:22'
deleted_at:
type: string
example: null
combo_variations:
type: string
example: null
variation_location_details:
type: array
example: [{ 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' }]
items: { type: object, properties: { id: { type: integer, example: 56 }, product_id: { type: integer, example: 1 }, product_variation_id: { type: integer, example: 1 }, variation_id: { type: integer, example: 1 }, location_id: { type: integer, example: 1 }, qty_available: { type: string, example: '20.0000' }, created_at: { type: string, example: '2020-06-08 23:46:40' }, updated_at: { type: string, example: '2020-06-08 23:46:40' } } }
media:
type: array
example: [{ 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: 'https://bqf.ai/uploads/media/1591686466_978227300_nn.jpeg' }]
items: { type: object, properties: { id: { type: integer, example: 1 }, business_id: { type: integer, example: 1 }, file_name: { type: string, example: 1591686466_978227300_nn.jpeg }, description: { type: string, example: null }, uploaded_by: { type: integer, example: 9 }, model_type: { type: string, example: App\Variation }, woocommerce_media_id: { type: string, example: null }, model_id: { type: integer, example: 1 }, created_at: { type: string, example: '2020-06-09 00:07:46' }, updated_at: { type: string, example: '2020-06-09 00:07:46' }, display_name: { type: string, example: nn.jpeg }, display_url: { type: string, example: 'https://bqf.ai/uploads/media/1591686466_978227300_nn.jpeg' } } }
discounts:
type: array
example: [{ 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' }]
items: { type: object, properties: { id: { type: integer, example: 2 }, name: { type: string, example: 'FLAT 10%' }, business_id: { type: integer, example: 1 }, brand_id: { type: string, example: null }, category_id: { type: string, example: null }, location_id: { type: integer, example: 1 }, priority: { type: integer, example: 2 }, discount_type: { type: string, example: fixed }, discount_amount: { type: string, example: '5.0000' }, starts_at: { type: string, example: '2021-09-01 11:45:00' }, ends_at: { type: string, example: '2021-09-30 11:45:00' }, is_active: { type: integer, example: 1 }, spg: { type: string, example: null }, applicable_in_cg: { type: integer, example: 1 }, created_at: { type: string, example: '2021-09-01 11:46:00' }, updated_at: { type: string, example: '2021-09-01 12:12:55' }, formated_starts_at: { type: string, example: ' 11:45' }, formated_ends_at: { type: string, example: ' 11:45' } } }
selling_price_group:
type: array
example: [{ 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' }]
items: { type: object, properties: { id: { type: integer, example: 2 }, variation_id: { type: integer, example: 1 }, price_group_id: { type: integer, example: 1 }, price_inc_tax: { type: string, example: '140.0000' }, created_at: { type: string, example: '2020-06-09 00:23:31' }, updated_at: { type: string, example: '2020-06-09 00:23:31' } } }
brand:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: Levis
description:
type: string
example: null
created_by:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:19:47'
updated_at:
type: string
example: '2018-01-03 21:19:47'
unit:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
actual_name:
type: string
example: Pieces
short_name:
type: string
example: Pc(s)
allow_decimal:
type: integer
example: 0
base_unit_id:
type: string
example: null
base_unit_multiplier:
type: string
example: null
created_by:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 15:15:20'
updated_at:
type: string
example: '2018-01-03 15:15:20'
category:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's"
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 0
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:06:34'
updated_at:
type: string
example: '2018-01-03 21:06:34'
sub_category:
type: object
properties:
id:
type: integer
example: 5
name:
type: string
example: Shirts
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 1
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:08:18'
updated_at:
type: string
example: '2018-01-03 21:08:18'
product_tax:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: VAT@10%
amount:
type: integer
example: 10
is_tax_group:
type: integer
example: 0
created_by:
type: integer
example: 1
woocommerce_tax_rate_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:40:07'
updated_at:
type: string
example: '2018-01-04 02:40:07'
product_locations:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
location_id:
type: string
example: null
name:
type: string
example: 'Awesome Shop'
landmark:
type: string
example: 'Linking Street'
country:
type: string
example: USA
state:
type: string
example: Arizona
city:
type: string
example: Phoenix
zip_code:
type: string
example: '85001'
invoice_scheme_id:
type: integer
example: 1
invoice_layout_id:
type: integer
example: 1
selling_price_group_id:
type: string
example: null
print_receipt_on_invoice:
type: integer
example: 1
receipt_printer_type:
type: string
example: browser
printer_id:
type: string
example: null
mobile:
type: string
example: null
alternate_number:
type: string
example: null
email:
type: string
example: null
website:
type: string
example: null
featured_products:
type: array
example:
- '5'
- '71'
items:
type: string
is_active:
type: integer
example: 1
default_payment_accounts:
type: string
example: '{"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:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:20'
updated_at:
type: string
example: '2020-06-09 01:07:05'
pivot:
type: object
properties:
product_id:
type: integer
example: 2
location_id:
type: integer
example: 1
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/product?page=1'
last:
type: string
example: 'https://bqf.ai/connector/api/product?page=32'
prev:
type: string
example: null
next:
type: string
example: 'https://bqf.ai/connector/api/product?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/product'
per_page:
type: integer
example: 10
to:
type: integer
example: 10
tags:
- 'Product management'
'/connector/api/product/{id}':
get:
summary: 'Get the specified product'
operationId: getTheSpecifiedProduct
description: ''
parameters:
-
in: query
name: selling_price_group
description: '(1, 0)'
example: quo
required: false
schema:
type: string
description: '(1, 0)'
example: quo
-
in: query
name: send_lot_detail
description: 'Send lot details in each variation location details(1, 0)'
example: quibusdam
required: false
schema:
type: string
description: 'Send lot details in each variation location details(1, 0)'
example: quibusdam
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/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: 'https://bqf.ai/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
properties:
data:
type: array
example:
-
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: 'https://bqf.ai/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: 'https://bqf.ai/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
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's Reverse Fleece Crew"
business_id:
type: integer
example: 1
type:
type: string
example: single
sub_unit_ids:
type: string
example: null
enable_stock:
type: integer
example: 1
alert_quantity:
type: string
example: '5.0000'
sku:
type: string
example: AS0001
barcode_type:
type: string
example: C128
expiry_period:
type: string
example: null
expiry_period_type:
type: string
example: null
enable_sr_no:
type: integer
example: 0
weight:
type: string
example: null
product_custom_field1:
type: string
example: null
product_custom_field2:
type: string
example: null
product_custom_field3:
type: string
example: null
product_custom_field4:
type: string
example: null
image:
type: string
example: null
woocommerce_media_id:
type: string
example: null
product_description:
type: string
example: null
created_by:
type: integer
example: 1
warranty_id:
type: string
example: null
is_inactive:
type: integer
example: 0
repair_model_id:
type: string
example: null
not_for_selling:
type: integer
example: 0
ecom_shipping_class_id:
type: string
example: null
ecom_active_in_store:
type: integer
example: 1
woocommerce_product_id:
type: integer
example: 356
woocommerce_disable_sync:
type: integer
example: 0
image_url:
type: string
example: 'https://bqf.ai/img/default.png'
product_variations:
type: array
example:
-
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: 'https://bqf.ai/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'
items:
type: object
properties:
id:
type: integer
example: 1
variation_template_id:
type: string
example: null
name:
type: string
example: DUMMY
product_id:
type: integer
example: 1
is_dummy:
type: integer
example: 1
created_at:
type: string
example: '2018-01-03 21:29:08'
updated_at:
type: string
example: '2018-01-03 21:29:08'
variations:
type: array
example:
-
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: 'https://bqf.ai/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' }
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: DUMMY
product_id:
type: integer
example: 1
sub_sku:
type: string
example: AS0001
product_variation_id:
type: integer
example: 1
woocommerce_variation_id:
type: string
example: null
variation_value_id:
type: string
example: null
default_purchase_price:
type: string
example: '130.0000'
dpp_inc_tax:
type: string
example: '143.0000'
profit_percent:
type: string
example: '0.0000'
default_sell_price:
type: string
example: '130.0000'
sell_price_inc_tax:
type: string
example: '143.0000'
created_at:
type: string
example: '2018-01-03 21:29:08'
updated_at:
type: string
example: '2020-06-09 00:23:22'
deleted_at:
type: string
example: null
combo_variations:
type: string
example: null
variation_location_details:
type: array
example: [{ 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' }]
items: { type: object, properties: { id: { type: integer, example: 56 }, product_id: { type: integer, example: 1 }, product_variation_id: { type: integer, example: 1 }, variation_id: { type: integer, example: 1 }, location_id: { type: integer, example: 1 }, qty_available: { type: string, example: '20.0000' }, created_at: { type: string, example: '2020-06-08 23:46:40' }, updated_at: { type: string, example: '2020-06-08 23:46:40' } } }
media:
type: array
example: [{ 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: 'https://bqf.ai/uploads/media/1591686466_978227300_nn.jpeg' }]
items: { type: object, properties: { id: { type: integer, example: 1 }, business_id: { type: integer, example: 1 }, file_name: { type: string, example: 1591686466_978227300_nn.jpeg }, description: { type: string, example: null }, uploaded_by: { type: integer, example: 9 }, model_type: { type: string, example: App\Variation }, woocommerce_media_id: { type: string, example: null }, model_id: { type: integer, example: 1 }, created_at: { type: string, example: '2020-06-09 00:07:46' }, updated_at: { type: string, example: '2020-06-09 00:07:46' }, display_name: { type: string, example: nn.jpeg }, display_url: { type: string, example: 'https://bqf.ai/uploads/media/1591686466_978227300_nn.jpeg' } } }
discounts:
type: array
example: [{ 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' }]
items: { type: object, properties: { id: { type: integer, example: 2 }, name: { type: string, example: 'FLAT 10%' }, business_id: { type: integer, example: 1 }, brand_id: { type: string, example: null }, category_id: { type: string, example: null }, location_id: { type: integer, example: 1 }, priority: { type: integer, example: 2 }, discount_type: { type: string, example: fixed }, discount_amount: { type: string, example: '5.0000' }, starts_at: { type: string, example: '2021-09-01 11:45:00' }, ends_at: { type: string, example: '2021-09-30 11:45:00' }, is_active: { type: integer, example: 1 }, spg: { type: string, example: null }, applicable_in_cg: { type: integer, example: 1 }, created_at: { type: string, example: '2021-09-01 11:46:00' }, updated_at: { type: string, example: '2021-09-01 12:12:55' }, formated_starts_at: { type: string, example: ' 11:45' }, formated_ends_at: { type: string, example: ' 11:45' } } }
selling_price_group:
type: array
example: [{ 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' }]
items: { type: object, properties: { id: { type: integer, example: 2 }, variation_id: { type: integer, example: 1 }, price_group_id: { type: integer, example: 1 }, price_inc_tax: { type: string, example: '140.0000' }, created_at: { type: string, example: '2020-06-09 00:23:31' }, updated_at: { type: string, example: '2020-06-09 00:23:31' } } }
brand:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: Levis
description:
type: string
example: null
created_by:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:19:47'
updated_at:
type: string
example: '2018-01-03 21:19:47'
unit:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
actual_name:
type: string
example: Pieces
short_name:
type: string
example: Pc(s)
allow_decimal:
type: integer
example: 0
base_unit_id:
type: string
example: null
base_unit_multiplier:
type: string
example: null
created_by:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 15:15:20'
updated_at:
type: string
example: '2018-01-03 15:15:20'
category:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's"
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 0
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:06:34'
updated_at:
type: string
example: '2018-01-03 21:06:34'
sub_category:
type: object
properties:
id:
type: integer
example: 5
name:
type: string
example: Shirts
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 1
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:08:18'
updated_at:
type: string
example: '2018-01-03 21:08:18'
product_tax:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: VAT@10%
amount:
type: integer
example: 10
is_tax_group:
type: integer
example: 0
created_by:
type: integer
example: 1
woocommerce_tax_rate_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:40:07'
updated_at:
type: string
example: '2018-01-04 02:40:07'
product_locations:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
location_id:
type: string
example: null
name:
type: string
example: 'Awesome Shop'
landmark:
type: string
example: 'Linking Street'
country:
type: string
example: USA
state:
type: string
example: Arizona
city:
type: string
example: Phoenix
zip_code:
type: string
example: '85001'
invoice_scheme_id:
type: integer
example: 1
invoice_layout_id:
type: integer
example: 1
selling_price_group_id:
type: string
example: null
print_receipt_on_invoice:
type: integer
example: 1
receipt_printer_type:
type: string
example: browser
printer_id:
type: string
example: null
mobile:
type: string
example: null
alternate_number:
type: string
example: null
email:
type: string
example: null
website:
type: string
example: null
featured_products:
type: array
example:
- '5'
- '71'
items:
type: string
is_active:
type: integer
example: 1
default_payment_accounts:
type: string
example: '{"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:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:20'
updated_at:
type: string
example: '2020-06-09 01:07:05'
pivot:
type: object
properties:
product_id:
type: integer
example: 2
location_id:
type: integer
example: 1
tags:
- 'Product management'
parameters:
-
in: path
name: id
description: 'The ID of the product.'
example: quae
required: true
schema:
type: string
-
in: path
name: product
description: 'comma separated ids of products'
example: '1'
required: true
schema:
type: string
/connector/api/selling-price-group:
get:
summary: 'List Selling Price Group'
operationId: listSellingPriceGroup
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: Retail
description:
type: string
example: null
business_id:
type: integer
example: 1
is_active:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2020-10-21 04:30:06'
updated_at:
type: string
example: '2020-11-16 18:23:15'
tags:
- 'Product management'
'/connector/api/variation/{id}':
get:
summary: 'List Variations'
operationId: listVariations
description: ''
parameters:
-
in: query
name: product_id
description: 'Filter by comma separated products ids'
example: porro
required: false
schema:
type: string
description: 'Filter by comma separated products ids'
example: porro
-
in: query
name: location_id
description: ''
example: '1'
required: false
schema:
type: string
description: ''
example: '1'
-
in: query
name: brand_id
description: ''
example: nostrum
required: false
schema:
type: string
description: ''
example: nostrum
-
in: query
name: category_id
description: ''
example: provident
required: false
schema:
type: string
description: ''
example: provident
-
in: query
name: sub_category_id
description: ''
example: voluptates
required: false
schema:
type: string
description: ''
example: voluptates
-
in: query
name: not_for_selling
description: 'Values: 0 or 1'
example: id
required: false
schema:
type: string
description: 'Values: 0 or 1'
example: id
-
in: query
name: name
description: 'Search term for product name'
example: est
required: false
schema:
type: string
description: 'Search term for product name'
example: est
-
in: query
name: sku
description: 'Search term for product sku'
example: voluptatem
required: false
schema:
type: string
description: 'Search term for product sku'
example: voluptatem
-
in: query
name: per_page
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
required: false
schema:
type: integer
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/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: 'https://bqf.ai/uploads/media/1596701997_743693452_test.jpg'
selling_price_group: []
product_image_url: 'https://bqf.ai/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: 'https://bqf.ai/connector/api/variation?page=1'
last: null
prev: null
next: 'https://bqf.ai/connector/api/variation?page=2'
meta:
current_page: 1
from: 1
path: 'https://bqf.ai/connector/api/variation'
per_page: '2'
to: 2
properties:
data:
type: array
example:
-
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: 'https://bqf.ai/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: 'https://bqf.ai/uploads/media/1596701997_743693452_test.jpg'
selling_price_group: []
product_image_url: 'https://bqf.ai/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'
items:
type: object
properties:
variation_id:
type: integer
example: 1
variation_name:
type: string
example: ''
sub_sku:
type: string
example: AS0001
product_id:
type: integer
example: 1
product_name:
type: string
example: "Men's Reverse Fleece Crew"
sku:
type: string
example: AS0001
type:
type: string
example: single
business_id:
type: integer
example: 1
barcode_type:
type: string
example: C128
expiry_period:
type: string
example: null
expiry_period_type:
type: string
example: null
enable_sr_no:
type: integer
example: 0
weight:
type: string
example: null
product_custom_field1:
type: string
example: null
product_custom_field2:
type: string
example: null
product_custom_field3:
type: string
example: null
product_custom_field4:
type: string
example: null
product_image:
type: string
example: 1528728059_fleece_crew.jpg
product_description:
type: string
example: null
warranty_id:
type: string
example: null
brand_id:
type: integer
example: 1
brand_name:
type: string
example: Levis
unit_id:
type: integer
example: 1
enable_stock:
type: integer
example: 1
not_for_selling:
type: integer
example: 0
unit_name:
type: string
example: Pc(s)
unit_allow_decimal:
type: integer
example: 0
category_id:
type: integer
example: 1
category:
type: string
example: "Men's"
sub_category_id:
type: integer
example: 5
sub_category:
type: string
example: Shirts
tax_id:
type: integer
example: 1
tax_type:
type: string
example: exclusive
tax_name:
type: string
example: VAT@10%
tax_amount:
type: integer
example: 10
product_variation_id:
type: integer
example: 1
default_purchase_price:
type: string
example: '130.0000'
dpp_inc_tax:
type: string
example: '143.0000'
profit_percent:
type: string
example: '0.0000'
default_sell_price:
type: string
example: '130.0000'
sell_price_inc_tax:
type: string
example: '143.0000'
product_variation_name:
type: string
example: ''
variation_location_details:
type: array
example: []
media:
type: array
example: []
selling_price_group:
type: array
example: []
product_image_url:
type: string
example: 'https://bqf.ai/uploads/img/1528728059_fleece_crew.jpg'
product_locations:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
location_id:
type: string
example: null
name:
type: string
example: 'Awesome Shop'
landmark:
type: string
example: 'Linking Street'
country:
type: string
example: USA
state:
type: string
example: Arizona
city:
type: string
example: Phoenix
zip_code:
type: string
example: '85001'
invoice_scheme_id:
type: integer
example: 1
invoice_layout_id:
type: integer
example: 1
selling_price_group_id:
type: string
example: null
print_receipt_on_invoice:
type: integer
example: 1
receipt_printer_type:
type: string
example: browser
printer_id:
type: string
example: null
mobile:
type: string
example: null
alternate_number:
type: string
example: null
email:
type: string
example: null
website:
type: string
example: null
featured_products:
type: string
example: null
is_active:
type: integer
example: 1
default_payment_accounts:
type: string
example: ''
custom_field1:
type: string
example: null
custom_field2:
type: string
example: null
custom_field3:
type: string
example: null
custom_field4:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:20'
updated_at:
type: string
example: '2019-12-11 04:53:39'
pivot:
type: object
properties:
product_id:
type: integer
example: 1
location_id:
type: integer
example: 1
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/variation?page=1'
last:
type: string
example: null
prev:
type: string
example: null
next:
type: string
example: 'https://bqf.ai/connector/api/variation?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/variation'
per_page:
type: string
example: '2'
to:
type: integer
example: 2
tags:
- 'Product management'
parameters:
-
in: path
name: id
description: 'Optional parameter. comma separated ids of variations'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: '2'
/connector/api/sell:
get:
summary: 'List sells'
operationId: listSells
description: ''
parameters:
-
in: query
name: location_id
description: 'id of the location'
example: '1'
required: false
schema:
type: string
description: 'id of the location'
example: '1'
-
in: query
name: contact_id
description: 'id of the customer'
example: architecto
required: false
schema:
type: string
description: 'id of the customer'
example: architecto
-
in: query
name: status
description: 'Sell status. Available values final, draft, quotation, proforma'
example: final
required: false
schema:
type: string
description: 'Sell status. Available values final, draft, quotation, proforma'
example: final
-
in: query
name: payment_status
description: 'Comma separated values of payment statuses. Available values due, partial, paid, overdue'
example: 'due,partial'
required: false
schema:
type: string
description: 'Comma separated values of payment statuses. Available values due, partial, paid, overdue'
example: 'due,partial'
-
in: query
name: start_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: end_date
description: 'format:Y-m-d'
example: '2018-06-25'
required: false
schema:
type: string
description: 'format:Y-m-d'
example: '2018-06-25'
-
in: query
name: user_id
description: 'id of the user who created the sale'
example: quo
required: false
schema:
type: string
description: 'id of the user who created the sale'
example: quo
-
in: query
name: service_staff_id
description: 'id of the service staff assigned with the sale'
example: quo
required: false
schema:
type: string
description: 'id of the service staff assigned with the sale'
example: quo
-
in: query
name: shipping_status
description: "Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')"
example: ordered
required: false
schema:
type: string
description: "Shipping Status of the sale ('ordered', 'packed', 'shipped', 'delivered', 'cancelled')"
example: ordered
-
in: query
name: source
description: 'Source of the sale'
example: sit
required: false
schema:
type: string
description: 'Source of the sale'
example: sit
-
in: query
name: only_subscriptions
description: 'Filter only subcription invoices (1, 0)'
example: ut
required: false
schema:
type: string
description: 'Filter only subcription invoices (1, 0)'
example: ut
-
in: query
name: send_purchase_details
description: 'Get purchase details of each sell line (1, 0)'
example: ut
required: false
schema:
type: string
description: 'Get purchase details of each sell line (1, 0)'
example: ut
-
in: query
name: order_by_date
description: "Sort sell list by date ('asc', 'desc')"
example: desc
required: false
schema:
type: string
description: "Sort sell list by date ('asc', 'desc')"
example: desc
-
in: query
name: per_page
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
required: false
schema:
type: integer
description: 'Total records per page. default: 10, Set -1 for no pagination'
example: 10
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
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: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
links:
first: 'https://bqf.ai/connector/api/sell?page=1'
last: 'https://bqf.ai/connector/api/sell?page=6'
prev: null
next: 'https://bqf.ai/connector/api/sell?page=2'
meta:
current_page: 1
from: 1
path: 'https://bqf.ai/connector/api/sell'
per_page: 10
to: 10
properties:
data:
type: array
example:
-
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
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: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
items:
type: object
properties:
id:
type: integer
example: 6
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: string
example: null
res_waiter_id:
type: string
example: null
res_order_status:
type: string
example: null
type:
type: string
example: sell
sub_type:
type: string
example: null
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: paid
adjustment_type:
type: string
example: null
contact_id:
type: integer
example: 4
customer_group_id:
type: string
example: null
invoice_no:
type: string
example: AS0001
ref_no:
type: string
example: ''
source:
type: string
example: null
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '2018-04-10 13:23:21'
total_before_tax:
type: string
example: '770.0000'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
discount_type:
type: string
example: percentage
discount_amount:
type: string
example: '0.0000'
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: null
shipping_address:
type: string
example: null
shipping_status:
type: string
example: null
delivered_to:
type: string
example: null
shipping_charges:
type: string
example: '0.0000'
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '770.0000'
expense_category_id:
type: string
example: null
expense_for:
type: string
example: null
commission_agent:
type: string
example: null
document:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
exchange_rate:
type: string
example: '1.000'
total_amount_recovered:
type: string
example: null
transfer_parent_id:
type: string
example: null
return_parent_id:
type: string
example: null
opening_stock_product_id:
type: string
example: null
created_by:
type: integer
example: 1
import_batch:
type: string
example: null
import_time:
type: string
example: null
types_of_service_id:
type: string
example: null
packing_charge:
type: string
example: null
packing_charge_type:
type: string
example: null
service_custom_field_1:
type: string
example: null
service_custom_field_2:
type: string
example: null
service_custom_field_3:
type: string
example: null
service_custom_field_4:
type: string
example: null
mfg_parent_production_purchase_id:
type: string
example: null
mfg_wasted_units:
type: string
example: null
mfg_production_cost:
type: string
example: '0.0000'
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
rp_earned:
type: integer
example: 0
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_updates_email:
type: integer
example: 0
repair_updates_sms:
type: integer
example: 0
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
order_addresses:
type: string
example: null
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
invoice_token:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: string
example: null
created_at:
type: string
example: '2018-01-06 07:06:11'
updated_at:
type: string
example: '2018-01-06 07:06:11'
sell_lines:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
transaction_id:
type: integer
example: 6
product_id:
type: integer
example: 2
variation_id:
type: integer
example: 3
quantity:
type: integer
example: 10
mfg_waste_percent:
type: string
example: '0.0000'
quantity_returned:
type: string
example: '0.0000'
unit_price_before_discount:
type: string
example: '70.0000'
unit_price:
type: string
example: '70.0000'
line_discount_type:
type: string
example: null
line_discount_amount:
type: string
example: '0.0000'
unit_price_inc_tax:
type: string
example: '77.0000'
item_tax:
type: string
example: '7.0000'
tax_id:
type: integer
example: 1
discount_id:
type: string
example: null
lot_no_line_id:
type: string
example: null
sell_line_note:
type: string
example: null
res_service_staff_id:
type: string
example: null
res_line_order_status:
type: string
example: null
woocommerce_line_items_id:
type: string
example: null
parent_sell_line_id:
type: string
example: null
children_type:
type: string
example: ''
sub_unit_id:
type: string
example: null
created_at:
type: string
example: '2018-01-06 07:06:11'
updated_at:
type: string
example: '2018-01-06 07:06:11'
payment_lines:
type: array
example:
-
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
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'
items:
type: object
properties:
id:
type: integer
example: 1
transaction_id:
type: integer
example: 6
business_id:
type: string
example: null
is_return:
type: integer
example: 0
amount:
type: string
example: '770.0000'
method:
type: string
example: cash
transaction_no:
type: string
example: null
card_transaction_number:
type: string
example: null
card_number:
type: string
example: null
card_type:
type: string
example: visa
card_holder_name:
type: string
example: null
card_month:
type: string
example: null
card_year:
type: string
example: null
cheque_number:
type: string
example: null
bank_account_number:
type: string
example: null
paid_on:
type: string
example: '2018-01-09 17:30:35'
created_by:
type: integer
example: 1
payment_for:
type: string
example: null
parent_id:
type: string
example: null
note:
type: string
example: null
document:
type: string
example: null
payment_ref_no:
type: string
example: null
account_id:
type: string
example: null
created_at:
type: string
example: '2018-01-06 01:36:11'
updated_at:
type: string
example: '2018-01-06 01:36:11'
invoice_url:
type: string
example: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link:
type: string
example: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/sell?page=1'
last:
type: string
example: 'https://bqf.ai/connector/api/sell?page=6'
prev:
type: string
example: null
next:
type: string
example: 'https://bqf.ai/connector/api/sell?page=2'
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/sell'
per_page:
type: integer
example: 10
to:
type: integer
example: 10
tags:
- 'Sales management'
post:
summary: 'Create sell'
operationId: createSell
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link: 'https://bqf.ai/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
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'
properties:
data:
type: array
example:
-
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: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link: 'https://bqf.ai/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
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'
items:
type: object
properties:
id:
type: integer
example: 6
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: string
example: null
res_waiter_id:
type: string
example: null
res_order_status:
type: string
example: null
type:
type: string
example: sell
sub_type:
type: string
example: null
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: paid
adjustment_type:
type: string
example: null
contact_id:
type: integer
example: 4
customer_group_id:
type: string
example: null
invoice_no:
type: string
example: AS0001
ref_no:
type: string
example: ''
source:
type: string
example: null
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '2018-04-10 13:23:21'
total_before_tax:
type: string
example: '770.0000'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
discount_type:
type: string
example: percentage
discount_amount:
type: string
example: '0.0000'
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: null
shipping_address:
type: string
example: null
shipping_status:
type: string
example: null
delivered_to:
type: string
example: null
shipping_charges:
type: string
example: '0.0000'
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '770.0000'
expense_category_id:
type: string
example: null
expense_for:
type: string
example: null
commission_agent:
type: string
example: null
document:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
exchange_rate:
type: string
example: '1.000'
total_amount_recovered:
type: string
example: null
transfer_parent_id:
type: string
example: null
return_parent_id:
type: string
example: null
opening_stock_product_id:
type: string
example: null
created_by:
type: integer
example: 1
import_batch:
type: string
example: null
import_time:
type: string
example: null
types_of_service_id:
type: string
example: null
packing_charge:
type: string
example: null
packing_charge_type:
type: string
example: null
service_custom_field_1:
type: string
example: null
service_custom_field_2:
type: string
example: null
service_custom_field_3:
type: string
example: null
service_custom_field_4:
type: string
example: null
mfg_parent_production_purchase_id:
type: string
example: null
mfg_wasted_units:
type: string
example: null
mfg_production_cost:
type: string
example: '0.0000'
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
rp_earned:
type: integer
example: 0
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_updates_email:
type: integer
example: 0
repair_updates_sms:
type: integer
example: 0
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
order_addresses:
type: string
example: null
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
invoice_token:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: string
example: null
created_at:
type: string
example: '2018-01-06 07:06:11'
updated_at:
type: string
example: '2018-01-06 07:06:11'
invoice_url:
type: string
example: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link:
type: string
example: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
sell_lines:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
transaction_id:
type: integer
example: 6
product_id:
type: integer
example: 2
variation_id:
type: integer
example: 3
quantity:
type: integer
example: 10
mfg_waste_percent:
type: string
example: '0.0000'
quantity_returned:
type: string
example: '0.0000'
unit_price_before_discount:
type: string
example: '70.0000'
unit_price:
type: string
example: '70.0000'
line_discount_type:
type: string
example: null
line_discount_amount:
type: string
example: '0.0000'
unit_price_inc_tax:
type: string
example: '77.0000'
item_tax:
type: string
example: '7.0000'
tax_id:
type: integer
example: 1
discount_id:
type: string
example: null
lot_no_line_id:
type: string
example: null
sell_line_note:
type: string
example: null
res_service_staff_id:
type: string
example: null
res_line_order_status:
type: string
example: null
woocommerce_line_items_id:
type: string
example: null
parent_sell_line_id:
type: string
example: null
children_type:
type: string
example: ''
sub_unit_id:
type: string
example: null
created_at:
type: string
example: '2018-01-06 07:06:11'
updated_at:
type: string
example: '2018-01-06 07:06:11'
payment_lines:
type: array
example:
-
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
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'
items:
type: object
properties:
id:
type: integer
example: 1
transaction_id:
type: integer
example: 6
business_id:
type: string
example: null
is_return:
type: integer
example: 0
amount:
type: string
example: '770.0000'
method:
type: string
example: cash
transaction_no:
type: string
example: null
card_transaction_number:
type: string
example: null
card_number:
type: string
example: null
card_type:
type: string
example: visa
card_holder_name:
type: string
example: null
card_month:
type: string
example: null
card_year:
type: string
example: null
cheque_number:
type: string
example: null
bank_account_number:
type: string
example: null
paid_on:
type: string
example: '2018-01-09 17:30:35'
created_by:
type: integer
example: 1
payment_for:
type: string
example: null
parent_id:
type: string
example: null
note:
type: string
example: null
document:
type: string
example: null
payment_ref_no:
type: string
example: null
account_id:
type: string
example: null
created_at:
type: string
example: '2018-01-06 01:36:11'
updated_at:
type: string
example: '2018-01-06 01:36:11'
tags:
- 'Sales management'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
sells:
type: object
description: ''
example:
'*':
location_id: 1
properties:
'*':
type: object
description: ''
example:
location_id: 1
properties:
location_id:
type: integer
description: 'id of the business location'
example: 1
contact_id:
type: integer
description: 'id of the customer: one the user may see (their branches and, with customer.view_own only, their own customers) or the walk-in customer; otherwise 404 unless customer_mobile proves it'
example: 10
customer_mobile:
type: string
description: "the customer's full mobile number (9+ digits; only digits are compared, a leading + is fine). Needed only to serve a returning customer of another branch, found by pos-customer-search with the full number; the sale then links the customer to this branch"
example: '966501234567'
transaction_date:
type: string
description: 'transaction date format:Y-m-d H:i:s (Y/m/d is read too),'
example: '2020-07-22 15:48:29'
invoice_no:
type: string
description: 'Invoice number (a number is taken as text)'
example: magni
source:
type: string
description: 'Source of the invoice'
example: 'api, phone, woocommerce'
status:
type: string
description: 'sale status (final, draft, quotation, proforma)'
example: final
invoice_scheme_id:
type: integer
description: 'invoice numbering scheme of the business'
example: 9
sub_status:
type: string
description: 'sale sub status ("quotation" for quotation and "proforma" for proforma invoice)'
example: 'null'
is_quotation:
type: boolean
description: 'Is sell quotation (0, 1), If 1 status should be draft'
example: true
tax_rate_id:
type: integer
description: 'id of the tax rate applicable to the sale'
example: 14
discount_amount:
type: number
description: 'discount amount applicable to the sale'
example: 10.0
discount_type:
type: string
description: 'type of the discount amount (fixed, percentage)'
example: fixed
sale_note:
type: string
description: ''
example: veniam
staff_note:
type: string
description: ''
example: et
commission_agent:
type: integer
description: 'commission agent id'
example: 13
shipping_details:
type: string
description: 'shipping details'
example: 'Express Delivery'
shipping_address:
type: string
description: 'shipping address'
example: inventore
shipping_status:
type: string
description: "('ordered', 'packed', 'shipped', 'delivered', 'cancelled')"
example: ordered
delivered_to:
type: string
description: 'Name of the person recieved the consignment'
example: "'Mr robin'"
shipping_charges:
type: number
description: 'shipping amount'
example: 10.0
packing_charge:
type: number
description: 'packing charge'
example: 10.0
exchange_rate:
type: number
description: 'exchange rate for the currency used (0 or empty: 1)'
example: 1.0
selling_price_group_id:
type: integer
description: 'id of the selling price group'
example: 10
pay_term_number:
type: integer
description: 'pay term value'
example: 3
pay_term_type:
type: string
description: "type of the pay term value ('days', 'months')"
example: months
is_suspend:
type: boolean
description: 'Is suspended sale (0, 1, true, false); a parked sale is checked against the credit limit when it is finalised or paid, not when parked'
example: false
is_recurring:
type: integer
description: 'whether the invoice is recurring (0, 1)'
example: 0
recur_interval:
type: integer
description: 'value of the interval invoice will be regenerated'
example: 13
recur_interval_type:
type: string
description: "type of the recur interval ('days', 'months', 'years')"
example: months
subscription_repeat_on:
type: integer
description: 'day of the month on which invoice will be generated if recur interval type is months (1-30)'
example: 15
subscription_no:
type: string
description: 'subscription number'
example: numquam
recur_repetitions:
type: integer
description: 'total number of invoices to be generated'
example: 16
rp_redeemed:
type: integer
description: 'reward points redeemed'
example: 14
rp_redeemed_amount:
type: number
description: 'reward point redeemed amount after conversion'
example: 13.5
types_of_service_id:
type: integer
description: 'types of service id'
example: 13
service_custom_field_1:
type: string
description: 'types of service custom field 1'
example: aut
service_custom_field_2:
type: string
description: 'types of service custom field 2'
example: tempore
service_custom_field_3:
type: string
description: 'types of service custom field 3'
example: voluptatem
service_custom_field_4:
type: string
description: 'types of service custom field 4'
example: qui
service_custom_field_5:
type: string
description: 'types of service custom field 5'
example: dolorum
service_custom_field_6:
type: string
description: 'types of service custom field 6'
example: est
round_off_amount:
type: number
description: 'round off amount on total payable (added to final_total)'
example: 8339027.9239346
table_id:
type: integer
description: 'id of the table'
example: 11
service_staff_id:
type: integer
description: 'id of the service staff assigned to the sale'
example: 13
change_return:
type: number
description: 'Excess paid amount'
example: 0.0
products:
type: array
description: 'array of the products for the sale'
example:
- error
items:
type: string
payments:
type: array
description: 'payment lines for the sale'
example:
- cum
items:
type: string
'/connector/api/sell/{id}':
get:
summary: 'Get the specified sell'
operationId: getTheSpecifiedSell
description: ''
parameters:
-
in: query
name: send_purchase_details
description: 'Get purchase details of each sell line (1, 0)'
example: consectetur
required: false
schema:
type: string
description: 'Get purchase details of each sell line (1, 0)'
example: consectetur
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
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: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
properties:
data:
type: array
example:
-
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
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: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
items:
type: object
properties:
id:
type: integer
example: 55
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: integer
example: 5
res_waiter_id:
type: string
example: null
res_order_status:
type: string
example: null
type:
type: string
example: sell
sub_type:
type: string
example: null
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: paid
adjustment_type:
type: string
example: null
contact_id:
type: integer
example: 1
customer_group_id:
type: string
example: null
invoice_no:
type: string
example: AS0007
ref_no:
type: string
example: ''
source:
type: string
example: null
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '2020-06-04 23:29:36'
total_before_tax:
type: string
example: '437.5000'
tax_id:
type: integer
example: 1
tax_amount:
type: string
example: '39.3750'
discount_type:
type: string
example: percentage
discount_amount:
type: string
example: '10.0000'
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: 'Express Delivery'
shipping_address:
type: string
example: null
shipping_status:
type: string
example: ordered
delivered_to:
type: string
example: 'Mr Robin'
shipping_charges:
type: string
example: '10.0000'
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '453.1300'
expense_category_id:
type: string
example: null
expense_for:
type: string
example: null
commission_agent:
type: string
example: null
document:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
exchange_rate:
type: string
example: '1.000'
total_amount_recovered:
type: string
example: null
transfer_parent_id:
type: string
example: null
return_parent_id:
type: string
example: null
opening_stock_product_id:
type: string
example: null
created_by:
type: integer
example: 9
import_batch:
type: string
example: null
import_time:
type: string
example: null
types_of_service_id:
type: integer
example: 1
packing_charge:
type: string
example: '10.0000'
packing_charge_type:
type: string
example: fixed
service_custom_field_1:
type: string
example: null
service_custom_field_2:
type: string
example: null
service_custom_field_3:
type: string
example: null
service_custom_field_4:
type: string
example: null
mfg_parent_production_purchase_id:
type: string
example: null
mfg_wasted_units:
type: string
example: null
mfg_production_cost:
type: string
example: '0.0000'
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
rp_earned:
type: integer
example: 0
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_updates_email:
type: integer
example: 0
repair_updates_sms:
type: integer
example: 0
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
order_addresses:
type: string
example: null
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: days
recur_repetitions:
type: integer
example: 0
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
invoice_token:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: integer
example: 0
created_at:
type: string
example: '2020-06-04 23:29:36'
updated_at:
type: string
example: '2020-06-04 23:29:36'
sell_lines:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 38
transaction_id:
type: integer
example: 55
product_id:
type: integer
example: 17
variation_id:
type: integer
example: 58
quantity:
type: integer
example: 1
mfg_waste_percent:
type: string
example: '0.0000'
quantity_returned:
type: string
example: '0.0000'
unit_price_before_discount:
type: string
example: '437.5000'
unit_price:
type: string
example: '437.5000'
line_discount_type:
type: string
example: fixed
line_discount_amount:
type: string
example: '0.0000'
unit_price_inc_tax:
type: string
example: '437.5000'
item_tax:
type: string
example: '0.0000'
tax_id:
type: string
example: null
discount_id:
type: string
example: null
lot_no_line_id:
type: string
example: null
sell_line_note:
type: string
example: ''
res_service_staff_id:
type: string
example: null
res_line_order_status:
type: string
example: null
woocommerce_line_items_id:
type: string
example: null
parent_sell_line_id:
type: string
example: null
children_type:
type: string
example: ''
sub_unit_id:
type: string
example: null
created_at:
type: string
example: '2020-06-04 23:29:36'
updated_at:
type: string
example: '2020-06-04 23:29:36'
payment_lines:
type: array
example:
-
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
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'
items:
type: object
properties:
id:
type: integer
example: 37
transaction_id:
type: integer
example: 55
business_id:
type: integer
example: 1
is_return:
type: integer
example: 0
amount:
type: string
example: '453.1300'
method:
type: string
example: cash
transaction_no:
type: string
example: null
card_transaction_number:
type: string
example: null
card_number:
type: string
example: null
card_type:
type: string
example: credit
card_holder_name:
type: string
example: null
card_month:
type: string
example: null
card_year:
type: string
example: null
cheque_number:
type: string
example: null
bank_account_number:
type: string
example: null
paid_on:
type: string
example: '2020-06-04 23:29:36'
created_by:
type: integer
example: 9
payment_for:
type: integer
example: 1
parent_id:
type: string
example: null
note:
type: string
example: null
document:
type: string
example: null
payment_ref_no:
type: string
example: SP2020/0002
account_id:
type: string
example: null
created_at:
type: string
example: '2020-06-04 23:29:36'
updated_at:
type: string
example: '2020-06-04 23:29:36'
invoice_url:
type: string
example: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link:
type: string
example: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
tags:
- 'Sales management'
put:
summary: 'Update sell'
operationId: updateSell
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
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: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
properties:
id:
type: integer
example: 91
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: string
example: null
res_waiter_id:
type: string
example: null
res_order_status:
type: string
example: null
type:
type: string
example: sell
sub_type:
type: string
example: null
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: paid
adjustment_type:
type: string
example: null
contact_id:
type: integer
example: 1
customer_group_id:
type: integer
example: 1
invoice_no:
type: string
example: AS0020
ref_no:
type: string
example: ''
source:
type: string
example: null
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '25-09-2020 15:22'
total_before_tax:
type: number
example: 962.5
tax_id:
type: string
example: null
tax_amount:
type: integer
example: 0
discount_type:
type: string
example: fixed
discount_amount:
type: string
example: '19.5000'
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: null
shipping_address:
type: string
example: null
shipping_status:
type: string
example: null
delivered_to:
type: string
example: null
shipping_charges:
type: string
example: '0.0000'
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: integer
example: 943
expense_category_id:
type: string
example: null
expense_for:
type: string
example: null
commission_agent:
type: string
example: null
document:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
exchange_rate:
type: string
example: '1.000'
total_amount_recovered:
type: string
example: null
transfer_parent_id:
type: string
example: null
return_parent_id:
type: string
example: null
opening_stock_product_id:
type: string
example: null
created_by:
type: integer
example: 9
import_batch:
type: string
example: null
import_time:
type: string
example: null
types_of_service_id:
type: string
example: null
packing_charge:
type: string
example: '0.0000'
packing_charge_type:
type: string
example: null
service_custom_field_1:
type: string
example: null
service_custom_field_2:
type: string
example: null
service_custom_field_3:
type: string
example: null
service_custom_field_4:
type: string
example: null
mfg_parent_production_purchase_id:
type: string
example: null
mfg_wasted_units:
type: string
example: null
mfg_production_cost:
type: string
example: '0.0000'
mfg_production_cost_type:
type: string
example: percentage
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
rp_earned:
type: integer
example: 0
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_job_sheet_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
repair_updates_notif:
type: integer
example: 0
order_addresses:
type: string
example: null
is_recurring:
type: integer
example: 0
recur_interval:
type: integer
example: 1
recur_interval_type:
type: string
example: days
recur_repetitions:
type: integer
example: 0
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
invoice_token:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: integer
example: 0
created_at:
type: string
example: '2020-09-23 20:16:19'
updated_at:
type: string
example: '2020-09-25 17:57:08'
payment_lines:
type: array
example:
-
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
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'
items:
type: object
properties:
id:
type: integer
example: 55
transaction_id:
type: integer
example: 91
business_id:
type: integer
example: 1
is_return:
type: integer
example: 0
amount:
type: string
example: '461.7500'
method:
type: string
example: cash
transaction_no:
type: string
example: null
card_transaction_number:
type: string
example: null
card_number:
type: string
example: null
card_type:
type: string
example: credit
card_holder_name:
type: string
example: null
card_month:
type: string
example: null
card_year:
type: string
example: null
cheque_number:
type: string
example: null
bank_account_number:
type: string
example: null
paid_on:
type: string
example: '2020-09-23 20:16:19'
created_by:
type: integer
example: 9
is_advance:
type: integer
example: 0
payment_for:
type: integer
example: 1
parent_id:
type: string
example: null
note:
type: string
example: null
document:
type: string
example: null
payment_ref_no:
type: string
example: SP2020/0018
account_id:
type: string
example: null
created_at:
type: string
example: '2020-09-23 20:16:19'
updated_at:
type: string
example: '2020-09-23 20:16:19'
invoice_url:
type: string
example: 'https://bqf.ai/invoice/6dfd77eb80f4976b456128e7f1311c9f'
payment_link:
type: string
example: 'https://bqf.ai/pay/6dfd77eb80f4976b456128e7f1311c9f'
tags:
- 'Sales management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
contact_id:
type: integer
description: 'id of the customer (a new customer follows the rules of store, customer_mobile included)'
example: 18
customer_mobile:
type: string
description: "the new customer's full mobile number, as on store"
example: odio
transaction_date:
type: string
description: 'transaction date format:Y-m-d H:i:s,'
example: '2020-5-7 15:20:22'
status:
type: string
description: 'sale status (final, draft, quotation, proforma); final clears is_quotation and sub_status'
example: final
sub_status:
type: string
description: 'sale sub status ("quotation" for quotation and "proforma" for proforma invoice)'
example: 'null'
is_quotation:
type: boolean
description: 'Is sell quotation (0, 1), If 1 status should be draft'
example: true
tax_rate_id:
type: integer
description: 'id of the tax rate applicable to the sale'
example: 16
discount_amount:
type: number
description: 'discount amount applicable to the sale'
example: 10.0
discount_type:
type: string
description: 'type of the discount amount (fixed, percentage)'
example: fixed
sale_note:
type: string
description: ''
example: rerum
source:
type: string
description: 'Source of the invoice'
example: inventore
staff_note:
type: string
description: ''
example: ut
is_suspend:
type: boolean
description: 'Is suspended sale (0, 1)'
example: false
commission_agent:
type: integer
description: 'commission agent id'
example: 17
shipping_details:
type: string
description: 'shipping details'
example: 'Express Delivery'
shipping_address:
type: string
description: 'shipping address'
example: illo
shipping_status:
type: string
description: "('ordered', 'packed', 'shipped', 'delivered', 'cancelled')"
example: ordered
delivered_to:
type: string
description: 'Name of the person recieved the consignment'
example: 'Mr Robin'
shipping_charges:
type: number
description: 'shipping amount'
example: 10.0
packing_charge:
type: number
description: 'packing charge'
example: 10.0
exchange_rate:
type: number
description: 'exchange rate for the currency used (0 or empty: 1)'
example: 1.0
selling_price_group_id:
type: integer
description: 'id of the selling price group'
example: 2
pay_term_number:
type: integer
description: 'pay term value'
example: 14
pay_term_type:
type: string
description: "type of the pay term value ('days', 'months')"
example: months
is_recurring:
type: integer
description: 'whether the invoice is recurring (0, 1)'
example: 0
recur_interval:
type: integer
description: 'value of the interval invoice will be regenerated'
example: 15
recur_interval_type:
type: string
description: "type of the recur interval ('days', 'months', 'years')"
example: days
subscription_repeat_on:
type: integer
description: 'day of the month on which invoice will be generated if recur interval type is months (1-30)'
example: 7
subscription_no:
type: string
description: 'subscription number'
example: autem
recur_repetitions:
type: integer
description: 'total number of invoices to be generated'
example: 11
rp_redeemed:
type: integer
description: 'reward points redeemed'
example: 9
rp_redeemed_amount:
type: number
description: 'reward point redeemed amount after conversion'
example: 13.5
types_of_service_id:
type: integer
description: 'types of service id'
example: 15
service_custom_field_1:
type: string
description: 'types of service custom field 1'
example: cumque
service_custom_field_2:
type: string
description: 'types of service custom field 2'
example: explicabo
service_custom_field_3:
type: string
description: 'types of service custom field 3'
example: occaecati
service_custom_field_4:
type: string
description: 'types of service custom field 4'
example: corrupti
service_custom_field_5:
type: string
description: 'types of service custom field 5'
example: voluptatem
service_custom_field_6:
type: string
description: 'types of service custom field 6'
example: molestiae
round_off_amount:
type: number
description: 'round off amount on total payable (added to final_total)'
example: 10811027.1
table_id:
type: integer
description: 'id of the table'
example: 8
service_staff_id:
type: integer
description: 'id of the service staff assigned to the sale'
example: 9
change_return:
type: number
description: 'Excess paid amount'
example: 0.0
change_return_id:
type: integer
description: 'id of the change return payment if exists'
example: 3
products:
type: array
description: 'array of the products for the sale'
example:
- rerum
items:
type: string
payments:
type: array
description: 'payment lines for the sale. A request with only payments (and change_return / change_return_id) changes the payments and payment status and nothing else'
example:
- sunt
items:
type: string
required:
- products
delete:
summary: 'Delete Sell'
operationId: deleteSell
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses: { }
tags:
- 'Sales management'
parameters:
-
in: path
name: id
description: 'The ID of the sell.'
example: similique
required: true
schema:
type: string
-
in: path
name: sell
description: 'comma separated ids of the sells'
example: '55'
required: true
schema:
type: string
/connector/api/sell-return:
post:
summary: 'Add Sell Return'
operationId: addSellReturn
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
id:
type: integer
example: 159
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: string
example: null
res_waiter_id:
type: string
example: null
res_order_status:
type: string
example: null
type:
type: string
example: sell_return
sub_type:
type: string
example: null
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: paid
adjustment_type:
type: string
example: null
contact_id:
type: integer
example: 1
customer_group_id:
type: string
example: null
invoice_no:
type: string
example: CN2020/0005
ref_no:
type: string
example: null
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '2020-11-17 00:00:00'
total_before_tax:
type: integer
example: 3
tax_id:
type: string
example: null
tax_amount:
type: integer
example: 0
discount_type:
type: string
example: percentage
discount_amount:
type: integer
example: 12
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: null
shipping_address:
type: string
example: null
shipping_status:
type: string
example: null
delivered_to:
type: string
example: null
shipping_charges:
type: string
example: '0.0000'
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: number
example: 2.64
expense_category_id:
type: string
example: null
expense_for:
type: string
example: null
commission_agent:
type: string
example: null
document:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
exchange_rate:
type: string
example: '1.000'
total_amount_recovered:
type: string
example: null
transfer_parent_id:
type: string
example: null
return_parent_id:
type: integer
example: 157
opening_stock_product_id:
type: string
example: null
created_by:
type: integer
example: 9
import_batch:
type: string
example: null
import_time:
type: string
example: null
types_of_service_id:
type: string
example: null
packing_charge:
type: string
example: null
packing_charge_type:
type: string
example: null
service_custom_field_1:
type: string
example: null
service_custom_field_2:
type: string
example: null
service_custom_field_3:
type: string
example: null
service_custom_field_4:
type: string
example: null
mfg_parent_production_purchase_id:
type: string
example: null
mfg_wasted_units:
type: string
example: null
mfg_production_cost:
type: string
example: '0.0000'
mfg_production_cost_type:
type: string
example: percentage
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
rp_earned:
type: integer
example: 0
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_job_sheet_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
repair_updates_notif:
type: integer
example: 0
order_addresses:
type: string
example: null
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
invoice_token:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: string
example: null
created_at:
type: string
example: '2020-11-17 12:05:11'
updated_at:
type: string
example: '2020-11-17 13:22:09'
tags:
- 'Sales management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
transaction_id:
type: integer
description: 'Id of the sell'
example: 13
transaction_date:
type: string
description: 'transaction date format:Y-m-d H:i:s,'
example: '2020-5-7 15:20:22'
invoice_no:
type: string
description: 'Invoice number of the return'
example: possimus
discount_type:
type: string
description: 'type of the discount amount (fixed, percentage)'
example: fixed
discount_amount:
type: number
description: "discount on the return; omitted: the sale's discount, a fixed one in the share of the sale being returned"
example: 10.0
tax_id:
type: integer
description: ''
example: 8
return_settlement:
type: string
description: 'how the refund is settled (cash, store_credit)'
example: perferendis
products:
type: array
description: 'array of the products for the sale'
example:
- et
items:
type: string
required:
- transaction_id
- products
/connector/api/list-sell-return:
get:
summary: 'List Sell Return'
operationId: listSellReturn
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
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: 'https://bqf.ai/connector/api/list-sell-return?sell_id=157&page=1'
last: null
prev: null
next: null
meta:
current_page: 1
from: 1
path: 'https://bqf.ai/connector/api/list-sell-return'
per_page: 10
to: 1
properties:
data:
type: array
example:
-
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
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'
items:
type: object
properties:
id:
type: integer
example: 159
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: string
example: null
res_waiter_id:
type: string
example: null
res_order_status:
type: string
example: null
type:
type: string
example: sell_return
sub_type:
type: string
example: null
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: partial
adjustment_type:
type: string
example: null
contact_id:
type: integer
example: 1
customer_group_id:
type: string
example: null
invoice_no:
type: string
example: CN2020/0005
ref_no:
type: string
example: null
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '2020-11-17 00:00:00'
total_before_tax:
type: string
example: '3.0000'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
discount_type:
type: string
example: percentage
discount_amount:
type: string
example: '12.0000'
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: null
shipping_address:
type: string
example: null
shipping_status:
type: string
example: null
delivered_to:
type: string
example: null
shipping_charges:
type: string
example: '0.0000'
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '2.6400'
expense_category_id:
type: string
example: null
expense_for:
type: string
example: null
commission_agent:
type: string
example: null
document:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
exchange_rate:
type: string
example: '1.000'
total_amount_recovered:
type: string
example: null
transfer_parent_id:
type: string
example: null
return_parent_id:
type: integer
example: 157
opening_stock_product_id:
type: string
example: null
created_by:
type: integer
example: 9
import_batch:
type: string
example: null
import_time:
type: string
example: null
types_of_service_id:
type: string
example: null
packing_charge:
type: string
example: null
packing_charge_type:
type: string
example: null
service_custom_field_1:
type: string
example: null
service_custom_field_2:
type: string
example: null
service_custom_field_3:
type: string
example: null
service_custom_field_4:
type: string
example: null
mfg_parent_production_purchase_id:
type: string
example: null
mfg_wasted_units:
type: string
example: null
mfg_production_cost:
type: string
example: '0.0000'
mfg_production_cost_type:
type: string
example: percentage
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
rp_earned:
type: integer
example: 0
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_job_sheet_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
repair_updates_notif:
type: integer
example: 0
order_addresses:
type: string
example: null
is_recurring:
type: integer
example: 0
recur_interval:
type: string
example: null
recur_interval_type:
type: string
example: null
recur_repetitions:
type: string
example: null
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
invoice_token:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: string
example: null
created_at:
type: string
example: '2020-11-17 12:05:11'
updated_at:
type: string
example: '2020-11-17 13:22:09'
payment_lines:
type: array
example:
-
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
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'
items:
type: object
properties:
id:
type: integer
example: 126
transaction_id:
type: integer
example: 159
business_id:
type: integer
example: 1
is_return:
type: integer
example: 0
amount:
type: string
example: '1.8000'
method:
type: string
example: cash
transaction_no:
type: string
example: null
card_transaction_number:
type: string
example: null
card_number:
type: string
example: null
card_type:
type: string
example: credit
card_holder_name:
type: string
example: null
card_month:
type: string
example: null
card_year:
type: string
example: null
cheque_number:
type: string
example: null
bank_account_number:
type: string
example: null
paid_on:
type: string
example: '2020-11-17 12:05:00'
created_by:
type: integer
example: 9
is_advance:
type: integer
example: 0
payment_for:
type: integer
example: 1
parent_id:
type: string
example: null
note:
type: string
example: null
document:
type: string
example: null
payment_ref_no:
type: string
example: SP2020/0078
account_id:
type: string
example: null
created_at:
type: string
example: '2020-11-17 12:05:58'
updated_at:
type: string
example: '2020-11-17 12:05:58'
return_parent_sell:
type: object
properties:
id:
type: integer
example: 157
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
res_table_id:
type: string
example: null
res_waiter_id:
type: string
example: null
res_order_status:
type: string
example: null
type:
type: string
example: sell
sub_type:
type: string
example: null
status:
type: string
example: final
is_quotation:
type: integer
example: 0
payment_status:
type: string
example: paid
adjustment_type:
type: string
example: null
contact_id:
type: integer
example: 1
customer_group_id:
type: string
example: null
invoice_no:
type: string
example: AS0073
ref_no:
type: string
example: ''
subscription_no:
type: string
example: null
subscription_repeat_on:
type: string
example: null
transaction_date:
type: string
example: '2020-11-13 12:42:17'
total_before_tax:
type: string
example: '6.2500'
tax_id:
type: string
example: null
tax_amount:
type: string
example: '0.0000'
discount_type:
type: string
example: percentage
discount_amount:
type: string
example: '10.0000'
rp_redeemed:
type: integer
example: 0
rp_redeemed_amount:
type: string
example: '0.0000'
shipping_details:
type: string
example: null
shipping_address:
type: string
example: null
shipping_status:
type: string
example: null
delivered_to:
type: string
example: null
shipping_charges:
type: string
example: '0.0000'
additional_notes:
type: string
example: null
staff_note:
type: string
example: null
round_off_amount:
type: string
example: '0.0000'
final_total:
type: string
example: '5.6300'
expense_category_id:
type: string
example: null
expense_for:
type: string
example: null
commission_agent:
type: string
example: null
document:
type: string
example: null
is_direct_sale:
type: integer
example: 0
is_suspend:
type: integer
example: 0
exchange_rate:
type: string
example: '1.000'
total_amount_recovered:
type: string
example: null
transfer_parent_id:
type: string
example: null
return_parent_id:
type: string
example: null
opening_stock_product_id:
type: string
example: null
created_by:
type: integer
example: 9
import_batch:
type: string
example: null
import_time:
type: string
example: null
types_of_service_id:
type: string
example: null
packing_charge:
type: string
example: '0.0000'
packing_charge_type:
type: string
example: null
service_custom_field_1:
type: string
example: null
service_custom_field_2:
type: string
example: null
service_custom_field_3:
type: string
example: null
service_custom_field_4:
type: string
example: null
mfg_parent_production_purchase_id:
type: string
example: null
mfg_wasted_units:
type: string
example: null
mfg_production_cost:
type: string
example: '0.0000'
mfg_production_cost_type:
type: string
example: percentage
mfg_is_final:
type: integer
example: 0
is_created_from_api:
type: integer
example: 0
essentials_duration:
type: string
example: '0.00'
essentials_duration_unit:
type: string
example: null
essentials_amount_per_unit_duration:
type: string
example: '0.0000'
essentials_allowances:
type: string
example: null
essentials_deductions:
type: string
example: null
rp_earned:
type: integer
example: 0
repair_completed_on:
type: string
example: null
repair_warranty_id:
type: string
example: null
repair_brand_id:
type: string
example: null
repair_status_id:
type: string
example: null
repair_model_id:
type: string
example: null
repair_job_sheet_id:
type: string
example: null
repair_defects:
type: string
example: null
repair_serial_no:
type: string
example: null
repair_checklist:
type: string
example: null
repair_security_pwd:
type: string
example: null
repair_security_pattern:
type: string
example: null
repair_due_date:
type: string
example: null
repair_device_id:
type: string
example: null
repair_updates_notif:
type: integer
example: 0
order_addresses:
type: string
example: null
is_recurring:
type: integer
example: 0
recur_interval:
type: integer
example: 1
recur_interval_type:
type: string
example: days
recur_repetitions:
type: integer
example: 0
recur_stopped_on:
type: string
example: null
recur_parent_id:
type: string
example: null
invoice_token:
type: string
example: null
pay_term_number:
type: string
example: null
pay_term_type:
type: string
example: null
pjt_project_id:
type: string
example: null
pjt_title:
type: string
example: null
woocommerce_order_id:
type: string
example: null
selling_price_group_id:
type: integer
example: 0
created_at:
type: string
example: '2020-11-13 12:42:17'
updated_at:
type: string
example: '2020-11-13 12:42:18'
sell_lines:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 139
transaction_id:
type: integer
example: 157
product_id:
type: integer
example: 157
variation_id:
type: integer
example: 205
quantity:
type: integer
example: 5
mfg_waste_percent:
type: string
example: '0.0000'
quantity_returned:
type: string
example: '3.0000'
unit_price_before_discount:
type: string
example: '1.2500'
unit_price:
type: string
example: '1.2500'
line_discount_type:
type: string
example: fixed
line_discount_amount:
type: string
example: '0.0000'
unit_price_inc_tax:
type: string
example: '1.2500'
item_tax:
type: string
example: '0.0000'
tax_id:
type: string
example: null
discount_id:
type: string
example: null
lot_no_line_id:
type: string
example: null
sell_line_note:
type: string
example: ''
res_service_staff_id:
type: string
example: null
res_line_order_status:
type: string
example: null
woocommerce_line_items_id:
type: string
example: null
parent_sell_line_id:
type: string
example: null
children_type:
type: string
example: ''
sub_unit_id:
type: string
example: null
created_at:
type: string
example: '2020-11-13 12:42:17'
updated_at:
type: string
example: '2020-11-17 13:22:09'
links:
type: object
properties:
first:
type: string
example: 'https://bqf.ai/connector/api/list-sell-return?sell_id=157&page=1'
last:
type: string
example: null
prev:
type: string
example: null
next:
type: string
example: null
meta:
type: object
properties:
current_page:
type: integer
example: 1
from:
type: integer
example: 1
path:
type: string
example: 'https://bqf.ai/connector/api/list-sell-return'
per_page:
type: integer
example: 10
to:
type: integer
example: 1
tags:
- 'Sales management'
parameters:
-
in: path
name: sell_id
description: 'Optional parameter. Id of the sell for which return is added'
required: true
schema:
type: string
examples:
omitted:
summary: 'When the value is omitted'
value: ''
present:
summary: 'When the value is present'
value: ullam
/connector/api/update-shipping-status:
post:
summary: 'Update shipping status'
operationId: updateShippingStatus
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses: { }
tags:
- 'Sales management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
id:
type: integer
description: 'id of the sale'
example: 11
shipping_status:
type: string
description: "('ordered', 'packed', 'shipped', 'delivered', 'cancelled')"
example: ordered
delivered_to:
type: string
description: 'Name of the consignee'
example: quidem
required:
- id
/connector/api/active-subscription:
get:
summary: 'If SaaS installed get active subscription details, else return the enabled modules details in package_details'
operationId: ifSaaSInstalledGetActiveSubscriptionDetailsElseReturnTheEnabledModulesDetailsInPackageDetails
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
package_id:
type: integer
example: 3
start_date:
type: string
example: '2020-09-05 00:00:00'
trial_end_date:
type: string
example: '2020-09-15'
end_date:
type: string
example: '2020-10-05 00:00:00'
package_price:
type: string
example: '599.9900'
package_details:
type: object
properties:
location_count:
type: integer
example: 0
user_count:
type: integer
example: 0
product_count:
type: integer
example: 0
invoice_count:
type: integer
example: 0
name:
type: string
example: Unlimited
woocommerce_module:
type: integer
example: 1
essentials_module:
type: integer
example: 1
created_id:
type: integer
example: 1
paid_via:
type: string
example: stripe
payment_transaction_id:
type: string
example: ch_1CuLdQAhokBpT93LVZNg2At6
status:
type: string
example: approved
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-08-01 07:49:09'
updated_at:
type: string
example: '2018-08-01 07:49:09'
locations_created:
type: integer
example: 1
users_created:
type: integer
example: 6
products_created:
type: integer
example: 2
invoices_created:
type: integer
example: 1
tags:
- Superadmin
/connector/api/packages:
get:
summary: 'Get Superadmin Package List'
operationId: getSuperadminPackageList
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Starter - Free'
description:
type: string
example: 'Give it a test drive...'
location_count:
type: integer
example: 0
user_count:
type: integer
example: 0
product_count:
type: integer
example: 0
bookings:
type: integer
example: 0
kitchen:
type: integer
example: 0
order_screen:
type: integer
example: 0
tables:
type: integer
example: 0
invoice_count:
type: integer
example: 0
interval:
type: string
example: months
interval_count:
type: integer
example: 1
trial_days:
type: integer
example: 10
price:
type: string
example: '0.0000'
custom_permissions:
type: object
properties:
assetmanagement_module:
type: string
example: '1'
connector_module:
type: string
example: '1'
crm_module:
type: string
example: '1'
essentials_module:
type: string
example: '1'
manufacturing_module:
type: string
example: '1'
productcatalogue_module:
type: string
example: '1'
project_module:
type: string
example: '1'
repair_module:
type: string
example: '1'
woocommerce_module:
type: string
example: '1'
created_by:
type: integer
example: 1
sort_order:
type: integer
example: 0
is_active:
type: integer
example: 1
is_private:
type: integer
example: 0
is_one_time:
type: integer
example: 0
enable_custom_link:
type: integer
example: 0
custom_link:
type: string
example: ''
custom_link_text:
type: string
example: ''
deleted_at:
type: string
example: null
created_at:
type: string
example: '2020-10-09 16:38:02'
updated_at:
type: string
example: '2020-11-11 12:19:17'
tags:
- Superadmin
/connector/api/table:
get:
summary: 'List tables'
operationId: listTables
description: ''
parameters:
-
in: query
name: location_id
description: 'id of the location'
example: 1
required: false
schema:
type: integer
description: 'id of the location'
example: 1
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 5
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
name:
type: string
example: 'Table 1'
description:
type: string
example: null
created_by:
type: integer
example: 9
deleted_at:
type: string
example: null
created_at:
type: string
example: '2020-06-04 22:36:37'
updated_at:
type: string
example: '2020-06-04 22:36:37'
tags:
- 'Table management'
'/connector/api/table/{id}':
get:
summary: 'Show the specified table'
operationId: showTheSpecifiedTable
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 5
business_id:
type: integer
example: 1
location_id:
type: integer
example: 1
name:
type: string
example: 'Table 1'
description:
type: string
example: null
created_by:
type: integer
example: 9
deleted_at:
type: string
example: null
created_at:
type: string
example: '2020-06-04 22:36:37'
updated_at:
type: string
example: '2020-06-04 22:36:37'
tags:
- 'Table management'
parameters:
-
in: path
name: id
description: 'The ID of the table.'
example: odio
required: true
schema:
type: string
-
in: path
name: table
description: 'comma separated ids of required tables'
example: '5'
required: true
schema:
type: string
/connector/api/tax:
get:
summary: 'List taxes'
operationId: listTaxes
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: VAT@10%
amount:
type: integer
example: 10
is_tax_group:
type: integer
example: 0
created_by:
type: integer
example: 1
woocommerce_tax_rate_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:40:07'
updated_at:
type: string
example: '2018-01-04 02:40:07'
tags:
- 'Tax management'
'/connector/api/tax/{id}':
get:
summary: 'Get the specified tax'
operationId: getTheSpecifiedTax
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
name:
type: string
example: VAT@10%
amount:
type: integer
example: 10
is_tax_group:
type: integer
example: 0
created_by:
type: integer
example: 1
woocommerce_tax_rate_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:40:07'
updated_at:
type: string
example: '2018-01-04 02:40:07'
tags:
- 'Tax management'
parameters:
-
in: path
name: id
description: 'The ID of the tax.'
example: vel
required: true
schema:
type: string
-
in: path
name: tax
description: 'comma separated ids of required taxes'
example: '1'
required: true
schema:
type: string
/connector/api/taxonomy:
get:
summary: 'List taxonomy'
operationId: listTaxonomy
description: ''
parameters:
-
in: query
name: type
description: 'Type of taxonomy (product, device, hrm_department)'
example: nisi
required: false
schema:
type: string
description: 'Type of taxonomy (product, device, hrm_department)'
example: nisi
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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: []
properties:
data:
type: array
example:
-
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: []
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's"
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 0
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:06:34'
updated_at:
type: string
example: '2018-01-03 21:06:34'
sub_categories:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 4
name:
type: string
example: Jeans
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 1
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:07:34'
updated_at:
type: string
example: '2018-01-03 21:07:34'
tags:
- 'Taxonomy management'
'/connector/api/taxonomy/{id}':
get:
summary: 'Get the specified taxonomy'
operationId: getTheSpecifiedTaxonomy
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: "Men's"
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 0
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:06:34'
updated_at:
type: string
example: '2018-01-03 21:06:34'
sub_categories:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 4
name:
type: string
example: Jeans
business_id:
type: integer
example: 1
short_code:
type: string
example: null
parent_id:
type: integer
example: 1
created_by:
type: integer
example: 1
category_type:
type: string
example: product
description:
type: string
example: null
slug:
type: string
example: null
woocommerce_cat_id:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 21:07:34'
updated_at:
type: string
example: '2018-01-03 21:07:34'
tags:
- 'Taxonomy management'
parameters:
-
in: path
name: id
description: 'The ID of the taxonomy.'
example: molestiae
required: true
schema:
type: string
-
in: path
name: taxonomy
description: 'comma separated ids of product categories'
example: '1'
required: true
schema:
type: string
/connector/api/types-of-service:
get:
summary: 'List types of service'
operationId: listTypesOfService
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Home Delivery'
description:
type: string
example: null
business_id:
type: integer
example: 1
location_price_group:
type: object
properties:
1:
type: string
example: '0'
packing_charge:
type: string
example: '10.0000'
packing_charge_type:
type: string
example: fixed
enable_custom_fields:
type: integer
example: 0
created_at:
type: string
example: '2020-06-04 22:41:13'
updated_at:
type: string
example: '2020-06-04 22:41:13'
tags:
- 'Types of service management'
'/connector/api/types-of-service/{id}':
get:
summary: 'Get the specified types of service'
operationId: getTheSpecifiedTypesOfService
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
name:
type: string
example: 'Home Delivery'
description:
type: string
example: null
business_id:
type: integer
example: 1
location_price_group:
type: object
properties:
1:
type: string
example: '0'
packing_charge:
type: string
example: '10.0000'
packing_charge_type:
type: string
example: fixed
enable_custom_fields:
type: integer
example: 0
created_at:
type: string
example: '2020-06-04 22:41:13'
updated_at:
type: string
example: '2020-06-04 22:41:13'
tags:
- 'Types of service management'
parameters:
-
in: path
name: id
description: 'The ID of the types of service.'
example: illum
required: true
schema:
type: string
-
in: path
name: types_of_service
description: 'comma separated ids of required types of services'
example: '1'
required: true
schema:
type: string
/connector/api/unit:
get:
summary: 'List units'
operationId: listUnits
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
actual_name:
type: string
example: Pieces
short_name:
type: string
example: Pc(s)
allow_decimal:
type: integer
example: 0
base_unit_id:
type: string
example: null
base_unit_multiplier:
type: string
example: null
created_by:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 15:15:20'
updated_at:
type: string
example: '2018-01-03 15:15:20'
base_unit:
type: string
example: null
tags:
- 'Unit management'
'/connector/api/unit/{id}':
get:
summary: 'Get the specified unit'
operationId: getTheSpecifiedUnit
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
data:
type: array
example:
-
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
items:
type: object
properties:
id:
type: integer
example: 1
business_id:
type: integer
example: 1
actual_name:
type: string
example: Pieces
short_name:
type: string
example: Pc(s)
allow_decimal:
type: integer
example: 0
base_unit_id:
type: string
example: null
base_unit_multiplier:
type: string
example: null
created_by:
type: integer
example: 1
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-03 15:15:20'
updated_at:
type: string
example: '2018-01-03 15:15:20'
base_unit:
type: string
example: null
tags:
- 'Unit management'
parameters:
-
in: path
name: id
description: 'The ID of the unit.'
example: illo
required: true
schema:
type: string
-
in: path
name: unit
description: 'comma separated ids of the units'
example: '1'
required: true
schema:
type: string
/connector/api/user/loggedin:
get:
summary: 'Get the loggedin user details.'
operationId: getTheLoggedinUserDetails
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: object
properties:
id:
type: integer
example: 1
user_type:
type: string
example: user
surname:
type: string
example: Mr
first_name:
type: string
example: Admin
last_name:
type: string
example: null
username:
type: string
example: admin
email:
type: string
example: admin@example.com
language:
type: string
example: en
contact_no:
type: string
example: null
address:
type: string
example: null
business_id:
type: integer
example: 1
max_sales_discount_percent:
type: string
example: null
allow_login:
type: integer
example: 1
essentials_department_id:
type: string
example: null
essentials_designation_id:
type: string
example: null
status:
type: string
example: active
crm_contact_id:
type: string
example: null
is_cmmsn_agnt:
type: integer
example: 0
cmmsn_percent:
type: string
example: '0.00'
selected_contacts:
type: integer
example: 0
dob:
type: string
example: null
gender:
type: string
example: null
marital_status:
type: string
example: null
blood_group:
type: string
example: null
contact_number:
type: string
example: null
fb_link:
type: string
example: null
twitter_link:
type: string
example: null
social_media_1:
type: string
example: null
social_media_2:
type: string
example: null
permanent_address:
type: string
example: null
current_address:
type: string
example: null
guardian_name:
type: string
example: null
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
bank_details:
type: string
example: null
id_proof_name:
type: string
example: null
id_proof_number:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:19'
updated_at:
type: string
example: '2018-01-04 02:15:19'
tags:
- 'User management'
/connector/api/user-registration:
post:
summary: 'Register User'
operationId: registerUser
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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
properties:
success:
type: integer
example: 1
msg:
type: string
example: 'User added successfully'
user:
type: object
properties:
surname:
type: string
example: Mr
first_name:
type: string
example: Test
last_name:
type: string
example: kumar
email:
type: string
example: test@example.com
user_type:
type: string
example: user_customer
crm_contact_id:
type: string
example: '2'
allow_login:
type: integer
example: 1
username:
type: string
example: '0017'
cmmsn_percent:
type: string
example: '25'
max_sales_discount_percent:
type: string
example: '52'
dob:
type: string
example: '1997-10-12'
gender:
type: string
example: male
marital_status:
type: string
example: unmarried
blood_group:
type: string
example: 0+
contact_number:
type: string
example: '4578451245'
alt_number:
type: string
example: '7474747474'
family_number:
type: string
example: '7474147414'
fb_link:
type: string
example: fb.com/username
twitter_link:
type: string
example: twitter.com/username
social_media_1:
type: string
example: test
social_media_2:
type: string
example: test
custom_field_1:
type: string
example: test
custom_field_2:
type: string
example: test
custom_field_3:
type: string
example: test
custom_field_4:
type: string
example: test
guardian_name:
type: string
example: test
id_proof_name:
type: string
example: uid
id_proof_number:
type: string
example: '747845120124'
permanent_address:
type: string
example: 'test permanent adrress'
current_address:
type: string
example: 'test current address'
bank_details:
type: string
example: '{"account_holder_name":"test","account_number":"test","bank_name":"test","bank_code":"test","branch":"test","tax_payer_id":"test"}'
selected_contacts:
type: string
example: '1'
status:
type: string
example: active
business_id:
type: integer
example: 1
updated_at:
type: string
example: '2021-08-12 18:03:58'
created_at:
type: string
example: '2021-08-12 18:03:58'
id:
type: integer
example: 140
tags:
- 'User management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
surname:
type: string
description: 'prefix like Mr, Mrs,Dr'
example: sunt
first_name:
type: string
description: ''
example: quidem
last_name:
type: string
description: ''
example: aut
email:
type: string
description: ''
example: ewilliamson@example.net
is_active:
type: string
description: "'active', 'inactive', 'terminated'"
example: sit
user_type:
type: string
description: "'user_customer' for contact/customer login & 'user' for general user"
example: aliquid
crm_contact_id:
type: integer
description: "if user_type is 'user_customer' then required"
example: 12
allow_login:
type: boolean
description: '1 to allow login & 0 to disable login'
example: false
username:
type: string
description: 'minimum 5 characters'
example: ullam
password:
type: string
description: "minimum 5 characters (as the web user form) & required if 'allow_login' is 1"
example: 'po~Aj[ZM%,yh'
role:
type: integer
description: "id of role to be assigned to user & required if user_type is 'user'"
example: 7
access_all_locations:
type: boolean
description: "1 if user has access all location else 0 & required if user_type is 'user'"
example: true
location_permissions:
type: array
description: "array of location ids to be assigned to user & required if user_type is 'user' and 'access_all_locations' is 0"
example:
- et
items:
type: string
cmmsn_percent:
type: decimal
description: ''
example: itaque
max_sales_discount_percent:
type: decimal
description: ''
example: pariatur
selected_contacts:
type: boolean
description: '1 or 0'
example: true
selected_contact_ids:
type: array
description: "array of contact ids & required if 'selected_contacts' is 1"
example:
- facilis
items:
type: string
dob:
type: date
description: 'dob of user in "Y-m-d" format Ex: 1997-10-29'
example: omnis
gender:
type: string
description: "if user is 'male', 'female', 'others'"
example: voluptatem
marital_status:
type: string
description: "if user is 'married', 'unmarried', 'divorced'"
example: tempore
blood_group:
type: string
description: ''
example: placeat
contact_number:
type: string
description: ''
example: dolores
alt_number:
type: string
description: ''
example: nulla
family_number:
type: string
description: ''
example: tempora
fb_link:
type: string
description: ''
example: quo
twitter_link:
type: string
description: ''
example: voluptatem
social_media_1:
type: string
description: ''
example: quibusdam
social_media_2:
type: string
description: ''
example: molestiae
custom_field_1:
type: string
description: ''
example: reprehenderit
custom_field_2:
type: string
description: ''
example: et
custom_field_3:
type: string
description: ''
example: nihil
custom_field_4:
type: string
description: ''
example: sequi
guardian_name:
type: string
description: ''
example: cum
id_proof_name:
type: string
description: 'ID proof of user like Adhar No.'
example: et
id_proof_number:
type: string
description: 'Id Number like adhar number'
example: necessitatibus
permanent_address:
type: string
description: ''
example: molestiae
current_address:
type: string
description: ''
example: reprehenderit
bank_details:
type: object
description: ''
example:
'*':
account_holder_name: aperiam
properties:
'*':
type: object
description: ''
example:
account_holder_name: aperiam
properties:
account_holder_name:
type: string
description: ''
example: aperiam
account_number:
type: string
description: ''
example: consequatur
bank_name:
type: string
description: ''
example: officiis
bank_code:
type: string
description: ''
example: nesciunt
branch:
type: string
description: ''
example: nulla
tax_payer_id:
type: string
description: ''
example: possimus
required:
- first_name
- email
- is_active
- user_type
/connector/api/user:
get:
summary: 'List users'
operationId: listUsers
description: ''
parameters:
-
in: query
name: service_staff
description: 'Filter service staffs from users list (0, 1)'
example: false
required: false
schema:
type: boolean
description: 'Filter service staffs from users list (0, 1)'
example: false
-
in: query
name: per_page
description: 'Optional paging (up to 500 per page); without it, or with -1, the whole list'
example: 50
required: false
schema:
type: integer
description: 'Optional paging (up to 500 per page); without it, or with -1, the whole list'
example: 50
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
user_type:
type: string
example: user
surname:
type: string
example: Mr
first_name:
type: string
example: Admin
last_name:
type: string
example: null
username:
type: string
example: admin
email:
type: string
example: admin@example.com
language:
type: string
example: en
contact_no:
type: string
example: null
address:
type: string
example: null
business_id:
type: integer
example: 1
max_sales_discount_percent:
type: string
example: null
allow_login:
type: integer
example: 1
essentials_department_id:
type: string
example: null
essentials_designation_id:
type: string
example: null
status:
type: string
example: active
crm_contact_id:
type: string
example: null
is_cmmsn_agnt:
type: integer
example: 0
cmmsn_percent:
type: string
example: '0.00'
selected_contacts:
type: integer
example: 0
dob:
type: string
example: null
gender:
type: string
example: null
marital_status:
type: string
example: null
blood_group:
type: string
example: null
contact_number:
type: string
example: null
fb_link:
type: string
example: null
twitter_link:
type: string
example: null
social_media_1:
type: string
example: null
social_media_2:
type: string
example: null
permanent_address:
type: string
example: null
current_address:
type: string
example: null
guardian_name:
type: string
example: null
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
bank_details:
type: string
example: null
id_proof_name:
type: string
example: null
id_proof_number:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:19'
updated_at:
type: string
example: '2018-01-04 02:15:19'
tags:
- 'User management'
'/connector/api/user/{id}':
get:
summary: 'Get the specified user'
operationId: getTheSpecifiedUser
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
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'
properties:
data:
type: array
example:
-
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'
items:
type: object
properties:
id:
type: integer
example: 1
user_type:
type: string
example: user
surname:
type: string
example: Mr
first_name:
type: string
example: Admin
last_name:
type: string
example: null
username:
type: string
example: admin
email:
type: string
example: admin@example.com
language:
type: string
example: en
contact_no:
type: string
example: null
address:
type: string
example: null
business_id:
type: integer
example: 1
max_sales_discount_percent:
type: string
example: null
allow_login:
type: integer
example: 1
essentials_department_id:
type: string
example: null
essentials_designation_id:
type: string
example: null
status:
type: string
example: active
crm_contact_id:
type: string
example: null
is_cmmsn_agnt:
type: integer
example: 0
cmmsn_percent:
type: string
example: '0.00'
selected_contacts:
type: integer
example: 0
dob:
type: string
example: null
gender:
type: string
example: null
marital_status:
type: string
example: null
blood_group:
type: string
example: null
contact_number:
type: string
example: null
fb_link:
type: string
example: null
twitter_link:
type: string
example: null
social_media_1:
type: string
example: null
social_media_2:
type: string
example: null
permanent_address:
type: string
example: null
current_address:
type: string
example: null
guardian_name:
type: string
example: null
custom_field_1:
type: string
example: null
custom_field_2:
type: string
example: null
custom_field_3:
type: string
example: null
custom_field_4:
type: string
example: null
bank_details:
type: string
example: null
id_proof_name:
type: string
example: null
id_proof_number:
type: string
example: null
deleted_at:
type: string
example: null
created_at:
type: string
example: '2018-01-04 02:15:19'
updated_at:
type: string
example: '2018-01-04 02:15:19'
tags:
- 'User management'
parameters:
-
in: path
name: id
description: 'The ID of the user.'
example: 1
required: true
schema:
type: integer
-
in: path
name: user
description: 'comma separated ids of the required users'
example: '1'
required: true
schema:
type: string
/connector/api/update-password:
post:
summary: 'Update user password.'
operationId: updateUserPassword
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: 1
msg: 'Password updated successfully'
properties:
success:
type: integer
example: 1
msg:
type: string
example: 'Password updated successfully'
tags:
- 'User management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
current_password:
type: string
description: 'Current password of the user'
example: similique
new_password:
type: string
description: 'New password of the user, at least 5 characters'
example: numquam
required:
- current_password
- new_password
/connector/api/forget-password:
post:
summary: 'Recover forgotten password.'
operationId: recoverForgottenPassword
description: ''
parameters:
-
in: header
name: Authorization
description: ''
example: 'Bearer {access_token}'
schema:
type: string
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: 1
msg: 'New password sent to user@example.com successfully'
properties:
success:
type: integer
example: 1
msg:
type: string
example: 'New password sent to user@example.com successfully'
tags:
- 'User management'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
email:
type: string
description: 'Users email id'
example: wmueller@example.org
required:
- email
tags:
-
name: 'Attendance (HRM)'
description: ''
-
name: Authentication
description: ''
-
name: 'Brand management'
description: ''
-
name: 'Business Location management'
description: ''
-
name: CRM
description: ''
-
name: 'Cash register management'
description: ''
-
name: 'Contact management'
description: ''
-
name: 'Expense management'
description: ''
-
name: 'Field Force'
description: ''
-
name: 'New end points'
description: ''
-
name: 'Online store (Ecommerce)'
description: ''
-
name: 'Other endpoints · واجهات أخرى'
description: ''
-
name: 'Product management'
description: ''
-
name: 'Sales management'
description: ''
-
name: Superadmin
description: ''
-
name: 'Table management'
description: ''
-
name: 'Tax management'
description: ''
-
name: 'Taxonomy management'
description: ''
-
name: 'Types of service management'
description: ''
-
name: 'Unit management'
description: ''
-
name: 'User management'
description: ''
components:
securitySchemes:
default:
type: http
scheme: bearer
description: ''
security:
-
default: []