Tableau Connector for Square

Build 21.0.8137

CatalogDiscounts

Query the available catalog discounts.

Table Specific Information

Select

Retrieve all catalog discounts:

SELECT * FROM CatalogDiscounts

Insert

To create an item, you will need to specify the DiscountType, Name, Amount and Currency columns.

INSERT INTO CatalogDiscounts (PINRequired, DiscountType, Name, Amount, Currency) VALUES (false,'FIXED_PERCENTAGE','Special_Discount1','200000','USD') 

Update

To Update an item, you will need to specify the Id column.

UPDATE catalogdiscounts set amount=1234, currency='USD' where id='1234'

Delete

Delete a discount object by providing the Id of the discount object:

DELETE FROM catalogdiscounts WHERE Id='32123'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The discount's ID.

Name String False

The discount's name.

UpdatedAt Datatime False

Last modification timestamp.

IsDeleted Boolean False

If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time.

DiscountType String False

Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale.

Percentage String False

The percentage of the discount as a string representation of a decimal number, using a . as the decimal separator and without a % sign. A value of 7.5 corresponds to 7.5%. Specify a percentage of 0 if DiscountType is VARIABLE_PERCENTAGE.

Amount Integer False

The discount's amount.

Currency String False

The discount's money currency.

PinRequired Boolean False

Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.

LabelColor String False

The color of the discount's display label in the Square Point of Sale app.

PresentAtAllLocations Boolean False

If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true.

PresentAtLocationIds String False

A list of locations where the object is present, even if PresentAtAllLocations is false.

AbsentAtLocationIds String False

A list of locations where the object is not present, even if PresentAtAllLocations is true.

Version Int64 False

The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137