Create tax
curl --request POST \
--url https://staging-api.tyms.io/v1/adam/taxes \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "VAT",
"percentage": 7.5,
"currency": "NGN",
"is_deduction": false,
"payable_account": "VAT Payable",
"receivable_account": "VAT Receivable"
}
'import requests
url = "https://staging-api.tyms.io/v1/adam/taxes"
payload = {
"name": "VAT",
"percentage": 7.5,
"currency": "NGN",
"is_deduction": False,
"payable_account": "VAT Payable",
"receivable_account": "VAT Receivable"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'VAT',
percentage: 7.5,
currency: 'NGN',
is_deduction: false,
payable_account: 'VAT Payable',
receivable_account: 'VAT Receivable'
})
};
fetch('https://staging-api.tyms.io/v1/adam/taxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Tax created successfully",
"data": {
"id": "a1b2c3d4e5f6478990abcdef12345678",
"uuid": "a1b2c3d4e5f6478990abcdef12345678",
"name": "VAT",
"label": "VAT (7.5%)",
"percentage": 7.5,
"currency": "NGN",
"is_deduction": false,
"payable_account": "VAT Payable",
"receivable_account": "VAT Receivable"
}
}{
"status": "failed",
"message": "The date field is required. The currency field is required.",
"errors": [
{
"field": "date",
"message": "The date field is required."
},
{
"field": "currency",
"message": "The currency field is required."
}
],
"data": {
"date": [
"The date field is required."
],
"currency": [
"The currency field is required."
]
}
}Taxes
Create tax
Create a sales tax or, with is_deduction: true, a withholding tax. percentage is the human rate (7.5 for 7.5%). The payable account for sales tax must be an Expenses account and the receivable account a Liabilities account. For withholding tax those are reversed: payable is Liabilities and receivable is Assets. Accounts may be a name, code, or id.
POST
/
taxes
Create tax
curl --request POST \
--url https://staging-api.tyms.io/v1/adam/taxes \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "VAT",
"percentage": 7.5,
"currency": "NGN",
"is_deduction": false,
"payable_account": "VAT Payable",
"receivable_account": "VAT Receivable"
}
'import requests
url = "https://staging-api.tyms.io/v1/adam/taxes"
payload = {
"name": "VAT",
"percentage": 7.5,
"currency": "NGN",
"is_deduction": False,
"payable_account": "VAT Payable",
"receivable_account": "VAT Receivable"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'VAT',
percentage: 7.5,
currency: 'NGN',
is_deduction: false,
payable_account: 'VAT Payable',
receivable_account: 'VAT Receivable'
})
};
fetch('https://staging-api.tyms.io/v1/adam/taxes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "success",
"message": "Tax created successfully",
"data": {
"id": "a1b2c3d4e5f6478990abcdef12345678",
"uuid": "a1b2c3d4e5f6478990abcdef12345678",
"name": "VAT",
"label": "VAT (7.5%)",
"percentage": 7.5,
"currency": "NGN",
"is_deduction": false,
"payable_account": "VAT Payable",
"receivable_account": "VAT Receivable"
}
}{
"status": "failed",
"message": "The date field is required. The currency field is required.",
"errors": [
{
"field": "date",
"message": "The date field is required."
},
{
"field": "currency",
"message": "The currency field is required."
}
],
"data": {
"date": [
"The date field is required."
],
"currency": [
"The currency field is required."
]
}
}Authorizations
Body
application/json
Response
Tax created