Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Square.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Square, along with an indication of whether the procedure succeeded or failed.

CData Power BI Connector for Square Stored Procedures


Name	Description
AcceptDispute	Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED.
AccumulateLoyaltyPoints	Adds points earned from a purchase to a loyalty account.
AddItemImage	Uploads an image file to be represented by a CatalogImage object linked to an existing CatalogObject instance.
AdjustLoyaltyPoints	Adds points to or subtracts points from a loyalty account.
CalculateLoyaltyPoints	Calculates the points earned from a potential purchase. Provide either OrderId or TransactionAmountMoney (one is required).
CalculateOrder	Calculates the total for an order including taxes and discounts, returning the calculated order. This is a Beta API.
CancelBooking	Cancels an existing booking.
CancelInvoice	Cancels an invoice.
CancelLoyaltyPromotion	Cancels a loyalty promotion.
CancelPayment	Cancels (voids) a payment.
CancelPaymentByIdempotencyKey	Cancels (voids) a payment identified by the idempotency key that is specified in the request.
CancelSubscription	Schedules a CANCEL action to cancel an active subscription.
CancelTerminalAction	Cancels a terminal action request if the status of the associated action permits it.
CancelTerminalCheckout	Cancels a terminal checkout request if the status of the associated checkout permits it.
CancelTerminalRefund	Cancels a terminal refund request if the status of the associated refund permits it.
CancelTransferOrder	Cancels a transfer order, transitioning its status to CANCELED. This is a Beta API.
ChangeBillingAnchorDate	Changes the billing anchor date for a subscription.
CloneOrder	Clones an existing order to create a new draft order. This is a Beta API. If IdempotencyKey is omitted, the request is sent without one and duplicate submissions are not protected against.
CompletePayment	Completes (captures) a payment.
CreateCatalogImage	Uploads an image file to be represented by a CatalogImage object linked to an existing CatalogObject instance.
CreateInvoiceAttachment	Uploads a file and attaches it to an invoice.
CreateOrder	Creates an Order that can then be referenced as OrderId in a request to the Charge endpoint.
DeleteInvoiceAttachment	Removes an attachment from an invoice and permanently deletes the file.
DeleteSubscriptionAction	Deletes a scheduled action for a subscription.
DisableBankAccount	Disables a bank account, preventing further use. This is a Beta API.
DismissTerminalAction	Dismisses a Terminal action request if the status and type of the request permits it.
DismissTerminalCheckout	Dismisses a Terminal checkout request if the status and type of the request permits it.
DismissTerminalRefund	Dismisses a Terminal refund request if the status and type of the request permits it.
GetOAuthAccessToken	Retrieves an authentication token from Square.
GetOAuthAuthorizationURL	Retrieves the authorization URL used to grant access to your application. The user must open this URL separately to complete authorization and obtain the OAuthAccessToken. Only required when developing web applications.
LinkCustomerToGiftCard	Links a customer to a gift card, which is also referred to as adding a card on file.
PauseSubscription	Schedules a PAUSE action to pause an active subscription.
PayOrder	Completes payment for an order. Payment IDs must cover the total order amount. This is a Beta API.
PublishInvoice	Publishes the specified draft invoice.
ReceiveTransferOrder	Records goods received from a transfer order, updating its quantities and status. This is a Beta API.
RedeemLoyaltyReward	Redeems a loyalty reward.
RefreshOAuthAccessToken	Refreshes the OAuth access token used for authentication with Square.
RegisterDomain	Registers a domain for use with Apple Pay on the Web and Square.
ResumeSubscription	Schedules a RESUME action to resume a paused or deactivated subscription.
StartTransferOrder	Starts a transfer order, transitioning its status from DRAFT to STARTED. This is a Beta API.
SubmitEvidence	Submits evidence to the Disputes API for the dispute review process, moving the dispute to a state that awaits a response from Square.
SwapPlan	Changes the subscription plan variation for a subscription, allowing a subscriber to change plans, upgrade, or downgrade.
UnlinkCustomerFromGiftCard	Unlinks a customer from a gift card, which is also referred to as removing a card on file.
UpdateCatalogImage	Uploads a new image file to replace the existing one in the specified CatalogImage object.
UpdateItemModifierLists	Updates the CatalogModifierList objects that apply to the targeted CatalogItems, without having to reupload the entire item. Enables or disables the modifier list associations for a set of items in a single request.
UpdateItemTaxes	Updates the CatalogTax objects that apply to the targeted CatalogItems, without having to reupload the entire item. Enables or disables the tax associations for a set of items in a single request.