Chapter 4.2.3 - Override File

What is an Override file?

The Override file is used to modify tax rates for a specified jurisdiction, alter the tax logic (how or when the tax is applied) for a Transaction/Service pair, and add or remove taxes from a Transaction/Service pair.

The Override file is made up of:

  • A version number of the Override file
  • The override being applied, including tax type, PCode for the jurisdiction, and effective date
  • A history of updates made in the AFC Tax Engine

Creating the Override file

The only way to create an Override file is through the AFC Rate and Logic Modifier (RLM) within the desktop AFC Manager application. Contact your Customer Account Manager (CAM) for more details.

Override files use a *.ovr file extension.

Sample

For this example, the Override file is overriding the local (Tax Level 3) Sales Tax (Tax Type 1) in Overland Park, KS to a rate of 0.123.

3.4
1248900,1,3,3,3,1
20180101,1
0.123,2147483647,0,0,0,0
19990401,1
0.01125,2147483647,0,0,0,0
19000101,1
0.01,2147483647,0,0,0,0

Using the Override file

The Override file is applied to a client profile. You must pass the associated client_profile_id as part of the header to use the Override file.

Nothing special needs to be included in the transaction for the Override file to be applied. Simply run a transaction with the applicable client_profile_id. Remove any instances of the Tax Override object (ovr) that may be included in the transaction.
For example, the local Sales Tax for Overland Park, KS is overridden to 0.123 in this transaction, assuming a client profile is in use that has been updated with an Override file overriding the local Sales Tax.

{
  "cmpn": {
    "bscl": 1,
    "svcl": 1,
    "fclt": true,
    "frch": true,
    "reg": true
  },
  "inv": [
    {
      "bill": {
        "ctry": "USA",
        "st": "KS",
        "cty": "Overland Park",
        "zip": 66212
      },
      "cust": 1,
      "date": "2018-09-24T11:00:00",
      "itms": [
        {
          "chg": 100,
          "line": 10,
          "sale": 1,
          "tran": 19,
          "serv": 6
        }
      ]
    }
  ]
}
PreviousNext