Jump to

• Request
• Response

Update Tax Classes

post

/config/sim/v1/sales/updatetaxclasses

Updates the tax class. If tax class is not found, it creates a new tax class.

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 ()

Tax Class object of the organization

Root Schema : TaxClass

Type: object

Model for Tax Class Object

Show Source

• 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
• taxes(optional): array taxes
  An array of taxes configured for the tax class

{
    "description":"Model for Tax Class Object",
    "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"
        },
        "taxes":{
            "description":"An array of taxes configured for the tax class",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "taxObjNum":{
                        "description":"Object Number of the tax",
                        "type":"integer",
                        "example":1
                    }
                }
            }
        }
    }
}

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 : taxes

Type: array

An array of taxes configured for the tax class

Show Source

• Array of: object items

{
    "description":"An array of taxes configured for the tax class",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "taxObjNum":{
                "description":"Object Number of the tax",
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• taxObjNum(optional): integer
  Object Number of the tax

  Example: 1

{
    "type":"object",
    "properties":{
        "taxObjNum":{
            "description":"Object Number of the tax",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Tax Class object of the organization

Body ()

Root Schema : TaxClassResponse

Type: object

Model for the response

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the tax class

  Example: 1

{
    "description":"Model for the response",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the tax class",
            "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"
        }
    }
}

Back to Top