Jump to

• Request
• Response

Update Tax Parameters

post

/config/sim/v1/sales/updatetaxparameters

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

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string(string)
  Detail that Identifies that who made the change

Body ()

Tax Parameter object of the organization

Root Schema : TaxParametersCURequestBody

Type: object

Model for Tax Parameter object.

Show Source

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

  Example: 2
• internationalOptions: string
  A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the currency parameter

  Example: 00000000000000000000000000000000
• options: string
  A string value of 0s & 1s of length 9 representing the enablement or disablement of the options associated with the tax parameter

  Example: 000000000
• printVATLineForTaxRates: string
  A string value of 0s & 1s of length 64 representing the enablement / disablement of printing the VAT lines for the tax rates.

  Example: 0000000001011110000000000000000000000000000000000000000000000000

{
    "description":"Model for Tax Parameter object.",
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":2
        },
        "internationalOptions":{
            "description":"A string value of 0s & 1s of length 32 representing the enablement or disablement of the options associated with the currency parameter",
            "type":"string",
            "example":"00000000000000000000000000000000"
        },
        "options":{
            "description":"A string value of 0s & 1s of length 9 representing the enablement or disablement of the options associated with the tax parameter",
            "type":"string",
            "example":"000000000"
        },
        "printVATLineForTaxRates":{
            "description":"A string value of 0s & 1s of length 64 representing the enablement / disablement of printing the VAT lines for the tax rates.",
            "type":"string",
            "example":"0000000001011110000000000000000000000000000000000000000000000000"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Tax Parameters object of the organization

Body ()

Root Schema : TaxParameterResponse

Type: object

Model for the tax Parameter response

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit value

  Example: 1

{
    "description":"Model for the tax Parameter response",
    "type":"object",
    "required":[
        "hierUnitId"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit value",
            "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"
        }
    }
}

Back to Top