AvaTax for Communications SaaS Pro (SOAP) Telecom developer manual

Integration Requirements

Please see the integration checklist for the most current and detailed integration requirements.

Key Input Requirements

The following items are required as input for AFC SaaS Pro:

• Transaction Date (Please reference Transaction Date for additional details).
• Jurisdiction information details: (Please reference Specifying a Tax Jurisdiction for additional details).
  • Address
  • Zip
  • Zip+4
  • FIPS Code
  • PCode
  • NPANXX
• Product Information/ Transaction and Service Types (Please reference AFC Transaction and Service Types for additional details.)
• Sale Type details: (Please reference Transaction for additional details.)
  • Retail
  • Wholesale
• Customer Type Info (of who is being billed) details: (Please reference CustomerType for additional details.)
  • Business
  • Residential
  • Industrial
  • Senior Citizen
• Business Class (of who is billing) details: (Please reference BusinessClass for additional details.)
  • CLEC
  • ILEC
  • Other
• Service Class (of who is billing) details: (Please reference ServiceClass for additional details.)
  • Primarily Long Distance
  • Primarily Local
  • Other
• Other Company Info (of who is billing) details: (Please reference Transaction for additional details.)
  • Regulated: Y or N
  • Franchise: Y or N
  • Facilities: Y or N

*Certain Inputs can be set as defaults and do not have to be selectable options in the billing platform being utilized. This represents a selection of data elements. Additional features/functions may require additional elements.

AFC Transaction and Service Types

The AFC SaaS Pro software package provides a wide range of transaction and service types. The result is a complete taxation package. When passing a transaction to AFC SaaS Pro, the user must indicate the transaction and service type of the transaction. See TM_00115_AFC Transaction and Service Types for more details about the transaction and service types supported by AFC SaaS Pro.

Client Information

Many taxing jurisdictions apply taxes differently to different types of customers. In addition, many jurisdictions apply taxes differently depending upon the type of sale. For these reasons, it is necessary to indicate to AFC SaaS Pro the type of client the transaction occurred with. The client type will be “Business”, “Residential”, “Industrial” or “Senior Citizen”. Likewise, it is necessary to indicate the type of sale, “sale” or “resale”. Transactions that are performed with the end user of that product or service are “sale”. Products that are with a reseller (entity that intends to resell the product or service purchased) are “resale”. To have exempt taxes available for reporting, exemption type 3 (Sales For Resale) should be used in combination with Resale.

Transaction Date

AFC SaaS Pro maintains multiple tax rates for every tax contained in the system. One rate is the current tax rate and the others are the previous tax rates. When transactions are passed to AFC SaaS Pro for tax generation, the caller is required to specify a date. AFC SaaS Pro compares this date to the effective date of each tax that applies to the transaction. If the date passed to AFC SaaS Pro is "equal to" or "greater than" the effective tax date, the current tax rate is used. If the date passed to AFC SaaS Pro is prior to the effective date, AFC SaaS Pro will select the previous tax rate for the tax based on the effective date of the previous tax rate. If a transaction is passed to AFC SaaS Pro without a date (that is, the date is set to zero), AFC SaaS Pro will set the date to the current date.

The Date field is normally populated with the bill date, invoice date or call date (as applicable) and may appear in one of the following Standard Date and Time Format Strings for .NET Framework shown in the table below.

A common question asked for some transactions is "What date should be used for taxing a transaction, the date it occurred or the billing date?" Normally this should be the billing date. Generally accepted accounting principles tell us we should record our liabilities when we record our revenues. In most cases neither of these are recorded (or even known) until billing occurs. Large organizations may have a different answer to this question. If you are running high volumes of transactions daily and record revenue as it occurs, then the tax should be recorded on the same basis (i.e. the transaction date should be used).

Note: The invoice date passed to the server in the transaction by default is preserved as is. It is recommended that clients not use time zone modifiers on the invoice date.

Tax Types

The application of taxes varies from location to location as well as the particular transaction and service provided. Different localities typically have different taxes and logic associated with the application of the taxes. For example, one locality may apply tax to medical equipment paid for by Medicare but not to equipment paid for by Medicaid. A neighboring locality may apply tax to both or neither.  For the most current list of Tax Types, see AFC Tax Types.

Bundles

The Bundling feature allows the user to define multiple AFC SaaS Pro transaction/service type pairs as one unique “bundle” transaction/service pair type. AFC SaaS Pro processes all of the transaction/service type pairs in the bundle and stores the results in the file EZtax.bdl, the formatted text bundle definition file.  This file must be created and edited by AFC Bundler, an optional utility program. The bundle (.bdl) file must be installed on our web server to be implemented. Submit a support case with your bundle file attached for installation. We will contact you when it has been installed.

Overrides

Overrides allow the client to change the rate of a tax in the AFC Engine. Avalara markets the AFC Override Utility (a Graphic User Interface based Windows program that is sold separately) to support this activity. It steps the user through the process of creating an EZtax.ovr file.

WARNING: An override to exempt taxes OVERRIDES the tax information in Avalara’s tax research database. This is not recommended for those that do not possess a full understanding of the tax ramifications and liabilities when doing so.

The override (.ovr) file must be installed on our web server to be implemented. Submit a support case with your zipped override file attached for installation. We will contact you when it has been installed.

Overrides on tax rates may also be performed for specific transactions.

Exclusions

The AFC SaaS Pro Telecom interface allows the client to specify the states where the client’s company wants to exclude all taxes. There are two methods in which exclusions can be specified to AFC SaaS Pro:

If both methods are utilized, the exclusions passed in via the API call will be used and the exclusion file will be ignored for that particular transaction.

Note: Excluded tax jurisdictions will either appear as unknown or will not be included in any Transaction Service Reports (TSRs) produced.

Exemptions

There are three types of exemptions allowed in AFC SaaS Pro.

Compliance Files

The web service automatically generate compliance files at the end of the month for the clients contracted for compliance services. These files contain a summary of the tax data generated for all transactions processed throughout the month. The format of the compliance files may be that of any of the available AFC SaaS Pro sorting and reporting utilities. The compliance files may be placed in an FTP site where they can be downloaded or they may be automatically emailed to a specific email account. AFC SaaS Pro Clients are required to submit a support case in order to set up these preferences.

Sorting & Reporting Utilities

To allow enough time to complete tax calculations for your billing cycle, Network Services will assist in establishing the correct date method depending on your transaction method and the appropriate date of the month for your compliance reports. Please submit a support case to set up or establish the appropriate preferences.

Test Environment

Each client is provided with a three-character company code when signing up for the AFC SaaS Pro product. In order to run a live transaction, the client’s company code must be placed in the CompanyIdentifier field of the Transaction to be processed using AFC SaaS Pro (see Transaction data definition). Only taxes for transactions that contain this code in the CompanyIdentifier field will be included in the monthly compliance files created by the AFC SaaS Pro Web Service. Leave the CompanyIdentifier field blank or use a value other than the assigned company code in order to process transactions where the taxes generated are to be excluded from the monthly compliance reports such as test transactions or quotes.

There is a SOAP Sandbox that is a dedicated testing environment. The sandbox is for testing purposes only. Test data cannot be used in reporting.

There are two endpoints for testing the SOAP Sandbox -- one for Telecom taxes and one for Sales and Use taxes.

• Telecom: https://afcprosoapsbx.avalara.net/EZTaxWebService/EZTaxWebService.svc 
• Sales and Use: https://afcprosoapsbx.avalara.net/EZTaxWebService/EZTaxWebServiceSAUSaleAttributesExplicit.svc

Note: Data in the Sandbox will be purged periodically by Avalara.

Compliance Month

Optional10 field applies when Date Method 2 is used. The month for the billing cycle must be specified in the Optional10 field of the transaction by entering the year and month in YYYYMM format. This will allow the transaction and taxes to be reported in the appropriate compliance reports for the specified month.

Tax Adjustments

Tax adjustment functions are used for adjustment activities such as refunds, changing a customer’s bill or writing off un-collectable accounts. Please apply the following general rules while passing tax adjustments via Web Service.

Interstate/Intrastate Determination

The Interstate or Intrastate feature provides clients with the ability to apply interstate or intrastate charges appropriately when sending transaction messages to the AFC SaaS Pro service without specifying either the transaction type or the service type. To use this functionality, set the transaction type to ‘-1’ and a valid service type listed in the below scenarios; conversely, set the transaction type to a valid transaction type listed in the below scenarios and the service type to ‘-1’. The AFC SaaS Pro service will determine the appropriate interstate or intrastate transaction or service and return the appropriate taxes.

This feature is enabled for the following APIs:

• CalcTaxesWithZipAddress
• CalcTaxesWithFipsCode
• CalcTaxesWithPCode
• CalcTaxesWithNpaNxx
• CalcProRatedTaxes
• CalcAdjWithZipAddress
• CalcAdjWithFipsCode
• CalcAdjWithPCode
• CalcAdjWithNpaNxx
• CalcProRatedAdj
• CalcTaxesInCustMode
• CalcTaxesInCustModeV2
• ProcessCustomerBatch
• ProcessCustomerBatchV2

Note: This feature is only supported with use of the APIs listed above.

In addition, this feature is only applicable in each of the following scenarios:

Private Line

The Private Line feature provides clients with the ability to obtain taxes for a private line transaction. Clients must call with one of the following APIs:

• CalcTaxesWithPCode
• CalcTaxesWithFipsCode
• CalcTaxesWithNpaNxx
• CalcTaxesWithZipAddress
• CalcAdjWithPCode
• CalcAdjWithFipsCode
• CalcAdjWithNpaNxx
• CalcAdjWithZipAddress
• CalcTaxesInCustMode
• CalcTaxesInCustModeV2
• ProcessCustomerBatch
• ProcessCustomerBatchV2

In addition, clients must specify that the transaction is for a private line and provide a number between 0 and 1 to indicate the percentage which applies to the origination point. Any remaining charges are then applied to the termination point.

Note: This feature is only supported with use of the eight APIs referenced. It is not supported for use with Tax Inclusive or Reverse APIs.

Proration

The Proration feature provides clients with the ability to calculate prorated taxes on a transaction that represents a partial month of service through use of the CalcProRatedTaxes API or the CalcProRatedAdj API. Percentage-based taxes are prorated by way of the charge amount passed. However, fixed and per line taxes are subject to special pro-rating rules and procedures. Some tax authorities allow sellers to pro-rate fixed and per line taxes for partial months, but many insist on receiving the full amount. AFC SaaS Pro will apply these rules automatically if the pro-rating feature is used.  A number between 0 and 1 is passed to specify the percentage of the month the service was active. The pro-rating functionality checks the logic of each tax in the appropriate jurisdiction to determine if prorating is allowed. If prorating is not allowed, the full amount is taxed. If pro-rating is allowed, the fixed or per line tax applicable to the service will be returned multiplied by the fraction supplied.

If the proration is being used for an adjustment credit rather than a partial charge, the ratio of the percentage applied should reflect the portion of the month in which the service was not active.

Tax Grouping

The following options determine how tax calculation results are returned after calling one of the tax calculation API functions. By changing this option, the taxes returned by the tax calculation API function may be grouped according to this setting.

NOTE: This option will not modify the way that tax calculation results are logged into the AFC log data. Only the tax calculation results returned by either one of the tax calculation API will be group according to the values set for this option.

Please submit a support case in order to have tax grouping options set or activated.

General Rules

The following rules apply when using any value for this option:

Default Option:

• groupresults=default (default)

  The default option indicates that the taxes returned in the tax table after processing a transaction with AFC will not be grouped. Each tax will be returned in an individual tax record.

Tax Level Options:

• groupsamelevel

  This option will cause rate-based taxes at the same level to be grouped together. For example, if AFC returns a Local Sales Tax and a Local District Tax, these taxes will be grouped together since they have the same tax level (Local).

• groupstate_groupcountyandlocal

  This option will cause all state taxes to be grouped together into a single record, and all county and local taxes to be grouped together into a separate record.

• groupstatecountyandlocal

  This option will cause all state, county, and local taxes to be grouped together into a single record.

Sales Tax Options:

The following options may be used in combination with any of the tax level options specified above. These options may be used to group sales taxes separately from other taxes. This option must be appended to the EZTax.cfg file following the line for the tax level group option.

• groupsales

  This option will group Sales Taxes (tax type 1) and Use Taxes (tax type 49) taxes into a separate record according to the tax level option being specified.

• groupsalescategory

  When using this option, AFC will group any items that are considered Sales Taxes together. In addition to the Sales Tax (tax type 1) and Use Tax (tax type 49), some District and Transit taxes are also in the sales tax category.

Examples

• groupstatecountylocal

  By entering the configuration option shown above into the EZTax.cfg file, all State, County, and Local taxes will be grouped together into a single record.

• groupstatecountylocal
• groupsalescategory

By entering these two options in the configuration file, all State, County, and Local sales category taxes will be grouped together into a single record. Any other State, County and Local taxes (if any) will be grouped into a separate record.

Tax Return Table

When grouping taxes together, the fields in the tax return table will contain the following values:

NOTE: The remaining fields in the tax table will not contain any meaningful value. Grouping tax calculation results may serve as a way to simplify the tax information for display purposes only. If further detail is required for each tax being returned by AFC, this feature should not be used. 

Specifying a Unique Identifier

AFC SaaS Pro does not provide in the response a unique identifier for a specific transaction. However, there are numerous reporting fields which can be used for the requesting application to populate a unique identifier. Reporting fields do not impact tax calculations. It is recommended that clients generate or construct the unique identifier in a way that is meaningful to their billing application and then proceed to provide that data to Avalara through one of the available reporting fields.

Reporting fields that can be used individually or in combination to represent a unique identifier are shown in the table below.

Reporting Fields

Commit/Uncommit

The process to commit documents is optional and used to identify documents that should be included in the Compliance Reports for remittance to the Department of Revenue (DoR) for tax compliance reporting. This process is often used when not all taxes being calculated are considered final for compliance reporting. When a document is considered final, a commit can be sent to finalize the document. This also allows users to commit an entire invoice by using the document code instead of calculating the taxes again when the document is determined to be final.

Note: This feature is supported with the use of all tax calculations. Please reference the AvaTax for Communications SaaS Pro Commit/Uncommit Process document for additional information and details.

Application of Tax Brackets and Limits

Getting the Right Tax Jurisdiction for Local Taxation

It is important to get the end users location correct for local taxation. People tend to know what they are charged for local taxes. These taxes also have a tendency to change from one neighborhood to the next.

Avalara provides a comma delimited ASCII file to aid with entry of customers in your system and to help insure the correct taxing jurisdiction is setup. The file is "all_adr.txt". This comma delimited ASCII files is provided to allow AFC SaaS Pro clients to populate database tables in their system with this information. The all address (all_adr.txt) file is a cross-reference of locations to PCodes. The format of the files is illustrated below.

The "all_adr.txt" file format and example follows:

Pcode,P/A,Country,State,County,City,"Zip code range start","Zip code range end"

3346800,0,USA,PA,LANCASTER,BART,17503,17503

3346900,0,USA,PA,LANCASTER,BAUSMAN,17504,17504

3347000,0,USA,PA,LANCASTER,BIRD IN HAND,17505,17505

3347100,0,USA,PA,LANCASTER,BOWMANSVILLE,17507,17507

3347200,0,USA,PA,LANCASTER,CHRISTIANA,17509,17509

3347300,0,USA,PA,LANCASTER,CHURCHTOWN,17555,17555

3347400,0,USA,PA,LANCASTER,CONESTOGA,17516,17516

3347500,0,USA,PA,LANCASTER,DRUMORE,17518,17518

3347600,0,USA,PA,LANCASTER,EAST EARL,17519,17519

3347700,0,USA,PA,LANCASTER,ELM,17521,17521

3347800,0,USA,PA,LANCASTER,GAP,17527,17527

Overview

AFC SaaS Pro applies Brackets and/or Limits on a per transaction basis unless operating in Invoice Mode. Invoice Mode is used to group transactions that apply to the same customer. When in Invoice Mode, AFC SaaS Pro maintains a history of the transactions and applies the Brackets and/or Limits to the entire group of transactions.

NOTE: Please reference Application of Tax Brackets and Limits for additional details, descriptions and examples of tax brackets and limits.

AFC SaaS Pro provides the ability to process up to 30,000 transactions within an invoice for a single transaction or up to 50,000 transactions within an invoice for a batch transaction in Invoice Mode. Tax calculation results will be summarized by jurisdiction and tax type. Optionally, the individual taxes for each line item can also be returned in the output, but be advised that the response size may be up to a couple megabytes and may take up to one minute to process depending on the number of transactions in the customer batch. In addition, it is recommended to increase the timeout of your web API calls to 10 minutes although response times are expected to be much shorter even or the largest batches.

NOTE: The Invoice Mode feature must be individually activated for each client. Please submit a support case in order to access this functionality.

Also, it is recommended that transactions in Invoice Mode are contained within one monthly billing cycle.

Batch Transaction Submission

The CalcTaxesInCustMode APIs can be used for submitting a batch of telecom and/or sales and use transactions and adjustments within a single SOAP request in order to be processed using Invoice Mode. The steps for processing an invoice in using this method are the following:

Single Transaction Submission

The following APIs can be used in order to submit each transaction within an individual SOAP request. The advantage of using this method is that each transaction can be validated prior to processing the entire batch. The steps for processing an invoice in using this method are the following:

After invoking ProcessCustomerBatch, the customer batch ID will no longer be valid.

Note: It is recommended that the batch transaction method be attempted first and that the single transaction method only be utilized if the batch transaction method does not work.

Taxing Jurisdiction Specification

Invoice Mode APIs accept either combination of PCodes, FIPS Codes, Zip Address, or NPANXX for the bill- to, origination, and termination. However, make sure that only one property is assigned for each location. For example, if setting a value in the BillToPCode field, leave the BillToFipsCode, BillToAddress, and BillToNpaNxx fields null.

API Results

The response from any of these batch mode APIs contain two fields:

• SummarizedTaxes. This is an array of CustomerTaxData objects containing the accumulated taxes grouped by tax type and jurisdiction.
• Taxes. This is an array of TaxData objects containing the individual tax calculation results for each transaction in the batch. This array is populated only if the returnDetail parameter for the Invoice Mode API parameter is set to true. It is recommended to place a unique identifier within one of the optional fields of the transaction in order to be able to match the taxes in this array to its corresponding line item. (Please see Specifying a Unique Identifier for additional details).

Supported and Non-Supported Features

Not all options for all features are supported in Invoice Mode. Invoice Mode only supports tax calculation methods. Please reference the table below for a high-level overview of supported features within this functionality.

*Support for the Private Line feature DOES NOT include adjustments.

**The Tax Inclusive feature is supported only through use of the Tax Inclusive flag. It is not supported through use of the API.

Tax Inclusive Transactions

In order to process tax inclusive tax calculations in Invoice Mode, set the TaxInclusive property of the Transaction field to true. AFC SaaS Pro will determine the appropriate base sale amount required to arrive at the total desired charge. The calculated base sale amount will be included in the TransCharge field of the corresponding TaxDataV2 objects returned for that transaction.

Report Process Overview

AFC SaaS Pro provides the ability to dynamically generate a custom report containing the transactional data available in the database for a specified timeframe. The general process is as follows:

Note: Prior to the first time executing the CreateReport API call, please submit a support case. If not already established, an FTP account needs to be created and the FTP credentials provided.

Setting up ReportOptions

Report Types

The following report types are available. Note that each of the reports specified below will be generated as CSV files.

Custom Log Report Columns

The following columns are available when generating a report using the customlog ReportType. For each column, the Include and Sort proprieties must also be specified.

A Calculated column refers to data calculated within and returned from the AFC Engine.

Aggregation

Any records included in the report will be grouped together using any non-calculated fields that are included in the output. The non-calculated field values are aggregated. To avoid any grouping, include the TaxLogID column in the report output. For a list of calculated and non-calculated fields, see 4.3 - Custom Log Report Columns.

Output Files

The output files are compressed into a zip file with the name as specified in the FileName field. This zip file is then placed in the specific client FTP folder. The zip file may contain multiple files if the CreateNbaFile or CreateNcaFile options are set to true in the ReportOptions.

Sample Code

// Create instance of web service client
var client = new EZTaxWebServiceClient("BasicHttpBinding_IEZTaxWebService"); 
client.ClientCredentials.UserName.UserName = "(MyUserName)"; 
client.ClientCredentials.UserName.Password = "(MyPassword)";

// Create a ReportOptions object to specify the options for the report 
var reportOptions = new ReportOptions
{
    BaseReport = "srtcomma20l",
    CreateNbaFile = true, 
    CreateNcaFile = false,
    EmailAddress = "myemail@address.com", 
    EndDate = new DateTime(2016, 5, 1), 
    FileExtension = ".csv",
    FileName = "test-{yyyyMMdd}", 
    IncludeHeaders = true, 
    Precision = 6,
    ReportType = "customlog",
    StartDate = new DateTime(2016, 4, 1)
};

// For customlog reports, you may specify individual fields to be included 
reportOptions.CustomLogFields = new[]
{
    new CustomLogField
    {
        Column = "PCode",
        Include = true, 
        Sort = false
    },
    new CustomLogField
    {
        Column = "CategoryID",
        Include = true,
        Sort = true
    },
    new CustomLogField
    {
        Column = "CategoryDesc",
        Include = true, 
        Sort = false
    }
};

try
{
    // Invoke the CreateReport API to submit the report for processing 
    client.CreateReport(reportOptions); 
    Console.WriteLine("Report submitted for processing.");
}

catch (FaultException ex)
{
    Console.WriteLine("An error occurred submitting the report: " + ex.ToString());
}

Overview

AFC SaaS Pro provides a number of optional fields for use in reports.

There are two types of Optional Fields available in AFC SaaS Pro- 9 default Optional Fields and up to 10 Extended Optional Fields. All Optional Fields are part of the transaction.

Note: The Optional Fields do not impact taxation.

Default Optional Fields

There are 9 default Optional Fields.

Reporting Fields

Note: Please refer to Sections 1.9 Compliance Files and 1.11 Compliance Month for additional information about the Optional10 field.

Extended Optional Fields

AFC SaaS Pro has the ability to pass up to 10 additional Extended Optional Fields. The general process is as follows:

The Extended Optional Fields are not currently supported in Single-Transaction Invoice Mode or Batch- Transaction Invoice Mode.

Note: The Extended Optional Fields passed as part of the Transaction are persisted until otherwise changed. For example, if the first OptionalField is used in a transaction and updated with a description of “Purchase Order Number”, this field should continue to be utilized as a Purchase Order Number until at least the end of the reporting cycle so that mixed data does not appear on the resulting Detail Log report or Custom Report.

Overview

Zip Lookup functionality returns all or multiple PCodes and jurisdiction details associated with the address input provided.

To use this functionality, invoke the ZipLookup API.

Setting up a Request

In order to call the API, the ZipLookup data structure needs to be populated. At least one location field is required. If Country is not specified, the default value is set to “USA”.

Results

The LocationData structure is returned for each location found based on the provided input. All results are contained within the ZipLookupResult structure.

Examples

Examples using Manhattan in New York are as follows:

TaxService Endpoint

TaxService WSDL (secured with user id and password in SOAP header) Avalara recommends using HTTPS when connecting to this endpoint. The URL for this endpoint is http://EZtaxasp.billsoft.com/EZtaxWebService/EZtaxWebService.svc?wsdl.

There will be two ways to access the service, either via https or http. The TaxService endpoint requires the user id and password to be passed in a custom SOAP header element. These are sent in clear text, so Avalara requires the client to use one of the security models to secure the password.

Common Properties

WSDL URL https://eztaxasp.billsoft.com/EZTaxWebService/EZTaxWebService.svc?wsdl

Namespace http://tempuri.org/

Binding Specific Properties

Deprecated Binding

The remainder of this document describes the web service methods and customer data types required to call AFC SaaS Pro from your application. With this interface, the applications pass the transaction data to AFC SaaS Pro as they are being sold or billed. AFC SaaS Pro calculates all required taxes and returns the tax information to the billing system per transaction. In addition, AFC SaaS Pro stores all tax data generated in a database. This data can then be used to generate reports used for tax compliance. AFC SaaS Pro is capable of generating files that can be electronically processed by Atlantax, Ernst & Young, and Tax Partners, Inc., for tax compliance filing. AFC SaaS Pro provides facilities to generate tax adjustments or refunds based upon un-collectable accounts or customer refunds. Adjustment information is returned to the application and is utilized to update tax data for report generation and compliance filing.

CalcTaxesWithPCode

This method accepts transaction data and performs appropriate tax calculations. Origination, Termination, and Bill To information is passed using PCodes.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationPCode must be set! – The OriginationPCode property of the Transaction was not set
• TerminationPCode must be set! – The TerminationPCode property of the Transaction was not set
• BillToPCode must be set! – The BillToPCode property of the Transaction was not set
• Transaction is null! – No Transaction passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

None.

CalcTaxesWithNpaNxx

This method accepts transaction data and performs appropriate tax calculations. Origination, Termination, and Bill To information is passed using NpaNxx values.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction Telecom transaction data

Errors:

• OriginationNpaNxx must be set! – The OriginationNpaNxx property of the Transaction was not set
• TerminationNpaNxx must be set! – The TerminationNpaNxx property of the Transaction was not set
• BillToNpaNxx must be set! – The BillToNpaNxx property of the Transaction was not set
• Transaction is null! – No Transaction passed in
• NPANXX not found. – One of the three NpaNxx values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

None.

CalcTaxesWithZipAddress

This method accepts transaction data and performs appropriate tax calculations. Origination, Termination, and Bill To information is passed using Zip Addresses.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationZipAddress must be set! – The OriginationZipAddress property of the Transaction was not set
• TerminationZipAddress must be set! – The TerminationZipAddress property of the Transaction was not set
• BillToZipAddress must be set! – The BillToZipAddress property of the Transaction was not set
• Transaction is null! – No Transaction passed in
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

None.

CalcTaxesWithFipsCode

This method accepts transaction data and performs appropriate tax calculations. Origination, Termination, and Bill To information is passed using FIPS Code values.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationFipsCode must be set! – The OriginationFipsCode property of the Transaction was not set.
• TerminationFipsCode must be set! – The TerminationFipsCode property of the Transaction was not set.
• BillToFipsCode must be set! – The BillToFipsCode property of the Transaction was not set.
• Transaction is null! – No Transaction passed in
• FIPS not found. – One of the three FipsCode values passed in is not in AFC SaaS Pro
• FIPS (to PCode) cross-reference database not open. - – Indicates an error occurred on the server

See also Error Messages Common to all Calculation Methods

Remarks:

None.

CalcAdjWithPCode

This method accepts transaction data and performs appropriate tax adjustment calculations. Origination, Termination, and Bill To information is passed using PCodes.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationPCode must be set! – The OriginationPCode property of the Transaction was not set
• TerminationPCode must be set! – The TerminationPCode property of the Transaction was not set
• BillToPCode must be set! – The BillToPCode property of the Transaction was not set
• Adjustment is null! – No Adjustment passed in
• PCode not found. – One of the three PCode properties passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcAdjWithNpaNxx

This method accepts transaction data and performs appropriate tax adjustment calculations. Origination, Termination, and Bill To information is passed using NpaNxx values.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationNpaNxx must be set! – The OriginationNpaNxx property of the Transaction was not set.
• TerminationNpaNxx must be set! – The TerminationNpaNxx property of the Transaction was not set.
• BillToNpaNxx must be set! – The BillToNpaNxx property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• NPANXX not found. – One of the three NpaNxx properties passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcAdjWithZipAddress

This method accepts transaction data and performs appropriate tax adjustment calculations. Origination, Termination, and Bill To information is passed using Zip addresses.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationZipAddress must be set! – The OriginationZipAddress property of the Transaction was not set.
• TerminationZipAddress must be set! – The TerminationZipAddress property of the Transaction was not set.
• BillToZipAddress must be set! – The BillToZipAddress property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcAdjWithFipsCode

This method accepts transaction data and performs appropriate tax adjustment calculations. Origination, Termination, and Bill To information is passed using FIPS Codes.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationFipsCode must be set! – The OriginationFipsCode property of the Transaction was not set.
• TerminationFipsCode must be set! – The TerminationFipsCode property of the Transaction was not set.
• BillToFipsCode must be set! – The BillToFipsCode property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• FIPS no found. – One of the three FIPS codes passed in is not in AFC SaaS Pro
• FIPS (to PCode) cross-reference database not open. – Indicates an error occurred on the server

See also Error Messages Common to all Calculation Methods

Remarks:

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcReverseTaxesWithPCode

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveTaxesWithPCode, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using PCodes.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationPCode must be set! – The OriginationPCode property of the Transaction was not set
• TerminationPCode must be set! – The TerminationPCode property of the Transaction was not set
• BillToPCode must be set! – The BillToPCode property of the Transaction was not set
• Transaction is null! – No Transaction passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcReverseTaxesWithFipsCode

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveTaxesWithFipsCode, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using Fips Codes.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationFipsCode must be set! – The OriginationFipsCode property of the Transaction was not set.
• TerminationFipsCode must be set! – The TerminationFipsCode property of the Transaction was not set.
• BillToFipsCode must be set! – The BillToFipsCode property of the Transaction was not set.
• Transaction is null! – No Transaction passed in
• FIPS no found. – One of the three FIPS codes passed in is not in AFC SaaS Pro
• FIPS (to PCode) cross-reference database not open. – Indicates an error occurred on the server

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcReverseTaxesWithZipAddress

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveTaxesWithZipAddress, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using ZipAddress objects.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationZipAddress must be set! – The OriginationZipAddress property of the Transaction was not set.
• TerminationZipAddress must be set! – The TerminationZipAddress property of the Transaction was not set.
• BillToZipAddress must be set! – The BillToZipAddress property of the Transaction was not set.
• Transaction is null! – No Transaction passed in
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcReverseTaxesWithNpaNxx

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveTaxesWithNpaNxx, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using NPANXX numbers.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationNpaNxx must be set! – The OriginationNpaNxx property of the Transaction was not set.
• TerminationNpaNxx must be set! – The TerminationNpaNxx property of the Transaction was not set.
• BillToNpaNxx must be set! – The BillToNpaNxx property of the Transaction was not set.
• Transaction is null! – No Transaction passed in
• NPANXX not found. – One of the three NpaNxx properties passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcReverseAdjWithPCode

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveAdjWithPCode, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using PCodes.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationPCode must be set! – The OriginationPCode property of the Transaction was not set
• TerminationPCode must be set! – The TerminationPCode property of the Transaction was not set
• BillToPCode must be set! – The BillToPCode property of the Transaction was not set
• Adjustment is null! – No Adjustment passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcReverseAdjWithFipsCode

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveAdjWithFipsCode, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using Fips Codes.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationFipsCode must be set! – The OriginationFipsCode property of the Transaction was not set.
• TerminationFipsCode must be set! – The TerminationFipsCode property of the Transaction was not set.
• BillToFipsCode must be set! – The BillToFipsCode property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• FIPS no found. – One of the three FIPS codes passed in is not in AFC SaaS Pro
• FIPS (to PCode) cross-reference database not open. – Indicates an error occurred on the server

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcReverseAdjWithZipAddress

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveAdjWithZipAddress, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using ZipAddress objects.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationZipAddress must be set! – The OriginationZipAddress property of the Transaction was not set.
• TerminationZipAddress must be set! – The TerminationZipAddress property of the Transaction was not set.
• BillToZipAddress must be set! – The BillToZipAddress property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcReverseAdjWithNpaNxx

*It is recommended to begin using the newly renamed ‘tax inclusive’ API, CalcTaxInclusiveAdjWithNpaNxx, as the ‘reverse’ API will be deprecated in the future.

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using NPANXX numbers.

Return Type:

ReverseTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationNpaNxx must be set! – The OriginationNpaNxx property of the Transaction was not set.
• TerminationNpaNxx must be set! – The TerminationNpaNxx property of the Transaction was not set.
• BillToNpaNxx must be set! – The BillToNpaNxx property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• NPANXX not found. – One of the three NpaNxx properties passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcTaxInclusiveTaxesWithPCode

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using PCodes.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationPCode must be set! – The OriginationPCode property of the Transaction was not set
• TerminationPCode must be set! – The TerminationPCode property of the Transaction was not set
• BillToPCode must be set! – The BillToPCode property of the Transaction was not set
• Transaction is null! – No Transaction passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcTaxInclusiveTaxesWithFipsCode

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using Fips Codes.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationFipsCode must be set! – The OriginationFipsCode property of the Transaction was not set.
• TerminationFipsCode must be set! – The TerminationFipsCode property of the Transaction was not set.
• BillToFipsCode must be set! – The BillToFipsCode property of the Transaction was not set.
• Transaction is null! – No Transaction passed in
• FIPS no found. – One of the three FIPS codes passed in is not in AFC SaaS Pro
• FIPS (to PCode) cross-reference database not open. – Indicates an error occurred on the server

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcTaxInclusiveTaxesWithZipAddress

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using ZipAddress objects.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationZipAddress must be set! – The OriginationZipAddress property of the Transaction was not set.
• TerminationZipAddress must be set! – The TerminationZipAddress property of the Transaction was not set.
• BillToZipAddress must be set! – The BillToZipAddress property of the Transaction was not set.
• Transaction is null! – No Transaction passed in
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcTaxInclusiveTaxesWithNpaNxx

This method accepts transaction data and performs a tax inclusive calculation in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using NPANXX numbers.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationNpaNxx must be set! – The OriginationNpaNxx property of the Transaction was not set.
• TerminationNpaNxx must be set! – The TerminationNpaNxx property of the Transaction was not set.
• BillToNpaNxx must be set! – The BillToNpaNxx property of the Transaction was not set.
• Transaction is null! – No Transaction passed in
• NPANXX not found. – One of the three NpaNxx properties passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction.

CalcTaxInclusiveAdjWithPCode

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using PCodes.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationPCode must be set! – The OriginationPCode property of the Transaction was not set
• TerminationPCode must be set! – The TerminationPCode property of the Transaction was not set
• BillToPCode must be set! – The BillToPCode property of the Transaction was not set
• Adjustment is null! – No Adjustment passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcTaxInclusiveAdjWithFipsCode

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using Fips Codes.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationFipsCode must be set! – The OriginationFipsCode property of the Transaction was not set.
• TerminationFipsCode must be set! – The TerminationFipsCode property of the Transaction was not set.
• BillToFipsCode must be set! – The BillToFipsCode property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• FIPS no found. – One of the three FIPS codes passed in is not in AFC SaaS Pro
• FIPS (to PCode) cross-reference database not open. – Indicates an error occurred on the server

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcTaxInclusiveAdjWithZipAddress

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using ZipAddress objects.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationZipAddress must be set! – The OriginationZipAddress property of the Transaction was not set.
• TerminationZipAddress must be set! – The TerminationZipAddress property of the Transaction was not set.
• BillToZipAddress must be set! – The BillToZipAddress property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcTaxInclusiveAdjWithNpaNxx

This method accepts transaction data and performs tax inclusive adjustments in order to arrive at the base sale amount and taxes for the desired total charge. Origination, Termination, and Bill To information is passed using NPANXX numbers.

Return Type:

TaxInclusiveTaxResults - Contains the calculated base sale amount for the transaction and an array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Errors:

• OriginationNpaNxx must be set! – The OriginationNpaNxx property of the Transaction was not set.
• TerminationNpaNxx must be set! – The TerminationNpaNxx property of the Transaction was not set.
• BillToNpaNxx must be set! – The BillToNpaNxx property of the Transaction was not set.
• Adjustment is null! – No Adjustment passed in
• NPANXX not found. – One of the three NpaNxx properties passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

The desired total charge must be placed in the Charge field of the Transaction as a positive number.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

BeginCustomerBatch

Flags the beginning of a customer transaction batch and returns a customer batch ID that can be used to submit each transaction and process the entire batch.

Return Type:

long - A unique identifier for the customer batch.

Parameters:

None

CalcCustTaxes

Submits a single transaction to be processed for a customer batch.

Return Type:

bool - Boolean indicating success or failure

Parameters:

Long - Customer batch identifier

Transaction - Telecom transaction data

Errors:

• Origination location not specified. – The origination location of the Transaction was not set.
• Termination location not specified. – The termination location of the Transaction was not set.
• Bill-To location not specified. – The bill-to location of the Transaction was not set.
• Transaction is null – No transaction passed in.
• Invalid customer batch identifier.
• Maximum number of customer transaction exceeded.

See also Error Messages Common to all Calculation Methods

Remarks:

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcCustAdj

Submits a single adjustment to be processed for a customer batch.

Return Type:

bool - Boolean indicating success or failure

Parameters:

Long - Customer batch identifier

Transaction - Telecom Tranaction data

Errors:

• Origination location not specified. – The origination location of the Transaction was not set.
• Termination location not specified. – The termination location of the Transaction was not set.
• Bill-To location not specified. – The bill-to location of the Transaction was not set.
• Adjustment is null – No adjustment passed in.
• Invalid customer batch identifier.
• Maximum number of customer transaction exceeded.

See also Error Messages Common to all Calculation Methods

Remarks:

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

ProcessCustomerBatch

Processes a customer batch and returns the tax calculation results.

Return Type:

CustomerResults - Data structure containing an array of TaxData objects for each individual transaction processed and CustomerTaxData array containing the summarized taxes for the customer batch.

Parameters:

long - Customer batch ID

bool - Boolean indicating if the detailed taxes for each individual line item should be returned in the results.

Nexus[] - An array of Nexus objects. Can be null or an empty list.

Exclusion[] - An array of Exclusion objects. Can be null or an empty list.

Errors:

• Invalid customer batch identifier – Customer batch ID is not valid.

See also Error Messages Common to all Calculation Methods

NOTE: This API does not support tax inclusive calls. Please see ProcessCustomerBatchV2 for tax inclusive transactions.

ProcessCustomerBatchV2

Processes a customer batch and returns the tax calculation results. Individual taxes returned use the TaxDataV2 data structure which contains a TransCharge field for the calculated base sale amount for each corresponding transaction.

Return Type:

CustomerResultsV2 - Data structure containing an array of TaxDataV2 objects for each individual transaction processed and CustomerTaxData array containing the summarized taxes for the customer batch.

Parameters:

long - Customer batch ID

bool - Boolean indicating if the detailed taxes for each individual line item should be returned in the results.

Nexus[] - An array of Nexus objects. Can be null or an empty list.

Exclusion[] - An array of Exclusion objects. Can be null or an empty list.

Errors:

• Invalid customer batch identifier – Customer batch ID is not valid.

See also Error Messages Common to all Calculation Methods

NOTE: Use of this API does incorporate use of tax inclusive transactions.

CalcTaxesInCustMode

Processes a batch of telecom and/or sales and use transactions and adjustments in Invoice Mode.

Return Type:

CustomerResults - Data structure containing an array of TaxData objects for each individual transaction processed and CustomerTaxData array containing the summarized taxes for the customer batch.

Parameters:

Transaction[] - Telecom transaction array

Transaction[] - Telecom transaction array to be processed as adjustments.

SalesUseTransaction[] - Sales and use transaction array to be processed as adjustments (See TM_00117_AFC SaaS Pro Sales and Use Developer Manual).

Nexus[] - An array of Nexus objects. Can be null or an empty list.  Nexus only applies Sales and Use transactions.

Exclusion[] - An array of Exclusion objects. Can be null or an empty list.

bool - Boolean indicating if the detailed taxes for each individual line item should be returned in the results.

Errors:

See Error Messages Common to all Calculation Methods

NOTE: If a transaction in the batch generates and error, the entire batch will fail. Also, this API does not support tax inclusive calls. Please see ProcessCustomerBatchV2 for tax inclusive transactions.

CalcTaxesInCustModeV2

Processes a batch of telecom and/or sales and use transactions and adjustments in Invoice Mode. Individual taxes returned use the TaxDataV2 data structure which contains a TransCharge field for the calculated base sale amount for each corresponding transaction.

Return Type:

CustomerResultsV2 - Data structure containing an array of TaxDataV2 objects for each individual transaction processed and CustomerTaxData array containing the summarized taxes for the customer batch.

Parameters:

Transaction[] - Telecom transaction array

Transaction[] - Telecom transaction array to be processed as adjustments.

SalesUseTransaction[] - Sales and use transaction array to be processed as adjustments (See TM_00117_AFC SaaS Pro Sales and Use Developer Manual).

Nexus[] - An array of Nexus objects. Can be null or an empty list.  Nexus only applies Sales and Use transactions.

Exclusion[] - An array of Exclusion objects. Can be null or an empty list.

SafeHarborOverride[] – Array of SafeHarborOverride objects. Can be null or an empty list. These overrides are applied to all Telecom transactions in this batch. Overrides entered on the individual transactions are ignored.

bool - Boolean indicating if the detailed taxes for each individual line item should be returned in the results.

Errors:

See Error Messages Common to all Calculation Methods

NOTE: If a transaction in the batch generates and error, the entire batch will fail. Also, use of this API does incorporate use of tax inclusive transactions.

CalcProRatedTaxes

Accepts a pro-rated percentage that is used to calculate the taxable amount on the transaction and perform tax calculations. Bill-to, origination and termination may be entered as PCode, FIPS Codes, ZipAddress or NPANXX.

Return Type:

TaxData[] - An array of TaxData object that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Double - Pro-rated percent specified as a decimal.

Errors:

• Origination location not specified. – The origination property of the transaction was not set
• Termination location not specified. – The termination property of the transaction was not set
• Bill-to location not specified.– The bill-to property of the transaction was not set
• Transaction is null! – No Transaction passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro
• FIPS not found. – One of the three FipsCode values passed in is not in AFC SaaS Pro
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro
• NPANXX not found. – One of the three NpaNxx values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

None.

CalcProRatedAdj

Accepts a pro-rated percentage that is used to calculate the taxable amount on the transaction and perform tax adjustments. Bill-to, origination and termination may be entered as PCode, FIPS Codes, ZipAddress or NPANXX.

Return Type:

TaxData[] - An array of TaxData object that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

Double - Pro-rated percent specified as a decimal.

Errors:

• Origination location not specified. – The origination property of the transaction was not set
• Termination location not specified. – The termination property of the transaction was not set
• Bill-to location not specified.– The bill-to property of the transaction was not set
• Transaction is null! – No Transaction passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro
• FIPS not found. – One of the three FipsCode values passed in is not in AFC SaaS Pro
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro
• NPANXX not found. – One of the three NpaNxx values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

None.

CalcJurisdiction

Determines the taxing jurisdiction for a transaction and returns the PCode at the lowest jurisdiction level.

Return Type: 

uint - PCode for taxing jurisdiction

Parameters

Transaction - Telecom transaction data

Errors:

• Origination location not specified. – The origination property of the transaction was not set
• Termination location not specified. – The termination property of the transaction was not set
• Bill-to location not specified.– The bill-to property of the transaction was not set
• Transaction is null! – No Transaction passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro
• FIPS not found. – One of the three FipsCode values passed in is not in AFC SaaS Pro
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro
• NPANXX not found. – One of the three NpaNxx values passed in is not in AFC SaaS Pro

See also Error Messages Common to all Calculation Methods

Remarks:

None.

NOTE: The transaction/service pair is required and must be provided in order to determine the correct tax jurisdiction.

Also, please note if CalcJurisdiction is called along with an Exclusion, the Exclusion will not be applied.

CalcTaxesWithOverrides

Accepts transaction data and tax rate override data to perform tax calculations with provided override information. Bill-to, origination and termination may be entered as PCode, FIPS Codes, ZipAddress or NPANXX.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

TaxRateOverrideInfo[] - Tax rate override data

Errors:

• Origination location not specified. – The origination property of the transaction was not set
• Termination location not specified. – The termination property of the transaction was not set
• Bill-to location not specified.– The bill-to property of the transaction was not set
• Transaction is null! – No Transaction passed in
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro
• FIPS not found. – One of the three FipsCode values passed in is not in AFC SaaS Pro
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro
• NPANXX not found. – One of the three NpaNxx values passed in is not in AFC SaaS Pro
• This method cannot be used if you have override file in place. – Override file is in place.
• EZtax failed to insert the override. – Override data cannot be applied.

See also Error Messages Common to all Calculation Methods

Remarks:

This method cannot be used if the user already has an override file in place.

CalcAdjWithOverrides

Accepts transaction data and tax rate override data to perform tax adjustment calculations with provided override information. Bill-to, origination and termination may be entered as PCode, FIPS Codes, ZipAddress or NPANXX.

Return Type:

TaxData[] - An array of TaxData objects that contain the information about the taxes applied.

Parameters:

Transaction - Telecom transaction data

TaxRateOverrideInfo[] - Tax rate override data

Errors:

• Origination location not specified. – The origination property of the transaction was not set
• Termination location not specified. – The termination property of the transaction was not set
• Bill-to location not specified.– The bill-to property of the transaction was not set
• PCode not found. – One of the three PCode values passed in is not in AFC SaaS Pro
• Transaction is null! – No Transaction passed in
• FIPS not found. – One of the three FipsCode values passed in is not in AFC SaaS Pro
• County/State/Zip not found. – One of the three ZipAddress values passed in is not in AFC SaaS Pro
• NPANXX not found. – One of the three NpaNxx values passed in is not in AFC SaaS Pro
• This method cannot be used if you have override file in place. – Override file is in place.
• EZtax failed to insert the override. – Override data cannot be applied.

See also Error Messages Common to all Calculation Methods

Remarks:

This method cannot be used if the user already has an override file in place.

Adjustments require application of the same override data that is used with CalcTaxesWithOverrides.

Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

Discounts can also be processed by setting the DiscountType field in the adjustment transaction.

CalcBridgeConferenceTaxes

Note: The Bridge Conferencing feature is currently in development at this time. Please refrain from using this feature as well as the proposed solutions and APIs until further notice.

This method will take a Billing address, Bridge Address, Host Address (Optional) and list of participants and perform the following by participant:

Return Type:

BridgeConferenceResults - Data structure containing an array of BridgeConferenceParticipantResult objects for each participant transaction processed and TaxData array containing the summarized taxes for the bridge conference calculation.

Parameters:

BridgeConferenceTransaction - Bridge conference transaction data structure. Includes an array of BridgeConferenceParticipant objects that define the list of participants.

Errors:

• Bridge conference data is invalid – Invalid transaction data received

See also Error Messages Common to all Calculation Methods

Remarks:

• To return individual participant results, the flag ReturnParticipantTaxes must be set to true. Summarized taxes are always returned.
• If ProcessInvalidParticipant is set to true, and an invalid participant jurisdiction is encountered, the processing will continue with the greatest tax liability applied for the participant.

CalcAdjBridgeConferenceTaxes

Note: The Bridge Conferencing feature is currently in development at this time. Please refrain from using this feature as well as the proposed solutions and APIs until further notice.

This method will take a Billing address, Bridge Address, Host Address (Optional) and list of participants and perform the following by participant:

Return Type:

BridgeConferenceResults - Data structure containing an array of BridgeConferenceParticipantResult objects for each participant transaction processed and TaxData array containing the summarized taxes for the bridge conference calculation.

Parameters:

BridgeConferenceTransaction - Bridge conference transaction data structure. Includes an array of BridgeConferenceParticipant objects that define the list of participants.

Errors:

• Bridge conference data is invalid – Invalid transaction data received

See also Error Messages Common to all Calculation Methods

Remarks:

• To return individual participant results, the flag ReturnParticipantTaxes must be set to true. Summarized taxes are always returned.
• If ProcessInvalidParticipant is set to true, and an invalid participant jurisdiction is encountered, the processing will continue with the greatest tax liability applied for the participant.
• Adjustment transactions are primarily used to process refunds or credits. They rely on the AdjustmentMethod field.

CommitTransactions

The CommitTransactions API is used to commit or uncommit a DocumentCode.

Return Type:

bool - Boolean indicating success or failure

Note: Exception thrown with appropriate error message in case of failure.

Parameters:

Transaction - Telecom transaction data

CommitData - Required as a parameter in order to specify a valid DocumentCode and a Boolean indicating whether transactions with the specified DocumentCode should be committed or uncommitted. Any optional field values provided in this parameter are used when reports are generated in order to replace the corresponding values originally specified within the transaction at the time of tax calculation processing.

Errors:

• DocumentCode cannot be blank or null.
• DocumentCode not found.
• DocumentCode has been locked.
• DoccumentCode cannot exceed 150 characters.

See also Error Messages Common to all Calculation Methods

Remarks:

None.

Error Messages Common to all Calculation Methods

These messages can be returned by any of the calculation methods:

• AdjustmentMethod is Invalid! – The Adjustment Method passed in is not valid
• DiscountType is Invalid! – The Discount Type passed in is not valid
• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.
• CustomerType is Invalid! – The Customer Type passed in is not valid
• BusinessClass is Invalid! – The Business Class passed in is not valid
• ServiceClass is Invalid! – The Service Class passed in is not valid
• Jurisdiction not found. – The jurisdiction does not exist in AFC SaaS Pro
• Invalid Transaction Date – The Transaction Date passed in is not valid
• Invalid transaction/service pair – The Transaction Type and Service Type combination is not valid
• Transaction/Service pair is not supported by the API call – The Transaction Type and Service Type combination cannot be used by the Telecom Interface
• Session not initialized – Indicates an error occurred on the server
• JCode database not open. – Indicates an error occurred on the server
• PCode database not open. – Indicates an error occurred on the server
• ZipCode database not open. – Indicates an error occurred on the server
• NPANXX database not open. – Indicates an error occurred on the server
• Address database not open. – Indicates an error occurred on the server
• Unable to start EZtax. – Indicates an error occurred on the server
• filelocs.txt configuration file not found. – Indicates an error occurred on the server
• Unable to read filelocs.txt configuration file – Indicates an error occurred on the server
• An EZtaxSession hasn’t been specified for this transaction – Indicates an error occurred on the server
• The EZtaxSession object has been disposed. – Indicates an error occurred on the server
• Unable to return the log information – Indicates an error occurred on the server
• Split for private line transaction must be greater than or equal to 0 and less than or equal to 1.
• A valid Transaction Type or Service Type must be supplied.
• Supplied Service Type is invalid.
• Supplied Transaction Type is invalid.
• Cross country border transaction does not support transaction/service auto determination.
• Participants cannot be mixed jurisdiction types!
• PCode not found.
• Address not found.

GetAddress

This method returns the addresses for the specified jurisdiction. If the jurisdiction is invalid the return will be NULL.

Return Type:

AddressData[] - An array of AddressData objects that contain the addresses for the jurisdiction specified by the supplied PCode.

Parameters:

uint - The PCode for the desired jurisdiction.

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.
• PCode not found.

Remarks:

Some jurisdictions have multiple valid addresses.

GetTaxCategory

This method returns the tax category for the specified tax type. If the tax type is invalid the return will be NULL or an empty string.

Return Type:

string - A string describing the tax category for the specified tax type.

Parameters:

int - The tax type.

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

None.

GetTaxDescription

This method returns the description for the specified tax type. If the tax type is invalid the return will be NULL or an empty string.

Return Type:

string - A string describing the specified tax type.

Parameters:

int - The tax type.

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

None.

GetTaxRates

Determines the tax rate information for a jurisdiction identified by the input PCode.

Return Type:

TaxRateInfo - Tax Rate information for a jurisdiction.

Parameters:

uint - PCode for taxing jurisdiction

Errors:

• PCode not found. – The PCode value passed in is not in AFC SaaS Pro.

See also Error Messages Common to all Calculation Methods

Remarks:

None.

FipsToPCode

This method returns the PCode for the specified FIPS code. If the FIPS Code is invalid or has no AFC jurisdiction the return will be NULL.

Return Type:

uint - A nullable unsigned int for the PCode.

Parameters:

string - The FIPS code.

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.

Remarks:

None.

PCodeToFips

This method returns the FIPS Code for the specified PCode. If the PCode Code is invalid the return will be NULL.

Return Type:

string - A string for the FIPS Code.

Parameters:

uint - The PCode.

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

None.

ZipToPCode

This method returns the PCode for the specified ZIP Address. If the ZIP address is invalid or has no AFC jurisdiction the return will be NULL.

Return Type:

uint - A nullable unsigned int for the PCode.  Null indicates an invalid address.

Parameters:

ZipAddress - The ZipAddress object.

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

Based upon the best match, only one PCode is returned. To obtain a full list of matching PCodes, please reference the ZipLookup API. Also, please note it is not required to provide the State. Please reference Zip Lookup Requests for additional information and details.

NpaNxxToPCode

This method returns the PCode for the specified NpaNxx value. If the NpaNxx value is invalid or has no AFC jurisdiction the return will be NULL.

Return Type:

uint - A nullable unsigned int for the PCode

Parameters:

uint - The NpaNxx value

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.
• PCode not found.

Remarks:

None.

GetServerTime

This method returns the time on the AFC SaaS Pro Web Service.

Return Type:

DateTime - The AFC SaaS Pro Web Service server time.

Parameters:

None

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

None.

GetVersion

This method returns the time on the AFC SaaS Pro Web Service.

Return Type:

string - The version of the AFC SaaS Pro Web Service.

Parameters:

None

Errors:

• Authorization Error – Indicates that your userid or password is not recognized.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

None.

GetEZTaxVersion

This method returns the version of the AFC engine used in the background for performing tax calculations.

Return Type:

string - The version of the AFC engine.

Parameters:

None

Errors:

• Authorization Error – Indicates that your userid or password is not recognized.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

None.

GetEZTaxDbVersion

This method returns the version of the underlying AFC database used by the AFC engine.

Return Type:

string - The version of the AFC database.

Parameters:

None

Errors:

• Authorization Error – Indicates that your userid or password is not recognized.
• Server Fault! – Indicates an error occurred on the server.

Remarks:

None.

CreateReport

Submits a request for generating a custom report based on transactions and taxes that have been processed in the web service.

Return Type:

boolean - Boolean indicating success or failure.

Parameters:

ReportOptions - Data structure containing the options for the report.

Errors:

• reportOptions parameter must be specified.
• ReportType must be specified.
• StartDate for the report may not be a future date.
• StartDate for the report may not be prior than 91 days.
• TimeSpan cannot be greater than 31 days.
• TimeSpan or EndDate must be specified.
• EndDate cannot be more than 31 days apart from StartDate.
• EndDate must be greater than StartDate.
• Precision must be between 0 and 6.
• FileName may not exceed 100 characters
• FileExtension may not exceed 5 characters.
• EmailAddress cannot be longer than 100 characters.
• EmailAddress is not in a valid format.
• CustomLogFields must be specified if BaseReport is not used.

Remarks:

None.

Note: Only transactions and taxes that include the company’s 3-character company code in the CompanyIdentifier field of the transaction will be included in the report.

ZipLookup

Returns all or multiple PCodes and juridisdiction details associated with the address input provided by clients.

Return Type:

ZipLookupResult - The ZipLookupResult object.

Parameters:

ZipLookup - The ZipLookup object.

Errors:

• No Session Available! – Indicates that no sessions were available for your request. You may be making too many simultaneous requests to the web service or there is an issue that needs to be reported.
• Authorization Error – Indicates that your userid or password is not recognized.
• Not Authorized! – Indicates that you have called a method on the web service that your service agreement does not include.
• Server Fault! – Indicates an error occurred on the server.
• No jurisdiction data set – Indicates the request had no valid jurisdiction data set (at a minimum, one jurisdiction field must be set).
• Address not found.

Remarks:

If Country is not specified, the default value is set to “USA”.

Transaction

ZipAddress

AddressData

Nexus

Exclusion

TaxExemption

TaxData

TaxDataV2

CustomerResults

CustomerResultsV2

CustomerTaxData

ReverseTaxResults

TaxInclusiveTaxResults

TaxRateInfo

TaxRateHistory

TaxBracketInfo

ReportOptions

CustomLogField

TaxRateOverrideInfo

CategoryExemption

TaxLogDataV914

OptionalField

OptionalKey

ZipLookup

ZipLookupResult

LocationData

SafeHarborOverride

CommitData

BridgeConferenceTransaction

Note: The Bridge Conferencing feature is currently in development at this time. Please refrain from using this feature as well as the proposed solutions and APIs until further notice.

BridgeConferenceParticipant

BridgeConferenceResults

BrideConferenceParticipantResult

Specifying TaxLevel

Specifying CalculationType

Specifying AdjustmentMethod

In certain cases, when the rate of a tax will change based upon the charge or the number of lines in the transaction, clients may wish to make an adjustment at a different rate than would normally apply for the transaction.

For example, if the client purchased 20 lines at a rate of $0.67 per line and the credit or adjustment is for 5 lines at a rate of $1.25 per line, then usage of LEAST for the adjustment method would refund the 5 lines at the least favorable rate for the brackets making sure the client was not over compensated.

If unsure, use the value 0 - “Default”.

Specifying CustomerType

This field is used to specify the type of customer involved in the transaction. The customer type is selected from one of the following four Customer Types.

Specifying BusinessClass

The Business Class Indicator field is used to specify if the business making the transaction is an Incumbent Local Exchange Company (ILEC - 0) or a Competitive Local Exchange Company (CLEC - 1). Applies to Customer.

This setting can also be viewed as “you are ILEC” or ‘you are not ILEC.” If neither class applies, use the default value “CLEC”.

The business class only impacts Telecom transactions in certain jurisdictions, such as Oregon.

Specifying ServiceClass

The Service Class Indicator is provided to delineate the Primary activity of an organization as either Long Distance or Local Service.

The service class only impacts Telecom transactions in certain jurisdictions, such as New York.

Specifying DiscountType

AFC has an additional table that stores discount types by state with an “allow ability” indicator. The adjustment functions have arguments for the discount type which look up the discount type from the table to determine whether to apply taxes or not.

Discounts may or may not be taxed within each state. When a discount is taxed, the customer receives a tax benefit commensurate with the amount of the discount (i.e., if the customer gets $5 off on a transaction subject to a 5% tax, the customer pays $0.25 less in tax than they would have). When a discount is not taxed, the customer receives non-tax benefit from the discount. Whether a discount is taxed or not depends on the type of discount and the rules in a particular tax jurisdiction.

Discount types only apply to adjustment transactions. Refer to Section 4.7.1 Discount Adjustments in the AFC Telecom User Manual for more information on calculating adjustments.

Specifying ExemptionType

• Specifying the exemption type is for reporting purposes only and does not impact tax calculations.
• Spaces and capitalization do not matter in Exemption Type value.
• The bolded text is sufficient, additional characters are ignored.
• The optional numeric ID can be used. For example:
  • Non Profit Sales = nonprofitsales = nonprofit = 6
  • Fed Coupons WIC Vouchers = Fed Coupons = FEDCOUPONS = 4

Specifying Lines

When local service is provided, a transaction should be generated with the Lines field populated with the number of lines the customer subscribes to. AFC uses this information for generation of per line taxes usually associated with local E911 charges and local telecommunications relay service taxes and other assorted taxes.