--- title: "Get an individual tax exemption rule" method: GET path: "/v3/merchants/{mId}/tax_rules/{taxRuleId}" tags: ["INVENTORY"] --- # Get an individual tax exemption rule `GET /v3/merchants/{mId}/tax_rules/{taxRuleId}` ## Request - Base URL: `https://apisandbox.dev.clover.com` - URL: `https://apisandbox.dev.clover.com/v3/merchants/{mId}/tax_rules/{taxRuleId}` - Auth: HTTP bearer Returns the tax exemption rule specified in the request ## Path parameters - `mId` string, required - `taxRuleId` string, required ## Headers - `User-Agent` string, required ## Response `200` - object - `id` string: Unique identifier - `name` string, required: Name of Tax Rule - `merchant` object: The merchant the tax rule belongs to - `id` string: Unique identifier - `name` string, required: Name of the merchant - `owner` object, required: The account that owns this merchant - `id` string: Unique identifier - `name` string, required: Full name of the employee - `nickname` string: Nickname of the employee (shows up on receipts) - `customId` string: Custom ID of the employee - `email` string: Email of the employee (optional) - `inviteSent` boolean: Returns true if this employee was sent an invite to activate their account - `claimedTime` integer: Timestamp of when this employee claimed their account - `deletedTime` integer: Timestamp of when this employee was deleted - `pin` string: Employee PIN (hashed) - `unhashedPin` string: Employee PIN - `role` 'OWNER' | 'ADMIN' | 'MANAGER' | 'EMPLOYEE': Employee System Role - `roles` object[] - `id` string: Unique identifier. - `isOwner` boolean: Returns true if this employee is the owner account for this merchant - `shifts` object[]: This employee's shifts - `id` string: Unique identifier. - `payments` object[]: This employee's payments - `id` string: Unique identifier. - `orders` object[]: This employee's orders - `id` string: Unique identifier. - `employeeCards` object[]: This employee's employee cards - `id` string: Unique identifier. - `merchant` object: The merchant employing this employee. - `id` string: Unique identifier. - `address` object: The address of the merchant. - `address1` string: Customer's address, line one. - `address2` string: Customer's address, line two. - `address3` string: Customer's address, line three. - `city` string: Customer's city. - `country` string: Customer's country. - `state` string: Customer's state. - `zip` string: Postal code of the customer's address. - `orderType` object: Order Type which to apply the tax rule - `id` string: Unique identifier - `labelKey` string: Label Key - `label` string: Label Key - `taxable` boolean: If this order type is taxable - `isDefault` boolean: If this order type is the default - `filterCategories` boolean: If set to false, then this order type includes all of the merchant's categories. Otherwise, it only contains the categories defined in the "categories" field on this object. - `isHidden` boolean: If this order type is hidden on the Register - `fee` integer: The price of a fee added to this order type, not fully implemented at this time. - `minOrderAmount` integer: The minimum amount required for an order to be placed - `maxOrderAmount` integer: The maximum amount for an order allowed - `maxRadius` integer: The maximum radius allowed for an order (i.e. delivery) - `avgOrderTime` integer: The average time it takes to complete the order - `hoursAvailable` 'ALL' | 'BUSINESS' | 'CUSTOM' - `customerIdMethod` 'NAME' | 'TABLE' | 'NAME_TABLE' - `isDeleted` boolean: If this order type is deleted - `systemOrderTypeId` string: Optional system order type that this order type is associated with. - `hours` object: The hours this order type is available (if they differ from normal merchant hours) - `id` string: Unique identifier - `name` string: Friendly name to describe the hours. - `reference` object - `id` string: Unique identifier. - `sunday` object[] - `start` integer, required - `end` integer, required - `monday` object[] - `start` integer, required - `end` integer, required - `tuesday` object[] - `start` integer, required - `end` integer, required - `wednesday` object[] - `start` integer, required - `end` integer, required - `thursday` object[] - `start` integer, required - `end` integer, required - `friday` object[] - `start` integer, required - `end` integer, required - `saturday` object[] - `start` integer, required - `end` integer, required - `categories` object[]: The categories of items that can be assigned to this order type - `id` string: Unique identifier. - `rates` object[]: Tax rates associated with this rule - `id` string - `name` string, required - `taxType` 'VAT_TAXABLE' | 'VAT_NON_TAXABLE' | 'VAT_EXEMPT' | 'INTERNAL_TAX' | 'PARTNER_TAX': Tax type used in Argentina. - `rate` integer: For percentage based discounts like sales tax - `isDefault` boolean - `items` object[]: Items associated with this tax rate - `id` string: Unique identifier. - `taxAmount` integer: For a flat tax like recycling redemption fee, expressed as number of cents - `deletedTime` integer: Timestamp when tax rate was last deleted - `modifiedTime` integer: Timestamp when tax rate was last modified - `items` object[]: Items associated with this rule - `id` string: Unique identifier - `hidden` boolean: True if this item is hidden from Clover Register App - `available` boolean: True if this item is available for sale across all channels - `autoManage` boolean: False manually manage item availability, True item availability depends on stock count - `itemGroup` object: Reference to an item group - `id` string: Unique identifier. - `options` object[]: List of options pertaining to this item's attribute variation - `id` string: Unique identifier - `name` string, required: Name of the option - `attribute` object - `id` string: Unique identifier. - `items` object[]: Items associated with this option - `id` string: Unique identifier. - `name` string, required: Name of the item - `alternateName` string: Alternate name of the item - `code` string: Product code, e.g. UPC or EAN - `sku` string: SKU of the item - `price` integer, required: Price of the item, typically in cents; use priceType and merchant currency to determine actual item price. For non-VAT merchants, this field is exclusive of tax. For VAT merchants, this field is inclusive of tax. - `priceType` 'FIXED' | 'VARIABLE' | 'PER_UNIT' - `defaultTaxRates` boolean: Flag to indicate whether or not to use default tax rates - `unitName` string: Unit name, e.g. oz, lb - `cost` integer: Cost of the item to merchant, as opposed to customer price - `isRevenue` boolean: True if this item should be counted as revenue. For example, gift cards and donations would not be counted as revenue. - `stockCount` integer: Deprecated, use itemStock instead. - `taxRates` object[] - `id` string - `name` string, required - `taxType` 'VAT_TAXABLE' | 'VAT_NON_TAXABLE' | 'VAT_EXEMPT' | 'INTERNAL_TAX' | 'PARTNER_TAX': Tax type used in Argentina. - `rate` integer: For percentage based discounts like sales tax - `isDefault` boolean - `items` object[]: Items associated with this tax rate - `id` string: Unique identifier. - `taxAmount` integer: For a flat tax like recycling redemption fee, expressed as number of cents - `deletedTime` integer: Timestamp when tax rate was last deleted - `modifiedTime` integer: Timestamp when tax rate was last modified - `modifierGroups` object[] - `id` string: Unique identifier - `name` string: Name of the modifier group - `alternateName` string - `minRequired` integer: The minimum amount of modifiers from this group that must be applied to associated lineItems when using Register - `maxAllowed` integer: The maximum amount of modifiers from this group that can be applied to associated lineItems when using Register - `showByDefault` boolean: Whether employees will be automatically prompted to add modifiers from this category when using Register - `modifiers` object[] - `id` string: Unique identifier - `name` string: Name of the modifier - `alternateName` string: Alternate name of the modifier - `available` boolean: True if this modifier is available across all channels - `price` integer: Additional cost when used - `modifierGroup` object - `id` string: Unique identifier. - `modifierIds` string: An ordered, comma-separated list of modifier ids in this group. (READ ONLY) - `items` object[] - `id` string: Unique identifier. - `sortOrder` integer: The ordinal value used to determine where in an ordered list this modifier group should appear relative to others. - `categories` object[]: Categories associated with this item - `id` string: Unique identifier - `name` string, required: The name of the category which will appear in Clover Register App. - `sortOrder` integer: Integer used to determine how this category is sorted against other categories. - `items` object[]: Ordered list of items associated with this category. - `id` string: Unique identifier. - `colorCode` string: Hex code representation of the color assigned to this category and its items, in the form of #fff, #ffffff, or #ffffffff - `deleted` boolean: Whether the category has been deleted. - `modifiedTime` integer: The time this category was last modified - `canonical` object: Reference to canonical category - `id` string: Unique identifier. - `tags` object[]: Tags associated with this item - `id` string: Unique identifier - `name` string, required: Tag name - `showInReporting` boolean: True if tag is a summary label in the reporting app - `items` object[]: Items associated with this tag - `id` string: Unique identifier. - `printers` object[]: Printers associated with this tag - `id` string: Unique identifier. - `canonical` object: Reference to canonical items - `id` string: Unique identifier. - `itemStock` object: Item stock attribute that can be expanded to show stock quantity - `item` object: Reference to an item - `id` string: Unique identifier. - `stockCount` integer: Deprecated, use quantity instead. - `quantity` number: Current count of this item in stock. - `modifiedTime` integer - `modifiedTime` integer - `deletedTime` integer: Timestamp when item was last deleted - `priceWithoutVat` integer: The price without value-added tax (VAT). For non-VAT merchants, this field is ignored. For VAT merchants, this field is the base price of an item. - `colorCode` string: Hex code representation of the color assigned to item in the form of #fff, #ffffff, or #ffffffff - `createdTime` integer: Timestamp when the tax rule was created - `modifiedTime` integer: Timestamp when the tax rule was last modified - `deletedTime` integer: Timestamp when tax rule was last deleted --- [API](https://skmtc.dev/clover/apis/platform-api.md) - [All operations](https://skmtc.dev/clover/apis/platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/clover/apis/platform-api/revisions/95fd9ec401ef?raw)