Skip to content

Fetch Tax Rule IDs

Tax rules define the taxation framework applied to products in Fynd Commerce, including GST components, tax rates, and rate slabs based on product price ranges. Each tax rule consists of multiple versions with specific applicability dates and statuses, enabling companies to manage historical, current, and future tax configurations. Tax rules are essential for accurate price calculations, invoice generation, and regulatory compliance across different product categories and markets.

The Fetch Tax Rule IDs endpoint retrieves all tax rules configured for your company, including their versions, components, rate structures, and activation statuses. Use this API to access tax rule metadata (including rule IDs, names, tax components, rate slabs, and version details) which is required when creating products or managing tax configurations. The endpoint supports filtering by rule status, version status, and rule name, along with pagination for handling extensive tax rule catalogs.

Important: Tax Compliance

Assigning the correct tax rule to products is crucial for accurate GST calculations and compliance. Incorrect tax rule assignments can lead to pricing errors, invoice discrepancies, and regulatory issues. Always coordinate tax rule selection with your finance or compliance team

Request Type: GET
Scheme: HTTPS
Endpoint: https://{{host}}/v3/catalog/taxes/rules

Try out Fynd Konnect's Fetch Tax Rule IDs Endpoint


Common Request Headers

HeaderMandatoryDescription
x-access-tokenYesAccess token used for authenticating API requests to Fynd Konnect
Content-TypeYesapplication/json
Use Cases
  • Retrieve all tax rules to populate product creation form dropdowns
  • Filter active tax rules for assigning to new products
  • Search for specific tax rules by name
  • Understand tax rate structures and slabs for different product price ranges
  • Identify current and future tax rule versions for tax planning
  • Sync tax configuration data between your ERP/WMS and Fynd Commerce

Query Parameters

statusstring

Filter tax rules by rule status (e.g., ACTIVE, INACTIVE)

version_statusstring

Filter by version status (e.g., CURRENT, FUTURE, EXPIRED)

rule_namestring

Search query to filter tax rules by name (partial match supported)

page_numberinteger>= 1

Page number for pagination (default: 1)

page_sizeinteger[ 1 .. 200 ]

Number of items to retrieve per page (default: 10)

Filtering Tips
  • Use status=ACTIVE to retrieve only currently active tax rules for product assignment
  • Use version_status=CURRENT to get tax rules with versions active today
  • Search by rule_name to find specific tax rules quickly (e.g., "GST 12%")
  • Leave filters empty to retrieve all tax rules across all statuses
  • Cache tax rule data as it changes infrequently (usually quarterly or annually)

Success Response

itemsArray of objects

List of tax rules with their versions and configurations

page_numberinteger

Current page number in the paginated response

page_sizeinteger

Number of items returned in this page

totalinteger

Total number of tax rules available matching the query

API Call Example

curl -i -X GET \
  'https://fyndkonnect.konnect.uat.fyndx1.de/v3/catalog/taxes/rules?status=string&version_status=string&rule_name=string&page_number=1&page_size=1' \
  -H 'x-access-token: YOUR_API_KEY_HERE'

Example Response

{
  "items": [
    {
      "rule": {
        "rule_id": "tax_rule_12345",
        "name": "Tiered Tax Rule 7 – 3% and 5%",
        "description": "Tax rule for clothing items",
        "status": "ACTIVE",
        "is_default": false,
        "created_on": "2023-01-15T10:30:00Z",
        "modified_on": "2023-12-01T15:45:00Z"
      },
      "versions": [
        {
          "_id": "version_67890",
          "company_id": 26049,
          "applicable_date": "2023-01-01T00:00:00Z",
          "status": "ACTIVE",
          "version_status": "CURRENT",
          "components": [
            {
              "name": "GST",
              "slabs": [
                {
                  "value": 0.0,
                  "rate": 0.03
                },
                {
                  "value": 1000.0,
                  "rate": 0.05
                }
              ]
            }
          ],
          "created_on": "2023-01-15T10:30:00Z",
          "modified_on": "2023-12-01T15:45:00Z"
        }
      ]
    }
  ],
  "page_number": 1,
  "page_size": 10,
  "total": 15
}

Understanding Tax Rule Structure

Rule vs. Version

  • Rule: The top-level tax configuration with a unique rule_id and name
  • Versions: Time-bound configurations of the rule with specific effective dates and rate structures

Version Status Types

Status Description
CURRENTVersion is active and applicable for the current date range
FUTUREVersion is scheduled to become active on a future date (tax rate changes)
EXPIREDVersion was active in the past but has been superseded by a newer version

Best Practices

  1. Cache tax rule data: Tax rules change infrequently (usually quarterly or annually); implement caching to reduce API calls
  2. Use active rules only: Filter for status=ACTIVE when assigning tax rules to products
  3. Check version status: Use version_status=CURRENT to get tax rules applicable today
  4. Store rule IDs: Save rule_id values in your system for efficient product creation and updates
  5. Understand rate slabs: Review the components.slabs array to understand how tax rates vary by price
  6. Plan for future versions: Monitor FUTURE versions to prepare for upcoming tax rate changes
  7. Coordinate with finance: Always validate tax rule assignments with your finance or compliance team
  8. Handle multi-component taxes: Some rules may have multiple components (CGST, SGST, IGST); ensure your system handles this
Next Steps
© 2026 Shopsense Retail Technologies | MadeInIndia