openapi: 3.0.3 info: title: 'Gulf POS API Documentation' description: 'Gulf POS API Documentation' version: 1.0.0 servers: - url: 'https://gulfpos.com' tags: - name: Authentication description: '' - name: 'Business Locations' description: '' - name: Contacts description: '' - name: Products description: '' - name: Categories description: '' - name: Brands description: '' - name: Units description: '' - name: Tax description: '' - name: 'Types of Service' description: '' - name: Tables description: '' - name: Sales description: '' - name: Expenses description: '' - name: 'Cash Register' description: '' - name: Payments description: '' - name: Users description: '' - name: Attendance description: '' - name: Reports description: '' - name: Notifications description: '' components: securitySchemes: default: type: http scheme: bearer description: '

Getting your access token

  1. Navigate to the Connector section in your dashboard
  2. Click on Clients to view your API clients
  3. Create a new API client or use an existing one
  4. Use the Client ID and Client Secret to request an access token via the /oauth/token endpoint
  5. Include the access token in the Authorization header as Bearer {access_token}
' security: - default: [] paths: /oauth/token: post: summary: "Authorize a client to access the user's account." operationId: authorizeAClientToAccessTheUsersAccount description: '' parameters: [] responses: { } tags: - Authentication security: [] /oauth/token/refresh: post: summary: 'Get a fresh transient token cookie for the authenticated user.' operationId: getAFreshTransientTokenCookieForTheAuthenticatedUser description: '' parameters: [] responses: { } tags: - Authentication security: [] /connector/api/business-location: get: summary: 'List business locations' operationId: listBusinessLocations description: '' parameters: [] 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 nullable: true 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 nullable: true print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null nullable: true mobile: type: string example: null nullable: true alternate_number: type: string example: null nullable: true email: type: string example: null nullable: true website: type: string example: null nullable: true 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 nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:15:20' updated_at: type: string example: '2020-06-05 00:56:54' tags: - 'Business Locations' '/connector/api/business-location/{id}': get: summary: 'Get the specified business location' operationId: getTheSpecifiedBusinessLocation description: '' parameters: [] 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 nullable: true 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 nullable: true print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null nullable: true mobile: type: string example: null nullable: true alternate_number: type: string example: null nullable: true email: type: string example: null nullable: true website: type: string example: null nullable: true 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 nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:15:20' updated_at: type: string example: '2020-06-05 00:56:54' tags: - 'Business Locations' parameters: - in: path name: id description: 'The ID of the business location.' example: architecto 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/business-details: get: summary: 'Get business details' operationId: getBusinessDetails description: '' parameters: [] 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 nullable: true tax_label_2: type: string example: null nullable: true default_sales_tax: type: string example: null nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true essentials_settings: type: string example: null nullable: true ecom_settings: type: string example: null nullable: true woocommerce_wh_oc_secret: type: string example: null nullable: true woocommerce_wh_ou_secret: type: string example: null nullable: true woocommerce_wh_od_secret: type: string example: null nullable: true woocommerce_wh_or_secret: type: string example: null nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true business_location: type: string example: BL username: type: string example: null nullable: true subscription: type: string example: null nullable: true theme_color: type: string example: null nullable: true created_by: type: string example: null nullable: true enable_rp: type: integer example: 0 rp_name: type: string example: null nullable: true 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 nullable: true 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 nullable: true max_redeem_point: type: string example: null nullable: true rp_expiry_period: type: string example: null nullable: true rp_expiry_type: type: string example: year repair_settings: type: string example: null nullable: true email_settings: type: object properties: mail_driver: type: string example: smtp mail_host: type: string example: null nullable: true mail_port: type: string example: null nullable: true mail_username: type: string example: null nullable: true mail_password: type: string example: null nullable: true mail_encryption: type: string example: null nullable: true mail_from_address: type: string example: null nullable: true mail_from_name: type: string example: null nullable: true sms_settings: type: object properties: url: type: string example: null nullable: true 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 nullable: true param_val_1: type: string example: null nullable: true param_2: type: string example: null nullable: true param_val_2: type: string example: null nullable: true param_3: type: string example: null nullable: true param_val_3: type: string example: null nullable: true param_4: type: string example: null nullable: true param_val_4: type: string example: null nullable: true param_5: type: string example: null nullable: true param_val_5: type: string example: null nullable: true param_6: type: string example: null nullable: true param_val_6: type: string example: null nullable: true param_7: type: string example: null nullable: true param_val_7: type: string example: null nullable: true param_8: type: string example: null nullable: true param_val_8: type: string example: null nullable: true param_9: type: string example: null nullable: true param_val_9: type: string example: null nullable: true param_10: type: string example: null nullable: true param_val_10: type: string example: null nullable: true custom_labels: type: object properties: payments: type: object properties: custom_pay_1: type: string example: null nullable: true custom_pay_2: type: string example: null nullable: true custom_pay_3: type: string example: null nullable: true contact: type: object properties: custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true product: type: object properties: custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true location: type: object properties: custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true user: type: object properties: custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true purchase: type: object properties: custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true sell: type: object properties: custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true types_of_service: type: object properties: custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true 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 nullable: true 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 nullable: true print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null nullable: true mobile: type: string example: null nullable: true alternate_number: type: string example: null nullable: true email: type: string example: null nullable: true website: type: string example: null nullable: true 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 nullable: true card: type: object properties: is_enabled: type: string example: '1' account: type: string example: null nullable: true cheque: type: object properties: is_enabled: type: string example: '1' account: type: string example: null nullable: true bank_transfer: type: object properties: is_enabled: type: string example: '1' account: type: string example: null nullable: true other: type: object properties: is_enabled: type: string example: '1' account: type: string example: null nullable: true custom_pay_1: type: object properties: is_enabled: type: string example: '1' account: type: string example: null nullable: true custom_pay_2: type: object properties: is_enabled: type: string example: '1' account: type: string example: null nullable: true custom_pay_3: type: object properties: is_enabled: type: string example: '1' account: type: string example: null nullable: true custom_field1: type: string example: null nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true updated_at: type: string example: null nullable: true printers: type: array example: [] currency_precision: type: integer example: 2 quantity_precision: type: integer example: 2 tags: - 'Business Locations' /connector/api/get-location: get: summary: 'Get location details from coordinates' operationId: getLocationDetailsFromCoordinates description: '' parameters: [] 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: - 'Business Locations' 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/contactapi: get: summary: 'List contact' operationId: listContact description: '' parameters: - in: query name: type description: 'Type of contact (supplier, customer)' example: architecto required: true schema: type: string description: 'Type of contact (supplier, customer)' example: architecto - in: query name: name description: 'Search term for contact name' example: architecto required: false schema: type: string description: 'Search term for contact name' example: architecto - in: query name: biz_name description: "Search term for contact's business name" example: architecto required: false schema: type: string description: "Search term for contact's business name" example: architecto - in: query name: mobile_num description: "Search term for contact's mobile number" example: 16 required: false schema: type: integer description: "Search term for contact's mobile number" example: 16 - in: query name: contact_id description: "Search term for contact's contact_id. Ex(CO0005)" example: architecto required: false schema: type: string description: "Search term for contact's contact_id. Ex(CO0005)" example: architecto - in: query name: order_by description: 'Column name to sort the result, Column: name, supplier_business_name' example: architecto required: false schema: type: string description: 'Column name to sort the result, Column: name, supplier_business_name' example: architecto - in: query name: direction description: 'Direction to sort the result, Direction: desc, asc' example: architecto required: false schema: type: string description: 'Direction to sort the result, Direction: desc, asc' example: architecto - 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 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: 'http://local.pos.com/connector/api/contactapi?page=1' last: 'http://local.pos.com/connector/api/contactapi?page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 path: 'http://local.pos.com/connector/api/contactapi' per_page: '10' to: 4 total: 4 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 nullable: true first_name: type: string example: Michael middle_name: type: string example: null nullable: true last_name: type: string example: null nullable: true email: type: string example: null nullable: true 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 nullable: true zip_code: type: string example: null nullable: true dob: type: string example: null nullable: true mobile: type: string example: '(378) 400-1234' landline: type: string example: null nullable: true alternate_number: type: string example: null nullable: true pay_term_number: type: integer example: 15 pay_term_type: type: string example: days credit_limit: type: string example: null nullable: true 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 nullable: true position: type: string example: null nullable: true customer_group_id: type: string example: null nullable: true crm_source: type: string example: null nullable: true crm_life_stage: type: string example: null nullable: true custom_field1: type: string example: null nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true custom_field5: type: string example: null nullable: true custom_field6: type: string example: null nullable: true custom_field7: type: string example: null nullable: true custom_field8: type: string example: null nullable: true custom_field9: type: string example: null nullable: true custom_field10: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true password: type: string example: null nullable: true links: type: object properties: first: type: string example: 'http://local.pos.com/connector/api/contactapi?page=1' last: type: string example: 'http://local.pos.com/connector/api/contactapi?page=1' prev: type: string example: null nullable: true next: type: string example: null nullable: true 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: 'http://local.pos.com/connector/api/contactapi' per_page: type: string example: '10' to: type: integer example: 4 total: type: integer example: 4 tags: - Contacts post: summary: 'Create contact' operationId: createContact description: '' parameters: [] 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 nullable: true 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: - Contacts 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: architecto prefix: type: string description: 'Prefix for the name of the contact' example: architecto first_name: type: string description: 'Name of the contact' example: architecto middle_name: type: string description: '' example: architecto last_name: type: string description: '' example: architecto 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: architecto address_line_2: type: string description: '' example: architecto city: type: string description: '' example: architecto state: type: string description: '' example: architecto country: type: string description: '' example: architecto zip_code: type: string description: '' example: architecto customer_group_id: type: string description: '' example: architecto contact_id: type: string description: '' example: architecto dob: type: string description: 'Fromat: Y-m-d' example: '2000-06-13' custom_field1: type: string description: '' example: architecto custom_field2: type: string description: '' example: architecto custom_field3: type: string description: '' example: architecto custom_field4: type: string description: '' example: architecto email: type: string description: '' example: gbailey@example.net shipping_address: type: string description: '' example: architecto position: type: string description: '' example: architecto 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: 16 life_stage_id: type: integer description: 'Id of the Life stage. Applicable only if the type is lead' example: 16 assigned_to: type: array description: 'Ids of the users the lead is assigned to. Applicable only if the type is lead' example: - architecto 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: [] 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 nullable: true name: type: string example: ' Walk-In Customer ' prefix: type: string example: null nullable: true first_name: type: string example: 'Walk-In Customer' middle_name: type: string example: null nullable: true last_name: type: string example: null nullable: true 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 nullable: true 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 nullable: true zip_code: type: string example: '85001' dob: type: string example: null nullable: true mobile: type: string example: '(378) 400-1234' landline: type: string example: null nullable: true alternate_number: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true 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 nullable: true position: type: string example: null nullable: true customer_group_id: type: string example: null nullable: true crm_source: type: string example: null nullable: true crm_life_stage: type: string example: null nullable: true custom_field1: type: string example: null nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true password: type: string example: null nullable: true customer_group: type: string example: null nullable: true 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: - Contacts put: summary: 'Update contact' operationId: updateContact description: '' parameters: [] 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 nullable: true name: type: string example: 'created from api' prefix: type: string example: null nullable: true first_name: type: string example: 'created from api' middle_name: type: string example: null nullable: true last_name: type: string example: null nullable: true email: type: string example: null nullable: true contact_id: type: string example: CO0009 contact_status: type: string example: active tax_number: type: string example: null nullable: true city: type: string example: null nullable: true state: type: string example: null nullable: true country: type: string example: null nullable: true address_line_1: type: string example: 'test address' address_line_2: type: string example: null nullable: true zip_code: type: string example: '54878787' dob: type: string example: '2000-06-13' mobile: type: string example: '8754154872154' landline: type: string example: null nullable: true alternate_number: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true credit_limit: type: string example: null nullable: true 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 nullable: true position: type: string example: null nullable: true customer_group_id: type: string example: null nullable: true crm_source: type: string example: null nullable: true crm_life_stage: type: string example: null nullable: true custom_field1: type: string example: null nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true password: type: string example: null nullable: true tags: - Contacts 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: architecto prefix: type: string description: 'Prefix for the name of the contact' example: architecto first_name: type: string description: 'Name of the contact' example: architecto middle_name: type: string description: '' example: architecto last_name: type: string description: '' example: architecto 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: architecto address_line_2: type: string description: '' example: architecto city: type: string description: '' example: architecto state: type: string description: '' example: architecto country: type: string description: '' example: architecto zip_code: type: string description: '' example: architecto customer_group_id: type: string description: '' example: architecto contact_id: type: string description: '' example: architecto dob: type: string description: 'Fromat: Y-m-d' example: '2000-06-13' custom_field1: type: string description: '' example: architecto custom_field2: type: string description: '' example: architecto custom_field3: type: string description: '' example: architecto custom_field4: type: string description: '' example: architecto email: type: string description: '' example: gbailey@example.net shipping_address: type: string description: '' example: architecto position: type: string description: '' example: architecto opening_balance: type: number description: '' example: 10.3 source_id: type: integer description: 'Id of the source. Applicable only if the type is lead' example: 16 life_stage_id: type: integer description: 'Id of the Life stage. Applicable only if the type is lead' example: 16 assigned_to: type: array description: 'Ids of the users the lead is assigned to. Applicable only if the type is lead' example: - architecto items: type: string required: - first_name - mobile parameters: - in: path name: id description: 'The ID of the contactapi.' example: architecto 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: [] 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 nullable: true 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: - Contacts 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' example: 453.13 method: type: string description: "payment methods ('cash', 'card', 'cheque', 'bank_transfer', 'other', 'custom_pay_1', 'custom_pay_2', 'custom_pay_3')" example: cash paid_on: type: string description: 'transaction date format:Y-m-d H:i:s,' example: '2020-07-22 15:48:29' account_id: type: integer description: 'account id' example: 16 card_number: type: string description: '' example: architecto card_holder_name: type: string description: '' example: architecto card_transaction_number: type: string description: '' example: architecto card_type: type: string description: '' example: architecto card_month: type: string description: '' example: architecto card_year: type: string description: '' example: architecto card_security: type: string description: '' example: architecto transaction_no_1: type: string description: '' example: architecto transaction_no_2: type: string description: '' example: architecto transaction_no_3: type: string description: '' example: architecto cheque_number: type: string description: '' example: architecto bank_account_number: type: string description: '' example: architecto note: type: string description: 'payment note' example: architecto required: - contact_id - amount /connector/api/new_contactapi: get: summary: 'New List contact' operationId: newListContact description: '' parameters: - in: query name: type description: 'Type of contact (supplier, customer)' example: architecto required: true schema: type: string description: 'Type of contact (supplier, customer)' example: architecto - in: query name: customer_group_id description: 'id of the customer group' example: architecto required: false schema: type: string description: 'id of the customer group' example: architecto - in: query name: custom_field_1 description: 'Custom field 1 of the contact' example: architecto required: false schema: type: string description: 'Custom field 1 of the contact' example: architecto - 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: architecto required: false schema: type: string description: 'Search term for contact name' example: architecto - in: query name: biz_name description: "Search term for contact's business name" example: architecto required: false schema: type: string description: "Search term for contact's business name" example: architecto - in: query name: mobile_num description: "Search term for contact's mobile number" example: 16 required: false schema: type: integer description: "Search term for contact's mobile number" example: 16 - in: query name: contact_id description: "Search term for contact's contact_id. Ex(CO0005)" example: architecto required: false schema: type: string description: "Search term for contact's contact_id. Ex(CO0005)" example: architecto - in: query name: order_by description: 'Column name to sort the result, Column: name, supplier_business_name' example: architecto required: false schema: type: string description: 'Column name to sort the result, Column: name, supplier_business_name' example: architecto - in: query name: direction description: 'Direction to sort the result, Direction: desc, asc' example: architecto required: false schema: type: string description: 'Direction to sort the result, Direction: desc, asc' example: architecto - 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 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: 'http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1' last: 'http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1' prev: null next: null meta: current_page: 1 from: 1 last_page: 1 path: 'http://local.pos.com/connector/api/new_contactapi' per_page: 10 to: 1 total: 1 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 nullable: true contact_status: type: string example: active mobile: type: string example: '8596859647' credit_limit: type: string example: null nullable: true converted_by: type: string example: null nullable: true converted_on: type: string example: null nullable: true 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 nullable: true crm_life_stage: type: string example: null nullable: true custom_field1: type: string example: null nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true custom_field5: type: string example: null nullable: true custom_field6: type: string example: null nullable: true custom_field7: type: string example: null nullable: true custom_field8: type: string example: null nullable: true custom_field9: type: string example: null nullable: true custom_field10: type: string example: null nullable: true remember_token: type: string example: null nullable: true password: type: string example: null nullable: true links: type: object properties: first: type: string example: 'http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1' last: type: string example: 'http://local.pos.com/connector/api/new_contactapi?customer_group_id=1&page=1' prev: type: string example: null nullable: true next: type: string example: null nullable: true 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: 'http://local.pos.com/connector/api/new_contactapi' per_page: type: integer example: 10 to: type: integer example: 1 total: type: integer example: 1 tags: - Contacts /connector/api/product: get: summary: 'List products' operationId: listProducts description: '' parameters: - in: query name: order_by description: 'Values: product_name or newest' example: architecto required: false schema: type: string description: 'Values: product_name or newest' example: architecto - in: query name: order_direction description: 'Values: asc or desc' example: architecto required: false schema: type: string description: 'Values: asc or desc' example: architecto - in: query name: brand_id description: 'comma separated ids of one or multiple brands' example: architecto required: false schema: type: string description: 'comma separated ids of one or multiple brands' example: architecto - in: query name: category_id description: 'comma separated ids of one or multiple category' example: architecto required: false schema: type: string description: 'comma separated ids of one or multiple category' example: architecto - in: query name: sub_category_id description: 'comma separated ids of one or multiple sub-category' example: architecto required: false schema: type: string description: 'comma separated ids of one or multiple sub-category' example: architecto - 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: architecto required: false schema: type: string description: '(1, 0)' example: architecto - in: query name: send_lot_detail description: 'Send lot details in each variation location details(1, 0)' example: architecto required: false schema: type: string description: 'Send lot details in each variation location details(1, 0)' example: architecto - in: query name: name description: 'Search term for product name' example: architecto required: false schema: type: string description: 'Search term for product name' example: architecto - in: query name: sku description: 'Search term for product sku' example: architecto required: false schema: type: string description: 'Search term for product sku' example: architecto - 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 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: 'http://local.pos.com/img/default.png' product_variations: - id: 1 variation_template_id: null name: DUMMY product_id: 1 is_dummy: 1 created_at: '2018-01-03 21:29:08' updated_at: '2018-01-03 21:29:08' variations: - id: 1 name: DUMMY product_id: 1 sub_sku: AS0001 product_variation_id: 1 woocommerce_variation_id: null variation_value_id: null default_purchase_price: '130.0000' dpp_inc_tax: '143.0000' profit_percent: '0.0000' default_sell_price: '130.0000' sell_price_inc_tax: '143.0000' created_at: '2018-01-03 21:29:08' updated_at: '2020-06-09 00:23:22' deleted_at: null combo_variations: null variation_location_details: - id: 56 product_id: 1 product_variation_id: 1 variation_id: 1 location_id: 1 qty_available: '20.0000' created_at: '2020-06-08 23:46:40' updated_at: '2020-06-08 23:46:40' media: - id: 1 business_id: 1 file_name: 1591686466_978227300_nn.jpeg description: null uploaded_by: 9 model_type: App\Variation woocommerce_media_id: null model_id: 1 created_at: '2020-06-09 00:07:46' updated_at: '2020-06-09 00:07:46' display_name: nn.jpeg display_url: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' selling_price_group: - id: 2 variation_id: 1 price_group_id: 1 price_inc_tax: '140.0000' created_at: '2020-06-09 00:23:31' updated_at: '2020-06-09 00:23:31' brand: id: 1 business_id: 1 name: Levis description: null created_by: 1 deleted_at: null created_at: '2018-01-03 21:19:47' updated_at: '2018-01-03 21:19:47' unit: id: 1 business_id: 1 actual_name: Pieces short_name: Pc(s) allow_decimal: 0 base_unit_id: null base_unit_multiplier: null created_by: 1 deleted_at: null created_at: '2018-01-03 15:15:20' updated_at: '2018-01-03 15:15:20' category: id: 1 name: "Men's" business_id: 1 short_code: null parent_id: 0 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:06:34' updated_at: '2018-01-03 21:06:34' sub_category: id: 5 name: Shirts business_id: 1 short_code: null parent_id: 1 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:08:18' updated_at: '2018-01-03 21:08:18' product_tax: id: 1 business_id: 1 name: VAT@10% amount: 10 is_tax_group: 0 created_by: 1 woocommerce_tax_rate_id: null deleted_at: null created_at: '2018-01-04 02:40:07' updated_at: '2018-01-04 02:40:07' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: - '5' - '71' is_active: 1 default_payment_accounts: '{"cash":{"is_enabled":"1","account":"1"},"card":{"is_enabled":"1","account":"3"},"cheque":{"is_enabled":"1","account":"2"},"bank_transfer":{"is_enabled":"1","account":"1"},"other":{"is_enabled":"1","account":"3"},"custom_pay_1":{"is_enabled":"1","account":"1"},"custom_pay_2":{"is_enabled":"1","account":"2"},"custom_pay_3":{"is_enabled":"1","account":"3"}}' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2020-06-09 01:07:05' pivot: product_id: 2 location_id: 1 links: first: 'http://local.pos.com/connector/api/product?page=1' last: 'http://local.pos.com/connector/api/product?page=32' prev: null next: 'http://local.pos.com/connector/api/product?page=2' meta: current_page: 1 from: 1 path: 'http://local.pos.com/connector/api/product' per_page: 10 to: 10 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: 'http://local.pos.com/img/default.png' product_variations: - id: 1 variation_template_id: null name: DUMMY product_id: 1 is_dummy: 1 created_at: '2018-01-03 21:29:08' updated_at: '2018-01-03 21:29:08' variations: - id: 1 name: DUMMY product_id: 1 sub_sku: AS0001 product_variation_id: 1 woocommerce_variation_id: null variation_value_id: null default_purchase_price: '130.0000' dpp_inc_tax: '143.0000' profit_percent: '0.0000' default_sell_price: '130.0000' sell_price_inc_tax: '143.0000' created_at: '2018-01-03 21:29:08' updated_at: '2020-06-09 00:23:22' deleted_at: null combo_variations: null variation_location_details: - id: 56 product_id: 1 product_variation_id: 1 variation_id: 1 location_id: 1 qty_available: '20.0000' created_at: '2020-06-08 23:46:40' updated_at: '2020-06-08 23:46:40' media: - id: 1 business_id: 1 file_name: 1591686466_978227300_nn.jpeg description: null uploaded_by: 9 model_type: App\Variation woocommerce_media_id: null model_id: 1 created_at: '2020-06-09 00:07:46' updated_at: '2020-06-09 00:07:46' display_name: nn.jpeg display_url: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' selling_price_group: - id: 2 variation_id: 1 price_group_id: 1 price_inc_tax: '140.0000' created_at: '2020-06-09 00:23:31' updated_at: '2020-06-09 00:23:31' brand: id: 1 business_id: 1 name: Levis description: null created_by: 1 deleted_at: null created_at: '2018-01-03 21:19:47' updated_at: '2018-01-03 21:19:47' unit: id: 1 business_id: 1 actual_name: Pieces short_name: Pc(s) allow_decimal: 0 base_unit_id: null base_unit_multiplier: null created_by: 1 deleted_at: null created_at: '2018-01-03 15:15:20' updated_at: '2018-01-03 15:15:20' category: id: 1 name: "Men's" business_id: 1 short_code: null parent_id: 0 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:06:34' updated_at: '2018-01-03 21:06:34' sub_category: id: 5 name: Shirts business_id: 1 short_code: null parent_id: 1 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:08:18' updated_at: '2018-01-03 21:08:18' product_tax: id: 1 business_id: 1 name: VAT@10% amount: 10 is_tax_group: 0 created_by: 1 woocommerce_tax_rate_id: null deleted_at: null created_at: '2018-01-04 02:40:07' updated_at: '2018-01-04 02:40:07' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: - '5' - '71' is_active: 1 default_payment_accounts: '{"cash":{"is_enabled":"1","account":"1"},"card":{"is_enabled":"1","account":"3"},"cheque":{"is_enabled":"1","account":"2"},"bank_transfer":{"is_enabled":"1","account":"1"},"other":{"is_enabled":"1","account":"3"},"custom_pay_1":{"is_enabled":"1","account":"1"},"custom_pay_2":{"is_enabled":"1","account":"2"},"custom_pay_3":{"is_enabled":"1","account":"3"}}' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2020-06-09 01:07:05' pivot: product_id: 2 location_id: 1 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 nullable: true 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 nullable: true expiry_period_type: type: string example: null nullable: true enable_sr_no: type: integer example: 0 weight: type: string example: null nullable: true product_custom_field1: type: string example: null nullable: true product_custom_field2: type: string example: null nullable: true product_custom_field3: type: string example: null nullable: true product_custom_field4: type: string example: null nullable: true image: type: string example: null nullable: true woocommerce_media_id: type: string example: null nullable: true product_description: type: string example: null nullable: true created_by: type: integer example: 1 warranty_id: type: string example: null nullable: true is_inactive: type: integer example: 0 repair_model_id: type: string example: null nullable: true not_for_selling: type: integer example: 0 ecom_shipping_class_id: type: string example: null nullable: true 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: 'http://local.pos.com/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: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' selling_price_group: - id: 2 variation_id: 1 price_group_id: 1 price_inc_tax: '140.0000' created_at: '2020-06-09 00:23:31' updated_at: '2020-06-09 00:23:31' items: type: object properties: id: type: integer example: 1 variation_template_id: type: string example: null nullable: true 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: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' } discounts: - { id: 2, name: 'FLAT 10%', business_id: 1, brand_id: null, category_id: null, location_id: 1, priority: 2, discount_type: fixed, discount_amount: '5.0000', starts_at: '2021-09-01 11:45:00', ends_at: '2021-09-30 11:45:00', is_active: 1, spg: null, applicable_in_cg: 1, created_at: '2021-09-01 11:46:00', updated_at: '2021-09-01 12:12:55', formated_starts_at: ' 11:45', formated_ends_at: ' 11:45' } selling_price_group: - { id: 2, variation_id: 1, price_group_id: 1, price_inc_tax: '140.0000', created_at: '2020-06-09 00:23:31', updated_at: '2020-06-09 00:23:31' } 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 nullable: true variation_value_id: type: string example: null nullable: true 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 nullable: true combo_variations: type: string example: null nullable: true 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: 'http://local.pos.com/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, nullable: true }, uploaded_by: { type: integer, example: 9 }, model_type: { type: string, example: App\Variation }, woocommerce_media_id: { type: string, example: null, nullable: true }, 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: 'http://local.pos.com/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, nullable: true }, category_id: { type: string, example: null, nullable: true }, 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, nullable: true }, 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 nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true 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 nullable: true base_unit_multiplier: type: string example: null nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 0 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 1 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true 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 nullable: true print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null nullable: true mobile: type: string example: null nullable: true alternate_number: type: string example: null nullable: true email: type: string example: null nullable: true website: type: string example: null nullable: true 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 nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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: 'http://local.pos.com/connector/api/product?page=1' last: type: string example: 'http://local.pos.com/connector/api/product?page=32' prev: type: string example: null nullable: true next: type: string example: 'http://local.pos.com/connector/api/product?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'http://local.pos.com/connector/api/product' per_page: type: integer example: 10 to: type: integer example: 10 tags: - Products post: summary: 'Create product' operationId: createProduct description: "Creates a product with its variations, locations, optional rack details, media, module fields,\nand opening stock. User must have the product.create permission. If opening_stock is sent,\nuser must also have the product.opening_stock permission." parameters: [] responses: 201: description: '' content: application/json: schema: type: object example: data: id: 101 name: 'Test product' business_id: 1 type: single enable_stock: 1 sku: AS0101 barcode_type: C128 product_variations: - name: DUMMY variations: - name: DUMMY sub_sku: AS0101 default_purchase_price: '100.0000' sell_price_inc_tax: '125.0000' variation_location_details: - location_id: 1 qty_available: '10.0000' product_locations: - id: 1 name: 'Main Location' properties: data: type: object properties: id: type: integer example: 101 name: type: string example: 'Test product' business_id: type: integer example: 1 type: type: string example: single enable_stock: type: integer example: 1 sku: type: string example: AS0101 barcode_type: type: string example: C128 product_variations: type: array example: - name: DUMMY variations: - name: DUMMY sub_sku: AS0101 default_purchase_price: '100.0000' sell_price_inc_tax: '125.0000' variation_location_details: - location_id: 1 qty_available: '10.0000' items: type: object properties: name: type: string example: DUMMY variations: type: array example: - name: DUMMY sub_sku: AS0101 default_purchase_price: '100.0000' sell_price_inc_tax: '125.0000' variation_location_details: - location_id: 1 qty_available: '10.0000' items: type: object properties: name: type: string example: DUMMY sub_sku: type: string example: AS0101 default_purchase_price: type: string example: '100.0000' sell_price_inc_tax: type: string example: '125.0000' variation_location_details: type: array example: - { location_id: 1, qty_available: '10.0000' } items: type: object properties: { location_id: { type: integer, example: 1 }, qty_available: { type: string, example: '10.0000' } } product_locations: type: array example: - id: 1 name: 'Main Location' items: type: object properties: id: type: integer example: 1 name: type: string example: 'Main Location' tags: - Products requestBody: required: true content: multipart/form-data: schema: type: object properties: name: type: string description: 'Product name.' example: 'Test product' alternative_name: type: string description: 'Product alternative name.' example: 'Producto de prueba' brand_id: type: integer description: 'Brand id.' example: 1 unit_id: type: integer description: 'Unit id.' example: 1 category_id: type: integer description: 'Product category id.' example: 1 sub_category_id: type: integer description: 'Product sub-category id.' example: 2 tax: type: integer description: 'Tax rate id.' example: 1 tax_type: type: string description: 'Tax type: inclusive or exclusive.' example: exclusive type: type: string description: 'Product type: single, variable or combo.' example: single barcode_type: type: string description: 'Barcode type.' example: C128 sku: type: string description: 'Product SKU. Leave empty to auto generate.' example: architecto enable_stock: type: integer description: 'Enable stock management: 1 or 0.' example: 1 alert_quantity: type: numeric description: 'Stock alert quantity.' example: '5' not_for_selling: type: integer description: 'Not for selling: 1 or 0.' example: 0 enable_sr_no: type: integer description: 'Enable IMEI/serial number: 1 or 0.' example: 0 weight: type: string description: 'Product weight.' example: '1.25' product_description: type: string description: 'Product description.' example: 'Created from connector API' product_custom_field1: type: string description: 'Custom field 1.' example: 'Shelf A' product_custom_field2: type: string description: 'Custom field 2.' example: 'Batch 2026' product_custom_field3: type: string description: 'Custom field 3.' example: Online product_custom_field4: type: string description: 'Custom field 4.' example: Imported product_locations: type: array description: 'Product location ids to assign, for example [1, 2].' example: - architecto items: type: string product_racks: type: array description: 'Rack/row/position details keyed by location id. Send values like location 1 => rack R1, row A, position P1.' example: - architecto items: type: string image: type: string format: binary description: 'Product image upload.' product_brochure: type: string format: binary description: 'Product brochure/media upload.' single_dpp: type: numeric description: 'Required when type is single. Default purchase price excluding tax.' example: '100' single_dpp_inc_tax: type: numeric description: 'Required when type is single. Default purchase price including tax.' example: '100' profit_percent: type: numeric description: 'Required when type is single. Profit margin percentage.' example: '25' single_dsp: type: numeric description: 'Required when type is single. Default selling price excluding tax.' example: '125' single_dsp_inc_tax: type: numeric description: 'Required when type is single. Default selling price including tax.' example: '125' product_variation: type: array description: 'Required when type is variable. Variation groups and variation rows.' example: - architecto items: type: string composition_variation_id: type: array description: 'Required when type is combo. Component variation ids, for example [10, 11].' example: - architecto items: type: string quantity: type: array description: 'Required when type is combo. Component quantities matching composition_variation_id, for example [2, 1].' example: - architecto items: type: string unit: type: array description: 'Required when type is combo. Component unit ids matching composition_variation_id, for example [1, 1].' example: - architecto items: type: string item_level_purchase_price_total: type: numeric description: 'Required when type is combo. Combo purchase price excluding tax.' example: '200' purchase_price_inc_tax: type: numeric description: 'Required when type is combo. Combo purchase price including tax.' example: '200' selling_price: type: numeric description: 'Required when type is combo. Combo selling price excluding tax.' example: '250' selling_price_inc_tax: type: numeric description: 'Required when type is combo. Combo selling price including tax.' example: '250' opening_stock: type: array description: 'Optional opening stock keyed by location id. For single/combo products, each location value contains quantity and purchase_price. For variable products, each location value must be keyed by variation sub_sku/name or contain rows with sub_sku/variation_name.' example: - architecto items: type: string required: - name - unit_id - type - barcode_type '/connector/api/product/{id}': get: summary: 'Get the specified product' operationId: getTheSpecifiedProduct description: '' parameters: - in: query name: selling_price_group description: '(1, 0)' example: architecto required: false schema: type: string description: '(1, 0)' example: architecto - in: query name: send_lot_detail description: 'Send lot details in each variation location details(1, 0)' example: architecto required: false schema: type: string description: 'Send lot details in each variation location details(1, 0)' example: architecto 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: 'http://local.pos.com/img/default.png' product_variations: - id: 1 variation_template_id: null name: DUMMY product_id: 1 is_dummy: 1 created_at: '2018-01-03 21:29:08' updated_at: '2018-01-03 21:29:08' variations: - id: 1 name: DUMMY product_id: 1 sub_sku: AS0001 product_variation_id: 1 woocommerce_variation_id: null variation_value_id: null default_purchase_price: '130.0000' dpp_inc_tax: '143.0000' profit_percent: '0.0000' default_sell_price: '130.0000' sell_price_inc_tax: '143.0000' created_at: '2018-01-03 21:29:08' updated_at: '2020-06-09 00:23:22' deleted_at: null combo_variations: null variation_location_details: - id: 56 product_id: 1 product_variation_id: 1 variation_id: 1 location_id: 1 qty_available: '20.0000' created_at: '2020-06-08 23:46:40' updated_at: '2020-06-08 23:46:40' media: - id: 1 business_id: 1 file_name: 1591686466_978227300_nn.jpeg description: null uploaded_by: 9 model_type: App\Variation woocommerce_media_id: null model_id: 1 created_at: '2020-06-09 00:07:46' updated_at: '2020-06-09 00:07:46' display_name: nn.jpeg display_url: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' selling_price_group: - id: 2 variation_id: 1 price_group_id: 1 price_inc_tax: '140.0000' created_at: '2020-06-09 00:23:31' updated_at: '2020-06-09 00:23:31' brand: id: 1 business_id: 1 name: Levis description: null created_by: 1 deleted_at: null created_at: '2018-01-03 21:19:47' updated_at: '2018-01-03 21:19:47' unit: id: 1 business_id: 1 actual_name: Pieces short_name: Pc(s) allow_decimal: 0 base_unit_id: null base_unit_multiplier: null created_by: 1 deleted_at: null created_at: '2018-01-03 15:15:20' updated_at: '2018-01-03 15:15:20' category: id: 1 name: "Men's" business_id: 1 short_code: null parent_id: 0 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:06:34' updated_at: '2018-01-03 21:06:34' sub_category: id: 5 name: Shirts business_id: 1 short_code: null parent_id: 1 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:08:18' updated_at: '2018-01-03 21:08:18' product_tax: id: 1 business_id: 1 name: VAT@10% amount: 10 is_tax_group: 0 created_by: 1 woocommerce_tax_rate_id: null deleted_at: null created_at: '2018-01-04 02:40:07' updated_at: '2018-01-04 02:40:07' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: - '5' - '71' is_active: 1 default_payment_accounts: '{"cash":{"is_enabled":"1","account":"1"},"card":{"is_enabled":"1","account":"3"},"cheque":{"is_enabled":"1","account":"2"},"bank_transfer":{"is_enabled":"1","account":"1"},"other":{"is_enabled":"1","account":"3"},"custom_pay_1":{"is_enabled":"1","account":"1"},"custom_pay_2":{"is_enabled":"1","account":"2"},"custom_pay_3":{"is_enabled":"1","account":"3"}}' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2020-06-09 01:07:05' pivot: product_id: 2 location_id: 1 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: 'http://local.pos.com/img/default.png' product_variations: - id: 1 variation_template_id: null name: DUMMY product_id: 1 is_dummy: 1 created_at: '2018-01-03 21:29:08' updated_at: '2018-01-03 21:29:08' variations: - id: 1 name: DUMMY product_id: 1 sub_sku: AS0001 product_variation_id: 1 woocommerce_variation_id: null variation_value_id: null default_purchase_price: '130.0000' dpp_inc_tax: '143.0000' profit_percent: '0.0000' default_sell_price: '130.0000' sell_price_inc_tax: '143.0000' created_at: '2018-01-03 21:29:08' updated_at: '2020-06-09 00:23:22' deleted_at: null combo_variations: null variation_location_details: - id: 56 product_id: 1 product_variation_id: 1 variation_id: 1 location_id: 1 qty_available: '20.0000' created_at: '2020-06-08 23:46:40' updated_at: '2020-06-08 23:46:40' media: - id: 1 business_id: 1 file_name: 1591686466_978227300_nn.jpeg description: null uploaded_by: 9 model_type: App\Variation woocommerce_media_id: null model_id: 1 created_at: '2020-06-09 00:07:46' updated_at: '2020-06-09 00:07:46' display_name: nn.jpeg display_url: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' selling_price_group: - id: 2 variation_id: 1 price_group_id: 1 price_inc_tax: '140.0000' created_at: '2020-06-09 00:23:31' updated_at: '2020-06-09 00:23:31' brand: id: 1 business_id: 1 name: Levis description: null created_by: 1 deleted_at: null created_at: '2018-01-03 21:19:47' updated_at: '2018-01-03 21:19:47' unit: id: 1 business_id: 1 actual_name: Pieces short_name: Pc(s) allow_decimal: 0 base_unit_id: null base_unit_multiplier: null created_by: 1 deleted_at: null created_at: '2018-01-03 15:15:20' updated_at: '2018-01-03 15:15:20' category: id: 1 name: "Men's" business_id: 1 short_code: null parent_id: 0 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:06:34' updated_at: '2018-01-03 21:06:34' sub_category: id: 5 name: Shirts business_id: 1 short_code: null parent_id: 1 created_by: 1 category_type: product description: null slug: null woocommerce_cat_id: null deleted_at: null created_at: '2018-01-03 21:08:18' updated_at: '2018-01-03 21:08:18' product_tax: id: 1 business_id: 1 name: VAT@10% amount: 10 is_tax_group: 0 created_by: 1 woocommerce_tax_rate_id: null deleted_at: null created_at: '2018-01-04 02:40:07' updated_at: '2018-01-04 02:40:07' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: - '5' - '71' is_active: 1 default_payment_accounts: '{"cash":{"is_enabled":"1","account":"1"},"card":{"is_enabled":"1","account":"3"},"cheque":{"is_enabled":"1","account":"2"},"bank_transfer":{"is_enabled":"1","account":"1"},"other":{"is_enabled":"1","account":"3"},"custom_pay_1":{"is_enabled":"1","account":"1"},"custom_pay_2":{"is_enabled":"1","account":"2"},"custom_pay_3":{"is_enabled":"1","account":"3"}}' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2020-06-09 01:07:05' pivot: product_id: 2 location_id: 1 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 nullable: true 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 nullable: true expiry_period_type: type: string example: null nullable: true enable_sr_no: type: integer example: 0 weight: type: string example: null nullable: true product_custom_field1: type: string example: null nullable: true product_custom_field2: type: string example: null nullable: true product_custom_field3: type: string example: null nullable: true product_custom_field4: type: string example: null nullable: true image: type: string example: null nullable: true woocommerce_media_id: type: string example: null nullable: true product_description: type: string example: null nullable: true created_by: type: integer example: 1 warranty_id: type: string example: null nullable: true is_inactive: type: integer example: 0 repair_model_id: type: string example: null nullable: true not_for_selling: type: integer example: 0 ecom_shipping_class_id: type: string example: null nullable: true 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: 'http://local.pos.com/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: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' selling_price_group: - id: 2 variation_id: 1 price_group_id: 1 price_inc_tax: '140.0000' created_at: '2020-06-09 00:23:31' updated_at: '2020-06-09 00:23:31' items: type: object properties: id: type: integer example: 1 variation_template_id: type: string example: null nullable: true 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: 'http://local.pos.com/uploads/media/1591686466_978227300_nn.jpeg' } discounts: - { id: 2, name: 'FLAT 10%', business_id: 1, brand_id: null, category_id: null, location_id: 1, priority: 2, discount_type: fixed, discount_amount: '5.0000', starts_at: '2021-09-01 11:45:00', ends_at: '2021-09-30 11:45:00', is_active: 1, spg: null, applicable_in_cg: 1, created_at: '2021-09-01 11:46:00', updated_at: '2021-09-01 12:12:55', formated_starts_at: ' 11:45', formated_ends_at: ' 11:45' } selling_price_group: - { id: 2, variation_id: 1, price_group_id: 1, price_inc_tax: '140.0000', created_at: '2020-06-09 00:23:31', updated_at: '2020-06-09 00:23:31' } 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 nullable: true variation_value_id: type: string example: null nullable: true 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 nullable: true combo_variations: type: string example: null nullable: true 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: 'http://local.pos.com/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, nullable: true }, uploaded_by: { type: integer, example: 9 }, model_type: { type: string, example: App\Variation }, woocommerce_media_id: { type: string, example: null, nullable: true }, 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: 'http://local.pos.com/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, nullable: true }, category_id: { type: string, example: null, nullable: true }, 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, nullable: true }, 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 nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true 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 nullable: true base_unit_multiplier: type: string example: null nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 0 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 1 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true 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 nullable: true print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null nullable: true mobile: type: string example: null nullable: true alternate_number: type: string example: null nullable: true email: type: string example: null nullable: true website: type: string example: null nullable: true 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 nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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: - Products parameters: - in: path name: id description: 'The ID of the product.' example: architecto 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: [] 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 nullable: true business_id: type: integer example: 1 is_active: type: integer example: 1 deleted_at: type: string example: null nullable: true created_at: type: string example: '2020-10-21 04:30:06' updated_at: type: string example: '2020-11-16 18:23:15' tags: - Products '/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: architecto required: false schema: type: string description: 'Filter by comma separated products ids' example: architecto - in: query name: location_id description: '' example: '1' required: false schema: type: string description: '' example: '1' - in: query name: brand_id description: '' example: architecto required: false schema: type: string description: '' example: architecto - in: query name: category_id description: '' example: architecto required: false schema: type: string description: '' example: architecto - in: query name: sub_category_id description: '' example: architecto required: false schema: type: string description: '' example: architecto - in: query name: not_for_selling description: 'Values: 0 or 1' example: architecto required: false schema: type: string description: 'Values: 0 or 1' example: architecto - in: query name: name description: 'Search term for product name' example: architecto required: false schema: type: string description: 'Search term for product name' example: architecto - in: query name: sku description: 'Search term for product sku' example: architecto required: false schema: type: string description: 'Search term for product sku' example: architecto - 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 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: 'http://local.pos.com/uploads/img/1528728059_fleece_crew.jpg' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: null is_active: 1 default_payment_accounts: '' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2019-12-11 04:53:39' pivot: product_id: 1 location_id: 1 - variation_id: 2 variation_name: '28' sub_sku: AS0002-1 product_id: 2 product_name: "Levis Men's Slimmy Fit Jeans" sku: AS0002 type: variable business_id: 1 barcode_type: C128 expiry_period: null expiry_period_type: null enable_sr_no: 0 weight: null product_custom_field1: null product_custom_field2: null product_custom_field3: null product_custom_field4: null product_image: 1528727964_levis_jeans.jpg product_description: null warranty_id: null brand_id: 1 brand_name: Levis unit_id: 1 enable_stock: 1 not_for_selling: 0 unit_name: Pc(s) unit_allow_decimal: 0 category_id: 1 category: "Men's" sub_category_id: 4 sub_category: Jeans tax_id: 1 tax_type: exclusive tax_name: VAT@10% tax_amount: 10 product_variation_id: 2 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' profit_percent: '0.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' product_variation_name: 'Waist Size' variation_location_details: - id: 1 product_id: 2 product_variation_id: 2 variation_id: 2 location_id: 1 qty_available: '50.0000' created_at: '2018-01-06 06:57:11' updated_at: '2020-08-04 04:11:27' media: - id: 1 business_id: 1 file_name: 1596701997_743693452_test.jpg description: null uploaded_by: 9 model_type: App\Variation woocommerce_media_id: null model_id: 2 created_at: '2020-08-06 13:49:57' updated_at: '2020-08-06 13:49:57' display_name: test.jpg display_url: 'http://local.pos.com/uploads/media/1596701997_743693452_test.jpg' selling_price_group: [] product_image_url: 'http://local.pos.com/uploads/img/1528727964_levis_jeans.jpg' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: null is_active: 1 default_payment_accounts: '' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2019-12-11 04:53:39' pivot: product_id: 2 location_id: 1 discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' links: first: 'http://local.pos.com/connector/api/variation?page=1' last: null prev: null next: 'http://local.pos.com/connector/api/variation?page=2' meta: current_page: 1 from: 1 path: 'http://local.pos.com/connector/api/variation' per_page: '2' to: 2 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: 'http://local.pos.com/uploads/img/1528728059_fleece_crew.jpg' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: null is_active: 1 default_payment_accounts: '' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2019-12-11 04:53:39' pivot: product_id: 1 location_id: 1 - variation_id: 2 variation_name: '28' sub_sku: AS0002-1 product_id: 2 product_name: "Levis Men's Slimmy Fit Jeans" sku: AS0002 type: variable business_id: 1 barcode_type: C128 expiry_period: null expiry_period_type: null enable_sr_no: 0 weight: null product_custom_field1: null product_custom_field2: null product_custom_field3: null product_custom_field4: null product_image: 1528727964_levis_jeans.jpg product_description: null warranty_id: null brand_id: 1 brand_name: Levis unit_id: 1 enable_stock: 1 not_for_selling: 0 unit_name: Pc(s) unit_allow_decimal: 0 category_id: 1 category: "Men's" sub_category_id: 4 sub_category: Jeans tax_id: 1 tax_type: exclusive tax_name: VAT@10% tax_amount: 10 product_variation_id: 2 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' profit_percent: '0.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' product_variation_name: 'Waist Size' variation_location_details: - id: 1 product_id: 2 product_variation_id: 2 variation_id: 2 location_id: 1 qty_available: '50.0000' created_at: '2018-01-06 06:57:11' updated_at: '2020-08-04 04:11:27' media: - id: 1 business_id: 1 file_name: 1596701997_743693452_test.jpg description: null uploaded_by: 9 model_type: App\Variation woocommerce_media_id: null model_id: 2 created_at: '2020-08-06 13:49:57' updated_at: '2020-08-06 13:49:57' display_name: test.jpg display_url: 'http://local.pos.com/uploads/media/1596701997_743693452_test.jpg' selling_price_group: [] product_image_url: 'http://local.pos.com/uploads/img/1528727964_levis_jeans.jpg' product_locations: - id: 1 business_id: 1 location_id: null name: 'Awesome Shop' landmark: 'Linking Street' country: USA state: Arizona city: Phoenix zip_code: '85001' invoice_scheme_id: 1 invoice_layout_id: 1 selling_price_group_id: null print_receipt_on_invoice: 1 receipt_printer_type: browser printer_id: null mobile: null alternate_number: null email: null website: null featured_products: null is_active: 1 default_payment_accounts: '' custom_field1: null custom_field2: null custom_field3: null custom_field4: null deleted_at: null created_at: '2018-01-04 02:15:20' updated_at: '2019-12-11 04:53:39' pivot: product_id: 2 location_id: 1 discounts: - id: 2 name: 'FLAT 10%' business_id: 1 brand_id: null category_id: null location_id: 1 priority: 2 discount_type: fixed discount_amount: '5.0000' starts_at: '2021-09-01 11:45:00' ends_at: '2021-09-30 11:45:00' is_active: 1 spg: null applicable_in_cg: 1 created_at: '2021-09-01 11:46:00' updated_at: '2021-09-01 12:12:55' formated_starts_at: ' 11:45' formated_ends_at: ' 11:45' 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 nullable: true expiry_period_type: type: string example: null nullable: true enable_sr_no: type: integer example: 0 weight: type: string example: null nullable: true product_custom_field1: type: string example: null nullable: true product_custom_field2: type: string example: null nullable: true product_custom_field3: type: string example: null nullable: true product_custom_field4: type: string example: null nullable: true product_image: type: string example: 1528728059_fleece_crew.jpg product_description: type: string example: null nullable: true warranty_id: type: string example: null nullable: true 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: 'http://local.pos.com/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 nullable: true 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 nullable: true print_receipt_on_invoice: type: integer example: 1 receipt_printer_type: type: string example: browser printer_id: type: string example: null nullable: true mobile: type: string example: null nullable: true alternate_number: type: string example: null nullable: true email: type: string example: null nullable: true website: type: string example: null nullable: true featured_products: type: string example: null nullable: true is_active: type: integer example: 1 default_payment_accounts: type: string example: '' custom_field1: type: string example: null nullable: true custom_field2: type: string example: null nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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: 'http://local.pos.com/connector/api/variation?page=1' last: type: string example: null nullable: true prev: type: string example: null nullable: true next: type: string example: 'http://local.pos.com/connector/api/variation?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'http://local.pos.com/connector/api/variation' per_page: type: string example: '2' to: type: integer example: 2 tags: - Products 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/new_product: get: summary: 'New List products' operationId: newListProducts description: '' parameters: - in: query name: order_by description: 'Values: product_name or newest' example: architecto required: false schema: type: string description: 'Values: product_name or newest' example: architecto - in: query name: order_direction description: 'Values: asc or desc' example: architecto required: false schema: type: string description: 'Values: asc or desc' example: architecto - in: query name: location_custom_field_1 description: 'Custom field 1 of the location' example: architecto required: false schema: type: string description: 'Custom field 1 of the location' example: architecto - in: query name: category_id description: 'comma separated ids of one or multiple category' example: architecto required: false schema: type: string description: 'comma separated ids of one or multiple category' example: architecto - in: query name: sub_category_id description: 'comma separated ids of one or multiple sub-category' example: architecto required: false schema: type: string description: 'comma separated ids of one or multiple sub-category' example: architecto - 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: architecto required: false schema: type: string description: '(1, 0)' example: architecto - in: query name: send_lot_detail description: 'Send lot details in each variation location details(1, 0)' example: architecto required: false schema: type: string description: 'Send lot details in each variation location details(1, 0)' example: architecto - in: query name: name description: 'Search term for product name' example: architecto required: false schema: type: string description: 'Search term for product name' example: architecto - in: query name: sku description: 'Search term for product sku' example: architecto required: false schema: type: string description: 'Search term for product sku' example: architecto - 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 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: 'http://local.pos.com/uploads/img/1528727964_levis_jeans.jpg' product_variations: - id: 2 variation_template_id: 5 name: 'Waist Size' product_id: 2 is_dummy: 0 variations: - id: 2 name: '28' product_id: 2 sub_sku: AS0002-1 product_variation_id: 2 woocommerce_variation_id: 658 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' combo_variations: null variation_location_details: - id: 1 product_id: 2 product_variation_id: 2 variation_id: 2 location_id: 1 qty_available: '71.0000' media: [] discounts: [] - id: 3 name: '30' product_id: 2 sub_sku: AS0002-2 product_variation_id: 2 woocommerce_variation_id: 659 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' combo_variations: null variation_location_details: - id: 2 product_id: 2 product_variation_id: 2 variation_id: 3 location_id: 1 qty_available: '89.0000' media: [] discounts: [] - id: 4 name: '32' product_id: 2 sub_sku: AS0002-3 product_variation_id: 2 woocommerce_variation_id: 660 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' combo_variations: null variation_location_details: - id: 3 product_id: 2 product_variation_id: 2 variation_id: 4 location_id: 1 qty_available: '127.0000' - id: 1371 product_id: 2 product_variation_id: 2 variation_id: 4 location_id: 7 qty_available: '-1.0000' media: [] discounts: [] - id: 5 name: '34' product_id: 2 sub_sku: AS0002-4 product_variation_id: 2 woocommerce_variation_id: 661 default_purchase_price: '72.0000' dpp_inc_tax: '79.2000' default_sell_price: '72.0000' sell_price_inc_tax: '79.2000' combo_variations: null variation_location_details: - id: 4 product_id: 2 product_variation_id: 2 variation_id: 5 location_id: 1 qty_available: '128.0000' media: [] discounts: [] - id: 6 name: '36' product_id: 2 sub_sku: AS0002-5 product_variation_id: 2 woocommerce_variation_id: 662 default_purchase_price: '72.0000' dpp_inc_tax: '79.2000' default_sell_price: '72.0000' sell_price_inc_tax: '79.2000' combo_variations: null variation_location_details: - id: 5 product_id: 2 product_variation_id: 2 variation_id: 6 location_id: 1 qty_available: '99.0000' media: [] discounts: [] brand: id: 1 business_id: 1 name: Levis description: null created_by: 1 use_for_repair: 1 deleted_at: null created_at: '2018-01-03 21:19:47' updated_at: '2018-01-03 21:19:47' unit: id: 1 business_id: 1 actual_name: Pieces short_name: Pc(s) allow_decimal: 0 base_unit_id: null base_unit_multiplier: null category: id: 1 name: "Men's" business_id: 1 short_code: sfefef parent_id: 0 category_type: product description: null slug: null woocommerce_cat_id: null sub_category: id: 4 name: Jeans business_id: 1 short_code: null parent_id: 1 category_type: product description: null slug: null woocommerce_cat_id: null product_tax: id: 1 business_id: 1 name: VAT@10% amount: 10 is_tax_group: 0 for_tax_group: 0 created_by: 1 woocommerce_tax_rate_id: null deleted_at: null created_at: '2018-01-04 02:40:07' updated_at: '2018-01-04 02:40:07' product_locations: - id: 1 business_id: 1 name: 'Location 1' custom_field1: gdgdgd88 custom_field2: null custom_field3: null custom_field4: null links: first: 'http://local.pos.com/connector/api/new_product?per_page=1&page=1' last: 'http://local.pos.com/connector/api/new_product?per_page=1&page=1088' prev: null next: 'http://local.pos.com/connector/api/new_product?per_page=1&page=2' meta: current_page: 1 from: 1 last_page: 1088 path: 'http://local.pos.com/connector/api/new_product' per_page: '1' to: 1 total: 1088 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: 'http://local.pos.com/uploads/img/1528727964_levis_jeans.jpg' product_variations: - id: 2 variation_template_id: 5 name: 'Waist Size' product_id: 2 is_dummy: 0 variations: - id: 2 name: '28' product_id: 2 sub_sku: AS0002-1 product_variation_id: 2 woocommerce_variation_id: 658 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' combo_variations: null variation_location_details: - id: 1 product_id: 2 product_variation_id: 2 variation_id: 2 location_id: 1 qty_available: '71.0000' media: [] discounts: [] - id: 3 name: '30' product_id: 2 sub_sku: AS0002-2 product_variation_id: 2 woocommerce_variation_id: 659 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' combo_variations: null variation_location_details: - id: 2 product_id: 2 product_variation_id: 2 variation_id: 3 location_id: 1 qty_available: '89.0000' media: [] discounts: [] - id: 4 name: '32' product_id: 2 sub_sku: AS0002-3 product_variation_id: 2 woocommerce_variation_id: 660 default_purchase_price: '70.0000' dpp_inc_tax: '77.0000' default_sell_price: '70.0000' sell_price_inc_tax: '77.0000' combo_variations: null variation_location_details: - id: 3 product_id: 2 product_variation_id: 2 variation_id: 4 location_id: 1 qty_available: '127.0000' - id: 1371 product_id: 2 product_variation_id: 2 variation_id: 4 location_id: 7 qty_available: '-1.0000' media: [] discounts: [] - id: 5 name: '34' product_id: 2 sub_sku: AS0002-4 product_variation_id: 2 woocommerce_variation_id: 661 default_purchase_price: '72.0000' dpp_inc_tax: '79.2000' default_sell_price: '72.0000' sell_price_inc_tax: '79.2000' combo_variations: null variation_location_details: - id: 4 product_id: 2 product_variation_id: 2 variation_id: 5 location_id: 1 qty_available: '128.0000' media: [] discounts: [] - id: 6 name: '36' product_id: 2 sub_sku: AS0002-5 product_variation_id: 2 woocommerce_variation_id: 662 default_purchase_price: '72.0000' dpp_inc_tax: '79.2000' default_sell_price: '72.0000' sell_price_inc_tax: '79.2000' combo_variations: null variation_location_details: - id: 5 product_id: 2 product_variation_id: 2 variation_id: 6 location_id: 1 qty_available: '99.0000' media: [] discounts: [] brand: id: 1 business_id: 1 name: Levis description: null created_by: 1 use_for_repair: 1 deleted_at: null created_at: '2018-01-03 21:19:47' updated_at: '2018-01-03 21:19:47' unit: id: 1 business_id: 1 actual_name: Pieces short_name: Pc(s) allow_decimal: 0 base_unit_id: null base_unit_multiplier: null category: id: 1 name: "Men's" business_id: 1 short_code: sfefef parent_id: 0 category_type: product description: null slug: null woocommerce_cat_id: null sub_category: id: 4 name: Jeans business_id: 1 short_code: null parent_id: 1 category_type: product description: null slug: null woocommerce_cat_id: null product_tax: id: 1 business_id: 1 name: VAT@10% amount: 10 is_tax_group: 0 for_tax_group: 0 created_by: 1 woocommerce_tax_rate_id: null deleted_at: null created_at: '2018-01-04 02:40:07' updated_at: '2018-01-04 02:40:07' product_locations: - id: 1 business_id: 1 name: 'Location 1' custom_field1: gdgdgd88 custom_field2: null custom_field3: null custom_field4: null 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 nullable: true enable_stock: type: integer example: 1 sku: type: string example: AS0002 product_custom_field1: type: string example: null nullable: true product_custom_field2: type: string example: null nullable: true product_custom_field3: type: string example: null nullable: true product_custom_field4: type: string example: null nullable: true woocommerce_media_id: type: string example: null nullable: true product_description: type: string example: null nullable: true is_inactive: type: integer example: 0 repair_model_id: type: string example: null nullable: true not_for_selling: type: integer example: 0 ecom_shipping_class_id: type: string example: null nullable: true 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: 'http://local.pos.com/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 nullable: true 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 nullable: true created_by: type: integer example: 1 use_for_repair: type: integer example: 1 deleted_at: type: string example: null nullable: true 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 nullable: true base_unit_multiplier: type: string example: null nullable: true 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 nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true 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 nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true custom_field3: type: string example: null nullable: true custom_field4: type: string example: null nullable: true links: type: object properties: first: type: string example: 'http://local.pos.com/connector/api/new_product?per_page=1&page=1' last: type: string example: 'http://local.pos.com/connector/api/new_product?per_page=1&page=1088' prev: type: string example: null nullable: true next: type: string example: 'http://local.pos.com/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: 'http://local.pos.com/connector/api/new_product' per_page: type: string example: '1' to: type: integer example: 1 total: type: integer example: 1088 tags: - Products /connector/api/taxonomy: get: summary: 'List taxonomy' operationId: listTaxonomy description: '' parameters: - in: query name: type description: 'Type of taxonomy (product, device, hrm_department)' example: architecto required: false schema: type: string description: 'Type of taxonomy (product, device, hrm_department)' example: architecto 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 nullable: true parent_id: type: integer example: 0 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 1 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-03 21:07:34' updated_at: type: string example: '2018-01-03 21:07:34' tags: - Categories '/connector/api/taxonomy/{id}': get: summary: 'Get the specified taxonomy' operationId: getTheSpecifiedTaxonomy description: '' parameters: [] 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 nullable: true parent_id: type: integer example: 0 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 1 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-03 21:07:34' updated_at: type: string example: '2018-01-03 21:07:34' tags: - Categories parameters: - in: path name: id description: 'The ID of the taxonomy.' example: architecto 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/brand: get: summary: 'List brands' operationId: listBrands description: '' parameters: [] 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 nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-03 21:19:47' updated_at: type: string example: '2018-01-03 21:19:47' tags: - Brands '/connector/api/brand/{id}': get: summary: 'Get the specified brand' operationId: getTheSpecifiedBrand description: '' parameters: [] 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 nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-03 21:19:47' updated_at: type: string example: '2018-01-03 21:19:47' tags: - Brands parameters: - in: path name: id description: 'The ID of the brand.' example: architecto 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/unit: get: summary: 'List units' operationId: listUnits description: '' parameters: [] 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 nullable: true base_unit_multiplier: type: string example: null nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true 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 nullable: true tags: - Units '/connector/api/unit/{id}': get: summary: 'Get the specified unit' operationId: getTheSpecifiedUnit description: '' parameters: [] 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 nullable: true base_unit_multiplier: type: string example: null nullable: true created_by: type: integer example: 1 deleted_at: type: string example: null nullable: true 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 nullable: true tags: - Units parameters: - in: path name: id description: 'The ID of the unit.' example: architecto 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/tax: get: summary: 'List taxes' operationId: listTaxes description: '' parameters: [] 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 nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:40:07' updated_at: type: string example: '2018-01-04 02:40:07' tags: - Tax '/connector/api/tax/{id}': get: summary: 'Get the specified tax' operationId: getTheSpecifiedTax description: '' parameters: [] 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 nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:40:07' updated_at: type: string example: '2018-01-04 02:40:07' tags: - Tax parameters: - in: path name: id description: 'The ID of the tax.' example: architecto 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/types-of-service: get: summary: 'List types of service' operationId: listTypesOfService description: '' parameters: [] 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 nullable: true 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' '/connector/api/types-of-service/{id}': get: summary: 'Get the specified types of service' operationId: getTheSpecifiedTypesOfService description: '' parameters: [] 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 nullable: true 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' parameters: - in: path name: id description: 'The ID of the types of service.' example: architecto 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/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 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 nullable: true created_by: type: integer example: 9 deleted_at: type: string example: null nullable: true created_at: type: string example: '2020-06-04 22:36:37' updated_at: type: string example: '2020-06-04 22:36:37' tags: - Tables '/connector/api/table/{id}': get: summary: 'Show the specified table' operationId: showTheSpecifiedTable description: '' parameters: [] 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 nullable: true created_by: type: integer example: 9 deleted_at: type: string example: null nullable: true created_at: type: string example: '2020-06-04 22:36:37' updated_at: type: string example: '2020-06-04 22:36:37' tags: - Tables parameters: - in: path name: id description: 'The ID of the table.' example: architecto 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/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: architecto required: false schema: type: string description: 'id of the user who created the sale' example: architecto - 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: architecto required: false schema: type: string description: 'Source of the sale' example: architecto - in: query name: only_subscriptions description: 'Filter only subcription invoices (1, 0)' example: architecto required: false schema: type: string description: 'Filter only subcription invoices (1, 0)' example: architecto - in: query name: send_purchase_details description: 'Get purchase details of each sell line (1, 0)' example: architecto required: false schema: type: string description: 'Get purchase details of each sell line (1, 0)' example: architecto - 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 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2018-01-09 17:30:35' created_by: 1 payment_for: null parent_id: null note: null document: null payment_ref_no: null account_id: null created_at: '2018-01-06 01:36:11' updated_at: '2018-01-06 01:36:11' invoice_url: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' links: first: 'http://local.pos.com/connector/api/sell?page=1' last: 'http://local.pos.com/connector/api/sell?page=6' prev: null next: 'http://local.pos.com/connector/api/sell?page=2' meta: current_page: 1 from: 1 path: 'http://local.pos.com/connector/api/sell' per_page: 10 to: 10 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2018-01-09 17:30:35' created_by: 1 payment_for: null parent_id: null note: null document: null payment_ref_no: null account_id: null created_at: '2018-01-06 01:36:11' updated_at: '2018-01-06 01:36:11' invoice_url: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' 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 nullable: true res_waiter_id: type: string example: null nullable: true res_order_status: type: string example: null nullable: true type: type: string example: sell sub_type: type: string example: null nullable: true status: type: string example: final is_quotation: type: integer example: 0 payment_status: type: string example: paid adjustment_type: type: string example: null nullable: true contact_id: type: integer example: 4 customer_group_id: type: string example: null nullable: true invoice_no: type: string example: AS0001 ref_no: type: string example: '' source: type: string example: null nullable: true subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true 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 nullable: true 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 nullable: true shipping_address: type: string example: null nullable: true shipping_status: type: string example: null nullable: true delivered_to: type: string example: null nullable: true shipping_charges: type: string example: '0.0000' additional_notes: type: string example: null nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: string example: '770.0000' expense_category_id: type: string example: null nullable: true expense_for: type: string example: null nullable: true commission_agent: type: string example: null nullable: true document: type: string example: null nullable: true 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 nullable: true transfer_parent_id: type: string example: null nullable: true return_parent_id: type: string example: null nullable: true opening_stock_product_id: type: string example: null nullable: true created_by: type: integer example: 1 import_batch: type: string example: null nullable: true import_time: type: string example: null nullable: true types_of_service_id: type: string example: null nullable: true packing_charge: type: string example: null nullable: true packing_charge_type: type: string example: null nullable: true service_custom_field_1: type: string example: null nullable: true service_custom_field_2: type: string example: null nullable: true service_custom_field_3: type: string example: null nullable: true service_custom_field_4: type: string example: null nullable: true mfg_parent_production_purchase_id: type: string example: null nullable: true mfg_wasted_units: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true rp_earned: type: integer example: 0 repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_updates_email: type: integer example: 0 repair_updates_sms: type: integer example: 0 repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true order_addresses: type: string example: null nullable: true is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true invoice_token: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true selling_price_group_id: type: string example: null nullable: true 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 nullable: true 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 nullable: true lot_no_line_id: type: string example: null nullable: true sell_line_note: type: string example: null nullable: true res_service_staff_id: type: string example: null nullable: true res_line_order_status: type: string example: null nullable: true woocommerce_line_items_id: type: string example: null nullable: true parent_sell_line_id: type: string example: null nullable: true children_type: type: string example: '' sub_unit_id: type: string example: null nullable: true 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2018-01-09 17:30:35' created_by: 1 payment_for: null parent_id: null note: null document: null payment_ref_no: null account_id: null created_at: '2018-01-06 01:36:11' updated_at: '2018-01-06 01:36:11' items: type: object properties: id: type: integer example: 1 transaction_id: type: integer example: 6 business_id: type: string example: null nullable: true is_return: type: integer example: 0 amount: type: string example: '770.0000' method: type: string example: cash transaction_no: type: string example: null nullable: true card_transaction_number: type: string example: null nullable: true card_number: type: string example: null nullable: true card_type: type: string example: visa card_holder_name: type: string example: null nullable: true card_month: type: string example: null nullable: true card_year: type: string example: null nullable: true card_security: type: string example: null nullable: true cheque_number: type: string example: null nullable: true bank_account_number: type: string example: null nullable: true paid_on: type: string example: '2018-01-09 17:30:35' created_by: type: integer example: 1 payment_for: type: string example: null nullable: true parent_id: type: string example: null nullable: true note: type: string example: null nullable: true document: type: string example: null nullable: true payment_ref_no: type: string example: null nullable: true account_id: type: string example: null nullable: true 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: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: type: string example: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' links: type: object properties: first: type: string example: 'http://local.pos.com/connector/api/sell?page=1' last: type: string example: 'http://local.pos.com/connector/api/sell?page=6' prev: type: string example: null nullable: true next: type: string example: 'http://local.pos.com/connector/api/sell?page=2' meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'http://local.pos.com/connector/api/sell' per_page: type: integer example: 10 to: type: integer example: 10 tags: - Sales post: summary: 'Create sell' operationId: createSell description: '' parameters: [] 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: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' sell_lines: - id: 1 transaction_id: 6 product_id: 2 variation_id: 3 quantity: 10 mfg_waste_percent: '0.0000' quantity_returned: '0.0000' unit_price_before_discount: '70.0000' unit_price: '70.0000' line_discount_type: null line_discount_amount: '0.0000' unit_price_inc_tax: '77.0000' item_tax: '7.0000' tax_id: 1 discount_id: null lot_no_line_id: null sell_line_note: null res_service_staff_id: null res_line_order_status: null woocommerce_line_items_id: null parent_sell_line_id: null children_type: '' sub_unit_id: null created_at: '2018-01-06 07:06:11' updated_at: '2018-01-06 07:06:11' payment_lines: - id: 1 transaction_id: 6 business_id: null is_return: 0 amount: '770.0000' method: cash transaction_no: null card_transaction_number: null card_number: null card_type: visa card_holder_name: null card_month: null card_year: null card_security: null cheque_number: null bank_account_number: null paid_on: '2018-01-09 17:30:35' created_by: 1 payment_for: null parent_id: null note: null document: null payment_ref_no: null account_id: null created_at: '2018-01-06 01:36:11' updated_at: '2018-01-06 01:36:11' 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: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' sell_lines: - id: 1 transaction_id: 6 product_id: 2 variation_id: 3 quantity: 10 mfg_waste_percent: '0.0000' quantity_returned: '0.0000' unit_price_before_discount: '70.0000' unit_price: '70.0000' line_discount_type: null line_discount_amount: '0.0000' unit_price_inc_tax: '77.0000' item_tax: '7.0000' tax_id: 1 discount_id: null lot_no_line_id: null sell_line_note: null res_service_staff_id: null res_line_order_status: null woocommerce_line_items_id: null parent_sell_line_id: null children_type: '' sub_unit_id: null created_at: '2018-01-06 07:06:11' updated_at: '2018-01-06 07:06:11' payment_lines: - id: 1 transaction_id: 6 business_id: null is_return: 0 amount: '770.0000' method: cash transaction_no: null card_transaction_number: null card_number: null card_type: visa card_holder_name: null card_month: null card_year: null card_security: null cheque_number: null bank_account_number: null paid_on: '2018-01-09 17:30:35' created_by: 1 payment_for: null parent_id: null note: null document: null payment_ref_no: null account_id: null created_at: '2018-01-06 01:36:11' updated_at: '2018-01-06 01:36:11' 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 nullable: true res_waiter_id: type: string example: null nullable: true res_order_status: type: string example: null nullable: true type: type: string example: sell sub_type: type: string example: null nullable: true status: type: string example: final is_quotation: type: integer example: 0 payment_status: type: string example: paid adjustment_type: type: string example: null nullable: true contact_id: type: integer example: 4 customer_group_id: type: string example: null nullable: true invoice_no: type: string example: AS0001 ref_no: type: string example: '' source: type: string example: null nullable: true subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true 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 nullable: true 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 nullable: true shipping_address: type: string example: null nullable: true shipping_status: type: string example: null nullable: true delivered_to: type: string example: null nullable: true shipping_charges: type: string example: '0.0000' additional_notes: type: string example: null nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: string example: '770.0000' expense_category_id: type: string example: null nullable: true expense_for: type: string example: null nullable: true commission_agent: type: string example: null nullable: true document: type: string example: null nullable: true 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 nullable: true transfer_parent_id: type: string example: null nullable: true return_parent_id: type: string example: null nullable: true opening_stock_product_id: type: string example: null nullable: true created_by: type: integer example: 1 import_batch: type: string example: null nullable: true import_time: type: string example: null nullable: true types_of_service_id: type: string example: null nullable: true packing_charge: type: string example: null nullable: true packing_charge_type: type: string example: null nullable: true service_custom_field_1: type: string example: null nullable: true service_custom_field_2: type: string example: null nullable: true service_custom_field_3: type: string example: null nullable: true service_custom_field_4: type: string example: null nullable: true mfg_parent_production_purchase_id: type: string example: null nullable: true mfg_wasted_units: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true rp_earned: type: integer example: 0 repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_updates_email: type: integer example: 0 repair_updates_sms: type: integer example: 0 repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true order_addresses: type: string example: null nullable: true is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true invoice_token: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true selling_price_group_id: type: string example: null nullable: true 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: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: type: string example: 'http://local.pos.com/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 nullable: true 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 nullable: true lot_no_line_id: type: string example: null nullable: true sell_line_note: type: string example: null nullable: true res_service_staff_id: type: string example: null nullable: true res_line_order_status: type: string example: null nullable: true woocommerce_line_items_id: type: string example: null nullable: true parent_sell_line_id: type: string example: null nullable: true children_type: type: string example: '' sub_unit_id: type: string example: null nullable: true 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2018-01-09 17:30:35' created_by: 1 payment_for: null parent_id: null note: null document: null payment_ref_no: null account_id: null created_at: '2018-01-06 01:36:11' updated_at: '2018-01-06 01:36:11' items: type: object properties: id: type: integer example: 1 transaction_id: type: integer example: 6 business_id: type: string example: null nullable: true is_return: type: integer example: 0 amount: type: string example: '770.0000' method: type: string example: cash transaction_no: type: string example: null nullable: true card_transaction_number: type: string example: null nullable: true card_number: type: string example: null nullable: true card_type: type: string example: visa card_holder_name: type: string example: null nullable: true card_month: type: string example: null nullable: true card_year: type: string example: null nullable: true card_security: type: string example: null nullable: true cheque_number: type: string example: null nullable: true bank_account_number: type: string example: null nullable: true paid_on: type: string example: '2018-01-09 17:30:35' created_by: type: integer example: 1 payment_for: type: string example: null nullable: true parent_id: type: string example: null nullable: true note: type: string example: null nullable: true document: type: string example: null nullable: true payment_ref_no: type: string example: null nullable: true account_id: type: string example: null nullable: true created_at: type: string example: '2018-01-06 01:36:11' updated_at: type: string example: '2018-01-06 01:36:11' tags: - Sales 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' example: 16 transaction_date: type: string description: 'transaction date format:Y-m-d H:i:s,' example: '2020-07-22 15:48:29' invoice_no: type: string description: 'Invoice number' example: architecto source: type: string description: 'Source of the invoice' example: 'api, phone, woocommerce' status: type: string description: 'sale status (final, draft)' 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: architecto staff_note: type: string description: '' example: architecto commission_agent: type: integer description: 'commission agent id' example: 16 shipping_details: type: string description: 'shipping details' example: 'Express Delivery' shipping_address: type: string description: 'shipping address' example: architecto 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' example: 1.0 selling_price_group_id: type: integer description: 'id of the selling price group' example: 16 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)' 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: 16 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: architecto recur_repetitions: type: integer description: 'total number of invoices to be generated' example: 16 rp_redeemed: type: integer description: 'reward points redeemed' example: 16 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: 16 service_custom_field_1: type: string description: 'types of service custom field 1' example: architecto service_custom_field_2: type: string description: 'types of service custom field 2' example: architecto service_custom_field_3: type: string description: 'types of service custom field 3' example: architecto service_custom_field_4: type: string description: 'types of service custom field 4' example: architecto service_custom_field_5: type: string description: 'types of service custom field 5' example: architecto service_custom_field_6: type: string description: 'types of service custom field 6' example: architecto round_off_amount: type: number description: 'round off amount on total payable' example: 4326.41688 table_id: type: integer description: 'id of the table' example: 16 service_staff_id: type: integer description: 'id of the service staff assigned to the sale' example: 16 change_return: type: number description: 'Excess paid amount' example: 0.0 products: type: array description: 'array of the products for the sale' example: - architecto items: type: string payments: type: array description: 'payment lines for the sale' example: - architecto items: type: string required: - location_id - contact_id - products '/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: architecto required: false schema: type: string description: 'Get purchase details of each sell line (1, 0)' example: architecto 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-06-04 23:29:36' created_by: 9 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0002 account_id: null created_at: '2020-06-04 23:29:36' updated_at: '2020-06-04 23:29:36' invoice_url: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-06-04 23:29:36' created_by: 9 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0002 account_id: null created_at: '2020-06-04 23:29:36' updated_at: '2020-06-04 23:29:36' invoice_url: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' 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 nullable: true res_order_status: type: string example: null nullable: true type: type: string example: sell sub_type: type: string example: null nullable: true status: type: string example: final is_quotation: type: integer example: 0 payment_status: type: string example: paid adjustment_type: type: string example: null nullable: true contact_id: type: integer example: 1 customer_group_id: type: string example: null nullable: true invoice_no: type: string example: AS0007 ref_no: type: string example: '' source: type: string example: null nullable: true subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true 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 nullable: true 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 nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: string example: '453.1300' expense_category_id: type: string example: null nullable: true expense_for: type: string example: null nullable: true commission_agent: type: string example: null nullable: true document: type: string example: null nullable: true 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 nullable: true transfer_parent_id: type: string example: null nullable: true return_parent_id: type: string example: null nullable: true opening_stock_product_id: type: string example: null nullable: true created_by: type: integer example: 9 import_batch: type: string example: null nullable: true import_time: type: string example: null nullable: true 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 nullable: true service_custom_field_2: type: string example: null nullable: true service_custom_field_3: type: string example: null nullable: true service_custom_field_4: type: string example: null nullable: true mfg_parent_production_purchase_id: type: string example: null nullable: true mfg_wasted_units: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true rp_earned: type: integer example: 0 repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_updates_email: type: integer example: 0 repair_updates_sms: type: integer example: 0 repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true order_addresses: type: string example: null nullable: true is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: days recur_repetitions: type: integer example: 0 recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true invoice_token: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true 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 nullable: true discount_id: type: string example: null nullable: true lot_no_line_id: type: string example: null nullable: true sell_line_note: type: string example: '' res_service_staff_id: type: string example: null nullable: true res_line_order_status: type: string example: null nullable: true woocommerce_line_items_id: type: string example: null nullable: true parent_sell_line_id: type: string example: null nullable: true children_type: type: string example: '' sub_unit_id: type: string example: null nullable: true 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-06-04 23:29:36' created_by: 9 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0002 account_id: null created_at: '2020-06-04 23:29:36' updated_at: '2020-06-04 23:29:36' 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 nullable: true card_transaction_number: type: string example: null nullable: true card_number: type: string example: null nullable: true card_type: type: string example: credit card_holder_name: type: string example: null nullable: true card_month: type: string example: null nullable: true card_year: type: string example: null nullable: true card_security: type: string example: null nullable: true cheque_number: type: string example: null nullable: true bank_account_number: type: string example: null nullable: true 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 nullable: true note: type: string example: null nullable: true document: type: string example: null nullable: true payment_ref_no: type: string example: SP2020/0002 account_id: type: string example: null nullable: true 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: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: type: string example: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' tags: - Sales put: summary: 'Update sell' operationId: updateSell description: '' parameters: [] 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-09-23 20:16:19' created_by: 9 is_advance: 0 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0018 account_id: null created_at: '2020-09-23 20:16:19' updated_at: '2020-09-23 20:16:19' invoice_url: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' 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 nullable: true res_waiter_id: type: string example: null nullable: true res_order_status: type: string example: null nullable: true type: type: string example: sell sub_type: type: string example: null nullable: true status: type: string example: final is_quotation: type: integer example: 0 payment_status: type: string example: paid adjustment_type: type: string example: null nullable: true 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 nullable: true subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true transaction_date: type: string example: '25-09-2020 15:22' total_before_tax: type: number example: 962.5 tax_id: type: string example: null nullable: true 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 nullable: true shipping_address: type: string example: null nullable: true shipping_status: type: string example: null nullable: true delivered_to: type: string example: null nullable: true shipping_charges: type: string example: '0.0000' additional_notes: type: string example: null nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: integer example: 943 expense_category_id: type: string example: null nullable: true expense_for: type: string example: null nullable: true commission_agent: type: string example: null nullable: true document: type: string example: null nullable: true 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 nullable: true transfer_parent_id: type: string example: null nullable: true return_parent_id: type: string example: null nullable: true opening_stock_product_id: type: string example: null nullable: true created_by: type: integer example: 9 import_batch: type: string example: null nullable: true import_time: type: string example: null nullable: true types_of_service_id: type: string example: null nullable: true packing_charge: type: string example: '0.0000' packing_charge_type: type: string example: null nullable: true service_custom_field_1: type: string example: null nullable: true service_custom_field_2: type: string example: null nullable: true service_custom_field_3: type: string example: null nullable: true service_custom_field_4: type: string example: null nullable: true mfg_parent_production_purchase_id: type: string example: null nullable: true mfg_wasted_units: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true rp_earned: type: integer example: 0 repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_job_sheet_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true repair_updates_notif: type: integer example: 0 order_addresses: type: string example: null nullable: true 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 nullable: true recur_parent_id: type: string example: null nullable: true invoice_token: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-09-23 20:16:19' created_by: 9 is_advance: 0 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0018 account_id: null created_at: '2020-09-23 20:16:19' updated_at: '2020-09-23 20:16:19' 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 nullable: true card_transaction_number: type: string example: null nullable: true card_number: type: string example: null nullable: true card_type: type: string example: credit card_holder_name: type: string example: null nullable: true card_month: type: string example: null nullable: true card_year: type: string example: null nullable: true card_security: type: string example: null nullable: true cheque_number: type: string example: null nullable: true bank_account_number: type: string example: null nullable: true 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 nullable: true note: type: string example: null nullable: true document: type: string example: null nullable: true payment_ref_no: type: string example: SP2020/0018 account_id: type: string example: null nullable: true 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: 'http://local.pos.com/invoice/6dfd77eb80f4976b456128e7f1311c9f' payment_link: type: string example: 'http://local.pos.com/pay/6dfd77eb80f4976b456128e7f1311c9f' tags: - Sales requestBody: required: true content: application/json: schema: type: object properties: contact_id: type: integer description: 'id of the customer' example: 16 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)' 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: architecto source: type: string description: 'Source of the invoice' example: architecto staff_note: type: string description: '' example: architecto is_suspend: type: boolean description: 'Is suspended sale (0, 1)' example: false commission_agent: type: integer description: 'commission agent id' example: 16 shipping_details: type: string description: 'shipping details' example: 'Express Delivery' shipping_address: type: string description: 'shipping address' example: architecto 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' example: 1.0 selling_price_group_id: type: integer description: 'id of the selling price group' example: 16 pay_term_number: type: integer description: 'pay term value' example: 16 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: 16 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: architecto recur_repetitions: type: integer description: 'total number of invoices to be generated' example: 16 rp_redeemed: type: integer description: 'reward points redeemed' example: 16 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: 16 service_custom_field_1: type: string description: 'types of service custom field 1' example: architecto service_custom_field_2: type: string description: 'types of service custom field 2' example: architecto service_custom_field_3: type: string description: 'types of service custom field 3' example: architecto service_custom_field_4: type: string description: 'types of service custom field 4' example: architecto service_custom_field_5: type: string description: 'types of service custom field 5' example: architecto service_custom_field_6: type: string description: 'types of service custom field 6' example: architecto round_off_amount: type: number description: 'round off amount on total payable' example: 4326.41688 table_id: type: integer description: 'id of the table' example: 16 service_staff_id: type: integer description: 'id of the service staff assigned to the sale' example: 16 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: 16 products: type: array description: 'array of the products for the sale' example: - architecto items: type: string payments: type: array description: 'payment lines for the sale' example: - architecto items: type: string required: - products delete: summary: 'Delete Sell' operationId: deleteSell description: '' parameters: [] responses: { } tags: - Sales parameters: - in: path name: id description: 'The ID of the sell.' example: architecto 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: [] 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 nullable: true res_waiter_id: type: string example: null nullable: true res_order_status: type: string example: null nullable: true type: type: string example: sell_return sub_type: type: string example: null nullable: true status: type: string example: final is_quotation: type: integer example: 0 payment_status: type: string example: paid adjustment_type: type: string example: null nullable: true contact_id: type: integer example: 1 customer_group_id: type: string example: null nullable: true invoice_no: type: string example: CN2020/0005 ref_no: type: string example: null nullable: true subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true transaction_date: type: string example: '2020-11-17 00:00:00' total_before_tax: type: integer example: 3 tax_id: type: string example: null nullable: true 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 nullable: true shipping_address: type: string example: null nullable: true shipping_status: type: string example: null nullable: true delivered_to: type: string example: null nullable: true shipping_charges: type: string example: '0.0000' additional_notes: type: string example: null nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: number example: 2.64 expense_category_id: type: string example: null nullable: true expense_for: type: string example: null nullable: true commission_agent: type: string example: null nullable: true document: type: string example: null nullable: true 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 nullable: true transfer_parent_id: type: string example: null nullable: true return_parent_id: type: integer example: 157 opening_stock_product_id: type: string example: null nullable: true created_by: type: integer example: 9 import_batch: type: string example: null nullable: true import_time: type: string example: null nullable: true types_of_service_id: type: string example: null nullable: true packing_charge: type: string example: null nullable: true packing_charge_type: type: string example: null nullable: true service_custom_field_1: type: string example: null nullable: true service_custom_field_2: type: string example: null nullable: true service_custom_field_3: type: string example: null nullable: true service_custom_field_4: type: string example: null nullable: true mfg_parent_production_purchase_id: type: string example: null nullable: true mfg_wasted_units: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true rp_earned: type: integer example: 0 repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_job_sheet_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true repair_updates_notif: type: integer example: 0 order_addresses: type: string example: null nullable: true is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true invoice_token: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true selling_price_group_id: type: string example: null nullable: true created_at: type: string example: '2020-11-17 12:05:11' updated_at: type: string example: '2020-11-17 13:22:09' tags: - Sales requestBody: required: true content: application/json: schema: type: object properties: transaction_id: type: integer description: 'Id of the sell' example: 16 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: architecto 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 products: type: array description: 'array of the products for the sale' example: - architecto items: type: string required: - transaction_id - products /connector/api/list-sell-return: get: summary: 'List Sell Return' operationId: listSellReturn description: '' parameters: [] 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-11-17 12:05:00' created_by: 9 is_advance: 0 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0078 account_id: null created_at: '2020-11-17 12:05:58' updated_at: '2020-11-17 12:05:58' return_parent_sell: id: 157 business_id: 1 location_id: 1 res_table_id: null res_waiter_id: null res_order_status: null type: sell sub_type: null status: final is_quotation: 0 payment_status: paid adjustment_type: null contact_id: 1 customer_group_id: null invoice_no: AS0073 ref_no: '' subscription_no: null subscription_repeat_on: null transaction_date: '2020-11-13 12:42:17' total_before_tax: '6.2500' tax_id: null tax_amount: '0.0000' discount_type: percentage discount_amount: '10.0000' rp_redeemed: 0 rp_redeemed_amount: '0.0000' shipping_details: null shipping_address: null shipping_status: null delivered_to: null shipping_charges: '0.0000' additional_notes: null staff_note: null round_off_amount: '0.0000' final_total: '5.6300' expense_category_id: null expense_for: null commission_agent: null document: null is_direct_sale: 0 is_suspend: 0 exchange_rate: '1.000' total_amount_recovered: null transfer_parent_id: null return_parent_id: null opening_stock_product_id: null created_by: 9 import_batch: null import_time: null types_of_service_id: null packing_charge: '0.0000' packing_charge_type: null service_custom_field_1: null service_custom_field_2: null service_custom_field_3: null service_custom_field_4: null mfg_parent_production_purchase_id: null mfg_wasted_units: null mfg_production_cost: '0.0000' mfg_production_cost_type: percentage mfg_is_final: 0 is_created_from_api: 0 essentials_duration: '0.00' essentials_duration_unit: null essentials_amount_per_unit_duration: '0.0000' essentials_allowances: null essentials_deductions: null rp_earned: 0 repair_completed_on: null repair_warranty_id: null repair_brand_id: null repair_status_id: null repair_model_id: null repair_job_sheet_id: null repair_defects: null repair_serial_no: null repair_checklist: null repair_security_pwd: null repair_security_pattern: null repair_due_date: null repair_device_id: null repair_updates_notif: 0 order_addresses: null is_recurring: 0 recur_interval: 1 recur_interval_type: days recur_repetitions: 0 recur_stopped_on: null recur_parent_id: null invoice_token: null pay_term_number: null pay_term_type: null pjt_project_id: null pjt_title: null woocommerce_order_id: null selling_price_group_id: 0 created_at: '2020-11-13 12:42:17' updated_at: '2020-11-13 12:42:18' sell_lines: - id: 139 transaction_id: 157 product_id: 157 variation_id: 205 quantity: 5 mfg_waste_percent: '0.0000' quantity_returned: '3.0000' unit_price_before_discount: '1.2500' unit_price: '1.2500' line_discount_type: fixed line_discount_amount: '0.0000' unit_price_inc_tax: '1.2500' item_tax: '0.0000' tax_id: null discount_id: null lot_no_line_id: null sell_line_note: '' res_service_staff_id: null res_line_order_status: null woocommerce_line_items_id: null parent_sell_line_id: null children_type: '' sub_unit_id: null created_at: '2020-11-13 12:42:17' updated_at: '2020-11-17 13:22:09' links: first: 'http://local.pos.com/connector/api/list-sell-return?sell_id=157&page=1' last: null prev: null next: null meta: current_page: 1 from: 1 path: 'http://local.pos.com/connector/api/list-sell-return' per_page: 10 to: 1 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-11-17 12:05:00' created_by: 9 is_advance: 0 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0078 account_id: null created_at: '2020-11-17 12:05:58' updated_at: '2020-11-17 12:05:58' return_parent_sell: id: 157 business_id: 1 location_id: 1 res_table_id: null res_waiter_id: null res_order_status: null type: sell sub_type: null status: final is_quotation: 0 payment_status: paid adjustment_type: null contact_id: 1 customer_group_id: null invoice_no: AS0073 ref_no: '' subscription_no: null subscription_repeat_on: null transaction_date: '2020-11-13 12:42:17' total_before_tax: '6.2500' tax_id: null tax_amount: '0.0000' discount_type: percentage discount_amount: '10.0000' rp_redeemed: 0 rp_redeemed_amount: '0.0000' shipping_details: null shipping_address: null shipping_status: null delivered_to: null shipping_charges: '0.0000' additional_notes: null staff_note: null round_off_amount: '0.0000' final_total: '5.6300' expense_category_id: null expense_for: null commission_agent: null document: null is_direct_sale: 0 is_suspend: 0 exchange_rate: '1.000' total_amount_recovered: null transfer_parent_id: null return_parent_id: null opening_stock_product_id: null created_by: 9 import_batch: null import_time: null types_of_service_id: null packing_charge: '0.0000' packing_charge_type: null service_custom_field_1: null service_custom_field_2: null service_custom_field_3: null service_custom_field_4: null mfg_parent_production_purchase_id: null mfg_wasted_units: null mfg_production_cost: '0.0000' mfg_production_cost_type: percentage mfg_is_final: 0 is_created_from_api: 0 essentials_duration: '0.00' essentials_duration_unit: null essentials_amount_per_unit_duration: '0.0000' essentials_allowances: null essentials_deductions: null rp_earned: 0 repair_completed_on: null repair_warranty_id: null repair_brand_id: null repair_status_id: null repair_model_id: null repair_job_sheet_id: null repair_defects: null repair_serial_no: null repair_checklist: null repair_security_pwd: null repair_security_pattern: null repair_due_date: null repair_device_id: null repair_updates_notif: 0 order_addresses: null is_recurring: 0 recur_interval: 1 recur_interval_type: days recur_repetitions: 0 recur_stopped_on: null recur_parent_id: null invoice_token: null pay_term_number: null pay_term_type: null pjt_project_id: null pjt_title: null woocommerce_order_id: null selling_price_group_id: 0 created_at: '2020-11-13 12:42:17' updated_at: '2020-11-13 12:42:18' sell_lines: - id: 139 transaction_id: 157 product_id: 157 variation_id: 205 quantity: 5 mfg_waste_percent: '0.0000' quantity_returned: '3.0000' unit_price_before_discount: '1.2500' unit_price: '1.2500' line_discount_type: fixed line_discount_amount: '0.0000' unit_price_inc_tax: '1.2500' item_tax: '0.0000' tax_id: null discount_id: null lot_no_line_id: null sell_line_note: '' res_service_staff_id: null res_line_order_status: null woocommerce_line_items_id: null parent_sell_line_id: null children_type: '' sub_unit_id: null created_at: '2020-11-13 12:42:17' updated_at: '2020-11-17 13:22:09' 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 nullable: true res_waiter_id: type: string example: null nullable: true res_order_status: type: string example: null nullable: true type: type: string example: sell_return sub_type: type: string example: null nullable: true status: type: string example: final is_quotation: type: integer example: 0 payment_status: type: string example: partial adjustment_type: type: string example: null nullable: true contact_id: type: integer example: 1 customer_group_id: type: string example: null nullable: true invoice_no: type: string example: CN2020/0005 ref_no: type: string example: null nullable: true subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true 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 nullable: true 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 nullable: true shipping_address: type: string example: null nullable: true shipping_status: type: string example: null nullable: true delivered_to: type: string example: null nullable: true shipping_charges: type: string example: '0.0000' additional_notes: type: string example: null nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: string example: '2.6400' expense_category_id: type: string example: null nullable: true expense_for: type: string example: null nullable: true commission_agent: type: string example: null nullable: true document: type: string example: null nullable: true 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 nullable: true transfer_parent_id: type: string example: null nullable: true return_parent_id: type: integer example: 157 opening_stock_product_id: type: string example: null nullable: true created_by: type: integer example: 9 import_batch: type: string example: null nullable: true import_time: type: string example: null nullable: true types_of_service_id: type: string example: null nullable: true packing_charge: type: string example: null nullable: true packing_charge_type: type: string example: null nullable: true service_custom_field_1: type: string example: null nullable: true service_custom_field_2: type: string example: null nullable: true service_custom_field_3: type: string example: null nullable: true service_custom_field_4: type: string example: null nullable: true mfg_parent_production_purchase_id: type: string example: null nullable: true mfg_wasted_units: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true rp_earned: type: integer example: 0 repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_job_sheet_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true repair_updates_notif: type: integer example: 0 order_addresses: type: string example: null nullable: true is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true invoice_token: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true selling_price_group_id: type: string example: null nullable: true 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 card_security: null cheque_number: null bank_account_number: null paid_on: '2020-11-17 12:05:00' created_by: 9 is_advance: 0 payment_for: 1 parent_id: null note: null document: null payment_ref_no: SP2020/0078 account_id: null created_at: '2020-11-17 12:05:58' updated_at: '2020-11-17 12:05:58' 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 nullable: true card_transaction_number: type: string example: null nullable: true card_number: type: string example: null nullable: true card_type: type: string example: credit card_holder_name: type: string example: null nullable: true card_month: type: string example: null nullable: true card_year: type: string example: null nullable: true card_security: type: string example: null nullable: true cheque_number: type: string example: null nullable: true bank_account_number: type: string example: null nullable: true 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 nullable: true note: type: string example: null nullable: true document: type: string example: null nullable: true payment_ref_no: type: string example: SP2020/0078 account_id: type: string example: null nullable: true 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 nullable: true res_waiter_id: type: string example: null nullable: true res_order_status: type: string example: null nullable: true type: type: string example: sell sub_type: type: string example: null nullable: true status: type: string example: final is_quotation: type: integer example: 0 payment_status: type: string example: paid adjustment_type: type: string example: null nullable: true contact_id: type: integer example: 1 customer_group_id: type: string example: null nullable: true invoice_no: type: string example: AS0073 ref_no: type: string example: '' subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true 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 nullable: true 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 nullable: true shipping_address: type: string example: null nullable: true shipping_status: type: string example: null nullable: true delivered_to: type: string example: null nullable: true shipping_charges: type: string example: '0.0000' additional_notes: type: string example: null nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: string example: '5.6300' expense_category_id: type: string example: null nullable: true expense_for: type: string example: null nullable: true commission_agent: type: string example: null nullable: true document: type: string example: null nullable: true 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 nullable: true transfer_parent_id: type: string example: null nullable: true return_parent_id: type: string example: null nullable: true opening_stock_product_id: type: string example: null nullable: true created_by: type: integer example: 9 import_batch: type: string example: null nullable: true import_time: type: string example: null nullable: true types_of_service_id: type: string example: null nullable: true packing_charge: type: string example: '0.0000' packing_charge_type: type: string example: null nullable: true service_custom_field_1: type: string example: null nullable: true service_custom_field_2: type: string example: null nullable: true service_custom_field_3: type: string example: null nullable: true service_custom_field_4: type: string example: null nullable: true mfg_parent_production_purchase_id: type: string example: null nullable: true mfg_wasted_units: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true rp_earned: type: integer example: 0 repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_job_sheet_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true repair_updates_notif: type: integer example: 0 order_addresses: type: string example: null nullable: true 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 nullable: true recur_parent_id: type: string example: null nullable: true invoice_token: type: string example: null nullable: true pay_term_number: type: string example: null nullable: true pay_term_type: type: string example: null nullable: true pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true 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 nullable: true discount_id: type: string example: null nullable: true lot_no_line_id: type: string example: null nullable: true sell_line_note: type: string example: '' res_service_staff_id: type: string example: null nullable: true res_line_order_status: type: string example: null nullable: true woocommerce_line_items_id: type: string example: null nullable: true parent_sell_line_id: type: string example: null nullable: true children_type: type: string example: '' sub_unit_id: type: string example: null nullable: true 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: 'http://local.pos.com/connector/api/list-sell-return?sell_id=157&page=1' last: type: string example: null nullable: true prev: type: string example: null nullable: true next: type: string example: null nullable: true meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'http://local.pos.com/connector/api/list-sell-return' per_page: type: integer example: 10 to: type: integer example: 1 tags: - Sales 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: architecto /connector/api/update-shipping-status: post: summary: 'Update shipping status' operationId: updateShippingStatus description: '' parameters: [] responses: { } tags: - Sales requestBody: required: true content: application/json: schema: type: object properties: id: type: integer description: 'id of the sale' example: 16 shipping_status: type: string description: "('ordered', 'packed', 'shipped', 'delivered', 'cancelled')" example: ordered delivered_to: type: string description: 'Name of the consignee' example: architecto required: - id /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: architecto required: false schema: type: string description: 'id of the customer' example: architecto - 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: architecto required: false schema: type: string description: 'id of the user who created the sale' example: architecto - 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: architecto required: false schema: type: string description: 'Source of the sale' example: architecto - in: query name: customer_group_id description: 'id of the customer group' example: architecto required: false schema: type: string description: 'id of the customer group' example: architecto - in: query name: product_name description: 'name of the product' example: architecto required: false schema: type: string description: 'name of the product' example: architecto - in: query name: product_sku description: 'sku of the product or variation' example: architecto required: false schema: type: string description: 'sku of the product or variation' example: architecto - in: query name: product_custom_field_1 description: 'custome field 1 of the product' example: architecto required: false schema: type: string description: 'custome field 1 of the product' example: architecto - in: query name: location_custom_field_1 description: 'custome field 1 of the location' example: architecto required: false schema: type: string description: 'custome field 1 of the location' example: architecto - in: query name: location_invoice_scheme_prefix description: 'Invoice scheme prefix of the location' example: architecto required: false schema: type: string description: 'Invoice scheme prefix of the location' example: architecto - in: query name: product_category_id description: 'category id of the product' example: architecto required: false schema: type: string description: 'category id of the product' example: architecto - in: query name: product_sub_category_id description: 'Sub category id of the product' example: architecto required: false schema: type: string description: 'Sub category id of the product' example: architecto - 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: architecto required: false schema: type: string description: 'Filter only subcription invoices (1, 0)' example: architecto - in: query name: send_purchase_details description: 'Get purchase details of each sell line (1, 0)' example: architecto required: false schema: type: string description: 'Get purchase details of each sell line (1, 0)' example: architecto - 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 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: 'http://local.pos.com/invoice/00f79f7fd292225e8c303a6bf8626d06' payment_link: '' links: first: 'http://local.pos.com/connector/api/new_sell?per_page=1&page=1' last: 'http://local.pos.com/connector/api/new_sell?per_page=1&page=213' prev: null next: 'http://local.pos.com/connector/api/new_sell?per_page=1&page=2' meta: current_page: 1 from: 1 last_page: 213 path: 'http://local.pos.com/connector/api/new_sell' per_page: '1' to: 1 total: 213 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: 'http://local.pos.com/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 nullable: true 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 nullable: true invoice_no: type: string example: AS0001 ref_no: type: string example: '' source: type: string example: null nullable: true unique_hash: type: string example: null nullable: true hash_control: type: string example: null nullable: true subscription_no: type: string example: null nullable: true subscription_repeat_on: type: string example: null nullable: true 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 nullable: true 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 nullable: true shipping_address: type: string example: null nullable: true shipping_status: type: string example: null nullable: true delivered_to: type: string example: null nullable: true additional_notes: type: string example: null nullable: true staff_note: type: string example: null nullable: true round_off_amount: type: string example: '0.0000' final_total: type: string example: '770.0000' expense_sub_category_id: type: string example: null nullable: true is_direct_sale: type: integer example: 0 is_suspend: type: integer example: 0 total_amount_recovered: type: string example: null nullable: true 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 nullable: true essentials_amount_per_unit_duration: type: string example: '0.0000' essentials_allowances: type: string example: null nullable: true essentials_deductions: type: string example: null nullable: true repair_completed_on: type: string example: null nullable: true repair_warranty_id: type: string example: null nullable: true repair_brand_id: type: string example: null nullable: true repair_status_id: type: string example: null nullable: true repair_model_id: type: string example: null nullable: true repair_job_sheet_id: type: string example: null nullable: true repair_defects: type: string example: null nullable: true repair_serial_no: type: string example: null nullable: true repair_checklist: type: string example: null nullable: true repair_security_pwd: type: string example: null nullable: true repair_security_pattern: type: string example: null nullable: true repair_due_date: type: string example: null nullable: true repair_device_id: type: string example: null nullable: true repair_updates_notif: type: integer example: 0 invoice_token: type: string example: 00f79f7fd292225e8c303a6bf8626d06 pjt_project_id: type: string example: null nullable: true pjt_title: type: string example: null nullable: true woocommerce_order_id: type: string example: null nullable: true selling_price_group_id: type: string example: null nullable: true 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 nullable: true table_description: type: string example: null nullable: true 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 nullable: true 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 nullable: true lot_no_line_id: type: string example: null nullable: true sell_line_note: type: string example: null nullable: true woocommerce_line_items_id: type: string example: null nullable: true 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 nullable: true 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 nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 1 created_by: type: integer example: 1 category_type: type: string example: product description: type: string example: null nullable: true slug: type: string example: null nullable: true woocommerce_cat_id: type: string example: null nullable: true 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 nullable: true 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 nullable: true invoice_url: type: string example: 'http://local.pos.com/invoice/00f79f7fd292225e8c303a6bf8626d06' payment_link: type: string example: '' links: type: object properties: first: type: string example: 'http://local.pos.com/connector/api/new_sell?per_page=1&page=1' last: type: string example: 'http://local.pos.com/connector/api/new_sell?per_page=1&page=213' prev: type: string example: null nullable: true next: type: string example: 'http://local.pos.com/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: 'http://local.pos.com/connector/api/new_sell' per_page: type: string example: '1' to: type: integer example: 1 total: type: integer example: 213 tags: - Sales /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: architecto required: false schema: type: string description: 'id of the user for which expense is created' example: architecto - 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 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: 'http://local.pos.com/connector/api/expense?page=1' last: null prev: null next: null meta: current_page: 1 from: 1 path: 'http://local.pos.com/connector/api/expense' per_page: 10 to: 1 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 nullable: true tax_amount: type: string example: '0.0000' final_total: type: string example: '50.0000' expense_category_id: type: string example: null nullable: true document: type: string example: null nullable: true created_by: type: integer example: 9 is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true 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 nullable: true username: type: string example: admin email: type: string example: admin@example.com language: type: string example: en contact_no: type: string example: null nullable: true address: type: string example: null nullable: true business_id: type: integer example: 1 max_sales_discount_percent: type: string example: null nullable: true allow_login: type: integer example: 1 essentials_department_id: type: string example: null nullable: true essentials_designation_id: type: string example: null nullable: true status: type: string example: active crm_contact_id: type: string example: null nullable: true 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 nullable: true gender: type: string example: null nullable: true marital_status: type: string example: null nullable: true blood_group: type: string example: null nullable: true contact_number: type: string example: null nullable: true fb_link: type: string example: null nullable: true twitter_link: type: string example: null nullable: true social_media_1: type: string example: null nullable: true social_media_2: type: string example: null nullable: true permanent_address: type: string example: null nullable: true current_address: type: string example: null nullable: true guardian_name: type: string example: null nullable: true custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true bank_details: type: string example: null nullable: true id_proof_name: type: string example: null nullable: true id_proof_number: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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: 'http://local.pos.com/connector/api/expense?page=1' last: type: string example: null nullable: true prev: type: string example: null nullable: true next: type: string example: null nullable: true meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'http://local.pos.com/connector/api/expense' per_page: type: integer example: 10 to: type: integer example: 1 tags: - Expenses post: summary: 'Create expense / expense refund' operationId: createExpenseExpenseRefund description: '' parameters: [] 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 nullable: true tax_amount: type: integer example: 0 final_total: type: string example: '43' expense_category_id: type: string example: null nullable: true document: type: string example: null nullable: true created_by: type: integer example: 1 is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true 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: - Expenses 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: 4326.41688 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: 16 expense_for: type: integer description: 'id of the user for which expense is created' example: 16 contact_id: type: integer description: 'id of the contact(customer or supplier) for which expense is created' example: 16 expense_category_id: type: integer description: 'id of the expense category' example: 16 expense_sub_category_id: type: integer description: 'id of the expense sub-category' example: 16 additional_notes: type: string description: '' example: architecto 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: 16 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: architecto recur_repetitions: type: integer description: 'total number of expense to be generated' example: 16 payment: type: array description: 'payment lines for the expense' example: - architecto items: type: string required: - location_id - final_total '/connector/api/expense/{id}': get: summary: 'Get the specified expense / expense refund' operationId: getTheSpecifiedExpenseExpenseRefund description: '' parameters: [] 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 nullable: true tax_amount: type: string example: '0.0000' final_total: type: string example: '50.0000' expense_category_id: type: string example: null nullable: true document: type: string example: null nullable: true created_by: type: integer example: 9 is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true 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 nullable: true username: type: string example: admin email: type: string example: admin@example.com language: type: string example: en contact_no: type: string example: null nullable: true address: type: string example: null nullable: true business_id: type: integer example: 1 max_sales_discount_percent: type: string example: null nullable: true allow_login: type: integer example: 1 essentials_department_id: type: string example: null nullable: true essentials_designation_id: type: string example: null nullable: true status: type: string example: active crm_contact_id: type: string example: null nullable: true 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 nullable: true gender: type: string example: null nullable: true marital_status: type: string example: null nullable: true blood_group: type: string example: null nullable: true contact_number: type: string example: null nullable: true fb_link: type: string example: null nullable: true twitter_link: type: string example: null nullable: true social_media_1: type: string example: null nullable: true social_media_2: type: string example: null nullable: true permanent_address: type: string example: null nullable: true current_address: type: string example: null nullable: true guardian_name: type: string example: null nullable: true custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true bank_details: type: string example: null nullable: true id_proof_name: type: string example: null nullable: true id_proof_number: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:15:19' updated_at: type: string example: '2018-01-04 02:15:19' tags: - Expenses put: summary: 'Update expense / expense refund' operationId: updateExpenseExpenseRefund description: '' parameters: [] 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 nullable: true tax_amount: type: integer example: 0 final_total: type: string example: '43' expense_category_id: type: string example: null nullable: true document: type: string example: null nullable: true created_by: type: integer example: 1 is_recurring: type: integer example: 0 recur_interval: type: string example: null nullable: true recur_interval_type: type: string example: null nullable: true recur_repetitions: type: string example: null nullable: true recur_stopped_on: type: string example: null nullable: true recur_parent_id: type: string example: null nullable: true 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: - Expenses requestBody: required: false content: application/json: schema: type: object properties: final_total: type: number description: 'Expense amount' example: 4326.41688 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: 16 expense_for: type: integer description: 'id of the user for which expense is created' example: 16 contact_id: type: integer description: 'id of the contact(customer or supplier) for which expense is created' example: 16 expense_category_id: type: integer description: 'id of the expense category' example: 16 expense_sub_category_id: type: integer description: 'id of the expense sub-category' example: 16 additional_notes: type: string description: '' example: architecto 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: 16 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: architecto recur_repetitions: type: integer description: 'total number of expense to be generated' example: 16 payment: type: array description: 'payment lines for the expense' example: - architecto items: type: string parameters: - in: path name: id description: 'The ID of the expense.' example: architecto 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: architecto required: false schema: type: string description: 'id of the user for which expense is created' example: architecto - 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 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: 'http://local.pos.com/connector/api/expense-refund?page=1' last: null prev: null next: null meta: current_page: 1 from: 1 path: 'http://local.pos.com/connector/api/expense-refund' per_page: 15 to: 1 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 nullable: true tax_amount: type: string example: '0.0000' final_total: type: string example: '65.0000' expense_category_id: type: string example: null nullable: true document: type: string example: null nullable: true 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: 'http://local.pos.com/connector/api/expense-refund?page=1' last: type: string example: null nullable: true prev: type: string example: null nullable: true next: type: string example: null nullable: true meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'http://local.pos.com/connector/api/expense-refund' per_page: type: integer example: 15 to: type: integer example: 1 tags: - Expenses /connector/api/expense-categories: get: summary: 'List expense categories' operationId: listExpenseCategories description: '' parameters: [] 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 nullable: true parent_id: type: string example: null nullable: true deleted_at: type: string example: null nullable: true 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 nullable: true parent_id: type: integer example: 1 deleted_at: type: string example: null nullable: true created_at: type: string example: '2021-12-16 18:12:07' updated_at: type: string example: '2021-12-16 18:12:07' tags: - Expenses /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. 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 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: 'http://local.pos.com/connector/api/cash-register?page=1' last: null prev: null next: null meta: current_page: 1 from: 1 path: 'http://local.pos.com/connector/api/cash-register' per_page: 10 to: 2 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 nullable: true 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 nullable: true 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 nullable: true 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: 'http://local.pos.com/connector/api/cash-register?page=1' last: type: string example: null nullable: true prev: type: string example: null nullable: true next: type: string example: null nullable: true meta: type: object properties: current_page: type: integer example: 1 from: type: integer example: 1 path: type: string example: 'http://local.pos.com/connector/api/cash-register' per_page: type: integer example: 10 to: type: integer example: 2 tags: - 'Cash Register' post: summary: 'Create Cash Register' operationId: createCashRegister description: '' parameters: [] responses: { } tags: - 'Cash Register' requestBody: required: true content: application/json: schema: type: object properties: location_id: type: integer description: 'id of the business location' example: 1 initial_amount: type: number description: 'Initial amount' example: 4326.41688 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' status: type: register description: 'status (open, close)' example: close closing_amount: type: number description: 'Closing amount' example: 4326.41688 total_card_slips: type: integer description: 'total number of card slips' example: 16 total_cheques: type: integer description: 'total number of checks' example: 16 closing_note: type: string description: 'Closing note' example: architecto transaction_ids: type: string description: 'Comma separated ids of sells associated with the register' example: "1,2,3\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: [] 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 nullable: true 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 nullable: true 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 nullable: true 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' put: summary: 'Close the specified Cash Register' operationId: closeTheSpecifiedCashRegister description: '' parameters: [] responses: { } tags: - 'Cash Register' requestBody: required: false content: application/json: schema: type: object properties: closing_amount: type: number description: 'Closing cash amount' example: 4326.41 total_card_slips: type: integer description: 'Total number of card slips' example: 0 total_cheques: type: integer description: 'Total number of cheques' example: 0 closing_note: type: string description: 'Closing note' example: 'End of day' parameters: - in: path name: id description: 'The ID of the cash register.' example: architecto 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/payment-accounts: get: summary: 'List payment accounts' operationId: listPaymentAccounts description: '' parameters: [] 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 nullable: true created_by: type: integer example: 9 is_closed: type: integer example: 0 deleted_at: type: string example: null nullable: true created_at: type: string example: '2020-06-04 21:34:21' updated_at: type: string example: '2020-06-04 21:34:21' tags: - Payments /connector/api/payment-methods: get: summary: 'List payment methods' operationId: listPaymentMethods description: '' parameters: [] 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: - Payments /connector/api/user/loggedin: get: summary: 'Get the loggedin user details.' operationId: getTheLoggedinUserDetails description: '' parameters: [] 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 nullable: true username: type: string example: admin email: type: string example: admin@example.com language: type: string example: en contact_no: type: string example: null nullable: true address: type: string example: null nullable: true business_id: type: integer example: 1 max_sales_discount_percent: type: string example: null nullable: true allow_login: type: integer example: 1 essentials_department_id: type: string example: null nullable: true essentials_designation_id: type: string example: null nullable: true status: type: string example: active crm_contact_id: type: string example: null nullable: true 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 nullable: true gender: type: string example: null nullable: true marital_status: type: string example: null nullable: true blood_group: type: string example: null nullable: true contact_number: type: string example: null nullable: true fb_link: type: string example: null nullable: true twitter_link: type: string example: null nullable: true social_media_1: type: string example: null nullable: true social_media_2: type: string example: null nullable: true permanent_address: type: string example: null nullable: true current_address: type: string example: null nullable: true guardian_name: type: string example: null nullable: true custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true bank_details: type: string example: null nullable: true id_proof_name: type: string example: null nullable: true id_proof_number: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:15:19' updated_at: type: string example: '2018-01-04 02:15:19' tags: - Users /connector/api/subscription: get: summary: "Get the current subscription status for the authenticated user's business." operationId: getTheCurrentSubscriptionStatusForTheAuthenticatedUsersBusiness description: 'Returns is_active=true when no Superadmin module is installed (unlimited access assumed).' parameters: [] responses: 401: description: '' content: application/json: schema: type: object example: message: Unauthenticated. properties: message: type: string example: Unauthenticated. tags: - Users /connector/api/user-registration: post: summary: 'Register User' operationId: registerUser description: '' parameters: [] 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: - Users requestBody: required: true content: application/json: schema: type: object properties: username: type: string description: 'minimum 5 characters' example: architecto email: type: string description: '' example: gbailey@example.net user_type: type: string description: "'user_customer' for contact/customer login & 'user' for general user" example: architecto surname: type: string description: 'prefix like Mr, Mrs,Dr' example: architecto first_name: type: string description: '' example: architecto last_name: type: string description: '' example: architecto is_active: type: string description: "'active', 'inactive', 'terminated'" example: architecto crm_contact_id: type: integer description: "if user_type is 'user_customer' then required" example: 16 allow_login: type: boolean description: '1 to allow login & 0 to disable login' example: false password: type: string description: "minimum 6 characters & required if 'allow_login' is 1" example: '|]|{+-' role: type: integer description: "id of role to be assigned to user & required if user_type is 'user'" example: 16 access_all_locations: type: boolean description: "1 if user has access all location else 0 & required if user_type is 'user'" example: false 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: - architecto items: type: string cmmsn_percent: type: decimal description: '' example: architecto max_sales_discount_percent: type: decimal description: '' example: architecto selected_contacts: type: boolean description: '1 or 0' example: false selected_contact_ids: type: array description: "array of contact ids & required if 'selected_contacts' is 1" example: - architecto items: type: string dob: type: date description: 'dob of user in "Y-m-d" format Ex: 1997-10-29' example: architecto gender: type: string description: "if user is 'male', 'female', 'others'" example: architecto marital_status: type: string description: "if user is 'married', 'unmarried', 'divorced'" example: architecto blood_group: type: string description: '' example: architecto contact_number: type: string description: '' example: architecto alt_number: type: string description: '' example: architecto family_number: type: string description: '' example: architecto fb_link: type: string description: '' example: architecto twitter_link: type: string description: '' example: architecto social_media_1: type: string description: '' example: architecto social_media_2: type: string description: '' example: architecto custom_field_1: type: string description: '' example: architecto custom_field_2: type: string description: '' example: architecto custom_field_3: type: string description: '' example: architecto custom_field_4: type: string description: '' example: architecto guardian_name: type: string description: '' example: architecto id_proof_name: type: string description: 'ID proof of user like Adhar No.' example: architecto id_proof_number: type: string description: 'Id Number like adhar number' example: architecto permanent_address: type: string description: '' example: architecto current_address: type: string description: '' example: architecto bank_details: type: object description: '' example: '*': account_holder_name: architecto properties: '*': type: object description: '' example: account_holder_name: architecto properties: account_holder_name: type: string description: '' example: architecto account_number: type: string description: '' example: architecto bank_name: type: string description: '' example: architecto bank_code: type: string description: '' example: architecto branch: type: string description: '' example: architecto tax_payer_id: type: string description: '' example: architecto required: - email - user_type - first_name - is_active /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 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 nullable: true username: type: string example: admin email: type: string example: admin@example.com language: type: string example: en contact_no: type: string example: null nullable: true address: type: string example: null nullable: true business_id: type: integer example: 1 max_sales_discount_percent: type: string example: null nullable: true allow_login: type: integer example: 1 essentials_department_id: type: string example: null nullable: true essentials_designation_id: type: string example: null nullable: true status: type: string example: active crm_contact_id: type: string example: null nullable: true 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 nullable: true gender: type: string example: null nullable: true marital_status: type: string example: null nullable: true blood_group: type: string example: null nullable: true contact_number: type: string example: null nullable: true fb_link: type: string example: null nullable: true twitter_link: type: string example: null nullable: true social_media_1: type: string example: null nullable: true social_media_2: type: string example: null nullable: true permanent_address: type: string example: null nullable: true current_address: type: string example: null nullable: true guardian_name: type: string example: null nullable: true custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true bank_details: type: string example: null nullable: true id_proof_name: type: string example: null nullable: true id_proof_number: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:15:19' updated_at: type: string example: '2018-01-04 02:15:19' tags: - Users '/connector/api/user/{id}': get: summary: 'Get the specified user' operationId: getTheSpecifiedUser description: '' parameters: [] 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 nullable: true username: type: string example: admin email: type: string example: admin@example.com language: type: string example: en contact_no: type: string example: null nullable: true address: type: string example: null nullable: true business_id: type: integer example: 1 max_sales_discount_percent: type: string example: null nullable: true allow_login: type: integer example: 1 essentials_department_id: type: string example: null nullable: true essentials_designation_id: type: string example: null nullable: true status: type: string example: active crm_contact_id: type: string example: null nullable: true 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 nullable: true gender: type: string example: null nullable: true marital_status: type: string example: null nullable: true blood_group: type: string example: null nullable: true contact_number: type: string example: null nullable: true fb_link: type: string example: null nullable: true twitter_link: type: string example: null nullable: true social_media_1: type: string example: null nullable: true social_media_2: type: string example: null nullable: true permanent_address: type: string example: null nullable: true current_address: type: string example: null nullable: true guardian_name: type: string example: null nullable: true custom_field_1: type: string example: null nullable: true custom_field_2: type: string example: null nullable: true custom_field_3: type: string example: null nullable: true custom_field_4: type: string example: null nullable: true bank_details: type: string example: null nullable: true id_proof_name: type: string example: null nullable: true id_proof_number: type: string example: null nullable: true deleted_at: type: string example: null nullable: true created_at: type: string example: '2018-01-04 02:15:19' updated_at: type: string example: '2018-01-04 02:15:19' tags: - Users parameters: - in: path name: id description: 'The ID of the user.' example: architecto required: true schema: type: string - 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: [] 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: - Users requestBody: required: true content: application/json: schema: type: object properties: current_password: type: string description: 'Current password of the user' example: architecto new_password: type: string description: 'New password of the user' example: architecto required: - current_password - new_password /connector/api/forget-password: post: summary: 'Recover forgotten password.' operationId: recoverForgottenPassword description: '' parameters: [] 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: - Users requestBody: required: true content: application/json: schema: type: object properties: email: type: string description: 'Users email id' example: gbailey@example.net required: - email '/connector/api/get-attendance/{user_id}': get: summary: 'Get Attendance' operationId: getAttendance description: '' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: data: id: 4 user_id: 1 business_id: 1 clock_in_time: '2020-09-12 13:13:00' clock_out_time: '2020-09-12 13:15:00' essentials_shift_id: 3 ip_address: null clock_in_note: 'test clock in from api' clock_out_note: 'test clock out from api' created_at: '2020-09-12 13:14:39' updated_at: '2020-09-12 13:15:39' properties: data: type: object properties: id: type: integer example: 4 user_id: type: integer example: 1 business_id: type: integer example: 1 clock_in_time: type: string example: '2020-09-12 13:13:00' clock_out_time: type: string example: '2020-09-12 13:15:00' essentials_shift_id: type: integer example: 3 ip_address: type: string example: null nullable: true clock_in_note: type: string example: 'test clock in from api' clock_out_note: type: string example: 'test clock out from api' created_at: type: string example: '2020-09-12 13:14:39' updated_at: type: string example: '2020-09-12 13:15:39' tags: - Attendance parameters: - in: path name: user_id description: 'id of the user' example: '1' required: true schema: type: string /connector/api/clock-in: post: summary: 'Clock In' operationId: clockIn description: '[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock in]' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: success: true msg: 'Clocked In successfully' type: clock_in properties: success: type: boolean example: true msg: type: string example: 'Clocked In successfully' type: type: string example: clock_in tags: - Attendance requestBody: required: true content: application/json: schema: type: object properties: user_id: type: integer description: 'id of the user' example: 1 clock_in_time: type: string description: 'Clock in time.If not given current date time will be used Fromat: Y-m-d H:i:s' example: '2000-06-13 13:13:00' clock_in_note: type: string description: 'Clock in note.' example: architecto ip_address: type: string description: 'IP address.' example: architecto latitude: type: string description: 'Latitude of the clock in location.' example: architecto longitude: type: string description: 'Longitude of the clock in location.' example: architecto required: - user_id /connector/api/clock-out: post: summary: 'Clock Out' operationId: clockOut description: '[User must have "essentials.allow_users_for_attendance_from_api" permission to Clock out]' parameters: [] responses: 200: description: '' content: application/json: schema: type: object example: success: true msg: 'Clocked Out successfully' type: clock_out properties: success: type: boolean example: true msg: type: string example: 'Clocked Out successfully' type: type: string example: clock_out tags: - Attendance requestBody: required: true content: application/json: schema: type: object properties: user_id: type: integer description: 'id of the user' example: 1 clock_out_time: type: string description: 'Clock out time.If not given current date time will be used Fromat: Y-m-d H:i:s' example: '2000-06-13 13:13:00' clock_out_note: type: string description: 'Clock out note.' example: architecto latitude: type: string description: 'Latitude of the clock out location.' example: architecto longitude: type: string description: 'Longitude of the clock out location.' example: architecto required: - user_id /connector/api/holidays: get: summary: 'List Holidays' operationId: listHolidays 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: start_date description: 'format:Y-m-d' example: '2020-06-25' required: false schema: type: string description: 'format:Y-m-d' example: '2020-06-25' - in: query name: end_date description: 'format:Y-m-d' example: '2020-06-25' required: false schema: type: string description: 'format:Y-m-d' example: '2020-06-25' responses: 200: description: '' content: application/json: schema: type: object example: data: - id: 2 name: 'Independence Day' start_date: '2020-08-15' end_date: '2020-09-15' business_id: 1 location_id: null note: 'test holiday' created_at: '2020-09-15 11:25:56' updated_at: '2020-09-15 11:25:56' properties: data: type: array example: - id: 2 name: 'Independence Day' start_date: '2020-08-15' end_date: '2020-09-15' business_id: 1 location_id: null note: 'test holiday' created_at: '2020-09-15 11:25:56' updated_at: '2020-09-15 11:25:56' items: type: object properties: id: type: integer example: 2 name: type: string example: 'Independence Day' start_date: type: string example: '2020-08-15' end_date: type: string example: '2020-09-15' business_id: type: integer example: 1 location_id: type: string example: null nullable: true note: type: string example: 'test holiday' created_at: type: string example: '2020-09-15 11:25:56' updated_at: type: string example: '2020-09-15 11:25:56' tags: - Attendance /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' 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: - Reports /connector/api/product-stock-report: get: summary: 'Get product current stock' operationId: getProductCurrentStock description: '' parameters: [] 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: 'http://local.pos.com/connector/api/product-stock-report?page=1' last: 'http://local.pos.com/connector/api/product-stock-report?page=22' prev: null next: 'http://local.pos.com/connector/api/product-stock-report?page=2' meta: current_page: 1 from: 1 last_page: 22 path: 'http://local.pos.com/connector/api/product-stock-report' per_page: 3 to: 3 total: 66 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 nullable: true total_transfered: type: string example: null nullable: true total_adjusted: type: string example: null nullable: true stock_price: type: string example: null nullable: true stock: type: string example: null nullable: true 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 nullable: true location_id: type: string example: null nullable: true variation_id: type: integer example: 1 links: type: object properties: first: type: string example: 'http://local.pos.com/connector/api/product-stock-report?page=1' last: type: string example: 'http://local.pos.com/connector/api/product-stock-report?page=22' prev: type: string example: null nullable: true next: type: string example: 'http://local.pos.com/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: 'http://local.pos.com/connector/api/product-stock-report' per_page: type: integer example: 3 to: type: integer example: 3 total: type: integer example: 66 tags: - Reports /connector/api/notifications: get: summary: 'Get notifications' operationId: getNotifications description: '' parameters: [] 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: 'http://local.pos.com/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: 'http://local.pos.com/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: 'http://local.pos.com/hrm/payroll' read_at: type: string example: null nullable: true created_at: type: string example: '3 hours ago' tags: - Notifications