global static ffbc.AvalaraTaxService.Settings getSettings()

Retrieves the Billing Central tax calculation settings for the org.

Return Value

The wrapper containing the settings.

global static void saveSettings(ffbc.AvalaraTaxService.Settings settings)

Saves settings.

Input Parameters

Exceptions Thrown

global static List<ffbc.AvalaraTaxService.TaxResponse> getTax(List<ffbc.AvalaraTaxService.TaxDocument> documents)

Sends a request to Avalara to calculate tax for the documents provided and returns the response. To calculate tax, the connection details on the Tax Calculation Settings tab must be valid.

Input Parameters

Exceptions Thrown

Return Value

The response to the tax calculation request for each document. Responses are provided in the same order in which the documents were supplied.

global static List<ffbc.AvalaraTaxService.DocumentValidationError> validateDocuments(Set<Id> billingDocumentIds)

Validates that a document can be taxed.

Input Parameters

Return Value

A list of validation errors. If this list is empty, the billing documents are valid.

global static List<ffbc.AvalaraTaxService.TaxResponse> calculate(Set<Id> billingDocumentIds)

Sends a request to calculate tax for the given documents to Avalara, provided that no errors are encountered, then sets the tax rates and values on the document line items according to the response. If the process encounters an error, it stops and throws an exception. To calculate tax, the connection details on the Tax Calculation Settings tab must be valid. If Use Mappings Component for External Tax is enabled in FFBC Tax Calculation Settings, the configuration in the related FDN Mappings component is used for external tax calculation.

Input Parameters

Exceptions Thrown

Return Value

The response to the tax calculation request for each document.

global static List<ffbc.AvalaraTaxService.TaxResponse> calculate(ffbc.AvalaraTaxService.TaxRequest request)

Sends a request to calculate tax for the given documents to Avalara, then sets the tax rates and values on the document line items according to the response.
When the ThrowExceptionForInvalidBillingDocument request parameter is set to true and a billing document isn't valid, the process stops and throws an exception. When the ThrowExceptionForInvalidBillingDocument request parameter is set to false and a billing document isn't valid, the process continues and returns an error in the response.
To calculate tax, the connection details on the Tax Calculation Settings tab must be valid. If Use Mappings Component for External Tax is enabled in FFBC Tax Calculation Settings, the configuration in the related FDN Mappings component is used for external tax calculation.

Input Parameters

Exceptions Thrown

Return Value

The response to the tax calculation request for each document.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * Example of using calculate() method of AvalaraTaxService API
 * Variables marked by asterisks need to be queried from your organisation's data.
 */

//Set of billing documents for which tax will be calculated with Avalara, identified by ID.
Set<Id> setOfBillingDocumentIds = New Set<Id> {*billingDocumentIds*};

ffbc.AvalaraTaxService.TaxRequest request = New ffbc.AvalaraTaxService.TaxRequest();

request.BillingDocumentIds = setOfBillingDocumentIds;
request.ThrowExceptionForInvalidBillingDocument = false;

List<ffbc.AvalaraTaxService.TaxResponse> responses = ffbc.AvalaraTaxService.calculate(request);

global static ffbc.AvalaraTaxService.TaxAsyncResponse calculateAsync(Set<Id> billingDocumentIds)

Sends requests to calculate tax for the given documents to Avalara using a background process. As each response is received from Avalara, sets the tax rates and values on the corresponding billing document line items according to the response.
To calculate tax, the connection details on the Tax Calculation Settings tab must be valid. If Use Mappings Component for External Tax is enabled in FFBC Tax Calculation Settings, the configuration in the related FDN Mappings component is used for external tax calculation.

Input Parameters

Return Value

A response containing the background process ID and the background process job ID.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * Example of using calculateAsync() method of AvalaraTaxService API
 * Variables marked by asterisks need to be queried from your organisation's data.
 */

//Set of billing documents for which tax will be calculated with Avalara, identified by ID.
Set<Id> setOfBillingDocumentIds = New Set<Id> {*billingDocumentIds*};

ffbc.AvalaraTaxService.TaxAsyncResponse response = ffbc.AvalaraTaxService.calculateAsync(setOfBillingDocumentIds);

global static List<ffbc.AvalaraTaxService.TaxResponse> commitTax(ffbc.AvalaraTaxService.TaxRequest request)

Sends a request to calculate and commit tax for the given documents to Avalara, then sets the tax rates and values on the document line items according to the response.
When the ThrowExceptionForInvalidBillingDocument request parameter is set to true and a billing document isn't valid, the process stops and throws an exception. If the process throws an exception, users should check what documents have been committed to Avalara to ensure all values are correct. When the ThrowExceptionForInvalidBillingDocument request parameter is set to false and a billing document isn't valid, the process continues and returns an error in the response.
To commit tax, the connection details on the Tax Calculation Settings tab must be valid. If Use Mappings Component for External Tax is enabled in FFBC Tax Calculation Settings, the configuration in the related FDN Mappings component is used for external tax calculation.

Input Parameters

Exceptions Thrown

Return Value

The response of the tax commit request for each document.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * Example of using commitTax() method of AvalaraTaxService API
 * Variables marked by asterisks need to be queried from your organisation's data.
 */

//Set of billing documents for which tax will be calculated and committed with Avalara, identified by ID.
Set<Id> setOfBillingDocumentIds = New Set<Id> {*billingDocumentIds*};

ffbc.AvalaraTaxService.TaxRequest request = New ffbc.AvalaraTaxService.TaxRequest();

request.BillingDocumentIds = setOfBillingDocumentIds;
request.ThrowExceptionForInvalidBillingDocument = false;

List<ffbc.AvalaraTaxService.TaxResponse> responses = ffbc.AvalaraTaxService.commitTax(request);

global static ffbc.AvalaraTaxService.TaxAsyncResponse commitTaxAsync(Set<Id> billingDocumentIds)

Sends requests to commit tax for the given documents to Avalara using a background process. As each response is received from Avalara, sets the tax rates and values on the corresponding billing document line items according to the response.
To commit tax, the connection details on the Tax Calculation Settings tab must be valid. If Use Mappings Component for External Tax is enabled in FFBC Tax Calculation Settings, the configuration in the related FDN Mappings component is used for external tax calculation.

Input Parameters

Return Value

A response containing the background process ID and the background process job ID.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * Example of using commitTaxAsync() method of AvalaraTaxService API
 * Variables marked by asterisks need to be queried from your organisation's data.
 */

//Set of billing documents for which tax will be committed with Avalara, identified by ID.
Set<Id> setOfBillingDocumentIds = New Set<Id> {*billingDocumentIds*};

ffbc.AvalaraTaxService.TaxAsyncResponse response = ffbc.AvalaraTaxService.commitTaxAsync(setOfBillingDocumentIds);

global static List<ffbc.AvalaraTaxService.TaxResponse> voidTax(ffbc.AvalaraTaxService.TaxRequest request)

Sends a request to void tax for the given documents to Avalara.
When the ThrowExceptionForInvalidBillingDocument request parameter is set to true and a billing document isn't valid, the process stops and throws an exception. If the process throws an exception, users should check what documents have been committed to Avalara to ensure all values are correct. When the ThrowExceptionForInvalidBillingDocument request parameter is set to false and a billing document isn't valid, the process continues and returns an error in the response.
To void tax, the connection details on the Tax Calculation Settings tab must be valid.

Input Parameters

Exceptions Thrown

Return Value

The response of the tax void request for each document.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * Example of using voidTax() method of AvalaraTaxService API
 * Variables marked by asterisks need to be queried from your organisation's data.
 */

//Set of billing documents for which tax will be voided in Avalara, identified by ID.
Set<Id> setOfBillingDocumentIds = New Set<Id> {*billingDocumentIds*};

ffbc.AvalaraTaxService.TaxRequest request = New ffbc.AvalaraTaxService.TaxRequest();

request.BillingDocumentIds = setOfBillingDocumentIds;
request.ThrowExceptionForInvalidBillingDocument = false;

List<ffbc.AvalaraTaxService.TaxResponse> responses = ffbc.AvalaraTaxService.voidTax(request);

global static ffbc.AvalaraTaxService.TaxAsyncResponse voidTaxAsync(Set<Id> billingDocumentIds)

Sends requests to void tax for the given documents to Avalara using a background process.
To void tax, the connection details on the Tax Calculation Settings tab must be valid.

Input Parameters

Return Value

A response containing the background process ID and the background process job ID.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

/**
 * Example of using voidTaxAsync() method of AvalaraTaxService API
 * Variables marked by asterisks need to be queried from your organisation's data.
 */

//Set of billing documents for which tax will be voided in Avalara, identified by ID.
Set<Id> setOfBillingDocumentIds = New Set<Id> {*billingDocumentIds*};

ffbc.AvalaraTaxService.TaxAsyncResponse response = ffbc.AvalaraTaxService.voidTaxAsync(setOfBillingDocumentIds);

global Settings()

The default constructor for this object.

global TaxDocument()

The default constructor for this object.

global TaxDocumentLineItem()

The default constructor for this object.

global TaxRequest()

Creates a new tax request.

global TaxResponse()

Creates a new tax response. You will not normally need to create an instance of this class. The constructor is global to make it easier for you to write unit tests for code that handles these responses.

global TaxResponseDetail()

Constructor for the TaxResponseDetail.