VertexModule

Vertex client

Map object mapper

The password associated with the User ID of the individual initiating the login

An identifier supplied by an ERP

The User ID of the individual initiating the login

Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system. Any changes made to a financial document can impact previously calculated transactions already written to the Tax Journal. The Synchronization Service schema enable you to accept changes made to a financial document and update the transaction in the Tax Journal accordingly. In addition, schema are provided that enable you to delete a transaction or to roll back a transaction to its previous state.
Note the following restrictions on synchronization services:

• A synchronization transaction fails if attempted on a reversal transaction.
• You cannot use this transaction on point of sale transactions. If you do, an exception is returned.

Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system. Any changes made to a financial document can impact previously calculated transactions already written to the Tax Journal. The Synchronization Service schema enable you to accept changes made to a financial document and update the transaction in the Tax Journal accordingly. In addition, schema are provided that enable you to delete a transaction or to roll back a transaction to its previous state.
Note the following restrictions on synchronization services:

• A synchronization transaction fails if attempted on a reversal transaction.
• You cannot use this transaction on point of sale transactions. If you do, an exception is returned.

Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system. Any changes made to a financial document can impact previously calculated transactions already written to the Tax Journal. The Synchronization Service schema enable you to accept changes made to a financial document and update the transaction in the Tax Journal accordingly. In addition, schema are provided that enable you to delete a transaction or to roll back a transaction to its previous state.

Note the following restrictions on synchronization services:

• A synchronization transaction fails if attempted on a reversal transaction.
• You cannot use this transaction on point of sale transactions. If you do, an exception is returned.

Use the Accrual schema in self-accrual situations. These situations occur when the buyer must remit tax on tangible personal property or services (used or consumed) when tax is due but has not been paid. Accrual transactions are written to the Tax Journal unless you set the postToJournal attribute to false.

Some examples of self-accrual situations include:

• When a seller does not have nexus in the buyer's state and does not collect tax
• When a buyer purchases non-exempt tangible personal property without tax and subsequently uses it in a taxable manner (and the buyer has provided the seller a direct pay permit)
• When a company uses items from inventory in a taxable manner (and the buyer has provided the seller a resale certificate)
• When a buyer in a VAT situation is required to collect and remit the tax, as in the case of intra-EU transactions as well as imports to EU and non-EU countries
• When a country's Place of Supply rules require a buyer to self-accrue in a VAT situation

Use the Asset Movement schema to calculate consumer use tax on movement of fixed assets from one tax jurisdiction to another. Whenever an asset is moved, the use tax rates and rules for the new location must be compared with the use tax rates and rules for the old location. Various reciprocity rules, which vary by tax jurisdiction, may need to be applied in these situations. Two factors that can be used to determine reciprocity are duration at a location and the number of times that an asset was moved. Unless you set the postToJournal attribute to false, Asset Movement transactions are written to the Tax Journal when additional use tax must be accrued at the new location. You can also use the Asset Movement schema to calculate the VAT on movement of fixed assets from one tax jurisdiction to another. A Call Off or Consignment indicator may be passed in the simplificationCode attribute on Asset Movement transactions to allow for the deferment of VAT when appropriate.

Use the Buyer Input Tax schema to record any input or import VAT paid on purchases, and to calculate the recoverable amounts on these taxes. Buyer Input Tax transactions are written to the Tax Journal unless you set the postToJournal attribute to false.

Use the Distribute Sales Tax (Distribute Previously Calculated Tax) schema to accept a combined total tax amount for a purchase and distribute that tax to the appropriate jurisdictions. The combined rates for the taxing jurisdictions are used with the total tax amount to determine the taxable base and then to redistribute the calculated taxes to each level for remittance. Distribute Sales Tax transactions are written to the Tax Journal unless you set the postToJournal attribute to false. You can also use the Distribute Sales Tax schema to process a tax-only credit (to receive credit for an overpayment to taxing jurisdictions) or debit (to report tax that should have been remitted to a taxing jurisdiction) on a sales tax transaction. You do this by setting the isTaxOnlyAdjustmentIndicator attribute on the Request message. The total tax amount that you provide is distributed across the taxing jurisdiction locations you identified, debiting or crediting the tax amount in the Tax Journal. The Distribute Sales Tax transaction uses Vertex Central rules that are in effect as of the date in the documentDate attribute. If records for jurisdiction registration, product exception, or customer exception or exemption are dated on or before that date, they override information in the transaction.

Use the Distribute Tax Procurement (Distribute Previously Calculated Tax) schema to accept a combined total tax amount for a purchase and distribute that tax to the appropriate jurisdictions. The combined rates for the taxing jurisdictions are used with the total tax amount to determine the taxable base and then to redistribute the calculated taxes to each level for remittance. Distribute Tax Procurement transactions are written to the Tax Journal unless you set the postToJournal attribute to false. You can also use the Distribute Tax Procurement schema to process a tax-only credit (to receive credit for an overpayment to taxing jurisdictions) or debit (to report tax that should have been remitted to a taxing jurisdiction) on a consumer use tax transaction. You do this by setting the isTaxOnlyAdjustmentIndicator attribute on the Request message. The total tax amount that you provide is distributed across the taxing jurisdiction locations you identified, debiting or crediting the tax amount in the Tax Journal. The Distribute Tax Procurement transaction uses Vertex Central rules that are in effect as of the date in the documentDate attribute. If records for jurisdiction registration, product exception, or customer exception or exemption are dated on or before that date, they override information in the transaction.

Use the ERS schema to calculate tax when a formalized agreement exists between the buyer and seller that places the tax calculation burden on the buyer. In these situations, no invoice is actually issued by the seller; rather, the buyer relies on pre-established terms (represented in a purchase order or other agreement) to calculate his or her obligation and remit payment directly to the seller. A current knowledge of the seller's tax status (for example, where the seller has nexus) must be maintained to assess tax at the proper rate. ERS transactions are written to the Tax Journal unless you set the postToJournal attribute to false.

Use the Inventory Removal schema to calculate consumer use tax when withdrawing inventory for a specific internal project or task. Consumer use tax that results from an Inventory Removal transaction should be accrued at the final destination location of the inventory. Inventory Removal transactions are written to the Tax Journal unless you set the postToJournal attribute to false.

Use the Invoice schema to calculate tax at the time of shipping, billing, or invoicing from the seller's perspective. Because tax liability is typically incurred at the point of invoicing, Invoice transactions are written to the Tax Journal.

Use the Invoice Verification schema to verify sales or seller use tax on incoming invoices to the buyer for tangible personal property, rentals, leases, and services. The invoice is recreated from the seller's perspective to validate that the proper tax has been applied. The interface verifies the total tax amount on the original invoice versus the calculated amount. User-defined thresholds for tolerance are validated at the transaction level or line-item level, and an indicator is returned for undercharges and overcharges outside these settings. No tax may be on the invoice if the buyer has filed a direct pay permit with the vendor. Invoice Verification transactions are written to the Tax Journal unless you set the postToJournal attribute to false. Invoice Verification transactions are not part of most standard reports. If the Invoice Verification transaction falls within the user-defined threshold, the Calculation Engine automatically determines if additional taxes are due in any jurisdictions. If additional taxes are due, the amount is returned with the AdditionalTaxesDue element in the response message. The result of this additional tax calculation is not written to the Tax Journal. If you require this detail to be recorded in the Tax Journal, pass a separate Accrual transaction. {@sample.xml../../../doc/vertex-connector-samples.xml vertex:calculate-invoice-verification}

Use the Purchase Order schema to estimate the sales tax or value added tax on intended purchases made by a buyer. The intended purchase of goods or services, including the estimated tax, is used as input to generate the purchase order. For sales tax, the ultimate use of the goods or services typically determines the taxability of the purchase. Note that because these events are used to estimate tax, no transactions are stored in the Tax Journal.

Use the Quotation schema to estimate taxes on the proposed sale, rental, or lease of goods or services by the seller. Quotations may be called from a CRM, Mobile Sale, Order Entry, or Internet Sale application. Because Quotation transactions are subject to change until an invoice is finalized, they are not written to the Tax Journal.

Use the Reversal schema to post a new transaction to the Tax Journal, using values that are numerically opposite the values in the original transaction. Note that no calculations are performed; instead, the values from the original transaction are used.

Restrictions
Note the following restrictions on Reversal transactions:

• You cannot reverse a transaction unless it was posted to the Tax Journal and given a unique user-defined identifier.
• Once a transaction has been reversed, you cannot reverse the original transaction again. However, you can reverse the reversal transaction itself.
• You can reverse active synchronization transactions but not inactive synchronization transactions. If you reverse a rolled-back active synchronization transaction, no exception is returned.
• Transaction Tester does not allow you to test transaction reversals.
• Point of sale transactions cannot be reversed. An exception is returned if you try to reverse a point of sale transaction.

Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system. Any changes made to a financial document can impact previously calculated transactions already written to the Tax Journal. The Synchronization Service schema enable you to accept changes made to a financial document and update the transaction in the Tax Journal accordingly. In addition, schema are provided that enable you to delete a transaction or to roll back a transaction to its previous state.
Note the following restrictions on synchronization services:

• A synchronization transaction fails if attempted on a reversal transaction.
• You cannot use this transaction on point of sale transactions. If you do, an exception is returned.

Use the Find Changed Tax Area schema to identify Tax Area IDs that have changed within a specified date period.

Use the Find Tax Areas schema to send a batch of queries to retrieve jurisdictional information. For example, you could use this to retrieve the Tax Area IDs for multiple postal addresses.

Returns the password.

Returns the trustedId.

Returns the username.

Initialize the VertexClient with the given login credentials

Use the Is Tax Area Changed schema to indicate whether a specified Tax Area ID has changed within a specified date period.

Pings the webservice

Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system. Any changes made to a financial document can impact previously calculated transactions already written to the Tax Journal. The Synchronization Service schema enable you to accept changes made to a financial document and update the transaction in the Tax Journal accordingly. In addition, schema are provided that enable you to delete a transaction or to roll back a transaction to its previous state.
Note the following restrictions on synchronization services:

• A synchronization transaction fails if attempted on a reversal transaction.
• You cannot use this transaction on point of sale transactions. If you do, an exception is returned.

Sets the VertexClient.

Sets the password.

Sets the trustedId.

Sets the username.

Use the Tax Area schema to send a single query to retrieve jurisdictional information. For example, you could use this to retrieve the Tax Area ID for a single postal address.

Use the Transaction Exists schema to find out whether a transaction with a unique user-defined identifier exists in the Tax Journal. The identifier is transactionId in the XML message and transSyncIdCode in the Tax Journal. Note that transactions that have been deleted from the Tax Journal (that is, flagged as Deleted) return False on the Transaction Exists query.