Get tax by id
GET/v2/taxes/:id
Get tax by id
Request
Path Parameters
id stringrequired
Tax id
Responses
- 200
- 400
- 401
- 403
- 404
- 500
Get tax by id
- application/json
- Schema
- Example (from schema)
Schema
id uuidrequired
Possible values: >= 36 characters
and <= 36 characters
Tax primary identifier
shopId integerrequired
Shop identifier for the tax to apply to
code stringnullable
Possible values: [H
, L
, N
]
Tax code
zone stringrequired
Possible values: <= 2 characters
Tax zone
percentage decimalnullable
Default value: 0
Tax percentage
exportCode stringnullable
Possible values: <= 10 characters
Tax export code
createdAt date-timerequired
Default value: CURRENT_TIMESTAMP
Tax initial creation timestamp
createdBy integernullable
Reference to the user that created the tax initially
lastModifiedAt date-timerequired
Default value: CURRENT_TIMESTAMP
Tax last update timestamp
lastModifiedBy integernullable
Reference to the user that last modified the tax
{
"id": "8bcacf9d-36a2-48d5-b713-eedb4eb8c28b",
"shopId": 1,
"code": "H",
"zone": "NL",
"percentage": 21.5,
"exportCode": "NL_H",
"createdAt": "2314-03-14T03:14:15.926Z",
"createdBy": 1234,
"lastModifiedAt": "2314-03-14T03:14:15.926Z",
"lastModifiedBy": 1234
}
Bad request
Unauthorized
- application/json
- Schema
- invalid_client_id
- invalid_client_cred
Schema
any
{
"ErrorCode": "invalid_client",
"Error": "ClientId is Invalid"
}
{
"ErrorCode": "invalid_client",
"Error": "Client credentials are invalid"
}
Forbidden.
Tax not found
Get tax error
Loading...