Cmdlets for Square

Build 25.0.9434

Changelog

General Changes

DateBuild
Number		Change
Type		Description
10/06/20259410GeneralAdded
  • Support for parsing datetime formats using ".S" and ",S" for milliseconds and nanoseconds.
09/12/20259386GeneralAdded
  • Added the IsInsertable, IsUpdateable, and IsDeleteable columns to the sys_tables table.
09/10/20259384GeneralChanged
  • All columns in statically defined Views are now reported as read-only.
09/03/20259377GeneralChanged
  • Corrected the behavior when IN criteria with NULL values are used in the projection part. It now returns NULL instead of 0. For example, "NULL IN (1,2)" returns "NULL".
09/01/20259375GeneralAdded
  • Added support for using the CAST function with infinity values. This function can cast "inf" and "-inf" to DOUBLE, FLOAT, or REAL.
08/21/20259364GeneralChanged
  • Report behavior change:
    • Fixed inconsistent string value comparisons in non-table queries.
    • For example, "SELECT 'A' = 'a'" previously returned false, but it now returns true.
08/14/20259357SquareAdded
  • Added the FileData input parameter to the CreateCatalogImage stored procedure.
08/13/20259356GeneralChanged
  • Changed the maximum number of pages held in memory from 15 to 5 for the page providers to decrease heap usage.
07/28/20259340SquareAdded
  • Added the following columns to the InventoryChanges table:
    • TeamMemberId
    • SourceProduct
    • SourceApplicationId
    • SourceName
    • AdjustmentGroupId
    • AdjustmentGroupRootAdjustmentId
    • AdjustmentGroupFromState
    • AdjustmentGroupToState
    • MeasurementUnitMeasurementUnitCustomUnitName
    • MeasurementUnitMeasurementUnitCustomUnitAbbreviation
    • MeasurementUnitMeasurementUnitAreaUnit
    • MeasurementUnitMeasurementUnitLengthUnit
    • MeasurementUnitMeasurementUnitVolumeUnit
    • MeasurementUnitMeasurementUnitWeightUnit
    • MeasurementUnitMeasurementUnitGenericUnit
    • MeasurementUnitMeasurementUnitTimeUnit
    • MeasurementUnitMeasurementUnitType
    • MeasurementUnitPrecision
    • MeasurementUnitId
07/25/20259337SquareAdded
  • Added the CatalogModifierListId column to the CatalogModifiers table.
07/18/20259330SquareRemoved
  • Removed the TenderId column from the Refunds table.
07/12/20259324SquareChanged
  • The datatype of the PaymentRequestsDueDate pseudo-column in the Invoices table has been changed from Datetime to Date.
07/11/20259323SquareAdded
  • Added the Scope connection property.
  • Added the Vendors table.

Changed
  • Changed Permissions to Scope in the GetOAuthAccessToken and GetOAuthAuthorizationURL stored procedures.
07/10/20259322SquareRemoved
  • Removed pseudo-columns DateRangeEndDate, DateRangeStartDate, StartEndAt, StartStartAt, EndEndAt, and EndStartAt from the Shifts table.

Changed
  • Changed the data type of the StartAt and EndAt columns to datetime in the Shifts table.
07/09/20259321SquareChanged
  • Changed column PlanID to PlanVariationID in the Subscriptions table.
  • Changed columns CategoryId, Description, ImageId to Categories, DescriptionHtml and ImageIds respectively in the CatalogItems table.

Removed
  • Removed columns DeclaredCashTipMoney, EmployeeID, and Wage from the Shifts table.
  • Removed the v1 data model and the Schema property.

Added
  • Added columns Actions and MonthlyBillingAnchorDate to the Subscriptions table.
  • Added columns DeclaredCashTipMoneyAmount, DeclaredCashTipMoneyCurrency, WageTitle, WageHourlyRateAmount, WageHourlyRateCurrency, WageJobId, and WageTipEligible to the Shifts table.
  • Added columns Unlinked, DestinationType, DestinationDetailsCardDetailsCardId, DestinationDetailsCardDetailsCardLast4, DestinationDetailsCardDetailsCardCardholderName, DestinationDetailsCardDetailsCardCustomerId, DestinationDetailsCardDetailsCardMerchantId, DestinationDetailsCardDetailsCardReferenceId, DestinationDetailsCardDetailsCardBin, DestinationDetailsCardDetailsCardVersion, DestinationDetailsCardDetailsEntryMethod, DestinationDetailsCardDetailsAuthResultCode, DestinationDetailsCashDetailsSellerSuppliedMoneyAmount, DestinationDetailsCashDetailsSellerSuppliedMoneyCurrency, DestinationDetailsCashDetailsChangeBackMoneyAmount, DestinationDetailsCashDetailsChangeBackMoneyCurrency, DestinationDetailsExternalDetailsType, DestinationDetailsExternalDetailsSource, DestinationDetailsExternalDetailsSourceId, TeamMemberId, and TerminalRefundId to the Refunds table.
  • Added columns DescriptionPlaintext, ItemOptions, SortName, IsArchived, EcomSeoDataPageTitle, EcomSeoDataPageDescription, EcomSeoDataPagePermalink, FoodAndBeverageDetailsCalorieCount, FoodAndBeverageDetailsDietaryPreferences, FoodAndBeverageDetailsIngredients, ReportingCategoryId, ReportingCategoryOrdinal, and TemporaryItemId to the CatalogItems table.
06/27/20259309SquareAdded
  • Added InputStream, FileData, and FileName input parameters to the CreateInvoiceAttachment stored procedure.
06/25/20259307GeneralRemoved
  • Removed the "ADLS Gen 1" value from the ConnectionType property.
06/25/20259307SquareAdded
  • Added the following columns to the Cards table:
    • BillingAddressFirstName, BillingAddressLastName, IssuerAlert, IssuerAlertAt, HsaFsa. - Added the pseudo-column 'IncludeDisabled' to the Cards table.
06/20/20259302GeneralAdded
  • Created the following functions:
    • TEXT_ENCODE: encodes a string into a different charset (UTF8 → UTF7 and returns a binary array as the result).
    • TEXT_DECODE: takes a binary array and decodes it back into a string when provided the charset.
    • BASE64_ENCODE: takes a binary array and encodes it as a base64 string (varchar).
    • BASE64_DECODE: takes a base 64-encoded string and decodes it into a binary array.
06/18/20259300GeneralChanged
  • The internal code for exception handling has been refactored. Exception messages returned during certain error conditions may now have different wording or formatting.
05/27/20259278GeneralRemoved
  • Removed the "Proprietary" enum option from ProxyAuthscheme.
05/16/20259267SquareRemoved
  • Removed the v1 option from the Schema connection property.
05/08/20259259SquareRemoved
  • Removed support for INSERT queries on the CatalogImages table in the v2 Data Model.
02/15/20259177GeneralAdded
  • Added support for converting unsigned integer types to the nearest signed data type that has enough precision to hold the unsigned value.This is done for JDBC only because it does not have support for unsigned data types.
12/27/20249127SquareAdded
  • Added support for the following stored procedures in the v2 Data Model: CancelPaymentByIdempotencyKey, CancelPayment, and CompletePayment.
12/20/20249120SquareAdded
  • Added support for the OrderEntries endpoint.
11/27/20249097GeneralAdded
  • Added ThreadId to LogModule output. Logfile lines now include the Thread ID associated with the action being performed.
10/25/20249064SquareAdded
  • Added columns to the following tables:
    • Cards: CardCoBrand, BillingAddressAdministrativeDistrictLevel2, BillingAddressAdministrativeDistrictLevel3, BillingAddressSubLocality2, BillingAddressSubLocality3.
    • CatalogCategories: CreatedAt, CategoryIsTopLevel, CatalogV1Ids
    • CatalogDiscounts: CreatedAt, CatalogV1Ids
    • CatalogImages: CreatedAt
    • CatalogItemVariations: CreatedAt, CatalogV1Ids, Channels
    • CatalogItems: CreatedAt, CatalogV1Ids, Channels, EcomAvailable, EcomImageURIs, EcomVisibility, IsTaxable, Visibility
    • CatalogModifierLists: CreatedAt, CatalogV1Ids
    • CatalogModifiers: CreatedAt, OnByDefault, Ordinal
    • CatalogTaxes: CreatedAt, CatalogV1Ids
    • Customers: CreationSource, GroupIds, Version, TaxIds
  • Added columns to the following views:
    • Locations: BusinessHours, Coordinates, MCC
    • Payments: ApplicationDetailsApplicationId, ApplicationDetailsSquareProduct, BuyNowPayLaterDetailsBrand, BuyNowAfterPayEmailAddress, and few others.
    • PayoutEntries: EffectiveAt, TypeAppFeeRevenueDetailsPaymentId, TypeAppFeeRevenueDetailsLocationId, TypeAppFeeRefundDetailsPaymentId, TypeAppFeeRefundDetailsLocationId, TypeAppFeeRefundDetailsRefundId, TypeAutomaticSavingsDetailsPaymentId, TypeAutomaticSavingsDetailsPayoutId, TypeAutomaticSavingsReversedDetailsPaymentId, TypeAutomaticSavingsReversedDetailsPayoutId, TypeDepositFeeDetailsPayoutId, TypeDisputeDetailsPaymentId, TypeDisputeDetailsDisputeId, TypeFeeDetailsPaymentId, TypeFreeProcessingDetailsPaymentId, TypeHoldAdjustmentDetailsPaymentId, TypeOpenDisputeDetailsPaymentId, TypeOpenDisputeDetailsDisputeId, TypeOtherDetailsPaymentId, TypeOtherAdjustmentDetailsPaymentId, TypeReleaseAdjustmentDetailsPaymentId, TypeReleaseHoldDetailsPaymentId, TypeReleaseReleaseDetailsPaymentId, TypeSquareCapitalPaymentDetailsPaymentId, TypeSquareCapitalReversedPaymentDetailsPaymentId, TypeTaxOnFeeDetailsPaymentId, TypeTaxOnFeeDetailsTaxRateDescription, TypeThirdPartyFeeDetailsPaymentId, TypeThirdPartyFeeRefundDetailsPaymentId, and TypeThirdPartyFeeRefundDetailsRefundId.
07/19/20248966SquareAdded
  • Added support for the Shifts endpoint. This includes the creation of pseudo columns that can be used with search shifts endpoint: DataRange_End_Date, DateRange_Start_Date, Start_End_At, Start_Start_At, End_End-At, and End_Start_At.
07/02/20248949SquareRemoved
  • Removed the CustomerCards table, the EmployeeId column from the Payments table, and the CardsAggregate column from the Customers table as the functionality for these items was discontinued by the Square API.
05/09/20248895GeneralChanged
  • The ROUND function previously did not accept negative precision values. That feature has now been restored.
04/17/20248873SquareChanged
  • Updated the datatype to BigInt from Int for the following columns: BankAccounts.Version, Cards.Version, OrderDiscounts.CatalogVersion, OrderTaxes.CatalogVersion, Orders.Version, Payouts.Version.
03/15/20248840GeneralAdded
  • Created a new SQL function called STRING_COMPARE that provides java's String.compare() ability to SQL queries. Returns a number representative of the compared value of two strings
11/29/20238733GeneralChanged
  • The ROUND function doesn't accept the negative precision values anymore.

Changed
  • The returning types of the FDMonth, FDQuarter, FDWeek, LDMonth, LDQuarter, LDWeek functions are changed from Timestamp to Date.
  • The return type of the ABS function will be consistent with the parameter value type.
11/28/20238732GeneralAdded
  • Added the HMACSHA256 formatter to allow for secrets to be decoded if it is in base64 format
09/18/20238661SquareRemoved
  • Removed the Settlements view as Square has deprecated the Settlements API.

Added
  • Added Payouts and PayoutEntries views.
07/26/20238607SquareRemoved
  • TaxesCatalogObjectId,TaxesName,TaxesPercentage,TaxesMoneyAmount,TaxesMoneyCurrency,DiscountsCatalogObjectId,DiscountsName,DiscountsPercentage,DiscountsMoneyAmount and DiscountsMoneyCurrency columns from orders views as we have made taxes and discount as aggregate column and created a different views.

Added
  • Added OrderDiscounts and OrderTaxes views.
  • CustomerId,Discounts,LineItems,NetDueAmount,NetDueCurrency,NetDiscountAmount,NetDiscountCurrency,NetServiceChargeAmount,NetServiceChargeCurrency,NetTaxAmount,NetTaxCurrency,NetTipAmount,NetTipCurrency,NetTotalAmount,NetTotalCurrency,PricingAutoApplyDiscounts,SourceName,State,Taxes,Tenders,TotalDiscountAmount,TotalDiscountCurrency,TotalAmount,TotalCurrency,ServiceChargeAmount,ServiceChargeCurrency,TaxAmount,TaxCurrency,TipAmount,TipCurrency and Version columns in orders views.
07/03/20238584SquareChanged
  • Changed the datatype of Birthday column in Customers table from datetime to string.
06/29/20238580PowerShell CmdletsRemoved
  • Removed support for .NET 2.0
06/20/20238571GeneralAdded
  • Added the new sys_lastresultinfo system table.
04/25/20238515GeneralRemoved
  • Removed support for the SELECT INTO CSV statement. The core code doesn't support it anymore.
03/21/20238480SquareAdded
  • Added Variations column in the CatalogItems table.
  • Added Type column in the CatalogItemVariations table.
12/14/20228383GeneralChanged
  • Added the Default column to the sys_procedureparameters table.
11/18/20228357SquareAdded
  • Added the TeamMemberId column in the Payments table.
09/30/20228308GeneralChanged
  • Added the IsPath column to the sys_procedureparameters table.
09/21/20228299SquareAdded
  • Added Content as input attribute to support input streams on the CreateCatalogImage stored procedure.
06/03/20228189SquareAdded
  • Added CreatedAt column to Merchants table.
  • Added CreatedAt and UpdatedAt columns to Orders table.
05/05/20228160SquareReplacements
  • Cards table has been added to replace CustomerCards table.
09/08/20217921SquareAdded
  • Added the ImageId column to the CatalogItems table.
09/03/20217916SquareAdded
  • Added the stored procedures CreateCatalogImage and AddItemImage to the V2 schema.

Deprecated
  • Removed the AddItemImage Stored Procedure from the V1 schema.
09/02/20217915GeneralAdded
  • Added support for the STRING_SPLIT table-valued function in the CROSS APPLY clause.
08/07/20217889GeneralChanged
  • Added the KeySeq column to the sys_foreignkeys table.
08/06/20217888GeneralChanged
  • Added the new sys_primarykeys system table.
07/23/20217874GeneralChanged
  • Updated the Literal Function Names for relative date/datetime functions. Previously, relative date/datetime functions resolved to a different value when used in the projection as opposed to the predicate. For example: SELECT LAST_MONTH() AS lm, Col FROM Table WHERE Col > LAST_MONTH(). Formerly, the two LAST_MONTH() methods would resolve to different datetimes. Now, they will match.
  • As a replacement for the previous behavior, the relative date/datetime functions in the criteria may have an 'L' appended to them. For example: WHERE col > L_LAST_MONTH(). This will continue to resolve to the same values that were previously calculated in the criteria. Note that the "L_" prefix will only work in the predicate - it not available for the projection.
07/15/20217866SquareAdded
  • Added the Version column in the CatalogCategories, CatalogDiscounts, CatalogImages, CatalogItems, CatalogItemVariations, CatalogModifierLists, CatalogModifiers and CatalogTaxes table in the V2 Schema.

Deprecated
  • Cells and Pages table from the V1 Schema as the functionality has been discontinued by the Square API. There is no replacement for these endpoints.
  • Refunds, Transactions, TransactionTenders, Payments and PaymentItemizations API support from V1 schema as they are deprecated.
  • Customers view from the V1 Schema as it is not supported in V1.
  • Locations view and Fees table from the V1 Schema as both the endpoints has been retired from the V1 Schema.

Replacements
  • v1 Locations are replaced with v2 Locations.
  • v1 Fees are replaced with v2 CatalogTaxes.
  • v1 Refunds are replaced with v2 Refunds.
  • v1 Transactions and TransactionTenders are replaced with v2 Orders and Payments.
  • v1 Payments and PaymentItemizations are replaced with v2 Payments.
06/01/20217822SquareDeprecated
  • Removed the Groups column in the Customers table as it is deprecated in the Customers V2 Schema API.
04/25/20217785GeneralAdded
  • Added support for handling client side formulas during insert / update. For example: UPDATE Table SET Col1 = CONCAT(Col1, " - ", Col2) WHERE Col2 LIKE 'A%'
04/23/20217783GeneralChanged
  • Updated how display sizes are determined for varchar primary key and foreign key columns so they will match the reported length of the column.
04/16/20217776GeneralAdded
  • Non-conditional updates between two columns is now available to all drivers. For example: UPDATE Table SET Col1=Col2
04/16/20217776GeneralChanged
  • Reduced the length to 255 for varchar primary key and foreign key columns.

Changed
  • Updated index naming convention to avoid duplicates.
04/16/20217776GeneralChanged
  • Updated implicit and metadata caching to improve performance and support for multiple connections. Old metadata caches are not compatible - you need to generate new metadata caches if you are currently using CacheMetadata.
04/16/20217776PowerShell CmdletsAdded
  • Added support for PowerShell 7.
03/30/20217759SquareAdded
  • Added CRUD support for the V2 tables CatalogCategories, CatalogDiscounts, CatalogImages, CatalogItems, CatalogItemVariations, CatalogModifierLists, CatalogModifiers and CatalogTaxes.

Deprecated
  • Employees, BankAccounts, Items, ItemVariations, Discounts, Categories, Inventory, Modifieroptions and ModifierLists API support from V1 schema as they are deprecated.

Replacements
  • v1 Employees replaced with v2 Teams
  • v1 BankAccounts replaced with v2 BankAccounts
  • v1 Inventory replaced with v2 InventoryChanges
  • v1 Items replaced with v2 CatalogItems
  • v1 ItemVariations replaced with v2 CatalogItemVariations
  • v1 Discounts replaced with v2 CatalogDiscounts
  • v1 Categories replaced with v2 CatalogCategories
  • v1 ModifierOptions replaced with v2 CatalogModifiers
  • v1 ModifierLists replaced with v2 CatalogModifierLists

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434