Square Connector Reference

15 metrics199 dimensions

Fields

The Square connector exposes 214 fields (15 metrics, 199 dimensions). Every field ID below can be passed to the Windsor.ai API in the fields parameter.

Square Fields

Square bank_accounts fields

The bank_accounts report of the Square connector includes 13 fields.

ID	Type	Name	Description
bank_accounts__account_number_suffix	TEXT	bank_accounts.account_number_suffix	bank_accounts.account_number_suffix
bank_accounts__account_type	TEXT	bank_accounts.account_type	bank_accounts.account_type
bank_accounts__bank_name	TEXT	bank_accounts.bank_name	bank_accounts.bank_name
bank_accounts__country	TEXT	bank_accounts.country	bank_accounts.country
bank_accounts__creditable	BOOLEAN	bank_accounts.creditable	bank_accounts.creditable
bank_accounts__currency	TEXT	bank_accounts.currency	bank_accounts.currency
bank_accounts__debitable	BOOLEAN	bank_accounts.debitable	bank_accounts.debitable
bank_accounts__holder_name	TEXT	bank_accounts.holder_name	bank_accounts.holder_name
bank_accounts__id	TEXT	bank_accounts.id	bank_accounts.id
bank_accounts__location_id	TEXT	bank_accounts.location_id	bank_accounts.location_id
bank_accounts__primary_bank_identification_number	TEXT	bank_accounts.primary_bank_identification_number	bank_accounts.primary_bank_identification_number
bank_accounts__status	TEXT	bank_accounts.status	bank_accounts.status
bank_accounts__version	NUMERIC	bank_accounts.version	bank_accounts.version

Square cash_drawers fields

The cash_drawers report of the Square connector includes 9 fields.

ID	Type	Name	Description
cash_drawers__closed_at	TIMESTAMP	cash_drawers.closed_at	cash_drawers.closed_at
cash_drawers__closed_cash_money	OBJECT	cash_drawers.closed_cash_money	cash_drawers.closed_cash_money
cash_drawers__description	TEXT	cash_drawers.description	cash_drawers.description
cash_drawers__ended_at	TIMESTAMP	cash_drawers.ended_at	cash_drawers.ended_at
cash_drawers__expected_cash_money	OBJECT	cash_drawers.expected_cash_money	cash_drawers.expected_cash_money
cash_drawers__id	TEXT	cash_drawers.id	cash_drawers.id
cash_drawers__opened_at	TIMESTAMP	cash_drawers.opened_at	cash_drawers.opened_at
cash_drawers__opened_cash_money	OBJECT	cash_drawers.opened_cash_money	cash_drawers.opened_cash_money
cash_drawers__state	TEXT	cash_drawers.state	cash_drawers.state

Square categories fields

The categories report of the Square connector includes 7 fields.

ID	Type	Name	Description
categories__category_data	OBJECT	categories.category_data	categories.category_data
categories__id	TEXT	categories.id	categories.id
categories__is_deleted	BOOLEAN	categories.is_deleted	categories.is_deleted
categories__present_at_all_locations	BOOLEAN	categories.present_at_all_locations	categories.present_at_all_locations
categories__type	TEXT	categories.type	categories.type
categories__updated_at	TIMESTAMP	categories.updated_at	categories.updated_at
categories__version	NUMERIC	categories.version	categories.version

Square customers fields

The customers report of the Square connector includes 17 fields.

ID	Type	Name	Description
customers__address	OBJECT	customers.address	customers.address
customers__birthday	TEXT	customers.birthday	customers.birthday
customers__cards	OBJECT	customers.cards	customers.cards
customers__company_name	TEXT	customers.company_name	customers.company_name
customers__created_at	TIMESTAMP	customers.created_at	customers.created_at
customers__creation_source	TEXT	customers.creation_source	customers.creation_source
customers__email_address	TEXT	customers.email_address	customers.email_address
customers__family_name	TEXT	customers.family_name	customers.family_name
customers__given_name	TEXT	customers.given_name	customers.given_name
customers__group_ids	OBJECT	customers.group_ids	customers.group_ids
customers__id	TEXT	customers.id	customers.id
customers__phone_number	TEXT	customers.phone_number	customers.phone_number
customers__preferences	OBJECT	customers.preferences	customers.preferences
customers__reference_id	TEXT	customers.reference_id	customers.reference_id
customers__segment_ids	OBJECT	customers.segment_ids	customers.segment_ids
customers__updated_at	TIMESTAMP	customers.updated_at	customers.updated_at
customers__version	NUMERIC	customers.version	customers.version

Square discounts fields

The discounts report of the Square connector includes 8 fields.

ID	Type	Name	Description
discounts__discount_data	OBJECT	discounts.discount_data	discounts.discount_data
discounts__id	TEXT	discounts.id	discounts.id
discounts__is_deleted	BOOLEAN	discounts.is_deleted	discounts.is_deleted
discounts__present_at_all_locations	BOOLEAN	discounts.present_at_all_locations	discounts.present_at_all_locations
discounts__present_at_location_ids	OBJECT	discounts.present_at_location_ids	discounts.present_at_location_ids
discounts__type	TEXT	discounts.type	discounts.type
discounts__updated_at	TIMESTAMP	discounts.updated_at	discounts.updated_at
discounts__version	NUMERIC	discounts.version	discounts.version

Square inventory fields

The inventory report of the Square connector includes 6 fields.

ID	Type	Name	Description
inventory__calculated_at	TIMESTAMP	inventory.calculated_at	inventory.calculated_at
inventory__catalog_object_id	TEXT	inventory.catalog_object_id	inventory.catalog_object_id
inventory__catalog_object_type	TEXT	inventory.catalog_object_type	inventory.catalog_object_type
inventory__location_id	TEXT	inventory.location_id	inventory.location_id
inventory__quantity	TEXT	inventory.quantity	inventory.quantity
inventory__state	TEXT	inventory.state	inventory.state

Square items fields

The items report of the Square connector includes 10 fields.

ID	Type	Name	Description
items__custom_attribute_values	OBJECT	items.custom_attribute_values	items.custom_attribute_values
items__id	TEXT	items.id	items.id
items__image_id	TEXT	items.image_id	items.image_id
items__is_deleted	BOOLEAN	items.is_deleted	items.is_deleted
items__item_data	OBJECT	items.item_data	items.item_data
items__present_at_all_locations	BOOLEAN	items.present_at_all_locations	items.present_at_all_locations
items__present_at_location_ids	OBJECT	items.present_at_location_ids	items.present_at_location_ids
items__type	TEXT	items.type	items.type
items__updated_at	TIMESTAMP	items.updated_at	items.updated_at
items__version	NUMERIC	items.version	items.version

Square locations fields

The locations report of the Square connector includes 22 fields.

ID	Type	Name	Description
locations__address	OBJECT	locations.address	locations.address
locations__business_email	TEXT	locations.business_email	locations.business_email
locations__business_hours	OBJECT	locations.business_hours	locations.business_hours
locations__business_name	TEXT	locations.business_name	locations.business_name
locations__capabilities	OBJECT	locations.capabilities	locations.capabilities
locations__country	TEXT	locations.country	locations.country
locations__created_at	TIMESTAMP	locations.created_at	locations.created_at
locations__currency	TEXT	locations.currency	locations.currency
locations__description	TEXT	locations.description	locations.description
locations__facebook_url	TEXT	locations.facebook_url	locations.facebook_url
locations__id	TEXT	locations.id	locations.id
locations__instagram_username	TEXT	locations.instagram_username	locations.instagram_username
locations__language_code	TEXT	locations.language_code	locations.language_code
locations__mcc	TEXT	locations.mcc	locations.mcc
locations__merchant_id	TEXT	locations.merchant_id	locations.merchant_id
locations__name	TEXT	locations.name	locations.name
locations__phone_number	TEXT	locations.phone_number	locations.phone_number
locations__status	TEXT	locations.status	locations.status
locations__timezone	TEXT	locations.timezone	locations.timezone
locations__twitter_username	TEXT	locations.twitter_username	locations.twitter_username
locations__type	TEXT	locations.type	locations.type
locations__website_url	TEXT	locations.website_url	locations.website_url

Square loyalty fields

The loyalty report of the Square connector includes 8 fields.

ID	Type	Name	Description
loyalty__balance	NUMERIC	loyalty.balance	loyalty.balance
loyalty__created_at	TIMESTAMP	loyalty.created_at	loyalty.created_at
loyalty__customer_id	TEXT	loyalty.customer_id	loyalty.customer_id
loyalty__id	TEXT	loyalty.id	loyalty.id
loyalty__lifetime_points	NUMERIC	loyalty.lifetime_points	loyalty.lifetime_points
loyalty__mapping	OBJECT	loyalty.mapping	loyalty.mapping
loyalty__program_id	TEXT	loyalty.program_id	loyalty.program_id
loyalty__updated_at	TIMESTAMP	loyalty.updated_at	loyalty.updated_at

Square modifier_list fields

The modifier_list report of the Square connector includes 7 fields.

ID	Type	Name	Description
modifier_list__id	TEXT	modifier_list.id	modifier_list.id
modifier_list__is_deleted	BOOLEAN	modifier_list.is_deleted	modifier_list.is_deleted
modifier_list__modifier_list_data	OBJECT	modifier_list.modifier_list_data	modifier_list.modifier_list_data
modifier_list__present_at_all_locations	BOOLEAN	modifier_list.present_at_all_locations	modifier_list.present_at_all_locations
modifier_list__type	TEXT	modifier_list.type	modifier_list.type
modifier_list__updated_at	TIMESTAMP	modifier_list.updated_at	modifier_list.updated_at
modifier_list__version	NUMERIC	modifier_list.version	modifier_list.version

Square orders fields

The orders report of the Square connector includes 26 fields.

ID	Type	Name	Description
orders__closed_at	TIMESTAMP	orders.closed_at	orders.closed_at
orders__created_at	TIMESTAMP	orders.created_at	orders.created_at
orders__customer_id	TEXT	orders.customer_id	orders.customer_id
orders__discounts	OBJECT	orders.discounts	orders.discounts
orders__fulfillments	OBJECT	orders.fulfillments	orders.fulfillments
orders__id	TEXT	orders.id	orders.id
orders__line_items	OBJECT	orders.line_items	orders.line_items
orders__location_id	TEXT	orders.location_id	orders.location_id
orders__net_amounts	OBJECT	orders.net_amounts	orders.net_amounts
orders__net_amounts__total_money__amount	NUMERIC	orders.net_amounts.total_money.amount	orders.net_amounts.total_money.amount
orders__net_amounts__total_money__currency	TEXT	orders.net_amounts.total_money.currency	orders.net_amounts.total_money.currency
orders__refunds	OBJECT	orders.refunds	orders.refunds
orders__return_amounts	OBJECT	orders.return_amounts	orders.return_amounts
orders__returns	OBJECT	orders.returns	orders.returns
orders__service_charges	OBJECT	orders.service_charges	orders.service_charges
orders__source	OBJECT	orders.source	orders.source
orders__state	TEXT	orders.state	orders.state
orders__taxes	OBJECT	orders.taxes	orders.taxes
orders__tenders	OBJECT	orders.tenders	orders.tenders
orders__total_discount_money	OBJECT	orders.total_discount_money	orders.total_discount_money
orders__total_money	OBJECT	orders.total_money	orders.total_money
orders__total_service_charge_money	OBJECT	orders.total_service_charge_money	orders.total_service_charge_money
orders__total_tax_money	OBJECT	orders.total_tax_money	orders.total_tax_money
orders__total_tip_money	OBJECT	orders.total_tip_money	orders.total_tip_money
orders__updated_at	TIMESTAMP	orders.updated_at	orders.updated_at
orders__version	NUMERIC	orders.version	orders.version

Square payments fields

The payments report of the Square connector includes 30 fields.

ID	Type	Name	Description
payments__amount_money	OBJECT	payments.amount_money	payments.amount_money
payments__amount_money__amount	NUMERIC	payments.amount_money.amount	payments.amount_money.amount
payments__amount_money__currency	TEXT	payments.amount_money.currency	payments.amount_money.currency
payments__approved_money	OBJECT	payments.approved_money	payments.approved_money
payments__approved_money__amount	NUMERIC	payments.approved_money.amount	payments.approved_money.amount
payments__approved_money__currency	TEXT	payments.approved_money.currency	payments.approved_money.currency
payments__card_details	OBJECT	payments.card_details	payments.card_details
payments__created_at	TIMESTAMP	payments.created_at	payments.created_at
payments__customer_id	TEXT	payments.customer_id	payments.customer_id
payments__delay_action	TEXT	payments.delay_action	payments.delay_action
payments__delay_duration	TEXT	payments.delay_duration	payments.delay_duration
payments__delayed_until	TEXT	payments.delayed_until	payments.delayed_until
payments__employee_id	TEXT	payments.employee_id	payments.employee_id
payments__id	TEXT	payments.id	payments.id
payments__location_id	TEXT	payments.location_id	payments.location_id
payments__note	TEXT	payments.note	payments.note
payments__order_id	TEXT	payments.order_id	payments.order_id
payments__processing_fee	OBJECT	payments.processing_fee	payments.processing_fee
payments__receipt_number	TEXT	payments.receipt_number	payments.receipt_number
payments__receipt_url	TEXT	payments.receipt_url	payments.receipt_url
payments__refund_ids	OBJECT	payments.refund_ids	payments.refund_ids
payments__refunded_money	OBJECT	payments.refunded_money	payments.refunded_money
payments__risk_evaluation	OBJECT	payments.risk_evaluation	payments.risk_evaluation
payments__source_type	TEXT	payments.source_type	payments.source_type
payments__status	TEXT	payments.status	payments.status
payments__total_money	OBJECT	payments.total_money	payments.total_money
payments__total_money__amount	NUMERIC	payments.total_money.amount	payments.total_money.amount
payments__total_money__currency	TEXT	payments.total_money.currency	payments.total_money.currency
payments__updated_at	TIMESTAMP	payments.updated_at	payments.updated_at
payments__version_token	TEXT	payments.version_token	payments.version_token

Square refunds fields

The refunds report of the Square connector includes 10 fields.

ID	Type	Name	Description
refunds__amount_money	OBJECT	refunds.amount_money	refunds.amount_money
refunds__created_at	TIMESTAMP	refunds.created_at	refunds.created_at
refunds__id	TEXT	refunds.id	refunds.id
refunds__location_id	TEXT	refunds.location_id	refunds.location_id
refunds__order_id	TEXT	refunds.order_id	refunds.order_id
refunds__payment_id	TEXT	refunds.payment_id	refunds.payment_id
refunds__processing_fee	OBJECT	refunds.processing_fee	refunds.processing_fee
refunds__reason	TEXT	refunds.reason	refunds.reason
refunds__status	TEXT	refunds.status	refunds.status
refunds__updated_at	TIMESTAMP	refunds.updated_at	refunds.updated_at

Square shifts fields

The shifts report of the Square connector includes 13 fields.

ID	Type	Name	Description
shifts__breaks	OBJECT	shifts.breaks	shifts.breaks
shifts__created_at	TIMESTAMP	shifts.created_at	shifts.created_at
shifts__employee_id	TEXT	shifts.employee_id	shifts.employee_id
shifts__end_at	TIMESTAMP	shifts.end_at	shifts.end_at
shifts__id	TEXT	shifts.id	shifts.id
shifts__location_id	TEXT	shifts.location_id	shifts.location_id
shifts__start_at	TIMESTAMP	shifts.start_at	shifts.start_at
shifts__status	TEXT	shifts.status	shifts.status
shifts__team_member_id	TEXT	shifts.team_member_id	shifts.team_member_id
shifts__timezone	TEXT	shifts.timezone	shifts.timezone
shifts__updated_at	TIMESTAMP	shifts.updated_at	shifts.updated_at
shifts__version	NUMERIC	shifts.version	shifts.version
shifts__wage	OBJECT	shifts.wage	shifts.wage

Square taxes fields

The taxes report of the Square connector includes 8 fields.

ID	Type	Name	Description
taxes__absent_at_location_ids	OBJECT	taxes.absent_at_location_ids	taxes.absent_at_location_ids
taxes__id	TEXT	taxes.id	taxes.id
taxes__is_deleted	BOOLEAN	taxes.is_deleted	taxes.is_deleted
taxes__present_at_all_locations	BOOLEAN	taxes.present_at_all_locations	taxes.present_at_all_locations
taxes__tax_data	OBJECT	taxes.tax_data	taxes.tax_data
taxes__type	TEXT	taxes.type	taxes.type
taxes__updated_at	TIMESTAMP	taxes.updated_at	taxes.updated_at
taxes__version	NUMERIC	taxes.version	taxes.version

Square team_member_wages fields

The team_member_wages report of the Square connector includes 4 fields.

ID	Type	Name	Description
team_member_wages__hourly_rate	OBJECT	team_member_wages.hourly_rate	team_member_wages.hourly_rate
team_member_wages__id	TEXT	team_member_wages.id	team_member_wages.id
team_member_wages__team_member_id	TEXT	team_member_wages.team_member_id	team_member_wages.team_member_id
team_member_wages__title	TEXT	team_member_wages.title	team_member_wages.title

Square team_members fields

The team_members report of the Square connector includes 11 fields.

ID	Type	Name	Description
team_members__assigned_locations	OBJECT	team_members.assigned_locations	team_members.assigned_locations
team_members__created_at	TIMESTAMP	team_members.created_at	team_members.created_at
team_members__email_address	TEXT	team_members.email_address	team_members.email_address
team_members__family_name	TEXT	team_members.family_name	team_members.family_name
team_members__given_name	TEXT	team_members.given_name	team_members.given_name
team_members__id	TEXT	team_members.id	team_members.id
team_members__is_owner	BOOLEAN	team_members.is_owner	team_members.is_owner
team_members__phone_number	TEXT	team_members.phone_number	team_members.phone_number
team_members__reference_id	TEXT	team_members.reference_id	team_members.reference_id
team_members__status	TEXT	team_members.status	team_members.status
team_members__updated_at	TIMESTAMP	team_members.updated_at	team_members.updated_at

Square other fields

The Square connector has 5 fields that do not belong to a named report, or belong to a report with only one or two fields.

ID	Type	Name	Description
data_fetched_at	TIMESTAMP	Data fetched at	UTC timestamp (second precision) of when the connector request that pulled the row started. Freshly pulled rows show this request's start time; cache hits keep the start time of the request that filled the cache. Selecting this field disables aggregation, so rows are returned individually (each keeping its own fetch time) instead of being summed.
datasource	TEXT	Data Source	The name of the Windsor connector returning the row
now	TIMESTAMP	Now	Current timestamp
source	TEXT	Source	The name of the Windsor connector returning the row
today	DATE	Today	Today's date

API Connectors