cybersource-rest-client
Version:
Node.js SDK for the CyberSource REST API
106 lines (68 loc) • 3.52 kB
Markdown
# CyberSource.TaxesApi
All URIs are relative to *https://apitest.cybersource.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**calculateTax**](TaxesApi.md#calculateTax) | **POST** /vas/v2/tax | Calculate Taxes
[**voidTax**](TaxesApi.md#voidTax) | **PATCH** /vas/v2/tax/{id} | Void Taxes
<a name="calculateTax"></a>
# **calculateTax**
> VasV2PaymentsPost201Response calculateTax(taxRequest)
Calculate Taxes
The tax calculation service provides real-time sales tax and VAT calculations for orders placed with your business worldwide. It enhances your ability to conduct business globally and enables you to avoid the risk and complexity of managing online tax calculation. The service supports product-based tax rules and exemptions for goods and services. The tax rates are updated twice a month and calculations include sub-level detail (rates per taxing jurisdiction, names and types of jurisdictions). Implementation guidance, list of supported countries, and information on tax reporting are in the [Tax User Guide](https://developer.cybersource.com/docs/cybs/en-us/tax-calculation/developer/all/rest/tax-calculation/tax-overview.html). The availability of API features for a merchant can depend on the portfolio configuration and may need to be enabled at the portfolio level before they can be added to merchant accounts.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.TaxesApi();
var taxRequest = new CyberSource.TaxRequest(); // TaxRequest |
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.calculateTax(taxRequest, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**taxRequest** | [**TaxRequest**](TaxRequest.md)| |
### Return type
[**VasV2PaymentsPost201Response**](VasV2PaymentsPost201Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json;charset=utf-8
<a name="voidTax"></a>
# **voidTax**
> VasV2TaxVoid200Response voidTax(voidTaxRequest, id)
Void Taxes
Pass the Tax Request ID in the PATCH request to void the committed tax calculation.
### Example
```javascript
var CyberSource = require('CyberSource');
var apiInstance = new CyberSource.TaxesApi();
var voidTaxRequest = new CyberSource.VoidTaxRequest(); // VoidTaxRequest |
var id = "id_example"; // String | The tax ID returned from a previous request.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.voidTax(voidTaxRequest, id, callback);
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**voidTaxRequest** | [**VoidTaxRequest**](VoidTaxRequest.md)| |
**id** | **String**| The tax ID returned from a previous request. |
### Return type
[**VasV2TaxVoid200Response**](VasV2TaxVoid200Response.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json;charset=utf-8
- **Accept**: application/hal+json;charset=utf-8