Summary: Configuration | Message Processors
org.mule.modules

mule-module-vertex

1.0.1
Namespacehttp://www.mulesoft.org/schema/mule/vertex
Schema Locationhttp://www.mulesoft.org/schema/mule/vertex/1.0/mule-vertex.xsd
Version1.0
Minimum Mule Version3.2

Module Overview

Provides Vertex connectivity to mule.

Vertex provides tax data, technology, services, and expertise to help you manage every stage of the corporate tax lifecycle -- from tax accounting to calculation, compliance, audit support, and planning.

Summary

Configuration
<vertex:config>
Configure an instance of this module
Message Processors
<vertex:calculate-a-p-invoice-sync-tax>
Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system.
<vertex:calculate-a-r-billing-sync-tax>
Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system.
<vertex:calculate-accrual-sync-tax>
Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system.
<vertex:calculate-accrual-tax>

Use the Accrual schema in self-accrual situations.

<vertex:calculate-asset-movement-tax>
Use the Asset Movement schema to calculate consumer use tax on movement of fixed assets from one tax jurisdiction to another.
<vertex:calculate-buyer-input-tax>
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.
<vertex:calculate-distribute-tax>
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.
<vertex:calculate-distribute-tax-procurement>
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.
<vertex:calculate-e-r-s-tax>
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.
<vertex:calculate-inventory-removal-tax>
Use the Inventory Removal schema to calculate consumer use tax when withdrawing inventory for a specific internal project or task.
<vertex:calculate-invoice-tax>
Use the Invoice schema to calculate tax at the time of shipping, billing, or invoicing from the seller's perspective.
<vertex:calculate-invoice-verification>
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.
<vertex:calculate-purchase-order-tax>
Use the Purchase Order schema to estimate the sales tax or value added tax on intended purchases made by a buyer.
<vertex:calculate-quotation-tax>
Use the Quotation schema to estimate taxes on the proposed sale, rental, or lease of goods or services by the seller.
<vertex:calculate-reversal-tax>
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.
<vertex:delete-transaction-sync>
Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system.
<vertex:find-changed-tax-area-ids>
Use the Find Changed Tax Area schema to identify Tax Area IDs that have changed within a specified date period.
<vertex:find-tax-areas>
Use the Find Tax Areas schema to send a batch of queries to retrieve jurisdictional information.
<vertex:is-tax-area-changed>
Use the Is Tax Area Changed schema to indicate whether a specified Tax Area ID has changed within a specified date period.
<vertex:rollback-transaction-sync>
Use the Synchronization Services schema to reconcile transactions between Vertex O Series and your host system.
<vertex:tax-area-lookup>
Use the Tax Area schema to send a single query to retrieve jurisdictional information.
<vertex:transaction-exists>
Use the Transaction Exists schema to find out whether a transaction with a unique user-defined identifier exists in the Tax Journal.

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:vertex="http://www.mulesoft.org/schema/mule/vertex"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/vertex
               http://www.mulesoft.org/schema/mule/vertex/1.0/mule-vertex.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
TypeNameDefault ValueDescription
xs:string name Optional. Give a name to this configuration so it can be later referenced.
xs:string password The password associated with the User ID of the individual initiating the login
xs:string trustedId Optional. An identifier supplied by an ERP
xs:string username The User ID of the individual initiating the login

Message Processors

<vertex:calculate-a-p-invoice-sync-tax>

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.
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate Optional. The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType Optional. An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:chargedTax>
Optional. This value is used when the buyer has paid a portion of the tax due on the invoice but an undercharge scenario occurs that required a partial accrual of tax or additional use tax may be due depending on the jurisdiction and usage of the Purchase. The amount paid from the invoice verification process should be passed so that partial accrual can be applied. Additional consumer use tax will be automatically accrued.
<vertex:lineItems>
Optional. The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-a-r-billing-sync-tax>

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.
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate Optional. The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType Optional. An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:seller>
Optional. The Seller for the transaction. The Seller is described by the child elements and attributes. Required (1) at either the Transaction level or the Line Item level. If information is provided at both levels, the Line Item level information supersedes the Transaction level information.
<vertex:customer>
Optional. The Customer for the transaction. The Customer is described by the child elements and attributes.
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:discount>
Optional. Details on the discount. To pass Discount information, pass either DiscountPercent or DiscountAmount, but not both.
<vertex:lineItems>
Optional. The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-accrual-sync-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate Optional. The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType Optional. An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:chargedTax>
Optional. This value is used when the buyer has paid a portion of the tax due on the invoice but an undercharge scenario occurs that required a partial accrual of tax or additional use tax may be due depending on the jurisdiction and usage of the Purchase. The amount paid from the invoice verification process should be passed so that partial accrual can be applied. Additional consumer use tax will be automatically accrued.
<vertex:lineItems>
Optional. The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-accrual-tax>

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

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:chargedTax>
Optional. This value is used when the buyer has paid a portion of the tax due on the invoice but an undercharge scenario occurs that required a partial accrual of tax or additional use tax may be due depending on the jurisdiction and usage of the Purchase. The amount paid from the invoice verification process should be passed so that partial accrual can be applied. Additional consumer use tax will be automatically accrued.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-asset-movement-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
movementMethod Optional. Indicates how assets are moved. If no value is provided, the Calculation Engine defaults to REGULAR.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:owner>
Optional. The owner of the goods in the transaction. Required (1) at either the Transaction level or the Line Item level. If Owner information is provided at both levels, the Line Item level information supersedes the Transaction level information.
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-buyer-input-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-distribute-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
isTaxOnlyAdjustmentIndicator Optional. Indicates whether or not the transaction is a tax-only adjustment. If this indicator is set, the total tax amount passed is distributed across the specified taxing jurisdictions, debiting or crediting the tax amount in the Tax Journal. Tax-only adjustment transactions do not impact revenue.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:seller>
Optional. The seller for the transaction. The seller is described by the child elements and attributes.
<vertex:customer>
Optional. The customer for the transaction. The customer is described by the child elements and attributes.
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:discount>
Optional. Details on the discount. To pass Discount information, pass either DiscountPercent or DiscountAmount, but not both.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-distribute-tax-procurement>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
isTaxOnlyAdjustmentIndicator Optional. Indicates whether or not the transaction is a tax-only adjustment. If this indicator is set, the total tax amount passed is distributed across the specified taxing jurisdictions, debiting or crediting the tax amount in the Tax Journal. Tax-only adjustment transactions do not impact revenue.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:chargedTax>
Optional. This value is used when the buyer has paid a portion of the tax due on the invoice but an undercharge scenario occurs that required a partial accrual of tax or additional use tax may be due depending on the jurisdiction and usage of the Purchase. The amount paid from the invoice verification process should be passed so that partial accrual can be applied. Additional consumer use tax will be automatically accrued.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-e-r-s-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
calculateSelfAccrualIndicator Optional. When set to TRUE, causes the buyer's self-accrual liability to be processed when determining the vendor-charged liability.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-inventory-removal-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:owner>
Optional. The owner of the goods in the transaction. Required (1) at either the Transaction level or the Line Item level. If Owner information is provided at both levels, the Line Item level information supersedes the Transaction level information.
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-invoice-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:seller>
Optional. The Seller for the transaction. The Seller is described by the child elements and attributes. Required (1) at either the Transaction level or the Line Item level. If information is provided at both levels, the Line Item level information supersedes the Transaction level information.
<vertex:customer>
Optional. The Customer for the transaction. The Customer is described by the child elements and attributes.
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:discount>
Optional. Details on the discount. To pass Discount information, pass either DiscountPercent or DiscountAmount, but not both.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-invoice-verification>

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}

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
postToJournal Optional. Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:chargedTax>
Optional. This value is used when the buyer has paid a portion of the tax due on the invoice but an undercharge scenario occurs that required a partial accrual of tax or additional use tax may be due depending on the jurisdiction and usage of the Purchase. The amount paid from the invoice verification process should be passed so that partial accrual can be applied. Additional consumer use tax will be automatically accrued.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-purchase-order-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
recoverableDate Optional. The date used to calculate Recoverable Input VAT.
calculateVendorTaxIndicator Optional. When set to TRUE, causes the vendor-charged liability to be processed when determining the buyer's self-accrual liability.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:buyer>
Optional. The buyer for the transaction. The buyer is described by the child elements and attributes.
<vertex:vendor>
Optional. The vendor for the transaction. The vendor is described by the child elements and attributes
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-quotation-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
documentNumber Optional. The document number in the host application that references the event.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
locationCode Optional. A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
returnAssistedParametersIndicator Optional. Indicates whether the response message should contain an additional structure that shows the elements/attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
returnGeneratedLineItemsIndicator Optional. If this indicator is set, the response message returns child line items that were generated by the Tax Assist allocation feature. Otherwise, these line items are deleted after the transaction is written to the Tax Journal and only the primary line item, which contains the combined tax results of the child line items, is passed back to the host system.
deliveryTerm Optional. An identifier that determines the vendor or customer jurisdiction in which the title transfer of a supply takes place. This is also known as Shipping Terms. Delivery Terms information could be critical to determine the place of supply, for example, in distance selling.
documentDate The actual date of the requested action. The calculation engine uses this date to determine the valid tax rates and rules.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
transactionType An identifier for the specific transaction type to be used by the transaction and/or line item. If transactionType is not set at the line item level, the line item uses the transaction level value.
simplificationCode Optional. A code that indicates a special action on the transaction being processed.
Child Elements
<vertex:currency>
Optional. Default unit of currency for the entire transaction.
<vertex:originalCurrency>
Optional. This represents the currency in which the original business transaction took place.
<vertex:seller>
Optional. The seller for the transaction. The seller is described by the child elements and attributes.
<vertex:customer>
Optional. The customer for the transaction. The customer is described by the child elements and attributes.
<vertex:taxOverride>
Optional. Details on the tax override.
<vertex:impositionsToProcess>
Optional. Limits the taxes calculated for the transaction to a specific jurisdiction level and imposition type.
<vertex:jurisdictionOverrides>
Optional. Details on the jurisdiction overrides.
<vertex:situsOverride>
Optional. Details on the situs determination overrides.
<vertex:discount>
Optional. Details on the discount. To pass Discount information, pass either DiscountPercent or DiscountAmount, but not both.
<vertex:lineItems>
The header for a component of a transaction. A line item is required for each component of the transaction. Each transaction requires at least one line item. Note that a line item can contain child line items.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:calculate-reversal-tax>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
originalTransactionId The Transaction ID of the transaction to be reversed.
transactionId Optional. An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
postingDate Optional. The date when the transaction is posted for auditing and reporting purposes. If no date is provided, the Calculation Engine uses the date when the transaction was processed.
documentNumber Optional. The document number in the host application that references the event.
Child Elements
Return Payload
Exception Payload
VertexRuntimeException

<vertex:delete-transaction-sync>

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.
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
transactionId An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
Child Elements
Return Payload
Exception Payload
VertexRuntimeException

<vertex:find-changed-tax-area-ids>

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

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
Child Elements
<vertex:datePeriod>
The date range to be searched.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:find-tax-areas>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
Child Elements
<vertex:taxAreaLookups>
The criteria to use in looking up the tax area. Use one of the following: TaxAreaId, PostalAddress, or ExternalJurisdiction.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:is-tax-area-changed>

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

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
taxAreaId Optional. A Vertex-specific number that identifies a tax area.
Child Elements
<vertex:datePeriod>
The date range to be searched.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:rollback-transaction-sync>

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.
XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
transactionId An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes.
Child Elements
Return Payload
Exception Payload
VertexRuntimeException

<vertex:tax-area-lookup>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
Child Elements
<vertex:taxAreaLookup>
The criteria to use in looking up the tax area. Use one of the following: TaxAreaId, PostalAddress, or ExternalJurisdiction.
Return Payload
Exception Payload
VertexRuntimeException

<vertex:transaction-exists>

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.

XML Sample
INCLUDE_ERROR

Attributes
NameDefault ValueDescription
config-ref Optional. Specify which configuration to use.
transactionId An identifier that further defines the document and corresponds to the transaction stored in the host system. The Transaction ID is used for synchronization services, but is not used for reporting purposes. Stored in the Tax Journal as transSyncIdCode.
Child Elements
Return Payload
Exception Payload
VertexRuntimeException