Log in

Tax Module

AggregateSalesReportTaxData

Model

This class aggregates and refreshes sales tax report statistics for the last 25 hours. Developers would use this to update tax reporting data, typical...

Api\Data\AppliedTaxInterface

Interface

This interface defines the contract for representing tax that has been applied to an order item or total in Magento 2. Developers use this when workin...

Api\Data\AppliedTaxRateInterface

Interface

This interface defines the contract for representing a tax rate that has been applied to an order, quote, or invoice item in Magento 2. Developers use...

Api\Data\Converter

Model

This class converts between Magento's internal tax models (database models) and API data models (DTOs) for order taxes and tax items. Developers use i...

Api\Data\GrandTotalDetailsInterface

Interface

This interface defines the contract for grand total tax details in Magento 2. Developers use this to access tax information including the tax amount,...

Api\Data\GrandTotalRatesInterface

Interface

This interface defines the structure for tax rate data used in grand total calculations. Developers use this when working with checkout or order total...

Api\Data\OrderTaxDetailsAppliedTaxInterface

Interface

This interface defines the contract for representing applied tax details on orders in Magento 2. Developers use this when retrieving or manipulating t...

Api\Data\OrderTaxDetailsInterface

Interface

This interface defines the contract for accessing comprehensive tax details of an order in Magento 2. Developers use it to retrieve applied taxes at t...

Api\Data\OrderTaxDetailsItemInterface

Interface

This interface defines the contract for representing tax details of individual items within an order, such as products, shipping, or gift wrapping. De...

Api\Data\OrderTaxInterface

Interface

This interface defines the data structure for tax information applied to orders in Magento 2. Developers use this when working with order tax data thr...

Api\Data\OrderTaxItemInterface

Interface

This interface defines the data structure for tax items applied to order items in Magento 2. Developers use it to access and manipulate tax details fo...

Api\Data\QuoteDetailsInterface

Interface

This interface defines the contract for quote details data used in tax calculations. Developers use it when calculating taxes for shopping cart items,...

Api\Data\QuoteDetailsItemInterface

Interface

This interface defines the contract for representing individual line items in a quote when calculating taxes in Magento 2. Developers use this when wo...

Api\Data\TaxClassInterface

Interface

This interface defines the contract for tax class data objects in Magento 2. Developers use this to work with tax classes (like customer tax classes o...

Api\Data\TaxClassKeyInterface

Interface

This interface defines the structure for tax class identifiers in Magento 2. Developers use it when working with tax calculations to reference tax cla...

Api\Data\TaxClassSearchResultsInterface

Interface

This interface defines the contract for search results when querying tax classes in Magento 2. Developers use this when implementing repository method...

Api\Data\TaxDetailsInterface

Interface

This interface defines the contract for tax calculation details in Magento 2. Developers use it when working with tax calculations to access informati...

Api\Data\TaxDetailsItemInterface

Interface

This interface defines the structure for detailed tax information about individual items (products, shipping, etc.) in an order or quote. Developers u...

Api\Data\TaxRateInterface

Interface

This interface defines the structure for tax rate data objects in Magento 2's tax system. Developers use it to create, read, and manipulate tax rate e...

Api\Data\TaxRateSearchResultsInterface

Interface

This interface defines the contract for search results when querying tax rates in Magento 2. Developers use this when working with the Tax Rate reposi...

Api\Data\TaxRateTitleInterface

Interface

This interface defines the contract for tax rate title data objects in Magento 2. Developers use it to manage store-specific titles/labels for tax rat...

Api\Data\TaxRuleInterface

Interface

This interface defines the contract for tax rule data objects in Magento 2. Developers use it when working with tax rules that determine which tax rat...

Api\Data\TaxRuleSearchResultsInterface

Interface

This interface defines the contract for search results when querying tax rules in Magento 2. Developers use this when retrieving multiple tax rules th...

Api\OrderTaxManagementInterface

Interface

This interface defines the contract for retrieving tax details applied to an order in Magento 2. Developers use this interface to get comprehensive ta...

Api\TaxAddressManagerInterface

Interface

This interface defines methods for managing default tax addresses in the customer session. Developers would implement this interface to handle setting...

Api\TaxCalculationInterface

Interface

This interface defines the contract for tax calculation operations in Magento 2. Developers use it to calculate taxes on quote items, retrieve default...

Api\TaxClassManagementInterface

Interface

This interface defines the contract for managing tax class identification in Magento 2. Developers use it to retrieve tax class IDs based on tax class...

Api\TaxClassRepositoryInterface

Repository

This repository interface defines methods for managing tax classes in Magento 2, which are used to categorize products and customers for tax calculati...

Api\TaxRateManagementInterface

Interface

This interface defines the contract for retrieving applicable tax rates based on customer and product tax class IDs. Developers use this when they nee...

Api\TaxRateRepositoryInterface

Repository

This interface defines the contract for managing tax rate entities in Magento 2. Developers use this repository to create, read, update, and delete ta...

Api\TaxRuleRepositoryInterface

Repository

This interface defines the contract for managing tax rules in Magento 2, providing CRUD operations to create, read, update, and delete tax rule entiti...

App\Action\ContextPlugin

Model

This plugin intercepts controller actions to set tax rate information in the HTTP context for logged-in customers when page caching is enabled. It ens...

Calculation

Model

This class handles all tax calculation operations in Magento 2, including determining applicable tax rates based on customer location, product tax cla...

Calculation\AbstractAggregateCalculator

Model

This abstract base class provides the core tax calculation logic for aggregate tax calculations in Magento 2. It handles calculating taxes both when p...

Calculation\AbstractCalculator

Model

This abstract base class provides core tax calculation functionality for quote items in Magento 2. Developers would extend this class when implementin...

Calculation\GrandTotalDetails

Model

This class represents tax details for order/quote grand totals, storing information about tax amounts, tax group IDs, and applicable tax rates. Develo...

Calculation\GrandTotalRates

Model

This class represents individual tax rate information within the grand total calculation, storing the tax rate title and percentage. Developers use th...

Calculation\Rate

Model

This model manages tax rate data in Magento 2, including country, region, postcode/ZIP code ranges, and percentage rates. Developers use this class to...

Calculation\RateRegistry

Model

This class serves as an in-memory registry/cache for tax rate models in Magento 2. Developers use it to store, retrieve, and remove tax rate instances...

Calculation\RateRepository

Model

This repository class manages CRUD operations for tax rate entities in Magento 2. Developers use it to create, retrieve, update, and delete tax rates...

Calculation\Rate\Converter

Model

This converter class transforms tax rate data between different formats in Magento 2. Developers use it to convert TaxRateInterface data objects to ar...

Calculation\Rate\Title

Model

This model manages store-specific titles/labels for tax rates in Magento 2. Developers use this class when they need to display different tax rate nam...

Calculation\RowBaseCalculator

Model

This class calculates tax amounts using row-based calculation method, where tax is calculated on the entire row total rather than unit price. Develope...

Calculation\Rule

Model

This class manages tax calculation rules in Magento 2, which define how taxes are calculated by associating customer tax classes, product tax classes,...

Calculation\Rule\Validator

Model

This validator class ensures that Tax Calculation Rules have all required fields and valid data before being saved. Developers use it when creating or...

Calculation\TaxRuleRegistry

Model

This class acts as a registry (cache) for tax rule models, storing them in memory to avoid repeated database queries. Developers use this when they ne...

Calculation\TotalBaseCalculator

Model

This class calculates tax totals using a base calculation method that applies delta rounding to ensure accurate tax amounts across multiple line items...

Calculation\UnitBaseCalculator

Model

This calculator handles tax calculations on a per-unit basis for quote items in Magento 2. Developers use this class when tax needs to be calculated f...

ClassModel

Model

This model represents tax classes in Magento 2, which categorize customers and products for tax calculation purposes. Developers use this class to cre...

ClassModelRegistry

Model

This class serves as a registry (cache) for tax class models in Magento 2, storing loaded tax classes in memory to avoid redundant database queries. D...

Config

Model

This class manages all tax configuration settings for Magento 2, including whether prices include tax, how taxes should be displayed in the cart and o...

Config\Notification

Model

This class handles tax configuration notifications in Magento 2. When tax-related configuration settings are saved and changed, it automatically reset...

Config\Price\IncludePrice

Model

This model handles the configuration value for tax price inclusion settings in Magento. When the tax price inclusion configuration is saved, it automa...

Config\Source\Basedon

Model

This class provides configuration options for determining which address should be used as the basis for tax calculation in Magento 2. Developers would...

Config\Source\Catalog

Model

This class provides configuration options for how product prices are displayed in relation to taxes in the Magento catalog. Developers use this as a s...

Config\TaxClass

Model

This class handles the configuration for the default product tax class setting in Magento's admin panel. When an admin changes the default tax class c...

Data

Helper

This helper class provides tax-related configuration and utility methods throughout Magento 2. Developers use it to check tax display settings (includ...

Layout\DepersonalizePlugin

Model

This plugin manages tax-related customer data depersonalization for full page cache. It temporarily stores and restores customer tax addresses and tax...

Model\Calculation\CalculatorFactory

Factory

This factory class creates different types of tax calculators based on the calculation method configured in Magento (unit-based, row-based, or total-b...

Model\Calculation\RateFactory

Factory

This factory class creates instances of Tax Rate models (Magento\Tax\Model\Calculation\Rate). Developers use this when they need to programmatically c...

Model\ResourceModel\Calculation\Collection

Collection

This collection class is used to retrieve and manipulate multiple tax calculation records from the database. Developers use this when they need to fet...

Model\ResourceModel\Report\Collection

Collection

This collection class retrieves and aggregates tax report data from the tax_order_aggregated_created table. Developers use it in the Magento admin pan...

Model\ResourceModel\TaxClass\Collection

Collection

This collection class retrieves and manages tax class records from the database. Developers use it to fetch tax classes (like customer tax classes or...

Model\System\Message\NotificationInterface

Interface

This marker interface identifies system messages related to tax configuration issues in Magento 2. Developers implement this interface when creating n...

Model\TaxClass\Factory

Factory

This factory class creates tax class type objects (Customer or Product) based on a given tax class model. Developers use it when they need to instanti...

Model\TaxClass\Type\TypeInterface

Interface

This interface defines the contract for tax class types in Magento 2, which represent categories that tax rules can be applied to (like product tax cl...

Model\TaxRateCollection

Collection

This collection class manages tax rate data for display in the Magento admin grid. It fetches tax rates from the TaxRateRepository and converts them i...

Model\TaxRuleCollection

Collection

This collection class provides a service-based approach to loading and managing tax rules for display in admin grids. Developers use it when they need...

Quote\GrandTotalDetailsPlugin

Model

This plugin enriches the shopping cart tax totals with detailed breakdowns of tax rates and amounts for API responses. Developers use this when they n...

Quote\ToOrderConverter

Model

This class is a plugin for the Quote Address to Order conversion process that transfers tax-related data from a quote to an order. Developers would en...

Rate\Provider

Model

This class provides tax rates from the repository as formatted option arrays suitable for dropdown/select elements in the admin panel or frontend form...

Rate\Source

Model

This class provides a source model for tax rates in Magento 2, converting tax rate data into an options array format suitable for dropdown/select elem...

ResourceModel\Calculation

Model

This resource model handles database operations for tax calculations in Magento 2. Developers use this class to retrieve tax rates based on customer l...

ResourceModel\Calculation\Rate

Model

This resource model manages database operations for tax calculation rates in Magento 2. Developers use this class to perform CRUD operations on tax ra...

ResourceModel\Calculation\Rule

Model

This resource model manages database operations for tax calculation rules in Magento 2. Developers use it to retrieve tax rule codes based on specific...

ResourceModel\Report\Tax

Model

This resource model aggregates tax report data from order information in Magento 2. Developers use this class to generate summarized tax statistics ba...

ResourceModel\TaxClass

Model

This resource model manages database operations for tax classes in Magento 2. Developers use this class when they need to perform CRUD operations on t...

Sales\Order\Details

Model

This class represents the complete tax details for an order, including all applied taxes and tax information for each order item. Developers use this...

Sales\Order\Tax

Model

This model represents tax information applied to an order in Magento 2. Developers use this class to retrieve and store tax details including tax code...

Sales\Order\TaxManagement

Model

This class retrieves and organizes detailed tax information for an order, including taxes applied to each item, shipping, and other taxable entities....

Sales\Pdf\Grandtotal

Model

This class handles the display formatting of grand total amounts in PDF invoices and credit memos when tax should be shown alongside the grand total....

Sales\Pdf\Shipping

Model

This class handles the display of shipping totals in PDF documents (invoices, credit memos) with proper tax formatting. It determines whether to show...

Sales\Pdf\Subtotal

Model

This class handles the display of subtotal information in PDF documents (invoices, credit memos) for orders with tax considerations. Developers would...

Sales\Pdf\Tax

Model

This class handles the display of tax totals in PDF documents (invoices, credit memos) for sales orders in Magento 2. Developers use this class when c...

Sales\Quote\ItemDetails

Model

This model represents a single item (product, shipping, or other taxable entity) within a quote for tax calculation purposes. Developers use this clas...

Sales\Quote\QuoteDetails

Model

This class serves as a data transfer object (DTO) that holds all quote-related information needed for tax calculations in Magento 2. Developers use it...

System\Message\Notifications

Model

This class manages system notification messages for tax configuration issues in Magento 2. It checks for incompatible tax calculation settings (like d...

TaxAddressManager

Model

This class manages tax-related address information in the customer session. It stores default billing and shipping addresses (country, region, postcod...

TaxCalculation

Model

TaxCalculation is the core model responsible for calculating taxes on quotes and orders in Magento 2. Developers use this class when they need to comp...

TaxClassSearchResults

Model

This class serves as a data container for tax class search results returned by repository search operations. Developers use this when querying for mul...

TaxClass\AbstractType

Model

This abstract base class provides common functionality for tax class types (customer and product) in Magento 2's tax system. Developers extending this...

TaxClass\Key

Model

This class represents a tax class identifier key used to look up or reference tax classes in Magento 2. Developers use it when they need to identify a...

TaxClass\Management

Model

This class manages tax class operations, specifically resolving tax class IDs from different types of identifiers. Developers use this class when they...

TaxClass\Repository

Model

This repository class manages tax class entities in Magento 2, providing CRUD operations for both customer and product tax classes. Developers use thi...

TaxClass\Source\Customer

Model

This class provides customer tax class options for use in dropdown menus and form fields throughout Magento. Developers use this as a source model for...

TaxClass\Source\Product

Model

This class provides product tax class options for use in EAV attribute dropdowns and forms throughout Magento. Developers use this as a source model f...

TaxClass\Type\Customer

Model

This class represents a Customer Tax Class type in Magento 2's tax system. Developers use it to determine if a tax class is assigned to any customer g...

TaxClass\Type\Product

Model

This class represents a product tax class type in Magento's tax system. Developers use it to check if a specific tax class is assigned to any products...

TaxConfigProvider

Model

This class provides tax-related configuration settings for the Magento 2 checkout process. Developers use it to retrieve display preferences for tax c...

TaxDetails\AppliedTax

Model

This class represents applied tax information for a transaction in Magento 2. Developers use it to store and retrieve details about taxes applied to o...

TaxDetails\AppliedTaxRate

Model

This class represents a single tax rate that has been applied to an item or order in Magento 2. Developers use it to access tax rate information such...

TaxDetails\ItemDetails

Model

This class represents detailed tax information for individual items (products, shipping, etc.) in a quote or order. Developers use it to retrieve and...

TaxDetails\TaxDetails

Model

This class represents the complete tax calculation details for a shopping cart or quote, including subtotal, total tax amount, discount compensation,...

TaxRateManagement

Model

This class manages tax rate operations by retrieving applicable tax rates based on customer and product tax class combinations. Developers use this cl...

TaxRateSearchResults

Model

This class serves as a data container for tax rate search results returned from repository queries. Developers use this when retrieving multiple tax r...

TaxRuleRepository

Model

This repository manages tax rules in Magento 2, providing CRUD operations (create, read, update, delete) for tax rules. Developers use this class to p...

TaxRuleSearchResults

Model

This class serves as a data container for tax rule search results returned from repository queries. Developers use this when retrieving multiple tax r...