Referência do conector Square

info

Beta

Este recurso está em Beta. Os administradores do espaço de trabalho podem controlar o acesso a esse recurso na página Pré-visualizações . Consulte Gerenciar prévias do Databricks.

Esta página tem informação de referência para o conector Square gerenciado, incluindo tabelas de origem e esquemas de tabelas de destino compatíveis.

Tabelas de origem suportadas

O conector Square oferece suporte às seguintes tabelas de origem, todas no esquema de origem default:

Tabela de origem	Chave primária	Descrição	Modo de sincronização	Campo do cursor
`locations`	`id`	Localizações comerciais configuradas na sua conta Square, incluindo moeda, fuso horário e recursos.	refresh completo apenas
`customers`	`id`	Perfis de clientes em sua account Square, incluindo detalhes de contato e fonte de criação.	refresh completo apenas
`team_member_wages`	`id`	Configurações de salário para membros da equipe, incluindo cargo e elegibilidade para gorjetas.	refresh completo apenas
`bank_accounts`	`id`	Contas bancárias vinculadas à sua Square account, incluindo status e tipo de account.	refresh completo apenas
`shifts`	`id`	Turnos de trabalho realizados pelos membros da equipe, incluindo horários de início e término e salários.	refresh completo apenas
`team_members`	`id`	Membros da equipe na sua conta do Square, incluindo status, locais atribuídos e configurações salariais.	refresh completo apenas
`inventory`	`catalog_object_id`	Contagens de inventário para objetos de catálogo em cada local.	refresh completo apenas
`loyalty`	`id`	Contas de programa de fidelidade, incluindo saldos de pontos e datas de inscrição.	refresh completo apenas
`payments`	`id`	Pagamentos feitos pelo Square, incluindo valores, status e pedidos associados.	Incremental	`created_at`
`refunds`	`id`	Reembolsos processados via Square, incluindo valores, status e pagamentos associados.	Incremental	`created_at`
`items`	`id`	Itens de catálogo na sua account Square, incluindo detalhes do item e controle de versão.	Incremental	`updated_at`
`categories`	`id`	Categorias de catálogo usadas para organizar itens.	Incremental	`updated_at`
`discounts`	`id`	Descontos de catálogo disponíveis na sua account Square.	Incremental	`updated_at`
`taxes`	`id`	Impostos de catálogo configurados em sua account Square.	Incremental	`updated_at`
`modifier_lists`	`id`	Listas de modificadores de catálogo aplicadas aos itens.	Incremental	`updated_at`
`cash_drawers`	`id`	Turnos de caixa para cada local, incluindo os valores de abertura e fechamento de caixa.	refresh completo apenas
`orders`	`id`	Pedidos feitos em seus locais Square, incluindo itens de linha, totais e atendimentos.	Incremental	`updated_at`

Tabela de origem	Chave primária	Descrição	Modo de sincronização	Campo do cursor
`locations`	`id`	Localizações comerciais configuradas na sua conta Square, incluindo moeda, fuso horário e recursos.	refresh completo apenas
`customers`	`id`	Perfis de clientes em sua account Square, incluindo detalhes de contato e fonte de criação.	refresh completo apenas
`team_member_wages`	`id`	Configurações de salário para membros da equipe, incluindo cargo e elegibilidade para gorjetas.	refresh completo apenas
`bank_accounts`	`id`	Contas bancárias vinculadas à sua Square account, incluindo status e tipo de account.	refresh completo apenas
`shifts`	`id`	Turnos de trabalho realizados pelos membros da equipe, incluindo horários de início e término e salários.	refresh completo apenas
`team_members`	`id`	Membros da equipe na sua conta do Square, incluindo status, locais atribuídos e configurações salariais.	refresh completo apenas
`inventory`	`catalog_object_id`	Contagens de inventário para objetos de catálogo em cada local.	refresh completo apenas
`loyalty`	`id`	Contas de programa de fidelidade, incluindo saldos de pontos e datas de inscrição.	refresh completo apenas
`payments`	`id`	Pagamentos feitos pelo Square, incluindo valores, status e pedidos associados.	Incremental	`created_at`
`refunds`	`id`	Reembolsos processados via Square, incluindo valores, status e pagamentos associados.	Incremental	`created_at`
`items`	`id`	Itens de catálogo na sua account Square, incluindo detalhes do item e controle de versão.	Incremental	`updated_at`
`categories`	`id`	Categorias de catálogo usadas para organizar itens.	Incremental	`updated_at`
`discounts`	`id`	Descontos de catálogo disponíveis na sua account Square.	Incremental	`updated_at`
`taxes`	`id`	Impostos de catálogo configurados em sua account Square.	Incremental	`updated_at`
`modifier_lists`	`id`	Listas de modificadores de catálogo aplicadas aos itens.	Incremental	`updated_at`
`cash_drawers`	`id`	Turnos de caixa para cada local, incluindo os valores de abertura e fechamento de caixa.	refresh completo apenas
`orders`	`id`	Pedidos feitos em seus locais Square, incluindo itens de linha, totais e atendimentos.	Incremental	`updated_at`

Opções de conector

Veja Exemplos para uso.

Opção	Tipo	Escopo	Obrigatório	Aplica-se a	Descrição
`start_datetime`	String (`yyyy-MM-ddTHH:mm:ss.SSSSSSZ`)	Pipeline	Não	Todas as tabelas incrementais (`payments`, `refunds`, `items`, `categories`, `discounts`, `taxes`, `modifier_lists`, `orders`)	Data e hora mais antigas a partir das quais ingerir dados. default 365 dias antes da primeira sincronização. Aplica-se apenas à primeira sincronização de cada tabela; sincronizações posteriores são retomadas a partir do cursor armazenado.

Opção	Tipo	Escopo	Obrigatório	Aplica-se a	Descrição
`start_datetime`	String (`yyyy-MM-ddTHH:mm:ss.SSSSSSZ`)	Pipeline	Não	Todas as tabelas incrementais (`payments`, `refunds`, `items`, `categories`, `discounts`, `taxes`, `modifier_lists`, `orders`)	Data e hora mais antigas a partir das quais ingerir dados. default 365 dias antes da primeira sincronização. Aplica-se apenas à primeira sincronização de cada tabela; sincronizações posteriores são retomadas a partir do cursor armazenado.

Esquemas de tabela de destino

`locations`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`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`

campo	Tipo de dados
`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`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`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`

campo	Tipo de dados
`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`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`id`	`STRING`
`team_member_id`	`STRING`
`title`	`STRING`
`job_id`	`STRING`
`tip_eligible`	`BOOLEAN`

`bank_accounts`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`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`

campo	Tipo de dados
`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`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`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`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`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`

campo	Tipo de dados
`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`

catalog_object_id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`catalog_object_id`	`STRING`
`catalog_object_type`	`STRING`
`state`	`STRING`
`location_id`	`STRING`
`quantity`	`STRING`
`calculated_at`	`STRING`

`loyalty`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`id`	`STRING`
`program_id`	`STRING`
`balance`	`BIGINT`
`lifetime_points`	`BIGINT`
`customer_id`	`STRING`
`enrolled_at`	`STRING`
`created_at`	`STRING`
`updated_at`	`STRING`

`payments`

key primária: id Campo do cursor: created_at

campo	Tipo de dados
`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`

key primária: id Campo do cursor: created_at

campo	Tipo de dados
`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`

key primária: id Campo do cursor: updated_at

campo	Tipo de dados
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`item_data`	`STRING`

`categories`

key primária: id Campo do cursor: updated_at

campo	Tipo de dados
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`category_data`	`STRING`

`discounts`

key primária: id Campo do cursor: updated_at

campo	Tipo de dados
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`discount_data`	`STRING`

`taxes`

key primária: id Campo do cursor: updated_at

campo	Tipo de dados
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`tax_data`	`STRING`

`modifier_lists`

key primária: id Campo do cursor: updated_at

campo	Tipo de dados
`id`	`STRING`
`type`	`STRING`
`updated_at`	`STRING`
`version`	`BIGINT`
`is_deleted`	`BOOLEAN`
`present_at_all_locations`	`BOOLEAN`
`modifier_list_data`	`STRING`

`cash_drawers`

id **Chave primária:** **Modo de sincronização:** Somente refresh completo

campo	Tipo de dados
`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`

campo	Tipo de dados
`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`

key primária: id Campo do cursor: updated_at

campo	Tipo de dados
`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`

campo	Tipo de dados
`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`

Permissões OAuth necessárias

O access token do Square deve ter as seguintes permissões OAuth. O conjunto de permissões que o conector requer depende das tabelas que você ingere. Para obter mais informações, consulte a referência de permissões OAuth do Square.

Permissão	Obrigatório para
`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`

Permissão	Obrigatório para
`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`

Tabelas de origem suportadas​

Opções de conector​

Esquemas de tabela de destino​

locations​

customers​

team_member_wages​

bank_accounts​

shifts​

team_members​

inventory​

loyalty​

payments​

refunds​

items​

categories​

discounts​

taxes​

modifier_lists​

cash_drawers​

orders​

Permissões OAuth necessárias​

Tabelas de origem suportadas

Opções de conector

Esquemas de tabela de destino

`locations`

`customers`

`team_member_wages`

`bank_accounts`

`shifts`

`team_members`

`inventory`

`loyalty`

`payments`

`refunds`

`items`

`categories`

`discounts`

`taxes`

`modifier_lists`

`cash_drawers`

`orders`

Permissões OAuth necessárias