Catalog.getTaxClasses

Request the Catalog Tax Classes data from the shop system.

Request

JSON Example

[
  {
      "api":1,
      "method":"auth",
      "params":{
         "username":"...",
         "password":"..."
      },
      "id":1
   },
   {
    "api": 1,
    "method": "Catalog.getTaxClasses",
    "params": {},
    "id": 1
  }
]

Response

Response sends all Tax Class records:

[  
   {  
      "api":1,
      "result":[  
        {
        	"taxClassId": 1,
          "name": 'normal',
					"isDefault": true,
          "taxPercent": 18.00
        },
        {
        	"taxClassId": 2,
          "name": 'reduced',
					"isDefault": false,
          "taxPercent": 7.50
        },
      ],
      "id":1
   }
]

Make sure values are properly encoded in the types specified below, as the Sync Agent client will not do any automatic conversion. Using strings instead of integers (eg.: "42" instead of 42), or integers instead of booleans (1 instead of true) will result in a validation error during sync.

Field name

Type

Mandatory

Value

Description

taxClassId

integer

yes

 undefined

id of the tax class in the Shop system

name

varchar(255)

yes

 undefined

name of the tax class

isDefault

bool

yes

is this the default tax class?

taxPercent

decimal(5,2)

yes

 undefined

tax value