Show Source

• breakpoints: array breakpoints
  An array of breakpoints configured for the tax rate Applicable only if type = 1
• effGrpObjNum: integer
  Object number of the effectivity group associated with the tax rate

  Example: 1
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 2
• name(required): object name
  Name
• objectNum(required): integer
  Object Number of the tax rate

  Example: 1
• percent: number
  The tax percentage for the tax rate

  Example: 1
• repeatEnd: integer
  The field (1-32) when the incrementing pattern ends. Applicable only if type =1

  Example: 32
• repeatStart: integer
  The field (1-32) when the incrementing pattern begins. Applicable only if type =1

  Example: 1
• reportGroup: integer
  The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.

  Example: 0
• start: number
  Taxable sales amount that must be reached in a transaction before the tax rate is applied

  Example: 0.5
• taxLabel: string
  Tax Code for the tax rate

  Example: aaa
• type: integer

  Tax Rate Type

  Type	Type Description
  0	Disabled for Tax Rates that are not in use.
  1	Add On Breakpoint
  2	Add On Percentage
  3	Included
  4	Surcharge
  6	Add on, Excludes Start Amount

  Example: 1

{
    "description":"Model for TaxObject",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object Number of the tax rate",
            "type":"integer",
            "example":1
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "en-US":"Family Group 1",
                "de-DE":"Familiengruppe 1",
                "es-MX":"Grupo Familiar 1"
            }
        },
        "type":{
            "description":"\n<p>Tax Rate Type </p>\n<table>\n <tr>\n   <th>Type</th>\n   <th>Type Description</th>\n </tr>\n <tr>\n   <td> 0 </td>\n   <td> Disabled for Tax Rates that are not in use.</td>\n </tr>\n <tr>\n   <td> 1 </td>\n   <td> Add On Breakpoint </td>\n </tr>\n <tr>\n   <td> 2 </td>\n   <td> Add On Percentage </td>\n </tr>\n <tr>\n   <td> 3 </td>\n   <td> Included </td>\n </tr>\n <tr>\n   <td> 4 </td>\n   <td> Surcharge </td>\n </tr>\n <tr>\n   <td> 6 </td>\n   <td> Add on, Excludes Start Amount </td>\n </tr>\n</table>\n",
            "type":"integer",
            "example":1
        },
        "start":{
            "description":"Taxable sales amount that must be reached in a transaction before the tax rate is applied",
            "type":"number",
            "example":0.5
        },
        "percent":{
            "description":"The tax percentage for the tax rate",
            "type":"number",
            "example":1
        },
        "breakpoints":{
            "description":"An array of breakpoints configured for the tax rate Applicable only if type = 1",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "index":{
                        "description":"Tax breakpoint index",
                        "type":"integer",
                        "example":1
                    },
                    "breakpoint":{
                        "description":"Tax Breakpoint",
                        "type":"integer",
                        "example":1
                    }
                }
            }
        },
        "repeatStart":{
            "description":"The field (1-32) when the incrementing pattern begins. Applicable only if type =1",
            "type":"integer",
            "example":1
        },
        "repeatEnd":{
            "description":"The field (1-32) when the incrementing pattern ends. Applicable only if type =1",
            "type":"integer",
            "example":32
        },
        "reportGroup":{
            "description":"The report group number (0-99) for the Tax Rate. If set to 0, the tax rate does not appear on the reports.",
            "type":"integer",
            "example":0
        },
        "taxLabel":{
            "description":"Tax Code for the tax rate",
            "type":"string",
            "example":"aaa"
        },
        "effGrpObjNum":{
            "description":"Object number of the effectivity group associated with the tax rate",
            "type":"integer",
            "example":1
        }
    }
}

Show Source

• Array of: object items

{
    "description":"An array of breakpoints configured for the tax rate Applicable only if type = 1",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "index":{
                "description":"Tax breakpoint index",
                "type":"integer",
                "example":1
            },
            "breakpoint":{
                "description":"Tax Breakpoint",
                "type":"integer",
                "example":1
            }
        }
    }
}

Show Source

• breakpoint: integer
  Tax Breakpoint

  Example: 1
• index: integer
  Tax breakpoint index

  Example: 1

{
    "type":"object",
    "properties":{
        "index":{
            "description":"Tax breakpoint index",
            "type":"integer",
            "example":1
        },
        "breakpoint":{
            "description":"Tax Breakpoint",
            "type":"integer",
            "example":1
        }
    }
}