Square connector reference

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

This page has reference information for the managed Square connector, including supported source tables and destination table schemas.

Supported source tables

The Square connector supports the following source tables, all under the default source schema:

Source table	Primary key	Description	Sync mode	Cursor field
`locations`	`id`	Business locations configured in your Square account, including currency, timezone, and capabilities.	Full refresh only
`customers`	`id`	Customer profiles in your Square account, including contact details and creation source.	Full refresh only
`team_member_wages`	`id`	Wage settings for team members, including job title and tip eligibility.	Full refresh only
`bank_accounts`	`id`	Bank accounts linked to your Square account, including status and account type.	Full refresh only
`shifts`	`id`	Labor shifts worked by team members, including start and end times and wages.	Full refresh only
`team_members`	`id`	Team members in your Square account, including status, assigned locations, and wage settings.	Full refresh only
`inventory`	`catalog_object_id`	Inventory counts for catalog objects at each location.	Full refresh only
`loyalty`	`id`	Loyalty program accounts, including point balances and enrollment dates.	Full refresh only
`payments`	`id`	Payments taken through Square, including amounts, status, and associated orders.	Incremental	`created_at`
`refunds`	`id`	Refunds processed through Square, including amounts, status, and associated payments.	Incremental	`created_at`
`items`	`id`	Catalog items in your Square account, including item details and versioning.	Incremental	`updated_at`
`categories`	`id`	Catalog categories used to organize items.	Incremental	`updated_at`
`discounts`	`id`	Catalog discounts available in your Square account.	Incremental	`updated_at`
`taxes`	`id`	Catalog taxes configured in your Square account.	Incremental	`updated_at`
`modifier_lists`	`id`	Catalog modifier lists applied to items.	Incremental	`updated_at`
`cash_drawers`	`id`	Cash drawer shifts for each location, including opening and closing cash amounts.	Full refresh only
`orders`	`id`	Orders placed across your Square locations, including line items, totals, and fulfillments.	Incremental	`updated_at`

Connector options

The Square connector has no additional configuration options beyond the pipeline settings available for all managed connectors. See Ingest data from Square.

Destination table schemas

`locations`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`name`	`STRING`
`timezone`	`STRING`
`capabilities`	`STRING`
`status`	`STRING`
`created_at`	`STRING`
`merchant_id`	`STRING`
`country`	`STRING`
`language_code`	`STRING`
`currency`	`STRING`
`business_name`	`STRING`
`type`	`STRING`
`business_hours`	`STRING`
`mcc`	`STRING`

`customers`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`
`given_name`	`STRING`
`family_name`	`STRING`
`email_address`	`STRING`
`phone_number`	`STRING`
`company_name`	`STRING`
`reference_id`	`STRING`
`note`	`STRING`
`creation_source`	`STRING`
`version`	`BIGINT`

`team_member_wages`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`team_member_id`	`STRING`
`title`	`STRING`
`job_id`	`STRING`
`tip_eligible`	`BOOLEAN`

`bank_accounts`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`account_number_suffix`	`STRING`
`country`	`STRING`
`currency`	`STRING`
`account_type`	`STRING`
`holder_name`	`STRING`
`primary_bank_identification_number`	`STRING`
`status`	`STRING`
`creditable`	`BOOLEAN`
`debitable`	`BOOLEAN`
`location_id`	`STRING`

`shifts`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`employee_id`	`STRING`
`team_member_id`	`STRING`
`location_id`	`STRING`
`timezone`	`STRING`
`start_at`	`STRING`
`end_at`	`STRING`
`wage`	`STRING`
`status`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`

`team_members`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`is_owner`	`BOOLEAN`
`status`	`STRING`
`given_name`	`STRING`
`family_name`	`STRING`
`email_address`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`
`assigned_locations`	`STRING`
`merchant_id`	`STRING`
`wage_setting`	`STRING`

`inventory`

Primary key: catalog_object_id Sync mode: Full refresh only

Field	Data type
`catalog_object_id`	`STRING`
`catalog_object_type`	`STRING`
`state`	`STRING`
`location_id`	`STRING`
`quantity`	`STRING`
`calculated_at`	`STRING`

`loyalty`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`program_id`	`STRING`
`balance`	`BIGINT`
`lifetime_points`	`BIGINT`
`customer_id`	`STRING`
`enrolled_at`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`

`payments`

Primary key: id Cursor field: created_at

Field	Data type
`id`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`
`amount_money`	`STRING`
`total_money`	`STRING`
`status`	`STRING`
`source_type`	`STRING`
`location_id`	`STRING`
`order_id`	`STRING`
`receipt_number`	`STRING`
`receipt_url`	`STRING`

`refunds`

Primary key: id Cursor field: created_at

Field	Data type
`id`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`
`amount_money`	`STRING`
`status`	`STRING`
`location_id`	`STRING`
`order_id`	`STRING`
`payment_id`	`STRING`
`reason`	`STRING`

`items`

Primary key: id Cursor field: updated_at

Field	Data type
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`item_data`	`STRING`

`categories`

Primary key: id Cursor field: updated_at

Field	Data type
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`category_data`	`STRING`

`discounts`

Primary key: id Cursor field: updated_at

Field	Data type
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`discount_data`	`STRING`

`taxes`

Primary key: id Cursor field: updated_at

Field	Data type
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`tax_data`	`STRING`

`modifier_lists`

Primary key: id Cursor field: updated_at

Field	Data type
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`modifier_list_data`	`STRING`

`cash_drawers`

Primary key: id Sync mode: Full refresh only

Field	Data type
`id`	`STRING`
`location_id`	`STRING`
`opened_at`	`STRING`
`ended_at`	`STRING`
`closed_at`	`STRING`
`state`	`STRING`
`description`	`STRING`
`opened_cash_money`	`STRING`
`cash_payment_money`	`STRING`
`cash_refunds_money`	`STRING`
`cash_paid_in_money`	`STRING`
`cash_paid_out_money`	`STRING`
`expected_cash_money`	`STRING`
`closed_cash_money`	`STRING`
`opening_employee_id`	`STRING`
`ending_employee_id`	`STRING`
`closing_employee_id`	`STRING`
`device`	`STRING`

`orders`

Primary key: id Cursor field: updated_at

Field	Data type
`id`	`STRING`
`location_id`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`
`closed_at`	`STRING`
`state`	`STRING`
`version`	`BIGINT`
`total_money`	`STRING`
`total_tax_money`	`STRING`
`total_discount_money`	`STRING`
`total_tip_money`	`STRING`
`total_service_charge_money`	`STRING`
`net_amounts`	`STRING`
`source`	`STRING`
`line_items`	`STRING`
`fulfillments`	`STRING`
`returns`	`STRING`
`customer_id`	`STRING`
`reference_id`	`STRING`

Required OAuth permissions

The Square access token must have the following OAuth permissions. The set of permissions the connector requires depends on which tables you ingest. For more information, see the Square OAuth permissions reference.

Permission	Required for
`MERCHANT_PROFILE_READ`	`locations`
`CUSTOMERS_READ`	`customers`
`EMPLOYEES_READ`	`team_members`, `team_member_wages`
`TIMECARDS_READ`	`shifts`
`BANK_ACCOUNTS_READ`	`bank_accounts`
`INVENTORY_READ`	`inventory`
`LOYALTY_READ`	`loyalty`
`PAYMENTS_READ`	`payments`, `refunds`
`ITEMS_READ`	`items`, `categories`, `discounts`, `taxes`, `modifier_lists`
`CASH_DRAWER_READ`	`cash_drawers`
`ORDERS_READ`	`orders`

Supported source tables​

Connector options​

Destination table schemas​

locations​

customers​

team_member_wages​

bank_accounts​

shifts​

team_members​

inventory​

loyalty​

payments​

refunds​

items​

categories​

discounts​

taxes​

modifier_lists​

cash_drawers​

orders​

Required OAuth permissions​

Supported source tables

Connector options

Destination table schemas

`locations`

`customers`

`team_member_wages`

`bank_accounts`

`shifts`

`team_members`

`inventory`

`loyalty`

`payments`

`refunds`

`items`

`categories`

`discounts`

`taxes`

`modifier_lists`

`cash_drawers`

`orders`

Required OAuth permissions