Tables

The driver models the data in Square as a list of tables in a relational database that can be queried using standard SQL statements.

CData JDBC Driver for Square Tables


Name	Description
BankAccounts	Create and query the bank accounts of the merchant.
BookingCustomAttributeDefinitions	Create, update, delete, and query custom attribute definitions for Square Bookings.
BookingCustomAttributes	Create, retrieve, delete, and query custom attributes for Square Bookings. Requires filtering by BookingId.
Bookings	Lists all bookings.
BreakTypes	Create, update, delete, and query the available break types in Square. Note: Square enforces a maximum of 3 break types per location.
Cards	Creates, updates, deletes, and retrieves customer‑linked or merchant‑linked cards in Square. Includes cardholder details, billing address, expiration dates, brand information, and card usage status.
CatalogCategories	Query the available catalog categories.
CatalogCustomAttributeDefinitions	Create, update, and query catalog custom attribute definition objects in Square. These define custom metadata fields that can be attached to other catalog objects.
CatalogDiscounts	Query the available catalog discounts.
CatalogImages	Query the available catalog images.
CatalogItemOptions	Create, update, and query catalog item option objects in Square. Item options define selector attributes (e.g., color, size) that apply across multiple item variations.
CatalogItemOptionValues	Create, update, and query catalog item option value objects in Square. These are the individual values (e.g., Red, Large) within an item option.
CatalogItems	Retrieves detailed information about each item in a Square seller's catalog, including names, descriptions, pricing variations, availability, and location settings.
CatalogItemVariations	Query the available item variations.
CatalogMeasurementUnits	Create, update, and query catalog measurement unit objects in Square. Measurement units define how item quantities are measured and displayed.
CatalogModifierLists	Query the available catalog modifier lists.
CatalogModifiers	Retrieves detailed information about modifiers associated with Square catalog items, including pricing, availability, and location-specific settings. Modifiers represent add‑ons, options, or customizations that can be applied to an item during checkout.
CatalogPricingRules	Create, update, and query catalog pricing rule objects in Square. Pricing rules apply automatic discounts to qualifying orders.
CatalogProductSets	Create, update, and query catalog product set objects in Square. Product sets define groups of products used by pricing rules.
CatalogQuickAmountsSettings	Create, update, and query catalog quick amounts settings objects in Square. Quick amounts settings define preset tip or transaction amounts shown in Square Point of Sale.
CatalogSubscriptionPlans	Create, update, and query catalog subscription plan objects in Square. Subscription plans define recurring billing configurations.
CatalogSubscriptionPlanVariations	Create, update, and query catalog subscription plan variation objects in Square. Plan variations define different billing tiers or periods within a subscription plan.
CatalogTaxes	Create, update, and query catalog tax objects in Square. Taxes define percentage-based charges applied to items or orders.
CatalogTimePeriods	Create, update, and query catalog time period objects in Square. Time periods define when pricing rules are active using iCalendar VEVENT strings.
CheckoutLocationSettings	Retrieve and update the location-level settings for Square online checkout. Note: A maximum of 2 policy entries is supported in the Policies field.
CustomerGroups	Retrieves, creates, updates, deletes customer groups of a business.
Customers	Create, update, delete, and query the available customers in Square.
DeviceCodes	Creates and lists DeviceCode that can be used to login to a Square Terminal device to enter the connected terminal mode.
DisputeEvidence	Create, retrieve, list, and delete evidence for a Square dispute. Requires filtering by DisputeId.
GiftCardActivities	Creates and lists gift card activities.
GiftCards	Retrieves and creates gift card records in Square, including card type, balance, state, account details, and associated customers.
InventoryChanges	Query historical physical counts and adjustments on inventory items.
Invoices	Create, configure, and publish invoices for orders that were created.
Locations	Query Location information for a Merchant.
LoyaltyAccounts	Create and query Square Loyalty accounts.
LoyaltyPromotions	Create and query promotions for a Square Loyalty program. Requires filtering by ProgramId.
LoyaltyRewards	Create, delete, and query Square Loyalty rewards.
PaymentLinks	Lists, Creates, Updates, Deletes payment links.
Payments	Retrieves card payments processed through Square. Does not include cash or other non‑card tenders.
Refunds	Creates and retrieves details for refunds issued by a merchant or their staff within a specified date range. Includes refund amounts, payment references, processing fees, destination details, and status tracking.
Snippets	Retrieve, upsert, and delete the HTML snippet for a Square site. Keyed by SiteId from the Sites table. Requires filtering by SiteId.
Subscriptions	Creates and manages customer subscriptions in Square, including plan details, billing settings, payment methods, and subscription lifecycle status.
Teams	Lists available team members, including contact details, status, and location assignments.
TerminalActions	Create and query Square Terminal action requests.
TerminalCheckouts	Create and query Square Terminal checkout requests.
TerminalRefunds	Create and query Square Terminal refund requests.
Timecards	Create, update, delete, and query the available timecards in Square. This table uses the new /v2/labor/timecards endpoint; the legacy Shifts table remains available. Note: Square replaces the entire timecard on an update, so every UPDATE must set StartAt, TeamMemberId, WageTitle, WageHourlyRateAmount, and WageHourlyRateCurrency. LocationId is also required; if it is not set, it is read from the timecard being updated.
Vendors	Returns the available vendors, including contact details, address information, and account data.
WageSettings	(Beta) Retrieve and update the wage setting for a Square team member. Requires filtering by TeamMemberId.
WebhookSubscriptions	Create, update, delete, and query Square Webhook Subscriptions. NOTE: This endpoint requires a Personal Access Token for authentication. OAuth access tokens are not supported by Square for this API.
WorkweekConfigs	Query and update the workweek configurations in Square.