Jump to

• Request
• Response

Get Tax Classes

post

/config/sim/v1/sales/gettaxclasses

Gets all the tax classes

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body

Root Schema : TaxClassGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include: string
  Objects included in response
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned
• limit: integer
  If using paging, number of results returned in this page.
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy: string
  Sorts the response by the specified field name and sort order.
• searchCriteria: 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"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "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 class entities in an organization.

Body ()

Root Schema : TaxClassGetResponse

Type: object

Model for Tax Class Object

Show Source

• dataExtensions(required): array dataExtensions
  An array of data extensions for the Tax Class
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

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

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

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

{
    "description":"Model for Tax Class Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "hierUnitObjNum",
        "hierUnitName",
        "objectNum",
        "name",
        "taxes",
        "dataExtensions"
    ],
    "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
                    }
                }
            }
        },
        "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_HierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"Unternehmen",
        "es-MX":"Empresa"
    },
    "additionalProperties":{
        "type":"string"
    }
}

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

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

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
        }
    }
}

400 Response

400 Bad Request

Body ()

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"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top