Skip to main content

Taxes APIs

In Singapore, Goods and Services Tax (GST) is a broad-based consumption tax imposed on imported goods and almost all supplies of products and services. This tax may also be known as Value-added Tax (VAT) in other countries.

Exported goods and international services are considered Zero-Rated Supplies and are charged at 0%. There are 2 types of taxes - Output tax or Input tax. Output tax is GST to be charged on top of the selling price of your supplies sold to your customers. Input tax is GST incurred on your company’s business purchases and expenses, including imported goods, which are paid to your suppliers.

TaxDto helps to create new taxes, retrieve tax by id or get a list of taxes.

More about Taxes API documentation

API


Search Tax

Get taxes by filter criteria. More about search tax

Description:
  • Allows you to retrieve a list of all taxes.
  • Allows you to retrieve specific taxes based on it's filter criteria.

Get All Taxes

GET

/v1/taxes

Request URL

Taxes API documentation

Parameters
NameLocated inDescriptionRequiredSchema
limitquerylimitNointeger
pagequerypageNointeger
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200Taxes have been fetched successfully.TaxDto
401Unauthorized
403Forbidden
404Not Found

Create Tax

Create a new Tax. More about create tax

Description:
  • Allows you to create new tax.

POST

/v1/taxes

Request URL

Taxes API documentation

Parameters
NameLocated inDescriptionRequiredSchema
taxDtobodytaxDtoYesTaxDto
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
201Created
401Unauthorized
403Forbidden
404Not Found

Retrieve Tax

Get tax by id. More about retrieve tax

Description:
  • Allows you to retrieve a specific tax based on it's id.

GET

Taxes {id}

Request URL

Taxes API documentation

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
401Unauthorized
403Forbidden
404Not Found

Delete Tax

DELETE

/v1/taxes

Summary

Delete Tax.

Description

API to delete tax.

Parameters
NameLocated inDescriptionRequiredSchema
deleteTaxCriteriabodydeleteTaxCriteriaYesDeleteTaxCriteria
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKBulkTaxDeleteResponse
204No Content
401Unauthorized
403Forbidden

Get Standard withholding taxes

GET

Taxes il/standardwht

Summary

Get Standard withholding taxes

Description

API to get All Standard WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All Standard WHT has been fetched successfully.[ WhtResponseIsrael ]
401Unauthorized
403Forbidden
404Standard WHT Records not found

Get Withholding Taxes

GET

Taxes il/wht

Summary

Get Withholding Taxes

Description

API to get All Withholding Taxes

Parameters
NameLocated inDescriptionRequiredSchema
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All WHT has been fetched successfully.[ WhtResponseIsrael ]
401Unauthorized
403Forbidden
404WHT Records not found

Taxes codes

POST

Summary

Taxes Details.

Description

API to get the tax details.

Parameters
NameLocated inDescriptionRequiredSchema
getTaxCriteriabodygetTaxCriteriaYesGetTaxCriteria
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
201Created
401Unauthorized
403Forbidden
404Not Found

Taxes create-tax

POST

Summary

CreateNewTax.

Description

Create new Tax with response type as Tax

Parameters
NameLocated inDescriptionRequiredSchema
taxDtobodytaxDtoYesTaxDto
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
201Created
401Unauthorized
403Forbidden
404Not Found

Taxes method/{method}

PUT

Summary

SIMPLER

Description

Update taxes as per reporting method

Parameters
NameLocated inDescriptionRequiredSchema
methodpathmethodYesstring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKResponseEntity
201Taxes as per BAS reporting method updated successfully.ResponseEntity
400Invalid request to update Taxes
401Unauthorized
403Forbidden
404Not Found

Taxes missing-taxes

POST

Summary

Generate missing taxes.

Description

API to generate missing taxes.

Parameters
NameLocated inDescriptionRequiredSchema
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescription
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

Taxes names

POST

Summary

Taxes Details by name.

Description

API to get the tax details by tax name.

Parameters
NameLocated inDescriptionRequiredSchema
taxNamesbodytaxNamesYes[ string ]
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OK[ TaxDto ]
201Created
401Unauthorized
403Forbidden
404Not Found

Taxes set-default

PATCH

Summary

Update Tax is default value

Description

API to Update Tax is default value

Parameters
NameLocated inDescriptionRequiredSchema
taxIdAndStatusbodytaxIdAndStatusYesobject
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescription
200OK
204No Content
401Unauthorized
403Forbidden

Taxes sg/missing-taxes

POST

Summary

Generate sg missing taxes.

Description

API to generate sg missing taxes.

Parameters
NameLocated inDescriptionRequiredSchema
taxAccountCodeByTenantIdsbodytaxAccountCodeByTenantIdsYesobject
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescription
200OK
201Created
401Unauthorized
403Forbidden
404Not Found

Taxes taxCode

GET

Summary

getByTaxCode

Parameters
NameLocated inDescriptionRequiredSchema
codequerycodeNostring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
401Unauthorized
403Forbidden
404Not Found

Taxes taxid/{taxId}

GET

Summary

Check Used Tax.

Description

API to Check Used Tax.

Parameters
NameLocated inDescriptionRequiredSchema
taxIdpathtaxIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
401Unauthorized
403Forbidden
404Not Found

PUT

Summary

UpdateTax.

Description

API to update a existing tax.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
taxDtobodytaxDtoYesTaxDto
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200Tax information has been updated successfully.TaxDto
201Created
400Tax with same name already exists
401Unauthorized
403Forbidden
404Tax does not exist.

DELETE

Summary

Delete Tax.

Description

API to delete tax.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
204No Content
401Unauthorized
403Forbidden

Taxes {id}/default/{value}

PATCH

Summary

Update Tax is default value

Description

API to Update Tax is default value

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
valuepathvalueYesboolean
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
204No Content
401Unauthorized
403Forbidden

Taxes {id}/status/{status}

PATCH

Summary

Update Tax status.

Description

Update Tax status.

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
statuspathstatusYesstring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
204No Content
401Unauthorized
403Forbidden

Taxes {tenantId}

POST

Summary

Create standard tax rates.

Description

API to create a standard tax rates.

Parameters
NameLocated inDescriptionRequiredSchema
tenantIdpathtenantIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTaxDto
201Created
401Unauthorized
403Forbidden
404Not Found

wht-indonesia-controller

Tax APIs

Taxes id

GET

Summary

Get WHT

Description

API to get WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
residentStatusqueryresidentStatusYesboolean
whtIdquerywhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All WHT has been fetched successfully.WhtResponse
401Unauthorized
403Forbidden
404WHT Records not found

Taxes id/standardwht

GET

Summary

Get all Standard WHT

Description

API to get All Standard WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All Standard WHT has been fetched successfully.[ WhtResponseIndonesia ]
401Unauthorized
403Forbidden
404Standard WHT Records not found

Taxes id/wht

GET

Summary

Get all WHT

Description

API to get All WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All WHT has been fetched successfully.[ WhtResponseIndonesia ]
401Unauthorized
403Forbidden
404WHT Records not found

POST

Summary

Create a new WHT

Description

API to create WHT

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesWhtRequestIndonesia
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKWhtResponseIndonesia
201WHT has been created successfully.WhtResponseIndonesia
400Invalid request to create WHT
401Unauthorized
403Forbidden
404Not Found

Taxes id/wht/{whtId}

PUT

Summary

Update an existing WHT

Description

API to update WHT

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesWhtRequestIndonesia
whtIdpathwhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200WHT has been updated successfully.WhtResponseIndonesia
201Created
400Invalid request to update WHT
401Unauthorized
403Forbidden
404Not Found

DELETE

Summary

Delete WHT Payment

Description

API to dete WHT rate

Parameters
NameLocated inDescriptionRequiredSchema
whtIdpathwhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescription
200OK
204WHT has been deleted successfully.
401Unauthorized
403Forbidden
404Invalid request to fetch WHT payment

wht-israel-controller

Tax APIs

Taxes il

GET

Summary

Get WHT

Description

API to get WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
whtBusinessTypequerywhtBusinessTypeYesstring
whtIdquerywhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All WHT has been fetched successfully.WhtResponse
401Unauthorized
403Forbidden
404WHT Records not found

POST

Summary

Create a new WHT

Description

API to create WHT

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesWhtRequestIsrael
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKWhtResponseIsrael
201WHT has been created successfully.WhtResponseIsrael
400Invalid request to create WHT
401Unauthorized
403Forbidden
404Not Found

Taxes il/wht/{whtId}

PUT

Summary

Update an existing WHT

Description

API to update WHT

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesWhtRequestIsrael
whtIdpathwhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200WHT has been updated successfully.WhtResponseIsrael
201Created
400Invalid request to update WHT
401Unauthorized
403Forbidden
404Not Found

DELETE

Summary

Delete WHT Payment

Description

API to dete WHT rate

Parameters
NameLocated inDescriptionRequiredSchema
whtIdpathwhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescription
200OK
204WHT has been deleted successfully.
401Unauthorized
403Forbidden
404Invalid request to fetch WHT payment

tds-india-controller

Tax APIs

Taxes in/tds

GET

Summary

Get all TDS for a tenant

Description

API to get All TDS for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All TDS has been fetched successfully.[ TdsResponseIndia ]
401Unauthorized
403Forbidden
404TDS Records not found

POST

Summary

Create a new TDS

Description

API to create TDS

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesTdsRequestIndia
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKTdsResponseIndia
201TDS has been created successfully.TdsResponseIndia
400Invalid request to create TDS
401Unauthorized
403Forbidden
404Not Found

PUT

Summary

Update the all requested TDS

Description

API to update the given TDS list

Parameters
NameLocated inDescriptionRequiredSchema
tdsRequestIndiaListbodytdsRequestIndiaListYes[ TdsRequestIndia ]
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200TDS has been updated successfully.[ TdsResponseIndia ]
201Created
400Invalid request to update TDS
401Unauthorized
403Forbidden
404Not Found

Taxes in/tds-master

GET

Summary

Get all Standard TDS

Description

API to get All TDS for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All TDS has been fetched successfully.[ TdsResponseIndia ]
401Unauthorized
403Forbidden
404TDS Records not found

Taxes in/tds/limit

GET

Summary

Get annual exemption limit for a tenant

Description

API to get annual exemption limit for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All Annual Exemption limits for tenant fetched successfully.object
401Unauthorized
403Forbidden
404Failed to fetch annual limit exemption limits for tenant fetched successfully.

Taxes in/tds/{id}

GET

Summary

Get TDS for a tenant

Description

API to get TDS for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
idpathidYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200TDS has been fetched successfully.TdsResponseIndia
401Unauthorized
403Forbidden
404TDS Records not found

Taxes in/tds/{tdsId}

PUT

Summary

Update an existing TDS

Description

API to update TDS

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesTdsRequestIndia
tdsIdpathtdsIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200TDS has been updated successfully.TdsResponseIndia
201Created
400Invalid request to update TDS
401Unauthorized
403Forbidden
404Not Found

DELETE

Summary

Delete TDS Payment

Description

API to dete TDS rate

Parameters
NameLocated inDescriptionRequiredSchema
tdsIdpathtdsIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescription
200OK
204TDS has been deleted successfully.
401Unauthorized
403Forbidden
404Invalid request to fetch TDS payment

wht-philippines-controller

Tax APIs

Taxes ph

GET

Summary

Get WHT

Description

API to get WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
whtBusinessTypequerywhtBusinessTypeYesstring
whtIdquerywhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All WHT has been fetched successfully.WhtResponse
401Unauthorized
403Forbidden
404WHT Records not found

Taxes ph/standardwht

GET

Summary

Get all Standard WHT

Description

API to get All Standard WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
queryqueryqueryNostring
searchquerysearchNostring
sortquerysortNostring
sortDirquerysortDirNostring
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All Standard WHT has been fetched successfully.[ WhtResponsePhilippines ]
401Unauthorized
403Forbidden
404Standard WHT Records not found

Taxes ph/wht

GET

Summary

Get all WHT

Description

API to get All WHT for the tenant

Parameters
NameLocated inDescriptionRequiredSchema
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200All WHT has been fetched successfully.[ WhtResponsePhilippines ]
401Unauthorized
403Forbidden
404WHT Records not found

POST

Summary

Create a new WHT

Description

API to create WHT

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesWhtRequestPhlippines
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200OKWhtResponsePhilippines
201WHT has been created successfully.WhtResponsePhilippines
400Invalid request to create WHT
401Unauthorized
403Forbidden
404Not Found

Taxes ph/wht/{whtId}

PUT

Summary

Update an existing WHT

Description

API to update WHT

Parameters
NameLocated inDescriptionRequiredSchema
requestbodyrequestYesWhtRequestPhlippines
whtIdpathwhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescriptionSchema
200WHT has been updated successfully.WhtResponsePhilippines
201Created
400Invalid request to update WHT
401Unauthorized
403Forbidden
404Not Found

DELETE

Summary

Delete WHT Payment

Description

API to dete WHT rate

Parameters
NameLocated inDescriptionRequiredSchema
whtIdpathwhtIdYeslong
x-access-tokenheaderAccess tokenYesstring
Responses
CodeDescription
200OK
204WHT has been deleted successfully.
401Unauthorized
403Forbidden
404Invalid request to fetch WHT payment

Models

BulkTaxDeleteResponse

NameTypeDescriptionRequired
httpStatusstringHTTP Status
Enum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED"
Example: "404 NOT_FOUND"
No
idlongID
Example: 2
No
reasonstringExample: "NOT FOUND"No

DeleteTaxCriteria

NameTypeDescriptionRequired
taxIdList[ long ]No

GetTaxCriteria

NameTypeDescriptionRequired
taxCodeList[ string ]No

Pageable

NameTypeDescriptionRequired
offsetlongNo
pageNumberintegerNo
pageSizeintegerNo
pagedbooleanNo
sortSortNo
unpagedbooleanNo

Page«TaxDto»

NameTypeDescriptionRequired
content[ TaxDto ]No
emptybooleanNo
firstbooleanNo
lastbooleanNo
numberintegerNo
numberOfElementsintegerNo
pageablePageableNo
sizeintegerNo
sortSortNo
totalElementslongNo
totalPagesintegerNo

ResponseEntity

NameTypeDescriptionRequired
bodyobjectNo
statusCodestringEnum: "100 CONTINUE", "101 SWITCHING_PROTOCOLS", "102 PROCESSING", "103 CHECKPOINT", "200 OK", "201 CREATED", "202 ACCEPTED", "203 NON_AUTHORITATIVE_INFORMATION", "204 NO_CONTENT", "205 RESET_CONTENT", "206 PARTIAL_CONTENT", "207 MULTI_STATUS", "208 ALREADY_REPORTED", "226 IM_USED", "300 MULTIPLE_CHOICES", "301 MOVED_PERMANENTLY", "302 FOUND", "302 MOVED_TEMPORARILY", "303 SEE_OTHER", "304 NOT_MODIFIED", "305 USE_PROXY", "307 TEMPORARY_REDIRECT", "308 PERMANENT_REDIRECT", "400 BAD_REQUEST", "401 UNAUTHORIZED", "402 PAYMENT_REQUIRED", "403 FORBIDDEN", "404 NOT_FOUND", "405 METHOD_NOT_ALLOWED", "406 NOT_ACCEPTABLE", "407 PROXY_AUTHENTICATION_REQUIRED", "408 REQUEST_TIMEOUT", "409 CONFLICT", "410 GONE", "411 LENGTH_REQUIRED", "412 PRECONDITION_FAILED", "413 PAYLOAD_TOO_LARGE", "413 REQUEST_ENTITY_TOO_LARGE", "414 URI_TOO_LONG", "414 REQUEST_URI_TOO_LONG", "415 UNSUPPORTED_MEDIA_TYPE", "416 REQUESTED_RANGE_NOT_SATISFIABLE", "417 EXPECTATION_FAILED", "418 I_AM_A_TEAPOT", "419 INSUFFICIENT_SPACE_ON_RESOURCE", "420 METHOD_FAILURE", "421 DESTINATION_LOCKED", "422 UNPROCESSABLE_ENTITY", "423 LOCKED", "424 FAILED_DEPENDENCY", "426 UPGRADE_REQUIRED", "428 PRECONDITION_REQUIRED", "429 TOO_MANY_REQUESTS", "431 REQUEST_HEADER_FIELDS_TOO_LARGE", "451 UNAVAILABLE_FOR_LEGAL_REASONS", "500 INTERNAL_SERVER_ERROR", "501 NOT_IMPLEMENTED", "502 BAD_GATEWAY", "503 SERVICE_UNAVAILABLE", "504 GATEWAY_TIMEOUT", "505 HTTP_VERSION_NOT_SUPPORTED", "506 VARIANT_ALSO_NEGOTIATES", "507 INSUFFICIENT_STORAGE", "508 LOOP_DETECTED", "509 BANDWIDTH_LIMIT_EXCEEDED", "510 NOT_EXTENDED", "511 NETWORK_AUTHENTICATION_REQUIRED"No
statusCodeValueintegerNo

Sort

NameTypeDescriptionRequired
emptybooleanNo
sortedbooleanNo
unsortedbooleanNo

Tax

NameTypeDescriptionRequired
accountCodestringNo
additionalTaxInbooleanNo
basReportingstringNo
categorystringEnum: "SYSTEM", "CUSTOM"No
codestringNo
createdAtdateTimeNo
createdBylongNo
defaultMemoBEstringNo
defaultMemoDestringNo
defaultMemoNLstringNo
defaultMemoUkstringNo
deletedbooleanNo
descriptionstringNo
effectiveEndDatedateTimeNo
effectiveStartDatedateTimeNo
flatRateSchemeUkbooleanNo
idlongNo
isDefaultbooleanNo
isTaxGroupbooleanNo
namestringNo
netAmountBeforestringNo
netAmountBeforeBEstringNo
netAmountBeforeNLstringNo
netAmountDestringNo
netAmountUkstringNo
percentnumberNo
showInReportsIDbooleanNo
statusstringNo
taxAccountCodestringNo
taxAgencyCanstringNo
taxAmountDestringNo
taxAmountInstringNo
taxAmountInBEstringNo
taxAmountInNLstringNo
taxAmountUkstringNo
taxCodestringNo
taxGroupDetails[ TaxGroupDetails ]No
taxSectionAusstringEnum: "DEFAULT_GST=Default GST", "EXPORT_SALES=Export Sales", "OTHER_GST=Other GST-free sales", "INPUT_TAX_SALES=Input Taxed Sales", "CAPITAL_PURCHASES=Capital purchases", "NONCAPITAL_PURCHASES=Non-capital purchases", "INPUT_TAX_PURCHASES=Input Tax Purchases", "EXCLUDED_FROM_BAS=Excluded from BAS"No
taxSectionSARstringNo
tenantIdlongNo
typestringEnum: "SALES", "PURCHASE", "BOTH"No
updatedAtdateTimeNo
updatedBylongNo

TaxDto

NameTypeDescriptionRequired
accountCodestringAccount code
Example: "AC-001"
No
additionalTaxInbooleanTRUE/FALSE
Example: false
No
basReportingstringReporting Method
Example: "BOTH"
No
codestringTax code
Example: "TC-001"
No
defaultMemoBEstringDefault memo
Example: "Memo"
No
defaultMemoDestringDefault Memo Germany
Example: "memo"
No
defaultMemoNLstringDefault memo
Example: "Momo"
No
defaultMemoUkstringDefault Memo UK
Example: "memo"
No
deletedbooleanTax deleted
Example: false
No
descriptionstringDescription
Example: "sales Tax for SG"
No
effectiveEndDatedateTimeEffective end date of the tax
Example: "2023-12-31"
No
effectiveStartDatedateTimeEffective start date of the tax
Example: "2023-01-01"
No
flatRateSchemeUkbooleanFlat Rate Scheme UK
Example: false
No
isDefaultbooleanIs Default Tax
Example: false
No
isTaxGroupbooleanIs Tax Group
Example: false
No
namestringTax Name
Example: "SGST"
No
netAmountBeforestringNet Amount Before Section
Example: "Box 5,Box 6"
No
netAmountBeforeBEstringNet Amount Before Section
Example: "Box 00,Box 01"
No
netAmountBeforeNLstringNet Amount Before Section
Example: "Box 5,Box 6"
No
netAmountDestringNo
netAmountUkstringNet Amount Before Section
Example: "Box 5,Box 6"
No
percentnumberTax percentage
Example: 7
No
showInReportsIDbooleanFlag to consider in reports
Example: true
No
statusstringTax status
Example: "active"
No
taxAccountCodestringAccount Code
Example: "ACC-0000001"
No
taxAgencyCanstringExample: "British Columbia"No
taxAmountDestringTax Amount In Section
Example: "Box 5,Box 6"
No
taxAmountInstringTax Amount In Section
Example: "Box 5,Box 6"
No
taxAmountInBEstringTax Amount In Section
Example: "Box 54,Box 55"
No
taxAmountInNLstringTax Amount In Section
Example: "Box 5,Box 6"
No
taxAmountUkstringTax Amount In Section
Example: "Box 5,Box 6"
No
taxCodestringTax code
Example: "TC-001"
No
taxGroupDetails[ TaxGroupDetails ]Tax DetailsNo
taxSectionAusstringTax Section
Enum: "DEFAULT_GST=Default GST", "EXPORT_SALES=Export Sales", "OTHER_GST=Other GST-free sales", "INPUT_TAX_SALES=Input Taxed Sales", "CAPITAL_PURCHASES=Capital purchases", "NONCAPITAL_PURCHASES=Non-capital purchases", "INPUT_TAX_PURCHASES=Input Tax Purchases", "EXCLUDED_FROM_BAS=Excluded from BAS"
Example: "DEFAULT_GST"
No
taxSectionSARstringTax Section Name
Example: "Standard rates sales, Standard rated domestic purchase"
No
typestringSALES
Enum: "SALES", "PURCHASE", "BOTH"
Example: "SALES"
No

TaxGroupDetails

NameTypeDescriptionRequired
additionalTaxInbooleanNo
applyTostringNo
codestringNo
idlongNo
namestringNo
percentagenumberNo
typestringNo

TdsRequestIndia

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection Id
Example: 1
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No

TdsResponseIndia

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
annualExemptionLimitnumberAnnual exemption Limit
Example: 120000
No
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection name
Example: 190
No
sectionShortDescriptionstringSection short Description
Example: "Dividend"
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No

WhtRequestIndonesia

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
accountReceivableCodestringTds Receivable account code
Example: "A-0013"
Yes
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection Id
Example: 1
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No

WhtRequestIsrael

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
accountReceivableCodestringTds Receivable account code
Example: "A-0013"
Yes
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionDescriptionstringSection Description
Example: "Section Description"
No
sectionNamestringSection Id
Example: 1
No
sectionShortDescriptionstringSection short Description
Example: "Section short Description"
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No

WhtRequestPhlippines

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
accountReceivableCodestringTds Receivable account code
Example: "A-0013"
Yes
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection Id
Example: 1
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No
whtBusinessTypestringIndividual Or Corporation
Example: "Corporation"
No

WhtResponse

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
accountReceivableCodestringTds account receivable code
Example: "A-0013"
Yes
annualExemptionLimitnumberAnnual exemption Limit
Example: 120000
No
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection name
Example: 190
No
sectionShortDescriptionstringSection short Description
Example: "Dividend"
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No

WhtResponseIndonesia

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
accountReceivableCodestringTds Receivable account code
Example: "A-0013"
Yes
annualExemptionLimitnumberAnnual exemption Limit
Example: 120000
No
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection name
Example: 190
No
sectionShortDescriptionstringSection short Description
Example: "Dividend"
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No

WhtResponseIsrael

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
accountReceivableCodestringTds Receivable account code
Example: "A-0013"
Yes
annualExemptionLimitnumberAnnual exemption Limit
Example: 120000
No
isStandardTdsbooleanNo
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection name
Example: 190
No
sectionShortDescriptionstringSection short Description
Example: "Dividend"
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No

WhtResponsePhilippines

NameTypeDescriptionRequired
accountCodestringTds account code
Example: "A-0013"
Yes
accountReceivableCodestringTds Receivable account code
Example: "A-0013"
Yes
annualExemptionLimitnumberAnnual exemption Limit
Example: 120000
No
ratenumberRate
Example: 10
No
residentbooleanResident Or Non Resident
Example: true
No
sectionNamestringSection name
Example: 190
No
sectionShortDescriptionstringSection short Description
Example: "Dividend"
No
standardTaxIdlongStandard Tax Id
Example: 1
No
tdsIdlongTds Id
Example: 1
No
whtBusinessTypestringIndividual Or Corporation
Example: "Corporation"
No