Jump to

• Request
• Response

Get Tax Rates

post

/config/sim/v1/sales/gettaxrates

Gets all the tax rates.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef(optional): string(string)
  Detail that Identifies that who made the change
• Simphony-OrgShortName: string(string)
  Org Identifier

Body ()

A request body

Root Schema : TaxRatesGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy(optional): string
  Sorts the response by the specified field name and sort order.
• searchCriteria(optional): string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "description":"Sorts the response by the specified field name and sort order.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of tax rate entities in an organization.

Body ()

Root Schema : Tax

Type: object

Model for TaxObject

Show Source

• breakpoints(optional): array breakpoints
  An array of breakpoints configured for the tax rate Applicable only if type = 1
• effGrpName(optional): object TranslatedString_EffGrpName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the effectivity group associated with the tax rate in configured languages.
• effGrpObjNum(optional): integer
  Object number of the effectivity group associated with the tax rate

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

  Example: 2
• hierUnitName(optional): object TranslatedString_HierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(optional): integer
  Object number of the hierarchy unit

  Example: 1
• name: object TranslatedString_Name
  A group of string objects representing the name of the tax in configured languages
• objectNum: integer
  Object Number of the family group

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

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

  Example: 32
• repeatGroup(optional): 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
• repeatStart(optional): integer
  The field (1-32) when the incrementing pattern begins. Applicable only if type =1

  Example: 1
• start(optional): integer
  Example: 1
• taxLabel(optional): string
  Tax Code for the tax rate

  Example: aaa
• type(optional): integer
  The Tax Rate type 0 - Disabled for Tax Rates that are not in use. 1 ??? Add On Breakpoint 2 ??? Add On Percentage 3 ??? Included, Percentage 4 - Surcharge

  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
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "$ref":"#/definitions/TranslatedString_HierUnitName"
        },
        "objectNum":{
            "description":"Object Number of the family group",
            "type":"integer",
            "example":1
        },
        "name":{
            "$ref":"#/definitions/TranslatedString_Name"
        },
        "type":{
            "description":"The Tax Rate type 0 - Disabled for Tax Rates that are not in use. 1 ??? Add On Breakpoint 2 ??? Add On Percentage 3 ??? Included, Percentage 4 - Surcharge",
            "type":"integer",
            "example":1
        },
        "start":{
            "type":"integer",
            "example":1
        },
        "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
        },
        "repeatGroup":{
            "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
        },
        "effGrpName":{
            "$ref":"#/definitions/TranslatedString_EffGrpName"
        }
    }
}

Nested Schema : breakpoints

Type: array

An array of breakpoints configured for the tax rate Applicable only if type = 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
            }
        }
    }
}

Nested Schema : TranslatedString_EffGrpName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the effectivity group associated with the tax rate in configured languages.",
    "type":"object",
    "example":{
        "en-US":"Family Group 1",
        "es-SS":"Grupo familiar 1",
        "lt=LT":"1 ??eimos grup??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the effectivity group associated with the tax rate in configured languages.

Example:

{
    "en-US":"Family Group 1",
    "es-SS":"Grupo familiar 1",
    "lt=LT":"1 ??eimos grup??"
}

Nested Schema : TranslatedString_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "example":{
        "en-US":"Enterprise",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : TranslatedString_Name

Type: object

A group of string objects representing the name of the tax in configured languages

Example:

{
    "en-US":"Family Group 1",
    "es-SS":"Grupo familiar 1",
    "lt=LT":"1 ??eimos grup??"
}

Nested Schema : items

Type: object

Show Source

• breakpoint(optional): integer
  Tax Breakpoint

  Example: 1
• index(optional): 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
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top