Square ON THIS PAGE
Square is a large business technology platform serving all kinds of businesses. The Square operating system allows business owners to sell anywhere.
Square integration replicates data using the Square API version 2023-06-08 .
See the
Schema section for a list of objects available for replication.
Feature snapshot
A high-level look at this connector, including useful links, and supported features.
Preparing for authentication To access your data, you need to authenticate the connection with your account credentials.
Information note Make sure that the account you use has read access to the tables you want to fetch.
You must have administrator permissions for your Square Developer account.
Connections from Qlik Talend Cloud to the Square Sandbox instance are not currently supported.
To obtain your application ID and access token:
Log into your Square Developer account. Click + to create an app. Enter a name for your app. In the left navigation bar, select OAuth , and then select Production . Set Production Redirect URL to https://connector.qlik.com/auth/oauth/v3.htm . In the left navigation bar, select Credentials , and then select Production . Copy and paste your application ID and access token into a secured file. Creating the connection For more information, see Connecting to SaaS applications
Click Authenticate when you have filled in the required connection settings.
You may be asked to log in to the source application.
A window is displayed with an authentication code.
Copy the code to the clipboard and return to the connection dialog.
Paste the code in Complete authentication with the code provided by the source and click Verify .
Tip note You may need to scroll down to see this field.
When status is Verified , the authentication is verified.
Provide a name for the connection in Connection name .
Select Open connection metadata to define metadata for the connection when it has been created.
Connection settings Setting Description Data gateway
Select a Data Movement gateway if required by your use case.
Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway . If you have another subscription tier and do not want to use Data Movement gateway , select None .
For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement
Start Date Enter the date, in the format MM/DD/YYYY, from which the data must be replicated from your source to your target.
Application ID Application ID. Access Token Access token.
Information note Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.
The schema and info displayed below is for version 2.
Depending on your destination, table and column names may not appear as they are outlined below.
bank_accounts
The bank_accounts contains information about a merchant’s bank account in Square.
Note : This table can’t be replicated if the Connect to a sandbox environment box is checked in the integration’s settings due to limits imposed by Square.
bank_accounts table foreign keys Join bank_accounts with on categories bank_accounts.id = categories.absent_at_location_ids discounts bank_accounts.id = discounts.absent_at_location_ids team_members bank_accounts.id = team_members.assigned_locations.location_ids inventories bank_accounts.id = inventories.location_id items bank_accounts.id = items.absent_at_location_ids bank_accounts.id = items.item_data.variations.item_variation_data.location_overrides.location_id bank_accounts.id = items.item_data.variations.present_at_location_ids bank_accounts.id = items.present_at_location_ids locations bank_accounts.id = locations.id modifier_lists bank_accounts.id = modifier_lists.absent_at_location_ids orders bank_accounts.id = orders.id bank_accounts.id = orders.refunds.id bank_accounts.id = orders.tenders.id payments bank_accounts.id = payments.id refunds bank_accounts.id = refunds.id shifts bank_accounts.id = shifts.id taxes bank_accounts.id = taxes.absent_at_location_ids
bank_accounts table schema
account_number_suffix
STRING
account_type
STRING
bank_name
STRING
country
STRING
creditable
BOOLEAN
currency
STRING
debit_mandate_reference_id
STRING
debitable
BOOLEAN
holder_name
STRING
id
STRING
location_id
STRING
primary_bank_identification_number
STRING
reference_id
STRING
secondary_bank_identification_number
STRING
status
STRING
version
INTEGER
cash_drawer_shifts
The cash_drawer_shifts table contains infomration about cash transactions in Square.
cash_drawer_shifts table schema
closed_at
DATE-TIME
closed_cash_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
created_at
DATE-TIME
description
STRING
ended_at
DATE-TIME
expected_cash_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
id
STRING
location_id
STRING
opened_at
DATE-TIME
opened_cash_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
state
STRING
updated_at
DATE-TIME
categories
The categories table contains information about item categories for a given location in Square.
categories table foreign keys Join categories with on items categories.id = items.item_data.category_id categories.absent_at_location_ids = items.absent_at_location_ids categories.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id categories.absent_at_location_ids = items.item_data.variations.present_at_location_ids categories.absent_at_location_ids = items.present_at_location_ids bank_accounts categories.absent_at_location_ids = bank_accounts.id discounts categories.absent_at_location_ids = discounts.absent_at_location_ids team_members categories.absent_at_location_ids = team_members.assigned_locations.location_ids inventories categories.absent_at_location_ids = inventories.location_id locations categories.absent_at_location_ids = locations.id modifier_lists categories.absent_at_location_ids = modifier_lists.absent_at_location_ids orders categories.absent_at_location_ids = orders.id categories.absent_at_location_ids = orders.refunds.id categories.absent_at_location_ids = orders.tenders.id payments categories.absent_at_location_ids = payments.id refunds categories.absent_at_location_ids = refunds.id shifts categories.absent_at_location_ids = shifts.id taxes categories.absent_at_location_ids = taxes.absent_at_location_ids
categories table schema
absent_at_location_ids
ARRAY
category_data
OBJECT
This is a nested data structure:
id
STRING
is_deleted
BOOLEAN
present_at_all_locations
BOOLEAN
type
STRING
updated_at
DATE-TIME
version
INTEGER
customers
The customers contains information about customer profiles associated with your Square account.
customers table schema
address
OBJECT
This is a nested data structure:
address_line_1: STRING address_line_2: STRING address_line_3: STRING administrative_district_level_1: STRING administrative_district_level_2: STRING administrative_district_level_3: STRING country: STRING first_name: STRING last_name: STRING locality: STRING postal_code: STRING sublocality: STRING sublocality_2: STRING sublocality_3: STRING
birthday
DATE-TIME
STRING
company_name
STRING
created_at
DATE-TIME
creation_source
STRING
email_address
STRING
family_name
STRING
given_name
STRING
group_ids
ARRAY
id
STRING
nickname
STRING
note
STRING
phone_number
STRING
preferences
OBJECT
This is a nested data structure:
email_unsubscribed: BOOLEAN
reference_id
STRING
segment_ids
ARRAY
tax_ids
OBJECT
This is a nested data structure:
updated_at
DATE-TIME
version
INTEGER
discounts
The discounts table contains information about discounts for a given location in Square.
Replication Method
CDC
Primary Key
id
Replication Key
updated_at
Useful links
Square API method
discounts table foreign keys Join discounts with on bank_accounts discounts.absent_at_location_ids = bank_accounts.id categories discounts.absent_at_location_ids = categories.absent_at_location_ids team_members discounts.absent_at_location_ids = team_members.assigned_locations.location_ids inventories discounts.absent_at_location_ids = inventories.location_id items discounts.absent_at_location_ids = items.absent_at_location_ids discounts.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id discounts.absent_at_location_ids = items.item_data.variations.present_at_location_ids discounts.absent_at_location_ids = items.present_at_location_ids locations discounts.absent_at_location_ids = locations.id modifier_lists discounts.absent_at_location_ids = modifier_lists.absent_at_location_ids orders discounts.absent_at_location_ids = orders.id discounts.absent_at_location_ids = orders.refunds.id discounts.absent_at_location_ids = orders.tenders.id payments discounts.absent_at_location_ids = payments.id refunds discounts.absent_at_location_ids = refunds.id shifts discounts.absent_at_location_ids = shifts.id taxes discounts.absent_at_location_ids = taxes.absent_at_location_ids
discounts table schema
absent_at_location_ids
ARRAY
discount_data
OBJECT
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING application_method: STRING discount_type: STRING label_color: STRING modify_tax_basis: STRING name: STRING percentage: STRING pin_required: BOOLEAN
id
STRING
is_deleted
BOOLEAN
present_at_all_locations
BOOLEAN
type
STRING
updated_at
DATE-TIME
version
INTEGER
inventories
The inventories table contains info about the current calculated stock count for a Square location.
inventories table foreign keys Join inventories with on bank_accounts inventories.location_id = bank_accounts.id categories inventories.location_id = categories.absent_at_location_ids discounts inventories.location_id = discounts.absent_at_location_ids team_members inventories.location_id = team_members.assigned_locations.location_ids items inventories.location_id = items.absent_at_location_ids inventories.location_id = items.item_data.variations.item_variation_data.location_overrides.location_id inventories.location_id = items.item_data.variations.present_at_location_ids inventories.location_id = items.present_at_location_ids locations inventories.location_id = locations.id modifier_lists inventories.location_id = modifier_lists.absent_at_location_ids orders inventories.location_id = orders.id inventories.location_id = orders.refunds.id inventories.location_id = orders.tenders.id payments inventories.location_id = payments.id refunds inventories.location_id = refunds.id shifts inventories.location_id = shifts.id taxes inventories.location_id = taxes.absent_at_location_ids
inventories table schema
calculated_at
DATE-TIME
catalog_object_id
STRING
catalog_object_type
STRING
location_id
STRING
quantity
STRING
state
STRING
items
The items table contains information about items for a given location in Square.
items table foreign keys Join items with on categories items.item_data.category_id = categories.id items.absent_at_location_ids = categories.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = categories.absent_at_location_ids items.item_data.variations.present_at_location_ids = categories.absent_at_location_ids items.present_at_location_ids = categories.absent_at_location_ids bank_accounts items.absent_at_location_ids = bank_accounts.id items.item_data.variations.item_variation_data.location_overrides.location_id = bank_accounts.id items.item_data.variations.present_at_location_ids = bank_accounts.id items.present_at_location_ids = bank_accounts.id discounts items.absent_at_location_ids = discounts.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = discounts.absent_at_location_ids items.item_data.variations.present_at_location_ids = discounts.absent_at_location_ids items.present_at_location_ids = discounts.absent_at_location_ids team_members items.absent_at_location_ids = team_members.assigned_locations.location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = team_members.assigned_locations.location_ids items.item_data.variations.present_at_location_ids = team_members.assigned_locations.location_ids items.present_at_location_ids = team_members.assigned_locations.location_ids inventories items.absent_at_location_ids = inventories.location_id items.item_data.variations.item_variation_data.location_overrides.location_id = inventories.location_id items.item_data.variations.present_at_location_ids = inventories.location_id items.present_at_location_ids = inventories.location_id locations items.absent_at_location_ids = locations.id items.item_data.variations.item_variation_data.location_overrides.location_id = locations.id items.item_data.variations.present_at_location_ids = locations.id items.present_at_location_ids = locations.id modifier_lists items.absent_at_location_ids = modifier_lists.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = modifier_lists.absent_at_location_ids items.item_data.variations.present_at_location_ids = modifier_lists.absent_at_location_ids items.present_at_location_ids = modifier_lists.absent_at_location_ids items.item_data.modifier_list_info.modifier_list_id = modifier_lists.id items.item_data.modifier_list_info.modifier_list_id = modifier_lists.modifier_list_data.modifiers.modifier_data.modifier_list_id orders items.absent_at_location_ids = orders.id items.item_data.variations.item_variation_data.location_overrides.location_id = orders.id items.item_data.variations.present_at_location_ids = orders.id items.present_at_location_ids = orders.id items.absent_at_location_ids = orders.refunds.id items.item_data.variations.item_variation_data.location_overrides.location_id = orders.refunds.id items.item_data.variations.present_at_location_ids = orders.refunds.id items.present_at_location_ids = orders.refunds.id items.absent_at_location_ids = orders.tenders.id items.item_data.variations.item_variation_data.location_overrides.location_id = orders.tenders.id items.item_data.variations.present_at_location_ids = orders.tenders.id items.present_at_location_ids = orders.tenders.id payments items.absent_at_location_ids = payments.id items.item_data.variations.item_variation_data.location_overrides.location_id = payments.id items.item_data.variations.present_at_location_ids = payments.id items.present_at_location_ids = payments.id refunds items.absent_at_location_ids = refunds.id items.item_data.variations.item_variation_data.location_overrides.location_id = refunds.id items.item_data.variations.present_at_location_ids = refunds.id items.present_at_location_ids = refunds.id shifts items.absent_at_location_ids = shifts.id items.item_data.variations.item_variation_data.location_overrides.location_id = shifts.id items.item_data.variations.present_at_location_ids = shifts.id items.present_at_location_ids = shifts.id taxes items.absent_at_location_ids = taxes.absent_at_location_ids items.item_data.variations.item_variation_data.location_overrides.location_id = taxes.absent_at_location_ids items.item_data.variations.present_at_location_ids = taxes.absent_at_location_ids items.present_at_location_ids = taxes.absent_at_location_ids items.item_data.tax_ids = taxes.id
items table schema
absent_at_location_ids
ARRAY
id
STRING
is_deleted
BOOLEAN
item_data
OBJECT
This is a nested data structure:
abbreviation: STRING available_electronically: BOOLEAN available_for_pickup: BOOLEAN available_online: BOOLEAN category_id: STRING description: STRING item_options: ARRAY, which is also a nested data structure.
label_color: STRING legacy_tax_ids: ARRAY modifier_list_info: ARRAY, which is also a nested data structure.
enabled: BOOLEAN modifier_list_id: STRING name: STRING product_type: STRING skip_modifier_screen: BOOLEAN tax_ids: ARRAY variations: ARRAY, which is also a nested data structure.
id: STRING is_deleted: BOOLEAN item_variation_data: OBJECT, which is also a nested data structure.
inventory_alert_type: STRING item_id: STRING location_overrides: ARRAY, which is also a nested data structure.
inventory_alert_threshold: INTEGER inventory_alert_type: STRING location_id: STRING sold_out: BOOLEAN track_inventory: BOOLEAN name: STRING ordinal: INTEGER price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING pricing_type: STRING sku: STRING track_inventory: BOOLEAN user_data: STRING present_at_all_locations: BOOLEAN present_at_location_ids: ARRAY type: STRING updated_at: DATE-TIME version: INTEGER visibility: STRING
present_at_all_locations
BOOLEAN
present_at_location_ids
ARRAY
type
STRING
updated_at
DATE-TIME
version
INTEGER
locations
The locations table contains information about all of your business locations in Square.
locations table foreign keys Join locations with on bank_accounts locations.id = bank_accounts.id categories locations.id = categories.absent_at_location_ids discounts locations.id = discounts.absent_at_location_ids team_members locations.id = team_members.assigned_locations.location_ids inventories locations.id = inventories.location_id items locations.id = items.absent_at_location_ids locations.id = items.item_data.variations.item_variation_data.location_overrides.location_id locations.id = items.item_data.variations.present_at_location_ids locations.id = items.present_at_location_ids modifier_lists locations.id = modifier_lists.absent_at_location_ids orders locations.id = orders.id locations.id = orders.refunds.id locations.id = orders.tenders.id payments locations.id = payments.id refunds locations.id = refunds.id shifts locations.id = shifts.id taxes locations.id = taxes.absent_at_location_ids
locations table schema
address
OBJECT
This is a nested data structure:
address_line_1: STRING address_line_2: STRING address_line_3: STRING administrative_district_level_1: STRING administrative_district_level_2: STRING administrative_district_level_3: STRING country: STRING first_name: STRING last_name: STRING locality: STRING postal_code: STRING sublocality: STRING sublocality_2: STRING sublocality_3: STRING
business_email
STRING
business_hours
OBJECT
This is a nested data structure:
periods: ARRAY, which is also a nested data structure.
day_of_week: STRING end_local_time: STRING start_local_time: STRING
business_name
STRING
capabilities
ARRAY
coordinates
OBJECT
This is a nested data structure:
latitude: NUMBER longitude: NUMBER
country
STRING
created_at
DATE-TIME
currency
STRING
description
STRING
facebook_url
STRING
full_format_logo_url
STRING
id
STRING
instagram_username
STRING
language_code
STRING
logo_url
STRING
mcc
STRING
merchant_id
STRING
name
STRING
phone_number
STRING
pos_background_url
STRING
status
STRING
timezone
STRING
twitter_username
STRING
type
STRING
website_url
STRING
modifier_lists
The modifier_lists table contains information about modifier lists for a given location in Square.
modifier_lists table foreign keys Join modifier_lists with on bank_accounts modifier_lists.absent_at_location_ids = bank_accounts.id categories modifier_lists.absent_at_location_ids = categories.absent_at_location_ids discounts modifier_lists.absent_at_location_ids = discounts.absent_at_location_ids team_members modifier_lists.absent_at_location_ids = team_members.assigned_locations.location_ids inventories modifier_lists.absent_at_location_ids = inventories.location_id items modifier_lists.absent_at_location_ids = items.absent_at_location_ids modifier_lists.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id modifier_lists.absent_at_location_ids = items.item_data.variations.present_at_location_ids modifier_lists.absent_at_location_ids = items.present_at_location_ids modifier_lists.id = items.item_data.modifier_list_info.modifier_list_id modifier_lists.modifier_list_data.modifiers.modifier_data.modifier_list_id = items.item_data.modifier_list_info.modifier_list_id locations modifier_lists.absent_at_location_ids = locations.id orders modifier_lists.absent_at_location_ids = orders.id modifier_lists.absent_at_location_ids = orders.refunds.id modifier_lists.absent_at_location_ids = orders.tenders.id payments modifier_lists.absent_at_location_ids = payments.id refunds modifier_lists.absent_at_location_ids = refunds.id shifts modifier_lists.absent_at_location_ids = shifts.id taxes modifier_lists.absent_at_location_ids = taxes.absent_at_location_ids
modifier_lists table schema
absent_at_location_ids
ARRAY
id
STRING
is_deleted
BOOLEAN
modifier_list_data
OBJECT
This is a nested data structure:
modifiers: ARRAY, which is also a nested data structure.
id: STRING is_deleted: BOOLEAN modifier_data: OBJECT, which is also a nested data structure.
modifier_list_id: STRING name: STRING on_by_default: BOOLEAN ordinal: INTEGER price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING present_at_all_locations: BOOLEAN type: STRING updated_at: DATE-TIME version: INTEGER name: STRING ordinal: INTEGER selection_type: STRING
present_at_all_locations
BOOLEAN
type
STRING
updated_at
DATE-TIME
version
INTEGER
orders
The orders table contains information about order updates in Square.
orders table foreign keys Join orders with on bank_accounts orders.id = bank_accounts.id orders.refunds.id = bank_accounts.id orders.tenders.id = bank_accounts.id categories orders.id = categories.absent_at_location_ids orders.refunds.id = categories.absent_at_location_ids orders.tenders.id = categories.absent_at_location_ids discounts orders.id = discounts.absent_at_location_ids orders.refunds.id = discounts.absent_at_location_ids orders.tenders.id = discounts.absent_at_location_ids team_members orders.id = team_members.assigned_locations.location_ids orders.refunds.id = team_members.assigned_locations.location_ids orders.tenders.id = team_members.assigned_locations.location_ids inventories orders.id = inventories.location_id orders.refunds.id = inventories.location_id orders.tenders.id = inventories.location_id items orders.id = items.absent_at_location_ids orders.refunds.id = items.absent_at_location_ids orders.tenders.id = items.absent_at_location_ids orders.id = items.item_data.variations.item_variation_data.location_overrides.location_id orders.refunds.id = items.item_data.variations.item_variation_data.location_overrides.location_id orders.tenders.id = items.item_data.variations.item_variation_data.location_overrides.location_id orders.id = items.item_data.variations.present_at_location_ids orders.refunds.id = items.item_data.variations.present_at_location_ids orders.tenders.id = items.item_data.variations.present_at_location_ids orders.id = items.present_at_location_ids orders.refunds.id = items.present_at_location_ids orders.tenders.id = items.present_at_location_ids locations orders.id = locations.id orders.refunds.id = locations.id orders.tenders.id = locations.id modifier_lists orders.id = modifier_lists.absent_at_location_ids orders.refunds.id = modifier_lists.absent_at_location_ids orders.tenders.id = modifier_lists.absent_at_location_ids payments orders.id = payments.id orders.refunds.id = payments.id orders.tenders.id = payments.id orders.id = payments.order_id orders.returns.source_order_id = payments.order_id orders.refunds.id = payments.order_id orders.refunds.id = payments.refund_ids refunds orders.id = refunds.id orders.refunds.id = refunds.id orders.tenders.id = refunds.id orders.id = refunds.order_id orders.returns.source_order_id = refunds.order_id orders.tenders.id = refunds.payment_id shifts orders.id = shifts.id orders.refunds.id = shifts.id orders.tenders.id = shifts.id taxes orders.id = taxes.absent_at_location_ids orders.refunds.id = taxes.absent_at_location_ids orders.tenders.id = taxes.absent_at_location_ids
orders table schema
closed_at
DATE-TIME
created_at
DATE-TIME
discounts
ARRAY
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING catalog_object_id: STRING catalog_version: INTEGER name: STRING percentage: STRING pricing_rule_id: STRING scope: STRING type: STRING
fulfillments
ARRAY
This is a nested data structure:
pickup_details: OBJECT, which is also a nested data structure.
accepted_at: DATE-TIME auto_complete_duration: STRING cancel_reason: STRING canceled_at: DATE-TIME expired_at: DATE-TIME expires_at: DATE-TIME note: STRING picked_up_at: DATE-TIME pickup_at: DATE-TIME pickup_window_duration: STRING placed_at: DATE-TIME prep_time_duration: STRING ready_at: DATE-TIME recipient: OBJECT, which is also a nested data structure.
customer_id: STRING display_name: STRING email_address: STRING phone_number: STRING rejected_at: DATE-TIME schedule_type: STRING state: STRING type: STRING uid: STRING
id
STRING
line_items
ARRAY
This is a nested data structure:
base_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING catalog_object_id: STRING catalog_version: INTEGER gross_sales_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING item_type: STRING modifiers: ARRAY, which is also a nested data structure.
base_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING catalog_object_id: STRING catalog_version: INTEGER name: STRING quantity: STRING total_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING name: STRING note: STRING quantity: STRING quantity_unit: OBJECT, which is also a nested data structure.
catalog_object_id: STRING catalog_version: INTEGER measurement_unit: OBJECT, which is also a nested data structure.
area_unit: STRING custom_unit: OBJECT, which is also a nested data structure.
abbreviation: STRING name: STRING generic_unit: STRING length_unit: STRING time_unit: STRING type: STRING volume_unit: STRING weight_unit: STRING precision: INTEGER total_discount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_tax_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING uid: STRING variation_name: STRING variation_total_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING
location_id
STRING
net_amount_due_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
net_amounts
OBJECT
This is a nested data structure:
discount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING service_charge_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tax_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tip_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING
pricing_options
OBJECT
This is a nested data structure:
auto_apply_discounts: BOOLEAN
reference_id
STRING
refunds
ARRAY
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING created_at: DATE-TIME id: STRING location_id: STRING processing_fee_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING reason: STRING status: STRING tender_id: STRING transaction_id: STRING
return_amounts
OBJECT
This is a nested data structure:
discount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING service_charge_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tax_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tip_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING
returns
ARRAY
This is a nested data structure:
return_amounts: OBJECT, which is also a nested data structure.
discount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING service_charge_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tax_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tip_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING return_discounts: ARRAY, which is also a nested data structure.
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING catalog_object_id: STRING catalog_version: INTEGER name: STRING percentage: STRING scope: STRING source_discount_uid: STRING type: STRING uid: STRING return_line_items: ARRAY, which is also a nested data structure.
applied_discounts: ARRAY, which is also a nested data structure.
applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING discount_uid: STRING uid: STRING applied_service_charges: ARRAY, which is also a nested data structure.
applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING service_charge_uid: STRING uid: STRING applied_taxes: ARRAY, which is also a nested data structure.
applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tax_uid: STRING uid: STRING base_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING catalog_object_id: STRING catalog_version: INTEGER gross_return_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING item_type: STRING name: STRING note: STRING quantity: STRING quantity_unit: OBJECT, which is also a nested data structure.
catalog_object_id: STRING catalog_version: INTEGER measurement_unit: OBJECT, which is also a nested data structure.
area_unit: STRING custom_unit: OBJECT, which is also a nested data structure.
abbreviation: STRING name: STRING generic_unit: STRING length_unit: STRING time_unit: STRING type: STRING volume_unit: STRING weight_unit: STRING precision: INTEGER return_modifiers: ARRAY, which is also a nested data structure.
base_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING catalog_object_id: STRING catalog_version: INTEGER name: STRING quantity: STRING source_modifier_uid: STRING total_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING uid: STRING source_line_item_uid: STRING total_discount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_service_charge_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_tax_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING uid: STRING variation_name: STRING variation_total_price_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING return_service_charges: ARRAY, which is also a nested data structure.
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING calculation_phase: STRING catalog_object_id: STRING catalog_version: INTEGER name: STRING percentage: STRING source_service_charge_uid: STRING taxable: BOOLEAN total_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_tax_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING return_taxes: ARRAY, which is also a nested data structure.
applied_money: OBJECT, which is also a nested data structure. catalog_object_id: STRING catalog_version: INTEGER name: STRING percentage: STRING scope: STRING source_tax_uid: STRING type: STRING uid: STRING rounding_adjustment: OBJECT, which is also a nested data structure.
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING name: STRING uid: STRING source_order_id: STRING uid: STRING
service_charges
ARRAY
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING calculation_phase: STRING catalog_object_id: STRING catalog_version: INTEGER name: STRING percentage: STRING taxable: BOOLEAN total_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING total_tax_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING type: STRING
source
OBJECT
This is a nested data structure:
state
STRING
taxes
ARRAY
This is a nested data structure:
applied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING catalog_object_id: STRING catalog_version: INTEGER name: STRING percentage: STRING scope: STRING type: STRING
tenders
ARRAY
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING card_details: OBJECT, which is also a nested data structure.
card: OBJECT, which is also a nested data structure.
billing_address: OBJECT, which is also a nested data structure.
address_line_1: STRING address_line_2: STRING address_line_3: STRING administrative_district_level_1: STRING administrative_district_level_2: STRING administrative_district_level_3: STRING country: STRING first_name: STRING last_name: STRING locality: STRING postal_code: STRING sublocality: STRING sublocality_2: STRING sublocality_3: STRING bin: STRING card_brand: STRING card_co_brand: STRING card_type: STRING cardholder_name: STRING customer_id: STRING enabled: BOOLEAN exp_month: INTEGER exp_year: INTEGER fingerprint: STRING id: STRING last_4: STRING merchant_id: STRING prepaid_type: STRING reference_id: STRING version: INTEGER entry_method: STRING status: STRING cash_details: OBJECT, which is also a nested data structure.
buyer_tendered_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING change_back_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING created_at: DATE-TIME customer_id: STRING id: STRING location_id: STRING note: STRING payment_id: STRING processing_fee_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING tip_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING transaction_id: STRING type: STRING
total_discount_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
total_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
total_service_charge_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
total_tax_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
total_tip_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
updated_at
DATE-TIME
version
INTEGER
payments
The payments table contains information about all payments taken in Square.
payments table foreign keys Join payments with on bank_accounts payments.id = bank_accounts.id categories payments.id = categories.absent_at_location_ids discounts payments.id = discounts.absent_at_location_ids team_members payments.id = team_members.assigned_locations.location_ids inventories payments.id = inventories.location_id items payments.id = items.absent_at_location_ids payments.id = items.item_data.variations.item_variation_data.location_overrides.location_id payments.id = items.item_data.variations.present_at_location_ids payments.id = items.present_at_location_ids locations payments.id = locations.id modifier_lists payments.id = modifier_lists.absent_at_location_ids orders payments.id = orders.id payments.id = orders.refunds.id payments.id = orders.tenders.id payments.order_id = orders.id payments.order_id = orders.returns.source_order_id payments.order_id = orders.refunds.id payments.refund_ids = orders.refunds.id refunds payments.id = refunds.id payments.order_id = refunds.order_id payments.id = refunds.payment_id payments.order_id = refunds.id payments.refund_ids = refunds.id shifts payments.id = shifts.id taxes payments.id = taxes.absent_at_location_ids
payments table schema
amount_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
app_fee_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
application_details
OBJECT
This is a nested data structure:
application_id: STRING square_product: STRING
approved_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
bank_account_details
OBJECT
This is a nested data structure:
account_ownership_type: STRING ach_details: OBJECT, which is also a nested data structure.
account_number_suffix: STRING account_type: STRING routing_number: STRIN bank_name: STRING country: STRING errors: ARRAY, which is also a nested data structure.
category: STRING code: STRING detail: STRING field: STRING fingerprint: STRING statement_description: STRING transfer_type: STRING
billing_address
OBJECT
This is a nested data structure:
address_line_1: STRING address_line_2: STRING address_line_3: STRING administrative_district_level_1: STRING administrative_district_level_2: STRING administrative_district_level_3: STRING country: STRING first_name: STRING last_name: STRING locality: STRING postal_code: STRING sublocality: STRING sublocality_2: STRING sublocality_3: STRING
buy_now_pay_later_details
OBJECT
This is a nested data structure:
afterpay_details: OBJECT, which is also a nested data structure.
brand: STRING clearpay_details: OBJECT, which is also a nested data structure.
buyer_email_address
STRING
capabilities
ARRAY
card_details
OBJECT
This is a nested data structure:
application_cryptogram: STRING application_identifier: STRING application_name: STRING auth_result_code: STRING avs_status: STRING card: OBJECT, which is also a nested data structure.
billing_address: OBJECT, which is also a nested data structure. bin: STRING card_brand: STRING card_co_brand: STRING card_type: STRING cardholder_name: STRING customer_id: STRING enabled: BOOLEAN exp_month: INTEGER exp_year: INTEGER fingerprint: STRING id: STRING last_4: STRING merchant_id: STRING prepaid_type: STRING reference_id: STRING version: INTEGER card_payment_timeline: OBJECT, which is also a nested data structure.
authorized_at: DATE-TIME captured_at: DATE-TIME voided_at: DATE-TIME cvv_status: STRING entry_method: STRING errors: ARRAY, which is also a nested data structure.
category: STRING code: STRING detail: STRING field: STRING statement_description: STRING status: STRING verification_method: STRING verification_results: STRING
cash_details
OBJECT
This is a nested data structure:
buyer_supplied_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING change_back_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING
created_at
DATE-TIME
customer_id
STRING
delay_action
STRING
delay_duration
STRING
delayed_until
DATE-TIME
device_details
OBJECT
This is a nested data structure:
device_id: STRING device_installation_id: STRING device_name: STRING
external_details
OBJECT
This is a nested data structure:
source: STRING source_fee_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING source_id: STRING type: STRING
id
STRING
location_id
STRING
note
STRING
order_id
STRING
processing_fee
ARRAY
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING effective_at: DATE-TIME type: STRING
receipt_number
STRING
receipt_url
STRING
reference_id
STRING
refund_ids
ARRAY
refunded_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
risk_evaluation
OBJECT
This is a nested data structure:
created_at: DATE-TIME risk_level: STRING
shipping_address
OBJECT
This is a nested data structure:
address_line_1: STRING address_line_2: STRING address_line_3: STRING administrative_district_level_1: STRING administrative_district_level_2: STRING administrative_district_level_3: STRING country: STRING first_name: STRING last_name: STRING locality: STRING postal_code: STRING sublocality: STRING sublocality_2: STRING sublocality_3: STRING
source_type
STRING
statement_description_identifier
STRING
status
STRING
team_member_id
STRING
tip_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
total_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
updated_at
DATE-TIME
version_token
STRING
wallet_details
OBJECT
This is a nested data structure:
brand: STRING cash_app_details: OBJECT, which is also a nested data structure.
buyer_cashtag: STRING buyer_country_code: STRING buyer_full_name: STRING status: STRING
payouts
The payouts table contains information about all payouts made in Square.
payouts table schema
amount_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
arrival_date
DATE-TIME
created_at
DATE-TIME
destination
OBJECT
This is a nested data structure:
end_to_end_id
STRING
id
STRING
location_id
STRING
payout_fee
ARRAY
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING effective_at: DATE-TIME type: STRING
status
STRING
type
STRING
updated_at
DATE-TIME
version
INTEGER
refunds
The refunds table contains information about refunds on items in Square.
refunds table foreign keys Join refunds with on bank_accounts refunds.id = bank_accounts.id categories refunds.id = categories.absent_at_location_ids discounts refunds.id = discounts.absent_at_location_ids team_members refunds.id = team_members.assigned_locations.location_ids inventories refunds.id = inventories.location_id items refunds.id = items.absent_at_location_ids refunds.id = items.item_data.variations.item_variation_data.location_overrides.location_id refunds.id = items.item_data.variations.present_at_location_ids refunds.id = items.present_at_location_ids locations refunds.id = locations.id modifier_lists refunds.id = modifier_lists.absent_at_location_ids orders refunds.id = orders.id refunds.id = orders.refunds.id refunds.id = orders.tenders.id refunds.order_id = orders.id refunds.order_id = orders.returns.source_order_id refunds.payment_id = orders.tenders.id payments refunds.id = payments.id refunds.order_id = payments.order_id refunds.payment_id = payments.id refunds.id = payments.order_id refunds.id = payments.refund_ids shifts refunds.id = shifts.id taxes refunds.id = taxes.absent_at_location_ids
refunds table schema
amount_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
app_fee_money
OBJECT
This is a nested data structure:
amount: INTEGER currency: STRING
created_at
DATE-TIME
destination_details
OBJECT
This is a nested data structure:
card_details: OBJECT, which is also a nested data structure.
card: OBJECT, which is also a nested data structure.
billing_address: OBJECT, which is also a nested data structure.
address_line_1: STRING address_line_2: STRING address_line_3: STRING administrative_district_level_1: STRING administrative_district_level_2: STRING administrative_district_level_3: STRING country: STRING first_name: STRING last_name: STRING locality: STRING postal_code: STRING sublocality: STRING sublocality_2: STRING sublocality_3: STRING bin: STRING card_brand: STRING card_co_brand: STRING card_type: STRING cardholder_name: STRING customer_id: STRING enabled: BOOLEAN exp_month: INTEGER exp_year: INTEGER fingerprint: STRING id: STRING last_4: STRING merchant_id: STRING prepaid_type: STRING reference_id: STRING version: INTEGER entry_method: STRING
destination_type
STRING
id
STRING
location_id
STRING
order_id
STRING
payment_id
STRING
processing_fee
ARRAY
This is a nested data structure:
amount_money: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING effective_at: DATE-TIME type: STRING
reason
STRING
status
STRING
team_member_id
STRING
unlinked
BOOLEAN
updated_at
DATE-TIME
roles
The roles table contains information about employees’ roles in Square.
Note : This table can’t be replicated if the Connect to a sandbox environment box is checked in the integration’s settings due to limits imposed by Square.
roles table schema
created_at
DATE-TIME
id
STRING
is_owner
BOOLEAN
name
STRING
permissions
ARRAY
updated_at
DATE-TIME
shifts
The shifts table contains information about employee’s shifts in Square.
shifts table foreign keys Join shifts with on team_members shifts.team_member_id = team_members.id shifts.id = team_members.assigned_locations.location_ids bank_accounts shifts.id = bank_accounts.id categories shifts.id = categories.absent_at_location_ids discounts shifts.id = discounts.absent_at_location_ids inventories shifts.id = inventories.location_id items shifts.id = items.absent_at_location_ids shifts.id = items.item_data.variations.item_variation_data.location_overrides.location_id shifts.id = items.item_data.variations.present_at_location_ids shifts.id = items.present_at_location_ids locations shifts.id = locations.id modifier_lists shifts.id = modifier_lists.absent_at_location_ids orders shifts.id = orders.id shifts.id = orders.refunds.id shifts.id = orders.tenders.id payments shifts.id = payments.id refunds shifts.id = refunds.id taxes shifts.id = taxes.absent_at_location_ids
shifts table schema
breaks
ARRAY
This is a nested data structure:
break_type_id: STRING end_at: DATE-TIME expected_duration: STRING id: STRING is_paid: BOOLEAN name: STRING start_at: DATE-TIME
created_at
DATE-TIME
end_at
DATE-TIME
id
STRING
location_id
STRING
start_at
DATE-TIME
status
STRING
team_member_id
STRING
timezone
STRING
updated_at
DATE-TIME
version
INTEGER
wage
OBJECT
This is a nested data structure:
hourly_rate: OBJECT, which is also a nested data structure.
amount: INTEGER currency: STRING job_id: STRING title: STRING
taxes
The taxes table contains information about taxes enabled on your items in Square.
Replication Method
CDC
Primary Key
id
Replication Key
updated_at
Useful links
Square API method
taxes table foreign keys Join taxes with on bank_accounts taxes.absent_at_location_ids = bank_accounts.id categories taxes.absent_at_location_ids = categories.absent_at_location_ids discounts taxes.absent_at_location_ids = discounts.absent_at_location_ids team_members taxes.absent_at_location_ids = team_members.assigned_locations.location_ids inventories taxes.absent_at_location_ids = inventories.location_id items taxes.absent_at_location_ids = items.absent_at_location_ids taxes.absent_at_location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id taxes.absent_at_location_ids = items.item_data.variations.present_at_location_ids taxes.absent_at_location_ids = items.present_at_location_ids taxes.id = items.item_data.tax_ids locations taxes.absent_at_location_ids = locations.id modifier_lists taxes.absent_at_location_ids = modifier_lists.absent_at_location_ids orders taxes.absent_at_location_ids = orders.id taxes.absent_at_location_ids = orders.refunds.id taxes.absent_at_location_ids = orders.tenders.id payments taxes.absent_at_location_ids = payments.id refunds taxes.absent_at_location_ids = refunds.id shifts taxes.absent_at_location_ids = shifts.id
taxes table schema
absent_at_location_ids
ARRAY
id
STRING
is_deleted
BOOLEAN
present_at_all_locations
BOOLEAN
tax_data
OBJECT
This is a nested data structure:
applies_to_custom_amounts: BOOLEAN calculation_phase: STRING enabled: BOOLEAN inclusion_type: STRING name: STRING percentage: STRING tax_type_id: STRING tax_type_name: STRING
type
STRING
updated_at
DATE-TIME
version
INTEGER
team_members
Replication Method
CDC
Replication Key
updated_at
Useful links
Square documentation
Square API method
team_members table foreign keys Join team_members with on shifts team_members.id = shifts.team_member_id team_members.assigned_locations.location_ids = shifts.id bank_accounts team_members.assigned_locations.location_ids = bank_accounts.id categories team_members.assigned_locations.location_ids = categories.absent_at_location_ids discounts team_members.assigned_locations.location_ids = discounts.absent_at_location_ids inventories team_members.assigned_locations.location_ids = inventories.location_id items team_members.assigned_locations.location_ids = items.absent_at_location_ids team_members.assigned_locations.location_ids = items.item_data.variations.item_variation_data.location_overrides.location_id team_members.assigned_locations.location_ids = items.item_data.variations.present_at_location_ids team_members.assigned_locations.location_ids = items.present_at_location_ids locations team_members.assigned_locations.location_ids = locations.id modifier_lists team_members.assigned_locations.location_ids = modifier_lists.absent_at_location_ids orders team_members.assigned_locations.location_ids = orders.id team_members.assigned_locations.location_ids = orders.refunds.id team_members.assigned_locations.location_ids = orders.tenders.id payments team_members.assigned_locations.location_ids = payments.id refunds team_members.assigned_locations.location_ids = refunds.id taxes team_members.assigned_locations.location_ids = taxes.absent_at_location_ids
team_members table schema
assigned_locations
OBJECT
This is a nested data structure:
assignment_type: STRING location_ids: ARRAY
created_at
DATE-TIME
email_address
STRING
family_name
STRING
given_name
STRING
id
STRING
is_owner
BOOLEAN
phone_number
STRING
reference_id
STRING
status
STRING
updated_at
DATE-TIME
