Communications REST v1 - Methods

Method Purpose Summary
Address Lookup all countries in AFC

List of countries with details including name, PCode, ISO code and IOC code.

AddressCity Lookup all cities for a given country and state/province/region.

List of cities in a given country and state/province/region with details including name, Postal/ZIP Code, county and PCode.

AddressState Lookup all states in a given country

List of states/provinces/regions in a given country with details including name, two-letter code, and any counties within.

AddressToPCode Lookup jurisdictions by location name and/or postal code

Searches jurisdiction matches for the address provided.

AllAddress List of all addresses raw.

.

CalcAdjustmentsWithOverrides Calculate tax adjustments using overrides

Accepts transaction and tax rate override data to perform tax adjustments with the provided override information.

CalcTaxesInCustMode Process transactions and adjustments in customer mode

Processes a batch of transactions and adjustments in customer mode.

CalcTaxesWithOverrides Calculate taxes using overrides

Accepts transaction and tax rate override data to perform tax calculations with the provided override information.

CalculateAdjustments Calculate tax adjustments on transaction

This method accepts transaction data and performs appropriate tax adjustment calculations.

CalculateJurisdiction Determine jurisdiction for transaction

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

CalculateProRatedAdjustments Calculate tax adjustments for a pro-rated transaction

Accepts a pro-rated percentage that is used to calculate the taxable amount on the transaction and perform tax adjustments.

CalculateProRatedTaxes Calculate taxes for a pro-rated transaction

Accepts a pro-rated percentage that is used to calculate the taxable amount on the transaction and perform tax calculations.

CalculateReversalAdjustment Perform a tax-inclusive tax adjustment

This method accepts transaction data and performs a reverse tax adjustment in order to arrive at the base sale amount and taxes for the desired total charge.

CalculateReversalTaxes Perform a tax-inclusive tax calculation

This method accepts transaction data and performs a reverse tax calculation in order to arrive at the base sale amount and taxes for the desired total charge.

CalculateTaxes Calculates taxes on a transaction batch.

.

CalculateTaxes Calculate taxes on a transaction

This method accepts transaction data and performs appropriate tax calculations.

CommitTransactions Calculate taxes on a transaction

This method accepts transaction data and performs appropriate tax calculations.

GetAddress Get address information for a jurisdiction

This method returns a list of addresses for the specified jurisdiction.

GetAFCDatabaseEngineVersion Get the AFC tax engine database version

Returns the AFC tax engine database version.

GetAfcEngineVersion Get the version of the AFC tax engine

Returns the version of the AFC tax engine.

GetPCode Determine PCode for a location

Converts the given request data to a PCode.

GetRESTVersion Get the version of the Rest APIs

Returns the version of the REST APIs.

GetServerTime Get server time

Returns the server time in UTC.

GetTaxCategory Get tax category for a tax type

This method returns the tax category for the specified tax type.

GetTaxDescription Get the tax description for a tax type

This method returns the description for the specified tax type ID.

GetTaxRates Get tax rates for a jurisdiction

Returns the tax rate information for a jurisdiction identified by the specified PCode.

GetTransactionServices Get list of all Transaction-Service pairs.

.

PCodeToFips Convert a PCode to FIPS code

This method returns the FIPS code for the specified PCode.