Configuration and Content API Guide

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

Detail that Identifies that who made the change

Tax Class object of the organization

Root Schema : TaxClassCURequestBody

Type: object

Model for Tax Class Object

Show Source

dataExtensions: array dataExtensions

An array of data extensions for the tax class
hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 2
name(required): object TranslatedString_Name

Additional Properties Allowed: additionalProperties

A group of translated names
objectNum(required): integer

Object Number of the family group

Example: 1
taxes: 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
        },
        "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
                    }
                }
            }
        },
        "dataExtensions":{
            "description":"An array of data extensions for the tax class",
            "type":"array",
            "items":{
                "properties":{
                    "columnName":{
                        "description":"Name of the extension field",
                        "type":"string",
                        "example":"extension column 1"
                    },
                    "value":{
                        "description":"Value of the extension field",
                        "type":"string",
                        "example":"Value1"
                    }
                }
            }
        }
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the tax class

Show Source

Array of: object items

{
    "description":"An array of data extensions for the tax class",
    "type":"array",
    "items":{
        "properties":{
            "columnName":{
                "description":"Name of the extension field",
                "type":"string",
                "example":"extension column 1"
            },
            "value":{
                "description":"Value of the extension field",
                "type":"string",
                "example":"Value1"
            }
        }
    }
}

Nested Schema : TranslatedString_Name

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "description":"A group of translated names",
    "example":{
        "en-US":"Family Group 1",
        "de-DE":"Familiengruppe 1",
        "es-MX":"Grupo Familiar 1"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of translated names

Example:

{
    "en-US":"Family Group 1",
    "de-DE":"Familiengruppe 1",
    "es-MX":"Grupo Familiar 1"
}

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

columnName: string

Name of the extension field

Example: extension column 1
value: string

Value of the extension field

Example: Value1

{
    "properties":{
        "columnName":{
            "description":"Name of the extension field",
            "type":"string",
            "example":"extension column 1"
        },
        "value":{
            "description":"Value of the extension field",
            "type":"string",
            "example":"Value1"
        }
    }
}

Nested Schema : items

Type: object

Show Source

taxObjNum: integer

Object Number of the tax

Example: 1

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

Response

Supported Media Types

application/json

200 Response

Tax Class object of the organization

Root Schema : TaxClassResponse

Type: object

Model for the response

Show Source

hierUnitId(required): integer

Unique hierarchy unit value

Example: 1
objectNum(required): 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

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): 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",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "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"
        }
    }
}