2024 is the year of the connector - vote here

Explore the Square API data model

See how the various Square endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the Square API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Square API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

Card

Documentation: https://developer.squareup.com/reference/square/cards-api

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
CardBrand string - -
Last4 string - -
ExpYear int - -
ExpMonth int - -
CardholderName string - -
Fingerprint string - -
CustomerID string Customer → ID -
MerchantID string Merchant → ID -
Enabled boolean - -
CardType string - -
PrepaidType string - -
Bin string - -
Version int - -
CardCoBrand string - -
CreatedAt datetime - -
UpdatedAt datetime - -

Category

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
CategoryType string - -
ParentCategoryID string Category → ID -
IsTopLevel boolean - -
ObjectTypeName string - -
CatalogObjectID string CatalogObject → ID -

Item

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
DescriptionHtml string - -
Abbreviation string - -
LabelColor string - -
AvailableOnline boolean - -
AvailableForPickup boolean - -
AvailableElectronically boolean - -
SkipModifierScreen boolean - -
IsArchived boolean - -
SortName string - -
ProductType string - -
DescriptionPlaintext string - -
ReportingCategoryID string Category → ID -
ObjectTypeName string - -
CatalogObjectID string CatalogObject → ID -

ItemOption

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
DisplayName string - -
ShowColors boolean - -
ObjectTypeName string - -
CatalogObjectID string CatalogObject → ID -

ItemOptionValue

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
ItemOptionID string CatalogObject → RemoteID -
DisplayName string - -
Color string - -
Ordinal int - -
ObjectTypeName string - -
CatalogObjectID string CatalogObject → ID -

ItemVariation

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
ItemID string Item → ID -
Sku string - -
Upc string - -
Ordinal long - -
PricingType string - -
PriceCurrency string - -
PriceAmount long - -
TrackInventory boolean - -
InventoryAlertType string - -
UserData string - -
ServiceDuration long - -
TrackInveavailableForBookingntory boolean - -
ObjectTypeName string - -
CatalogObjectID string CatalogObject → ID -

Modifier

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
ImageID string - -
ModifierListID string - -
PriceCurrency string - -
PriceAmount long - -
DisplayName string - -
Color string - -
Ordinal int - -
ObjectTypeName string - -
CatalogObjectID string CatalogObject → ID -

CatalogObject

Documentation: https://developer.squareup.com/reference/square/catalog-api/search-catalog-objects

Column Type Relates to Notes
RemoteID string - -
CategoryRemoteID string Category → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Type string - -
Version long - -
PresentAtAllLocations boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

Customer

Documentation: https://developer.squareup.com/reference/square/customers-api/search-customers

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
GivenName string - -
FamilyName string - -
Nickname string - -
CompanyName string - -
EmailAddress string - -
PhoneNumber string - -
Birthday string - -
ReferenceID string - -
Note string - -
EmailIsUnsubscribed boolean - -
CreationSource string - -
CreatedAt datetime - -
UpdatedAt datetime - -

Group

Documentation: https://developer.squareup.com/reference/square/customer-groups-api

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -

Location

Documentation: https://developer.squareup.com/docs/locations-api

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
Timezone string - -
LanguageCode string - -
MerchantID string Merchant → ID -
Country string - -
Currency string - -
PhoneNumber string - -
BusinessName string - -
Type string - -
WebsiteUrl string - -
BusinessEmail string - -
TwitterUsername string - -
InstagramUsername string - -
FacebookUrl string - -
LogoUrl string - -
PosBackgroundUrl string - -
Mcc string - -
FullFormatLogoUrl string - -
Status string - -
CreatedAt datetime - -
UpdatedAt datetime - -

Merchant

Documentation: https://developer.squareup.com/docs/merchants-api

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Start string - -
BusinessName string - -
Country string - -
LanguageCode string - -
Currency string - -
Status string - -
MainLocationID string Location → ID -
OwnerEmail string - -
CreatedAt datetime - -

Order

Documentation: https://developer.squareup.com/docs/orders-api/manage-orders/search-orders

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
LocationID string Location → ID -
CustomerID string Customer → ID -
OrderSource string - -
Source string - -
ReferenceID string - -
Version int - -
ClosedAt datetime - -
State string - -
TicketName string - -
TotalCurrency string - -
TotalAmount long - -
TotalTaxCurrency string - -
TotalTaxAmount long - -
TotalDiscountCurrency string - -
TotalDiscountAmount long - -
TotalTipCurrency string - -
TotalTipAmount long - -
TotalServiceChargeCurrency string - -
TotalServiceChargeAmount long - -
TotalAmountDueCurrency string - -
TotalAmountDueAmount long - -
CreatedAt datetime - -
UpdatedAt datetime - -

Payment

Documentation: https://developer.squareup.com/reference/square/payments-api/list-payments

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
AmountMoneyCurrency string - -
AmountMoneyAmount long - -
TipMoneyCurrency string - -
TipMoneyAmount long - -
AppFeeMoneyCurrency string - -
AppFeeMoneyAmount long - -
ApprovedMoneyCurrency string - -
ApprovedMoneyAmount long - -
RefundMoneyCurrency string - -
RefundMoneyAmount long - -
Status string - -
DelayDuration string - -
DelayAction string - -
DelayedUntil datetime - -
SourceType string - -
LocationID string Location → ID -
OrderID string Order → ID -
ReferenceID string - -
CustomerID string Customer → ID -
TeamMemberID string TeamMember → ID -
BuyerEmailAddress string - -
Note string - -
StatementDescriptionIdentifier string - -
ReceiptNumber string - -
ReceiptUrl string - -
CreatedAt datetime - -
UpdatedAt datetime - -

Segment

Documentation: https://developer.squareup.com/reference/square/customer-segments-api

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
CreatedAt datetime - -
UpdatedAt datetime - -

Site

Documentation: https://developer.squareup.com/reference/square/sites-api/list-sites

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
SiteTitle string - -
Domain string - -
IsPublished boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -

TeamMember

Documentation: https://developer.squareup.com/reference/square/team-api/search-team-members

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
ReferenceID string - -
IsOwner boolean - -
GivenName string - -
FamilyName string - -
EmailAddress string - -
PhoneNumber string - -
AssignmentType string - -
Status string - -
CreatedAt datetime - -
UpdatedAt datetime - -

CardAddress

Column Type Relates to Notes
RemoteID string - -
CardRemoteID string Card → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CardID string Card → ID -
Iterator int - -
AddressLine1 string - -
AddressLine2 string - -
AddressLine3 string - -
Sublocality string - -
Sublocality2 string - -
Sublocality3 string - -
AdministrativeDistrictLevel1 string - -
AdministrativeDistrictLevel2 string - -
AdministrativeDistrictLevel3 string - -
PostalCode string - -
Country string - -
FirstName string - -
LastName string - -

ItemCategory

Column Type Relates to Notes
RemoteID string - -
ItemRemoteID string Item → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ItemID string Item → ID -
CategoryID string Category → ID -

ItemVariationLocationOverride

Column Type Relates to Notes
RemoteID string - -
ItemVariationRemoteID string ItemVariation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ItemVariationID string ItemVariation → ID -
LocationID string Location → ID -
PricingType string - -
PriceCurrency string - -
PriceAmount long - -
TrackInventory boolean - -
SoldOut boolean - -
InventoryAlertType string - -
SoldOutValidUntil datetime - -

ItemVariationItemOptionValue

Column Type Relates to Notes
RemoteID string - -
ItemVariationRemoteID string ItemVariation → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ItemOptionID string ItemOption → ID -
ItemVariationID string ItemVariation → ID -
ItemOptionValueID string ItemOptionValue → ID -

ModifierLocationOverride

Column Type Relates to Notes
RemoteID string - -
ModifierRemoteID string Modifier → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ModifierID string Modifier → ID -
LocationID string Location → ID -
ImageID string - -
PriceCurrency string - -
PriceAmount long - -
SoldOut boolean - -

CatalogLocationPresence

Column Type Relates to Notes
RemoteID string - -
CatalogObjectRemoteID string CatalogObject → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogObjectID string CatalogObject → ID -
LocationID string Location → ID -

CatalogLocationAbsence

Column Type Relates to Notes
RemoteID string - -
CatalogObjectRemoteID string CatalogObject → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CatalogObjectID string CatalogObject → ID -
LocationID string Location → ID -

CustomerAddress

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID string Customer → ID -
Iterator int - -
AddressLine1 string - -
AddressLine2 string - -
AddressLine3 string - -
Sublocality string - -
Sublocality2 string - -
Sublocality3 string - -
AdministrativeDistrictLevel1 string - -
AdministrativeDistrictLevel2 string - -
AdministrativeDistrictLevel3 string - -
PostalCode string - -
Country string - -
FirstName string - -
LastName string - -

CustomerGroup

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID string Customer → ID -
GroupID string Group → ID -

CustomerSegment

Column Type Relates to Notes
RemoteID string - -
CustomerRemoteID string Customer → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID string Customer → ID -
SegmentID string Segment → ID -
Iterator int -
  • 3 May 2024 Customers can belong to the same Segment multiple times

OrderDiscount

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Type string - -
Percentage string - -
AmountMoneyCurrency string - -
AmountMoneyAmount long - -
AppliedMoneyCurrency string - -
AppliedMoneyAmount long - -
Scope string - -
OrderID string Order → ID -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

OrderFulfillment

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Uid string - -
OrderID string Order → ID -
Percentage string - -
State string - -
LineItemApplication string - -

OrderLineItem

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
ItemVariationID string ItemVariation → ID -
Quantity decimal - -
Note string - -
ItemType string - -
BasePriceCurrency string - -
BasePriceAmount long - -
GrossSalesCurrency string - -
GrossSalesAmount long - -
TotalDiscountCurrency string - -
TotalDiscountAmount long - -
TotalCurrency string - -
TotalAmount long - -
TotalTaxCurrency string - -
TotalTaxAmount long - -
TotalServiceChargeCurrency string - -
TotalServiceChargeAmount long - -
VariationTotalPriceCurrency string - -
VariationTotalPriceAmount long - -
OrderID string Order → ID -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

OrderServiceCharge

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Percentage string - -
AppliedMoneyCurrency string - -
AppliedMoneyAmount long - -
AmountMoneyCurrency string - -
AmountMoneyAmount long - -
TotalMoneyCurrency string - -
TotalMoneyAmount long - -
TotalTaxMoneyCurrency string - -
TotalTaxMoneyAmount long - -
Scope string - -
CalculationPhase string - -
Taxable boolean - -
Type string - -
TreatmentType string - -
OrderID string Order → ID -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

OrderTax

Column Type Relates to Notes
RemoteID string - -
OrderRemoteID string Order → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Type string - -
Percentage string - -
AppliedMoneyCurrency string - -
AppliedMoneyAmount long - -
Scope string - -
OrderID string Order → ID -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

PaymentBankAccountDetails

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BankName string - -
TransferType string - -
AccountOwnershipType string - -
Fingerprint string - -
Country string - -
StatementDescription string - -
ACHDetailsRoutingNumber string - -
ACHDetailsAccountNumberSuffix string - -
ACHDetailsAccountType string - -
PaymentID string Payment → ID -

PaymentProcessingFee

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PaymentID string Payment → ID -
Increment int - -
EffectiveAt string - -
Type string - -
AmountMoneyCurrency string - -
AmountMoneyAmount long - -

PaymentBillingAddress

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PaymentID string Payment → ID -
Iterator int - -
AddressLine1 string - -
AddressLine2 string - -
AddressLine3 string - -
Sublocality string - -
Sublocality2 string - -
Sublocality3 string - -
AdministrativeDistrictLevel1 string - -
AdministrativeDistrictLevel2 string - -
AdministrativeDistrictLevel3 string - -
PostalCode string - -
Country string - -
FirstName string - -
LastName string - -

PaymentShippingAddress

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PaymentID string Payment → ID -
Iterator int - -
AddressLine1 string - -
AddressLine2 string - -
AddressLine3 string - -
Sublocality string - -
Sublocality2 string - -
Sublocality3 string - -
AdministrativeDistrictLevel1 string - -
AdministrativeDistrictLevel2 string - -
AdministrativeDistrictLevel3 string - -
PostalCode string - -
Country string - -
FirstName string - -
LastName string - -

PaymentCapability

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PaymentID string Payment → ID -
CapabilityName string - -

PaymentBuyNowPayLaterDetails

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Brand string - -
ClearpayBuyerBuyerName string - -
AfterpayBuyerEmailAddress string - -
PaymentID string Payment → ID -

PaymentCardDetails

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Status string - -
CvvStatus string - -
AvsStatus string - -
AuthResultCode string - -
ApplicationIdentifier string - -
ApplicationName string - -
ApplicationCryptogram string - -
VerificationMethod string - -
VerificationResults string - -
StatementDescription string - -
AuthorizedAt datetime - -
CapturedAt datetime - -
RefundRequiresCardPresence boolean - -
PaymentID string Payment → ID -

PaymentCashDetails

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BuyerSuppliedMoneyCurrency string - -
BuyerSuppliedMoneyAmount long - -
ChangeBackMoneyCurrency string - -
ChangeBackMoneyAmount long - -
PaymentID string Payment → ID -

PaymentExternalDetails

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Type string - -
SourceID string - -
Source string - -
SourceFeeMoneyCurrency string - -
SourceFeeMoneyAmount long - -
PaymentID string Payment → ID -

PaymentSquareAccountDetails

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PaymentSourceToken string - -
PaymentID string Payment → ID -

PaymentWalletDetails

Column Type Relates to Notes
RemoteID string - -
PaymentRemoteID string Payment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Status string - -
Brand string - -
CashAppDetailsBuyerName string - -
CashAppDetailsBuyerCountryCode string - -
CashAppDetailsBuyerCashTag string - -
PaymentID string Payment → ID -

TeamMemberAssignedLocation

Column Type Relates to Notes
RemoteID string - -
TeamMemberRemoteID string TeamMember → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TeamMemberID string TeamMember → ID -
LocationID string Location → ID -

TeamMemberWageSetting

Documentation: https://developer.squareup.com/reference/square/team-api/retrieve-wage-setting

Column Type Relates to Notes
RemoteID string - -
TeamMemberRemoteID string TeamMember → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string -
  • 29 Apr 2024 The response returns a single "wage setting" for team members, with no other identifier of note, so we'll use the team_member_id here as the unique identifier
TeamMemberID string TeamMember → ID -
IsOvertimeExempt boolean - -
CreatedAt datetime - -
UpdatedAt datetime - -
Version string - -

OrderFulfillmentDeliveryDetails

Column Type Relates to Notes
RemoteID string - -
OrderFulfillmentRemoteID string OrderFulfillment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID string Customer → ID -
ScheduleType string - -
PlacedAt datetime - -
DeliverAt datetime - -
CompletedAt datetime - -
InProgressAt datetime - -
RejectedAt datetime - -
ReadyAt datetime - -
CanceledAt datetime - -
CancelReason string - -
CourierPickupAt datetime - -
CourierPickupWindowDuration string - -
PrepTimeDuration string - -
DeliveryWindowDuration string - -
Note string - -
IsNoContactDelivery boolean - -
ManagedDelivery boolean - -
DropoffNotes string - -
CourierProviderName string - -
CourierSupportPhoneNumber string - -
SquareDeliveryID string - -
ExternalDeliveryID string - -

OrderFulfillmentShipmentDetails

Column Type Relates to Notes
RemoteID string - -
OrderFulfillmentRemoteID string OrderFulfillment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID string Customer → ID -
Carrier string - -
ShippingNote string - -
ShippingType string - -
TrackingNumber string - -
TrackingUrl string - -
PlacedAt datetime - -
InProgressAt datetime - -
PackagedAt datetime - -
ExpectedShippedAt datetime - -
ShippedAt datetime - -
CanceledAt datetime - -
CancelReason string - -
FailedAt datetime - -
FailureReason string - -

OrderFulfillmentPickupDetails

Column Type Relates to Notes
RemoteID string - -
OrderFulfillmentRemoteID string OrderFulfillment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
CustomerID string Customer → ID -
Carrier string - -
ExpiresAt datetime - -
AutoCompleteDuration string - -
ScheduleType string - -
PickupAt datetime - -
PickupWindowDuration string - -
PrepTimeDuration string - -
Note string - -
PlacedAt datetime - -
AcceptedAt datetime - -
RejectedAt datetime - -
ReadyAt datetime - -
ExpiredAt datetime - -
PickedUpAt datetime - -
CanceledAt datetime - -
CancelReason string - -
IsCurbsidePickup boolean - -
CurbsidePickupDetail string - -
CurbsidePickupBuyerArrivedAt datetime - -

OrderFulfillmentEntry

Column Type Relates to Notes
RemoteID string - -
OrderFulfillmentRemoteID string OrderFulfillment → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
LineItemUid string OrderLineItem → Uid -
Quantity decimal - -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

OrderLineItemModifier

Column Type Relates to Notes
RemoteID string - -
OrderLineItemRemoteID string OrderLineItem → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
Quantity decimal - -
BasePriceCurrency string - -
BasePriceAmount long - -
TotalPriceCurrency string - -
TotalPriceAmount long - -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

OrderLineAppliedTax

Column Type Relates to Notes
RemoteID string - -
OrderLineItemRemoteID string OrderLineItem → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaxUid string - -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

OrderLineAppliedDiscount

Column Type Relates to Notes
RemoteID string - -
OrderLineItemRemoteID string OrderLineItem → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
DiscountUid string - -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

OrderServiceChargeAppliedTax

Column Type Relates to Notes
RemoteID string - -
OrderServiceChargeRemoteID string OrderServiceCharge → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
TaxUid string - -
Uid string - -
CatalogObjectID string CatalogObject → ID -
CatalogVersion long - -

TeamMemberWageSettingJobAssignment

Column Type Relates to Notes
RemoteID string - -
TeamMemberWageSettingRemoteID string TeamMemberWageSetting → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
PayType string - -
JobTitle string - -
HourlyAmount long - -
HourlyCurrency string - -
AnnualAmount long - -
AnnualCurrency string - -
WeeklyHours int - -
TeamMemberWageSettingID string TeamMemberWageSetting → TeamMemberID -
Iterator int - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Square data Querying Square using regular SQL