CLclover
INVENTORY

Get all tax rates

Retrieves all tax rates applicable on an order. A tax rate is a percentage or a flat fee at which an item is taxed.

get/v3/merchants/{mId}/tax_rates

Request

  • Base URL
    https://apisandbox.dev.clover.com
  • URL
    https://apisandbox.dev.clover.com/v3/merchants/{mId}/tax_rates
  • Auth
    HTTP bearer

Path parameters

mIdstring required

Merchant identifier.

Query parameters

filterstring

Filter fields to display search results: [isDefault, rate, items.id, name, id, taxAmount, taxType]

expandstring

Additional information provided as an expanded response: [items]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <product> / <product-version> <comment>

Response

Successful response. Displays up to 1000 tax rates applicable on an order.

idstring
namestring required
taxType'VAT_TAXABLE' | 'VAT_NON_TAXABLE' | 'VAT_EXEMPT' | 'INTERNAL_TAX' | 'PARTNER_TAX'

Tax type used in Argentina.

rateinteger

For percentage based discounts like sales tax

isDefaultboolean
taxAmountinteger

For a flat tax like recycling redemption fee, expressed as number of cents

deletedTimeinteger

Timestamp when tax rate was last deleted

modifiedTimeinteger

Timestamp when tax rate was last modified

Changes

No recorded changes to this operation across all 2 revisions of this API.