Cmdlets for Square

Build 24.0.9062

CatalogTaxes

Query the available catalog taxes.

Table Specific Information

Select

Retrieve all catalog taxes:

SELECT * FROM CatalogTaxes

Insert

To create an item, you will need to specify the Name column.

INSERT INTO CatalogTaxes (Name) VALUES ('Cat Created 2')

Update

Modify the details of an existing CatalogTaxes by providing the Id of the tax:

UPDATE CatalogTaxes SET Name = 'Cat Updated' WHERE ID = '1234'

Delete

Delete a category object by providing the Id of the Categories:

DELETE FROM CatalogTaxes WHERE Id = '32123'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The Id of the tax.

Name String False

The tax's name.

UpdatedAt Datetime 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.

CalculationPhase String False

Whether the tax is calculated based on a payment's subtotal or total.

InclusionType String False

Whether the tax is ADDITIVE or INCLUSIVE.

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%.

AppliesToCustomAmounts Boolean False

If true, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular CatalogItem.

Enabled Boolean False

If true, the tax will be shown as enabled 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) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062