global static fferpcore.TaxCalculationService.Settings getSettings()

Gets the saved tax calculation settings.

Return Value

A Settings DTO that contains the tax calculation settings excluding the password/license key.

global static fferpcore.TaxCalculationService.SaveSettingsResponse saveSettings(fferpcore.TaxCalculationService.Settings settings)

Saves the modified settings. If the password is empty, the existing password/license key is not overwritten.

Input Parameters

global static Boolean isEnabled()

Determines whether external tax calculation is enabled.

Return Value

True if the endpoint service is enabled.

global static fferpcore.TaxCalculationService.TestConnectionResponse testConnection(fferpcore.TaxCalculationService.Settings settings)

Calls the external tax calculation service with the saved settings to validate values. This method bypasses the enabled flag.

Return Value

A Response object that contains the state of the connection and errors that occurred.

global static fferpcore.TaxCalculationService.ValidateAddressResponse validateAddress(fferpcore.TaxCalculationService.Address address)

Calls the external tax calculation service with the address to be validated.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A ValidateAddressResponse object that contains the validated address.

global static fferpcore.TaxCalculationService.TaxResponse calculateTax(fferpcore.TaxCalculationService.TaxDocument document)

Calls the external tax calculation service with the document for which tax is to be calculated.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A TaxResponse object that contains the tax values for the document.

global static fferpcore.TaxCalculationService.TaxResponse commitTax(fferpcore.TaxCalculationService.TaxDocument document)

Calls the external tax calculation service with a document for which tax is to be calculated and committed.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A TaxResponse object that contains the tax values for the document.

global static fferpcore.TaxCalculationService.TaxResponse commitTax(fferpcore.TaxCalculationService.CommitRequest request)

Calls the external tax calculation service with a request to commit a draft document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A TaxResponse object that contains the tax values for the document.

global static fferpcore.TaxCalculationService.ReversalResponse calculateReversal(fferpcore.TaxCalculationService.CreditDocument document)

Calls the external tax calculation service with a credit document for which tax is to be calculated. The monetary values in the document are expected to be positive. The returned tax values will also be positive.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A ReversalResponse object that contains the tax values for the credit document.

global static fferpcore.TaxCalculationService.ReversalResponse commitReversal(fferpcore.TaxCalculationService.CreditDocument document)

Calls the external tax calculation service with a credit document for which tax is to be calculated and committed. The monetary values in the document are expected to be positive. The returned tax values will also be positive.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A ReversalResponse object that contains the tax values for the credit document.

global static fferpcore.TaxCalculationService.ReversalResponse commitReversal(fferpcore.TaxCalculationService.CommitRequest request)

Calls the external tax calculation service with a request to commit a draft return document. The returned tax values will be positive.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A ReversalResponse object that contains the tax values for the credit document.

global static fferpcore.TaxCalculationService.UncommitResponse uncommitTax(fferpcore.TaxCalculationService.UncommitRequest request)

Calls the external tax calculation service with a request to uncommit a document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

An UncommitResponse object.

global static fferpcore.TaxCalculationService.UncommitResponse uncommitReversal(fferpcore.TaxCalculationService.UncommitRequest request)

Calls the external tax calculation service with a request to uncommit a return document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

An UncommitResponse object.

global static fferpcore.TaxCalculationService.VoidResponse voidTax(fferpcore.TaxCalculationService.VoidRequest request)

Calls the external tax calculation service with a request to void a previously committed tax document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A VoidResponse object.

global static fferpcore.TaxCalculationService.VoidResponse voidReversal(fferpcore.TaxCalculationService.VoidRequest request)

Calls the external tax calculation service with a request to void a previously committed credit document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A VoidResponse object.

global static fferpcore.TaxCalculationService.UnvoidResponse unvoidTax(fferpcore.TaxCalculationService.UnvoidRequest request)

Calls the external tax calculation service with a request to unvoid a previously voided document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

An UnvoidResponse object.

global static fferpcore.TaxCalculationService.UnvoidResponse unvoidReversal(fferpcore.TaxCalculationService.UnvoidRequest request)

Calls the external tax calculation service with a request to unvoid a previously voided credit document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

An UnvoidResponse object.

global static fferpcore.TaxCalculationService.VerifyResponse verifyTax(fferpcore.TaxCalculationService.VerifyRequest request)

Calls the external tax calculation service with a request to verify a previously created uncommitted document.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A VerifyResponse object.

global static fferpcore.TaxCalculationService.VerifyResponse verifyReversal(fferpcore.TaxCalculationService.VerifyRequest request)

Calls the external tax calculation service with a request to verify a previously created uncommitted return document. The monetary values in the request are expected to be positive.
This method might result in DML if logging is enabled and prevent further callouts. To defer DML until all callouts have been performed, see the createWorkScope() method.

Return Value

A VerifyResponse object.

global static fferpcore.Disposable createWorkScope()

Creates a scope to facilitate grouping tax operations together. Scopes can be nested.
This causes the logging system to defer its database writes until the end of the outermost work scope. It is necessary when performing multiple callouts to prevent a Salesforce exception.

Return Value

A Disposable object.

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.

public void calculateTax(List<Document> documents)
{
    fferpcore.Disposable workScope = fferpcore.TaxCalculationService.createWorkScope();
    try
    {
        for(Document document : documents)
        {
            // The calculateTax method marshals the Document, calculates tax and unmarshals
            // the result.
            calculateTax(document);
        }
    }
    finally
    {
        // Use of try-finally ensures that the work scope is always disposed,
        // even if calculateTax results in an exception.
        workScope.dispose();
    }
}

global Settings()

Constructs a new Settings object that is disabled by default.

global SaveSettingsResponse()

global SaveSettingsResponse(fferpcore.TaxCalculationService.TestConnectionResponse response)

global TaxResponse()

global ValidatedAddress()

global DocumentIdentity()

Default constructor.

global DocumentIdentity(String companyCode, String documentCode)

Construct a document identity with the given company code and document code.

Input Parameters

global CommitRequest()

global CommitRequest(fferpcore.TaxCalculationService.DocumentIdentity document, fferpcore.TaxCalculationService.DetailLevel detailsToInclude)

Construct a commit request for an existing document, specifying the level of detail to include in the tax response.

Input Parameters

global ReversalResponse()

global UncommitRequest()

global UncommitRequest(fferpcore.TaxCalculationService.DocumentIdentity document)

Construct an uncommit request for an existing document.

Input Parameters

global UncommitResponse()

global VoidRequest(fferpcore.TaxCalculationService.DocumentIdentity document, fferpcore.TaxCalculationService.VoidRequestReason reason)

Construct a Void Request for the given Document with the given Reason.

Input Parameters

global VoidRequest(String companyCode, String documentCode, fferpcore.TaxCalculationService.VoidRequestReason reason)

Construct a Void Request for the given Document with the given Reason.

Input Parameters

global VoidResponse()

global UnvoidRequest()

global UnvoidRequest(fferpcore.TaxCalculationService.DocumentIdentity document)

Construct an unvoid request for an existing void document.

Input Parameters

global UnvoidResponse()

global VerifyRequest()

global VerifyResponse()