--- title: "Get all taxes" method: GET path: "/api/rnb/pvt/taxes/calculatorconfiguration" tags: ["Promotions and taxes"] --- # Get all taxes `GET /api/rnb/pvt/taxes/calculatorconfiguration` ## Request - Base URL: `https://apiexamples.vtexcommercestable.com.br` - URL: `https://apiexamples.vtexcommercestable.com.br/api/rnb/pvt/taxes/calculatorconfiguration` - Auth: one of: - API key in header `X-VTEX-API-AppKey` and API key in header `X-VTEX-API-AppToken` - API key in header `VtexIdclientAutCookie` Retrieves all taxes from an account. ## Permissions Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint: | **Product** | **Category** | **Resource** | | --------------- | ----------------- | ----------------- | | Rates and Benefits | Manage benefits and rates | **GerenciarPromocoesETarifas** | There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication). >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations. ## Headers - `Content-Type` string, required - `Accept` string, required ## Response `200` OK - object - `limitConfiguration` object: Limit configuration. - `activesCount` integer: Actives count. - `limit` integer: Limit. - `items` object[]: Array with taxes. - `idCalculatorConfiguration` string: Tax ID. - `lastModifiedUtc` string: Date and time when the tax was last modified (UTC). - `name` string: Tax name. - `beginDate` string: Tax start date (UTC). - `endDate` string: Tax end date (UTC). - `isActive` boolean: If set as `true` the tax is activated. If set as `false` the tax is deactivated. - `description` string: Tax internal description. - `type` string: Defines the type of tax. - `utmSource` string: utmSource code. - `utmCampain` string: utmCampaign code. - `utmiCampaign` string: utmiCampaign code. - `status` string: Status of the tax. - `percentualTax` number: Percentual tax applied. - `isArchived` boolean: If set as `true` the tax is archived. If set as `false` the tax is not archived. - `hasMaxPricePerItem` boolean: Defines if there is a maximum price per item. - `isTax` boolean: Defines if it is a tax. - `campaigns` string[]: Campaign Audiences that activate this promotion. - `activateGiftsMultiplier` boolean: If set as `true`, it activates gifts Multiplier. - `scope` object: Scope of the tax. - `allCatalog` boolean: Determines if the tax applies to all products in the Catalog (`true`) or not (`false`). - `skus` number: Quantity of SKUs which activate or deactivate the tax. - `skusAreInclusive` boolean: If set to `true`, this tax will be applied to any SKU present on the `skus` field. If set to `false`, SKUs present on that field will make this tax not to be applied. - `products` number: Quantity of products which activate or deactivate the tax. - `productsAreInclusive` boolean: If set to `true`, this tax will be applied to any product present on the `products` field. If set to `false`, products present on that field will make this tax not to be applied. - `collections` number: Quantity of collections which activate or deactivate the tax. - `collectionsAreInclusive` boolean: If set to `true`, this tax will be applied to any collection present on the `collections` field. If set to `false`, collections present on that field will make this tax not to be applied. - `categories` number: Quantity of categories which activate or deactivate the tax. - `categoriesAreInclusive` boolean: If set to `true`, this tax will be applied to any category present on the `categories` field. If set to `false`, categories present on that field will make this tax not to be applied. - `brands` number: Quantity of brands which activate or deactivate the tax. - `brandsAreInclusive` boolean: If set to `true`, this tax will be applied to any brand present on the `brands` field. If set to `false`, brands present on that field will make this tax not to be applied. - `sellers` number: Quantity of sellers which activate or deactivate the tax. - `sellersAreInclusive` boolean: If set to `true`, this tax will be applied to any seller present on the `sellers` field. If set to `false`, sellers present on that field will make this tax not to be applied. - `maxUsage` number: Defines how many times the tax can be used. - `idsSalesChannel` string[]: List of Trade Policies that activate this tax. - `areSalesChannelIdsExclusive` boolean: If set to `false`, this tax will be applied to any trade policies present on the `idsSalesChannel` field. If set to `true`, trade policies present on that field will make this tax not to be applied. - `disabledItems` string[]: Disabled items. - `archivedItems` string[]: Archived items. ## Changes - **2023-12-19** `92d80ca08151`: 2 info - api tag `Promotions and taxes` added - api tag `Promotions and Taxes` removed - **2023-11-28** `7a8561183291`: 1 warning, 1 info - removed the optional property `items/items/Campaigns` from the response with the `200` status - added the optional property `items/items/campaigns` to the response with the `200` status - **2023-05-19** `e2056ec81801`: 1 info - endpoint added - **2023-05-18** `649ab443f2ce`: 1 breaking - api path removed without deprecation [Operation history](https://skmtc.dev/vtex/apis/promotions-taxes-api/changes/api/rnb/pvt/taxes/calculatorconfiguration/get.md) --- [API](https://skmtc.dev/vtex/apis/promotions-taxes-api.md) - [All operations](https://skmtc.dev/vtex/apis/promotions-taxes-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vtex/apis/promotions-taxes-api/revisions/6a0f116108ca?raw)