Tax Class Properties
Tax Class Properties describes tax class object properties. Tax class objects are referenced from product offers. If taxes are added by a downstream system outside of MATRIXX Engine, some fields are optional as noted.
Property | Description |
---|---|
ID | A unique, positive integer that identifies the tax class type in MATRIXX Engine. |
Name | A descriptive name for the tax class, which gets displayed in the product offer Tax/GST tab in My MATRIXX. The name is also saved to the Event Detail Record (EDR) and can be used to map the information to a tax code in a third-party system. |
External ID | A unique identifier that can be used externally to look up the tax class and map it to a tax code in a third-party system. This value is saved to the EDR. |
Start Date/Time | Optional start date and time. |
Rate (%) | The tax rate is a numeric value from 0 to 100 that represents the percentage of the
charge. The value is copied into applied offer records in EDRs. There is no default value for the rate property. You must set a value for the rate property if the tax class is referenced from an offer for which MATRIXX Engine adds taxes for its charges (the Add Tax property is selected in an offer application profile for charges that use the tax class). If a system outside of MATRIXX Engine adds all taxes for the charges that use the tax class (the tax class is referenced from an offer application profile where the Add Tax property is de-selected (set to false), you do not need to set a value for the rate property. The tax rate might be omitted, for example, in the scenario where an operator sets the tax rate only in the downstream system and has no need to update MATRIXX pricing when the tax rate changes. Note: You can add either a rate percentage or a
fixed tax, not both. |
Fixed Tax | A fixed tax is a fixed numeric value assessed regardless of the charge amount. Note: You can add either a rate percentage or a
fixed tax, not both. |
Is Paid | (Optional) Specifies whether the tax has already been paid. |
Tax Code | (Optional) A string that identifies an additional tax code. |
Tax Recognition Type | Specifies how taxes are to be reported in general ledger (GL) postings. This controls
when the tax is recognized in the general ledger. There is no default value for the tax recognition type property. The options are:
You must set a value for the tax recognition type if both conditions are true:
If the preceding conditions are true and no tax recognition type is specified, an error is logged during rating. The tax recognition type is optional (you can omit the tax recognition type, no value set) if the tax class is referenced from an offer application profile where the Add Tax property is deselected (because a downstream system outside of MATRIXX Engine adds all taxes for the charges that use the tax class). |