Square
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.Tarefas de replicação: Aplicar alterações Armazenar alterações Aterrisando dados em tarefas de data lake: Captura de dados de alterações (CDC) Obrigatório. É assim que o destino é mantido atualizado com as alterações na fonte. Para tarefas de replicação, consulte Programando tarefas Para tarefas de aterrisagem no lake, consulte Agendando uma CDC para tarefas de aterrisagem no lake Parcialmente compatível Somente CDC, pois o carregamento total não é relevante para esse conector.Recurso/Capacidade Detalhes do suporte Projetos do Qlik Talend Data Integration compatíveis Apenas Projetos de replicação. Não há suporte para projetos de pipeline de dados. A geração manual de metadados não é necessária. Somente a operação Alterar tipo de dados da coluna é compatível. Replicação de colunas LOB (NCLOB, CLOB e BLOB) Sem suporte. CDC agendado Notificações Monitoramento Desencaixe automático de cargas úteis de colunas JSON Sem suporte. As cargas úteis da coluna JSON nos conjuntos de dados de origem não são anuladas automaticamente no destino.
Preparing for authentication
To access your data, you need to authenticate the connection with your account credentials.
To obtain your Application ID and Access Token:
- Log into your Square account.
- Click Account at the top right of the page.
- Click Dashboard.
- Navigate to Settings from the left navigation bar and click App Integrations.
- Click Manage at the right of the selected application.
Creating the connection
For more information, see Conectando-se a aplicativos SAP.
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.
Nota de dicaYou 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.
| Setting | Description |
|---|---|
| Data gateway | Selecione um Gateway Data Movement se for necessário para seu caso de uso. Nota informativa Esse campo não está disponível com a assinatura do Iniciante do Qlik Talend Cloud, pois esta não é compatível com o Gateway Data Movement. Se você tiver outro nível de assinatura e não quiser usar o Gateway Data Movement, selecione Nenhum. Para obter informações sobre os benefícios do Gateway Data Movement e casos de uso que exigem isso, consulte Qlik Data Gateway - Movimentação de dados. |
| Start Date | Digite a data, no formato |
| Application ID | Application ID. |
| Access Token | Access Token. |
Schema
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.
Replication Method | Full Table |
Primary Key | id |
| Useful links |
| 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 |
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.
Replication Method | Full Table |
| Useful links |
closed_at DATE-TIME |
closed_cash_money OBJECT This is a nested data structure:
|
created_at DATE-TIME |
description STRING |
ended_at DATE-TIME |
expected_cash_money OBJECT This is a nested data structure:
|
id STRING |
location_id STRING |
opened_at DATE-TIME |
opened_cash_money OBJECT This is a nested data structure:
|
state STRING |
updated_at DATE-TIME |
categories
The categories table contains information about item categories for a given location in Square.
Replication Method | CDC |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| 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 |
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.
Replication Method | CDC |
Replication Key | updated_at |
| Useful links |
address OBJECT This is a nested data structure:
|
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:
|
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 |
| 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 |
absent_at_location_ids ARRAY |
discount_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 |
inventories
The inventories table contains info about the current calculated stock count for a Square location.
Replication Method | Full Table |
Loading Behavior | Append-Only |
| Useful links |
| 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 |
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.
Replication Method | CDC |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| 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 |
absent_at_location_ids ARRAY |
id STRING |
is_deleted BOOLEAN |
item_data OBJECT This is a nested data structure:
|
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.
Replication Method | Full Table |
| Useful links |
| 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 |
address OBJECT This is a nested data structure:
|
business_email STRING |
business_hours OBJECT This is a nested data structure:
|
business_name STRING |
capabilities ARRAY |
coordinates OBJECT This is a nested data structure:
|
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.
Replication Method | CDC |
Primary Key | id |
Replication Key | updated_at |
| Useful links |
| 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 |
absent_at_location_ids ARRAY |
id STRING |
is_deleted BOOLEAN |
modifier_list_data OBJECT This is a nested data structure:
|
present_at_all_locations BOOLEAN |
type STRING |
updated_at DATE-TIME |
version INTEGER |
orders
The orders table contains information about order updates in Square.
Replication Method | CDC |
Replication Key | updated_at |
| Useful links |
| 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 |
closed_at DATE-TIME |
created_at DATE-TIME |
discounts ARRAY This is a nested data structure:
|
fulfillments ARRAY This is a nested data structure:
|
id STRING |
line_items ARRAY This is a nested data structure:
|
location_id STRING |
net_amount_due_money OBJECT This is a nested data structure:
|
net_amounts OBJECT This is a nested data structure:
|
pricing_options OBJECT This is a nested data structure:
|
reference_id STRING |
refunds ARRAY This is a nested data structure:
|
return_amounts OBJECT This is a nested data structure:
|
returns ARRAY This is a nested data structure:
|
service_charges ARRAY This is a nested data structure:
|
source OBJECT This is a nested data structure:
|
state STRING |
taxes ARRAY This is a nested data structure:
|
tenders ARRAY This is a nested data structure:
|
total_discount_money OBJECT This is a nested data structure:
|
total_money OBJECT This is a nested data structure:
|
total_service_charge_money OBJECT This is a nested data structure:
|
total_tax_money OBJECT This is a nested data structure:
|
total_tip_money OBJECT This is a nested data structure:
|
updated_at DATE-TIME |
version INTEGER |
payments
The payments table contains information about all payments taken in Square.
Replication Method | Full Table |
| Useful links |
| 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 |
amount_money OBJECT This is a nested data structure:
|
app_fee_money OBJECT This is a nested data structure:
|
application_details OBJECT This is a nested data structure:
|
approved_money OBJECT This is a nested data structure:
|
bank_account_details OBJECT This is a nested data structure:
|
billing_address OBJECT This is a nested data structure:
|
buy_now_pay_later_details OBJECT This is a nested data structure:
|
buyer_email_address STRING |
capabilities ARRAY |
card_details OBJECT This is a nested data structure:
|
cash_details OBJECT This is a nested data structure:
|
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:
|
external_details OBJECT This is a nested data structure:
|
id STRING |
location_id STRING |
note STRING |
order_id STRING |
processing_fee ARRAY This is a nested data structure:
|
receipt_number STRING |
receipt_url STRING |
reference_id STRING |
refund_ids ARRAY |
refunded_money OBJECT This is a nested data structure:
|
risk_evaluation OBJECT This is a nested data structure:
|
shipping_address OBJECT This is a nested data structure:
|
source_type STRING |
statement_description_identifier STRING |
status STRING |
team_member_id STRING |
tip_money OBJECT This is a nested data structure:
|
total_money OBJECT This is a nested data structure:
|
updated_at DATE-TIME |
version_token STRING |
wallet_details OBJECT This is a nested data structure:
|
payouts
The payouts table contains information about all payouts made in Square.
Replication Method | Full Table |
| Useful links |
amount_money OBJECT This is a nested data structure:
|
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:
|
status STRING |
type STRING |
updated_at DATE-TIME |
version INTEGER |
refunds
The refunds table contains information about refunds on items in Square.
Replication Method | Full Table |
| Useful links |
| 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 |
amount_money OBJECT This is a nested data structure:
|
app_fee_money OBJECT This is a nested data structure:
|
created_at DATE-TIME |
destination_details OBJECT This is a nested data structure:
|
destination_type STRING |
id STRING |
location_id STRING |
order_id STRING |
payment_id STRING |
processing_fee ARRAY This is a nested data structure:
|
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.
Replication Method | Full Table |
Primary Key | id |
| Useful links |
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.
Replication Method | CDC |
Replication Key | updated_at |
| Useful links |
| 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 |
breaks ARRAY This is a nested data structure:
|
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:
|
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 |
| 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 |
absent_at_location_ids ARRAY |
id STRING |
is_deleted BOOLEAN |
present_at_all_locations BOOLEAN |
tax_data OBJECT This is a nested data structure:
|
type STRING |
updated_at DATE-TIME |
version INTEGER |
team_members
Replication Method | CDC |
Replication Key | updated_at |
| Useful links | Square documentation |
| 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 |
assigned_locations OBJECT This is a nested data structure:
|
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 |