Vertex Rest V2
Bad Request
Unauthorized
Forbidden
Internal Server Error
Vertex Tax Calculation API
Based on the property SaleMessageType value, a tax calculation is performed and may or may not be saved for reporting and tax remittance.
Quotation call / message
A quotation request is used to estimate taxes on a proposed sale or rental by the seller. Because it is an estimate, a quotation request is subject to change until the transaction is finalized and is not stored for reporting and remittance.
Invoice call / message
An Invoice request is used to initiate tax calculation on a transaction. Use this request to calculate tax at the time of shipping, billing, or invoicing from the seller’s perspective. Invoice transactions are stored and used for reporting and remittance.
Distribute Tax call / message
A Distribute tax message is used to initial a Distribute Tax Calculation. This request can be used for a tax-only adjustment (debit or credit) to reconcile a tax underpayment or overpayment. It accepts a combined total tax amount for a purchase and distributes that tax to the appropriate jurisdictions. The engine uses the total tax amount with the combined rate for the taxing jurisdictions to determine the taxable base and then redistributes the calculated taxes to each level for remittance. Distribute tax transactions are stored and may affect revenue and be used in reporting and remittance.
Request body
Responses
Success
Based on the property PurchaseMessageType value, a tax calculation is performed and may or may not be saved for reporting and tax remittance.
Purchase Order call / message
A Purchase Order is used to estimate the tax on intended purchases for a Buyer. The intended purchase of goods or services, including tax, is used as input to generate the purchase order. The ultimate use of the goods or services typically dictates the taxability of the purchase. Purchase Order transactions are not stored for reporting or used in tax remittance.
Accrual call / message
The Accrual Request initiates a self-accrual calculation. This situation occurs when the buyer must remit tax on tangible personal property or services (used or consumed) when tax due on the transaction has not been paid. Accrual transactions are stored and used for reporting and remittance.
Invoice Verification call / message
The Invoice Verification is used to verify tax on incoming invoices to the buyer for tangible personal property, rentals, and leases. The invoice is recreated from the seller’s perspective to validate that the appropriate tax has been applied. The Invoice Verification compares the total vendor-charged or supplier-charged tax amount from the original invoice to the Vertex-calculated tax amount. If any user-defined verification thresholds are set up, the engine validates for tolerances at the transaction level, and returns an indicator to the host system for undercharges and overcharges outside of the settings. The invoice may display no tax if the buyer has filed a direct pay permit with the vendor or supplier. Invoice Verification transactions are not stored for reporting or used in tax remittance.
Distribute Tax call / message
The Distribute Tax Procurement accepts a combined total tax amount for a purchase and distributes that tax to the appropriate jurisdictions. The engine uses the total tax amount with the combined rates for the taxing jurisdictions to determine the taxable base, and then redistributes the calculated taxes to each level for remittance. Use this request for a tax-only adjustment (debit or credit) to reconcile a tax underpayment or overpayment. The engine uses Vertex taxability rules that are effective on the date specified in the documentDate attribute. The engine processes records for jurisdiction registration, product exception or customer exception, or customer exemption if they are dated on or before that date. A Distribute Tax Procurement transaction impacts revenue unless you designate it as a tax-only adjustment. Distribute Tax Procurement transactions are stored for reporting.
Evaluated Receipts Settlement (ERS) call / message
Initiates an ERS calculation. Use the ERS request to calculate tax when a formalized agreement between the buyer and seller places the tax calculation burden on the buyer. In these situations, the seller does not issue an invoice. Instead, the buyer relies on pre-established terms (represented in a purchase order or other agreement) to calculate the tax due and remit payment directly to the seller. You must have a current knowledge of the seller’s tax status (for example, where the seller is registered or has nexus) to assess tax at the appropriate rate. In instances where the seller is not registered or does not have nexus in a taxing jurisdiction, the buyer determines the tax due and remits this Consumer Use Tax directly to the jurisdiction.
Request body
Responses
Success
Based on the property ownerMessageType value, a tax calculation is performed and may or may not be saved for reporting and tax remittance.
Request body
Responses
Success
Vertex Transactions Sync API
{id}{id}/reversal{transactionid}{id}Delete a transaction stored in the host system.
Path variables
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.
Responses
Success
{id}/reversalCreates a second transaction with negated taxability amounts to “reverse” the original transaction.
Path variables
The Transaction ID of the transaction to be reversed. This is a unique user-defined value that was provided on the original tax calculation.
Request body
Examples
{
"data": {
"transactionId": "",
"postingDate": "",
"documentNumber": ""
}
}Responses
Success
{transactionid}Check if the transaction with the specified transactionId exists.
Path variables
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.
Responses
Success
Tax area lookup API
The address lookup process takes an address and attempts to verify and cleanse the address by determining possible Vertex-defined tax areas and associated jurisdictions.
Request body
Responses
Success
The coordinates lookup process takes a latitude and a longitude and attempts to determine possible Vertex-defined tax areas and associated jurisdictions.
Request body
Responses
Success
Looks up details for a specific Tax Area ID.
Request body
Responses
Success
Looks up by using an identifier from a government authority.
Request body
Responses
Success
Batch Tax Area Lookup API
This operation allows multiple tax area searches in a single web service call. All the available search criteria may be used.
Request body
Responses
Success
Changed Tax Area API
{taxareaid}Identifies tax areas that have changed for any reason within a date range.
Request parameters
Begin date for the search.
End date for the search.
Responses
Success
{taxareaid}Identifies whether a specific tax area has changed for any reason within a date range.
Path variables
The specific tax area for which to check for changes.
Request parameters
Begin date for the search.
End date for the search.
Responses
Success
The monetary unit to be used in calculations as defined by ISO 4217 standard.
The three-character ISO 4217 alphabetic code for the currency unit.
The three-digit ISO 4217 numeric code for the currency unit.
The ISO 4217 name for the currency unit. This field is populated in the response if the user passes in a valid code or number in the request. It is ignored if passed in the request.
A currency conversion factor.
The conversion multiplier for converting a source currency to a target currency.
The rate (multiplier) used for converting the transaction currency amount to the filing currency amount. Pass in this value and the currency code (isoCurrencyCodeAlpha or isoCurrencyCodeNum) to have filing currency calculated if your configuration parameters are set up to do so.
The proper name of the city used to determine the Tax Area ID (if none is supplied). Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The country used to determine the Tax Area ID (if none is supplied). You can use a data extract report to see the valid country values. (Refer to the Online Help for information about for information on running data extract reports.) Defaults to the value of the Default Country Code For Address setting. The default value for this setting is USA. (For details about this setting, refer to the Configuration Parameters Reference Guide.)
Jurisdiction code assigned by the relevant governmental authority.
A number representing the geographical latitude coordinate of the location.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A number representing the geographical longitude coordinate of the location.
The proper name or the postal abbreviation of the state, province, or territory used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The postal code used to determine the Tax Area ID (if none is supplied). For valid formats, see the Supporting Information section in the XML Integration Guide. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The first line of the street address.
The second line of the street address.
The name of the county used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
A Vertex-specific number that identifies a tax area. If the Tax Area ID exists in your host system, use that data to populate this data element in a request message.
A code used to represent groups of customers who have similar taxability. Note: If you pass a classCode, you should not pass a TaxRegistrationNumber because the registration number does not apply to the entire class.
Indicates whether or not the participant is a business.
Details about the exemption certificate.
The identifier of the exemption certificate, which is recorded in the Tax Journal. Vertex recommends that you use the user interface to set up and maintain exemption certificates. Note: If you pass an exemption certificate number in the XML message, the isTaxExempt attribute of the participant is set to true and the transaction is treated as exempt from tax.
The type description assigned to the imposition. When multiple impositions are imposed within a jurisdiction, each must have a different type. This is assigned either by Vertex or by the user when setting up a user-defined imposition on the user interface.
The Vertex internal identifier for the impositionType.
Identifier for a user-defined imposition type. The default value is False.
The name of the imposition type.
The withholding type of the impositionType.
Indicates whether or not the override applies at this jurisdiction level.
Indicates whether or not the override applies at this jurisdiction level.
Indicates whether or not the override applies at this jurisdiction level.
Indicates whether or not the override applies at this jurisdiction level.
Indicates whether or not the override applies at this jurisdiction level.
The proper name of the city used to determine the Tax Area ID (if none is supplied). Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The country used to determine the Tax Area ID (if none is supplied). You can use a data extract report to see the valid country values. (Refer to the Online Help for information about running data extract reports.) Defaults to the value of the Default Country Code For Address setting. The default value for this setting is USA. (For details about this setting, refer to the Configuration Parameters Reference Guide.)
The proper name or the postal abbreviation of the state, province, or territory used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The postal code used to determine the Tax Area ID (if none is supplied). For valid formats, see the Supporting Information section in the XML Integration Guide. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The first line of the street address.
The second line of the street address.
The name of the county used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
A Vertex-specific number that identifies a tax area. If the Tax Area ID exists in your host system, use that data to populate this data element in a request message.
Enumeration containing the types of tax registrations.
Indicates whether or not the entity has a physical presence in the country represented by the registration.
The 2-character or 3-character alphabetic ISO 3166 code indicating the country represented by the registration.
The Vertex-specific number that identifies a jurisdiction.
The proper name or postal abbreviation of the state, province, or territory of the tax registration.
A list of nexus overrides. Maximum four overrides are allowed.
A list of physical locations.
The tax registration ID number.
The reason code can be passed through the ERP application if functionality is provided. However, most lessees will set up reason codes associated with lessees on the user interface. The valid reason codes are expected from the calling application and are predefined by Vertex for use in the Returns application. Note: To pass a standard (i.e., not user-defined) single-digit reason code, pad the code to four digits. Refer to the Supporting Information section of the XML Integration Guide for information about exemption and deduction reason codes.
Indicates that the buyer is not required to collect taxes, and all line items associated with the purchase order are exempt from taxes. It is recommended that the buyer and vendor nexus requirements be created and maintained on the user interface. Note: This attribute is set to true if you pass an exemption certificate number in the XML message.
Details on the discount. To pass discount information, pass either DiscountPercent or DiscountAmount, but not both.
A user-defined code that maps to a Vertex-supplied discount category. You can use the user interface to map your discount codes to discount categories.
The amount used to override taxability to partial or full exempt status. If this data element is used to pass an override amount from the host system, the calculation engine ignores any applicable exceptions or overrides set up on the user interface. Vertex recommends that you use the user interface to create and maintain exceptions and overrides rather than using this data element.
A code that indicates the reason for the override. If your host system provides this functionality, this data element can be used. You can use the user interface to set up reason codes. Valid reason codes are expected from the host system and are pre-defined by Vertex for use in Returns Export. Note: To pass a standard (i.e., not user-defined) single-digit reason code, pad the code to four digits. Refer to the Supporting Information section of the XML Integration Guide for information about exemption and deduction reason codes.
Limits the taxes calculated for the transaction to a specific jurisdiction type and imposition type.
Container for user-defined fields. Fields are provided for string values, numeric (double) values, and date values.
User-defined field for string values.
User-defined field for date values.
User-defined field for double values.
Line item declaration for Sale Request message.
The calculated tax amount in the default currency code for a transaction.
The total taxable amount in the default currency code for a transaction.
A value that indicates a specific area of an organization generally related to functional or accounting areas.
The 3-digit ISO 3166 code of the country where the product was produced or manufactured.
A unique identifier that associates a line item to a department for purchasing purposes.
The export procedure (sales) or import procedure (purchases) that is applied for INTRASTAT purposes.
A value that is used with a company’s Chart of Accounts.
The amount of tax to be distributed. This field is applicable to Distribute Tax only.
Used to classify the goods and services. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
Indicates whether the calculation engine calculates component-level max tax, where applicable. Amounts at the child level of the multicomponent item are used for tax calculation. Amounts at the parent level are ignored. Set this attribute to true for line items at the parent level only. Line items at the child level remain false. Defaults to false.
An identifier that further defines the line item and corresponds to the transaction stored in the host system. This parameter is needed to perform synchronization services, but it is not used for reporting purposes.
A line number for the line item. This number can be used as a reference in reports or in audits. If no line item number is supplied, a number will be assigned.
A sub-component (or child line item) of the transaction.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A value that represents a specific item or product.
The material origin type. Material origin applies to countries, such as Brazil and India, where taxation can vary based on where the goods were acquired before sale.
A code that indicates the type of vehicle that transported the product across the country border. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
A code that indicates the type of transaction being declared for Intrastat purposes. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
The mass of the product in kilograms.
A unique identifier that associates a line item to a project for purchasing purposes.
The amount of taxes paid previously on the asset. This information is needed to determine reciprocity rules between jurisdictions.
The date on which the line item record was produced. This can also be represented as a PO line item date, a lease line item date, and so on. Defaults to the documentDate of the transaction.
Indicates whether tax is included in the extended price.
Directly identifies a usage by user-defined usage code.
Directly identifies a usage class by user-defined usage class code.
A value that represents a specific item or product SKU number.
A line based telecommunication line item.
A code used to represent a data stream accumulation location for a line-based telecommunication line item.
A code used to represent data stream content for a line-based telecommunication line item.
A code used to represent data stream direction for a line-based telecommunication line item.
A code used to represent data stream status for a line-based telecommunication line item.
A code from the host system that identifies the line type of a line-based telecommunication line item.
The amount used to override taxability to partial or full nontaxable status. If this data element is used to pass an override amount from the host system, the calculation engine ignores any applicable exceptions or overrides set up on the user interface. Vertex recommends that you use the user interface to create and maintain exceptions and overrides rather than using this data element.
A code that indicates the reason for the override. If your host system provides this functionality, this data element can be used. You can use the user interface to set up reason codes. Valid reason codes are expected from the host system and are pre-defined by Vertex for use in the Returns Export module in Vertex Central. Note: To pass a standard (i.e., not user-defined) single-digit reason code, pad the code to four digits. Refer to the Supporting Information section of the XML Integration Guide for information about exemption and deduction reason codes.
A code from the host system that identifies the product, material, service, or SKU number. You can use the user interface to map your products to product categories. If the supplied Product and Product Class information is not recognized by the calculation engine, a general category indicating TPP is assigned. Required (1) if no Product Class information is supplied. If both are supplied, Product information supersedes Product Class information.
A code used to represent groups or categories of products or services with similar taxability. You can use the user interface to map your products classes to product class categories. If the supplied Product and Product Class information is not recognized by the calculation engine, a general category indicating TPP is assigned. Required (1) if no Product information is supplied. If both are supplied, Product information supersedes Product Class information.
The unit of measure for the line item to be used in surcharges based on quantity and not price. For a list of the possible values, see the Supporting Information section of the XML Integration Guide. If you pass a value that does not match the unit of measure for the quantity-based tax rule, that rule is not used. May be required (1) to determine tax liability in some jurisdictions. For a line-based line item in the telecommunication transaction, the passed in unit of measure can be converted to the tax rule unit of measure if a conversion rule exist.
The rate override percentage for the specified jurisdiction. Vertex recommends that you use the user interface to create and maintain exceptions and overrides rather than using this data element.
A text value for your returns. If you require a country-specific setting, preface this text with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for U.S. transactions.
A date value for your returns. If you require a country-specific setting, preface this date with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for U.S. transactions.
A Boolean value for your returns. If you require a country-specific setting, preface this value with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for US transactions.
A numeric value for your returns. If you require a country-specific setting, preface this number with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for U.S. transactions.
Supports the returns that are associated with your tax type. These fields enable you to pass in country-specific data to Vertex O Series for returns processing. This data is passed from Vertex O Series to your returns processing system. The value of the name attribute for country-specific fields is prefixed by the two-character ISO country code. These fields are included on the Returns report that is associated with your tax type. For example, these fields are included in VAT Returns reports. These fields are not available for U.S. transactions. Caution: Vertex recommends that, if you use the ReturnsFields data element, you always include all Returns-related subdata elements - even if there was no change in those elements. If you do not include all Returns-related subdata elements, the ReturnsFields information will be lost when you perform synchronization activities between Vertex O Series and your host system.
A text value for your returns. If you require a country-specific setting, preface this text with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for U.S. transactions.
A date value for your returns. If you require a country-specific setting, preface this date with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for U.S. transactions.
A Boolean value for your returns. If you require a country-specific setting, preface this value with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for US transactions.
A numeric value for your returns. If you require a country-specific setting, preface this number with the ISO 3166-1 alpha-2 country code and an underscore. This field is included on the Returns report that is associated with your tax type. For example, this field is included in VAT Returns reports. This field is not available for U.S. transactions.
A code used to represent groups of dispatchers who have similar taxability. Note: If you pass a classCode, you should not pass a TaxRegistrationNumber because the registration number does not apply to the entire class.
Identifies the top-level legal entity for which tax exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. This should be a parameter that is configurable to data from the host system based on an individual company’s legal and tax requirements.
Identifies the low-level legal entity for which specific tax requirements and exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. Based on your legal and tax liabilities at this level, map the appropriate host system parameter to this data element. If all your tax exceptions are at the top- or mid-level entity, you may choose not to populate this data element. Note that this data element is also used to sort reports.
Identifies the mid-level legal entity for which tax exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. This should be a parameter that is configurable to data from the host system based on an individual company’s legal and tax requirements.
Details about the situs determination overrides.
The amount field.
A unit type used with commodity codes that require an alternative to Net Mass by Kilograms. For example, a transaction may have no weight unit type, but there may be pieces, pairs, or liters. This element is used for intrastat purposes and is associated with the Supplementary Unit element.
Details on the tax override.
A code that indicates the reason for the override. If your host system provides this functionality, this data element can be used. You can use the user interface to set up reason codes. Valid reason codes are expected from the host system and are pre-defined by Vertex for use in Returns Export. Note: To pass a standard (i.e., not user-defined) single-digit reason code, pad the code to four digits. Refer to the Supporting Information section of the XML Integration Guide for information about exemption and deduction reason codes.
Sale Request message.
{
"accumulationCustomerNumber": "",
"accumulationDocumentNumber": "",
"billingType": "",
"companyCodeCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"currencyConversionFactors": [
{
"conversionFactor": 1,
"sourceCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"targetCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
}
}
],
"customer": {
"administrativeDestination": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "BONDED_WAREHOUSE",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"customerCode": {
"classCode": "",
"isBusinessIndicator": true,
"value": ""
},
"destination": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "OUTWARD_PROCESSING_RELIEF",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"exemptionCertificate": {
"exemptionCertificateNumber": "",
"value": ""
},
"exemptionReasonCode": "",
"isTaxExempt": true,
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"isoCountryCode": "",
"jurisdictionId": "",
"mainDivision": "",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "",
"country": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
}
],
"taxRegistrationNumber": "",
"filingCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"taxRegistrationType": "Import One Stop Shop"
}
]
},
"deliveryTerm": "CIF",
"discount": {
"discountType": "DiscountPercent",
"discountValue": 1,
"userDefinedDiscountCode": ""
},
"documentDate": "",
"documentNumber": "",
"documentSequenceId": "",
"documentType": "",
"exemptOverrides": [
{
"amount": 1,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "LOCAL_IMPROVEMENT_DISTRICT",
"reasonCode": ""
}
],
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "DISTRICT"
}
],
"isTaxOnlyAdjustmentIndicator": true,
"lineItems": [
{
"amountBilledToDate": 1,
"chainTransactionPhase": "INTERMEDIARY",
"commodityCode": {
"commodityCodeType": "",
"value": ""
},
"companyCodeCurrencyTaxAmount": 1,
"companyCodeCurrencyTaxableAmount": 1,
"cost": 1,
"costCenter": "",
"countryOfOriginISOCode": "",
"customer": {
"administrativeDestination": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "TEMPORARY_IMPORT",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"customerCode": {
"classCode": "",
"isBusinessIndicator": true,
"value": ""
},
"destination": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "INWARD_PROCESSING_RELIEF",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"exemptionCertificate": {
"exemptionCertificateNumber": "",
"value": ""
},
"exemptionReasonCode": "",
"isTaxExempt": true,
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"isoCountryCode": "",
"jurisdictionId": "",
"mainDivision": "",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "PHYSICAL_ORIGIN",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "",
"country": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
}
],
"taxRegistrationNumber": "",
"filingCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"taxRegistrationType": "VAT Registration"
}
]
},
"deliveryTerm": "DDP",
"departmentCode": "",
"discount": {
"discountType": "DiscountAmount",
"discountValue": 1,
"userDefinedDiscountCode": ""
},
"exemptOverrides": [
{
"amount": 1,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "TERRITORY",
"reasonCode": ""
}
],
"exportProcedure": "",
"extendedPrice": 1,
"fairMarketValue": 1,
"flexibleFields": {
"flexibleCodeFields": [
{
"fieldId": 1,
"value": ""
}
],
"flexibleDateFields": [
{
"fieldId": 1,
"value": ""
}
],
"flexibleNumericFields": [
{
"fieldId": 1,
"value": 1
}
]
},
"freight": 1,
"generalLedgerAccount": "",
"impositionInclusions": [
{
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "PARISH"
}
],
"inputTotalTax": 1,
"intrastatCommodityCode": "",
"isMulticomponent": true,
"landedCost": 1,
"lineItemId": "",
"lineItemNumber": 1,
"lineItems": [
null
],
"lineType": {
"accumulationLocation": "",
"content": "",
"direction": "",
"status": "",
"value": ""
},
"locationCode": "",
"materialCode": "",
"materialOrigin": "",
"modeOfTransport": 1,
"natureOfTransaction": 1,
"netMassKilograms": 1,
"nonTaxableOverrides": [
{
"amount": 1,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "APO",
"reasonCode": ""
}
],
"product": {
"productClass": "",
"value": ""
},
"projectNumber": "",
"quantity": {
"unitOfMeasure": "",
"value": 1
},
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "COUNTRY",
"rate": 1
}
],
"returnsFields": {
"returnsCodeFields": [
{
"name": "",
"value": ""
}
],
"returnsDateFields": [
{
"name": "",
"value": ""
}
],
"returnsIndicatorFields": [
{
"name": "",
"value": true
}
],
"returnsNumericFields": [
{
"name": "",
"value": 1
}
]
},
"seller": {
"administrativeOrigin": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "TEMPORARY_IMPORT",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"company": "",
"department": "",
"dispatcher": {
"dispatcherCode": {
"classCode": "",
"value": ""
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"isoCountryCode": "",
"jurisdictionId": "",
"mainDivision": "",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_ORIGIN",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "",
"country": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
}
],
"taxRegistrationNumber": "",
"filingCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"taxRegistrationType": "VAT Registration"
}
]
},
"division": "",
"nexusIndicator": true,
"nexusReasonCode": "",
"physicalOrigin": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "INWARD_PROCESSING_RELIEF",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"isoCountryCode": "",
"jurisdictionId": "",
"mainDivision": "",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_ORIGIN",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "",
"country": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
}
],
"taxRegistrationNumber": "",
"filingCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"taxRegistrationType": "Non-Union Scheme"
}
],
"utilityProvider": "REGULATED_TAXPAYER"
},
"simplificationCode": "CALL_OFF",
"situsOverride": {
"taxingLocation": "DESTINATION"
},
"statisticalValue": {
"amount": 1,
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
}
},
"supplementaryUnit": {
"unitType": "",
"value": 1
},
"previousTaxPaid": 1,
"taxDate": "",
"taxIncludedIndicator": true,
"taxOverride": {
"overrideReasonCode": "",
"overrideType": "TAXABLE"
},
"titleTransfer": "ORIGIN",
"transactionType": "LEASE",
"unitPrice": 1,
"usage": "",
"usageClass": "",
"vendorSKU": "",
"volume": {
"unitOfMeasure": "",
"value": 1
},
"weight": {
"unitOfMeasure": "",
"value": 1
}
}
],
"locationCode": "",
"nonTaxableOverrides": [
{
"amount": 1,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "CITY",
"reasonCode": ""
}
],
"orderType": "",
"originalCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"paymentDate": "",
"postToJournal": true,
"postingDate": "",
"proratePercentage": 1,
"rateOverrides": [
{
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"jurisdictionType": "PROVINCE",
"rate": 1
}
],
"returnAssistedParametersIndicator": true,
"returnGeneratedLineItemsIndicator": true,
"returnTimeElapsedDetailsIndicator": true,
"roundAtLineLevel": true,
"saleMessageType": "INVOICE",
"seller": {
"administrativeOrigin": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "FREE_TRADE_ZONE",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"company": "",
"department": "",
"dispatcher": {
"dispatcherCode": {
"classCode": "",
"value": ""
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"isoCountryCode": "",
"jurisdictionId": "",
"mainDivision": "",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_ORIGIN",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "",
"country": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
}
],
"taxRegistrationNumber": "",
"filingCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"taxRegistrationType": "Non-Union Scheme"
}
]
},
"division": "",
"nexusIndicator": true,
"nexusReasonCode": "",
"physicalOrigin": {
"city": "",
"country": "",
"currencyConversion": {
"currency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"rate": 1
},
"externalJurisdictionCode": "",
"latitude": "",
"locationCode": "",
"locationCustomsStatus": "FREE_TRADE_ZONE",
"longitude": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
},
"taxRegistrations": [
{
"hasPhysicalPresenceIndicator": true,
"impositionType": {
"impositionTypeId": "",
"userDefined": true,
"value": "",
"withholdingType": ""
},
"isoCountryCode": "",
"jurisdictionId": "",
"mainDivision": "",
"nexusOverrides": [
{
"city": true,
"country": true,
"district": true,
"locationRole": "ADMINISTRATIVE_DESTINATION",
"mainDivision": true,
"subDivision": true
}
],
"physicalLocations": [
{
"city": "",
"country": "",
"mainDivision": "",
"postalCode": "",
"streetAddress1": "",
"streetAddress2": "",
"subDivision": "",
"taxAreaId": ""
}
],
"taxRegistrationNumber": "",
"filingCurrency": {
"isoCurrencyCodeAlpha": "",
"isoCurrencyCodeNum": 1,
"isoCurrencyName": ""
},
"taxRegistrationType": "Tax Identification Number (TIN)"
}
],
"utilityProvider": "UNREGULATED_TAXPAYER"
},
"simplificationCode": "TRIANGULATION",
"situsOverride": {
"taxingLocation": "ADMINISTRATIVE_ORIGIN"
},
"taxOverride": {
"overrideReasonCode": "",
"overrideType": "TAXABLE"
},
"taxPointDate": "",
"transactionId": "",
"transactionType": "RENTAL"
}A string to represent the accumulation customer identity.
A string to represent the accumulation invoice identity.
Indicates the billing documents that specify different business transactions that are involved in billing activities. Examples of billing documents include invoice, credit or debit memo, or cancellation document. This field is at the transaction level.
The document number in the host application that references the event.
Supports reporting and the document sequence identifier used by your ERP system. Some countries require that documents follow a unique sequential sequence number, depending on the registration type and the type of invoice. Use this field for audit purposes to track the sequence of your documents. This field is used in European Union (EU) countries.
Indicates the type of business transaction to be posted. This field is at the transaction level.
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.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
The key that identifies the purpose of the order. This field is on the transaction level.
The date on which the purchaser paid for the product. If the purchaser pays for the product but physically receives it at a later date, Vertex O Series uses this field for returns and reporting for your tax type. This field is also used in cash accounting.
Indicates whether the results of the transaction are posted to the Tax Journal. Defaults to true. This field is not applicable to Invoice and Quotation tax calculation.
Percentage passed from the billing system to calculate a remainder of an assessed tax or fee.
Indicates whether the response message should contain an additional structure that shows the elements and attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
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 posted 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.
Indicates whether the response message should contain details of what composed the elapsed time. The default value is false.
The roundAtLineLevel attribute enables you to apply line-item level or invoice-level rounding to tax calculations. Set this attribute to true to set up line-item level rounding. With line-item level rounding, the calculation engine rounds amounts at the line-item level and then sums those amounts to calculate an invoice total. This method is useful for invoices that include line items with different taxing jurisdictions. The default value for this attribute is false. In this case, O Series applies an invoice-level rounding, where the calculation engine compares the sum of rounded line item-level totals to the rounded invoice-level total. When there is a difference between these totals, the calculation engine compares differences between rounded and unrounded amounts at each jurisdiction level and distributes the difference to the jurisdiction that results in the smallest total rounding difference amount. For more information about invoice-level rounding, contact Vertex Customer Support to obtain the Rounding Guide.
The date that drives the timing of when the VAT liability arises. In some countries, if the Tax Point Date (also called the Time of Supply) is different from the invoice date, this field is shown separately on an invoice. Use this field if you have reporting compliance in Spain, Poland, and/or Hungary.
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.
An assisted parameter on the tax or line item that were assisted by one or more assisting services.
The original value of the assisted parameter before the Calculation Engine applied a Tax Assist rule. This is an attribute of the XML response message AssistedParameter element.
Unique name by which the modified parameter can be identified.
The name of the Tax Assist rule that the Calculation Engine applied during transction processing. To return the Tax Assist rule name, the returnAssistedParametersIndicator must be enabled. The ruleName is an attribute of the XML response message AssistedParameter element.
Element body is the value for the assisted parameter. Body may be date (yyyy-mm-dd), numeric (default format for long or double), boolean (true or false), or simple string.
A standardized, unique code for the product or service.
The type of commodity code mapping.
The commodity code that the calculation engine used during tax calculation.
Indicates whether the returned commodity code is user-defined or not. This field is not required for an XML request, but is populated in an XML response when a commodity code mapping is used during tax calculation.
The commodity code users pass in.
Line item declaration for Sale Response message.
The calculated tax amount in the default currency code for a transaction.
The total taxable amount in the default currency code for a transaction.
A value that indicates a specific area of an organization generally related to functional or accounting areas.
The 3-digit ISO 3166 code of the country where the product was produced or manufactured.
A unique identifier that associates a line item to a department for purchasing purposes.
The export procedure (sales) or import procedure (purchases) that is applied for INTRASTAT purposes.
A value that is used with a company’s Chart of Accounts.
The amount of tax to be distributed. This field is applicable to Distribute Tax only.
Used to classify the goods and services. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
Indicates whether the calculation engine calculates component-level max tax, where applicable. Amounts at the child level of the multicomponent item are used for tax calculation. Amounts at the parent level are ignored. Set this attribute to true for line items at the parent level only. Line items at the child level remain false. Defaults to false.
An identifier that further defines the line item and corresponds to the transaction stored in the host system. This parameter is needed to perform synchronization services, but it is not used for reporting purposes.
A line number for the line item. This number can be used as a reference in reports or in audits. If no line item number is supplied, a number will be assigned.
A sub-component (or child line item) of the transaction.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A value that represents a specific item or product.
The material origin type. Material origin applies to countries, such as Brazil and India, where taxation can vary based on where the goods were acquired before sale.
A code that indicates the type of vehicle that transported the product across the country border. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
A code that indicates the type of transaction being declared for Intrastat purposes. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
The mass of the product in kilograms.
A unique identifier that associates a line item to a project for purchasing purposes.
The date on which the line item record was produced. This can also be represented as a PO line item date, a lease line item date, and so on. Defaults to the documentDate of the transaction.
Indicates whether tax is included in the extended price.
Directly identifies a usage by user-defined usage code.
Directly identifies a usage class by user-defined usage class code.
A value that represents a specific item or product SKU number.
The imposition to which the relevant tax rule belongs. This is assigned either by Vertex or by the user when setting up a user-defined imposition on the user interface.
The Vertex internal identifier for the imposition.
Identifier for user-defined rules. This identifier is useful for troubleshooting. The default value is False, Vertex-defined rule.
The name of the imposition.
The name by which this jurisdiction is commonly known. For example, Pennsylvania.
The date on which the tax for the jurisdiction became effective.
The date after which the tax for the jurisdiction is no longer effective.
Jurisdiction code assigned by the relevant governmental authority.
The Vertex-specific number that identifies a jurisdiction.
The name of the jurisdiction.
A grouping of filing currency-converted taxability amounts.
The calculated tax amount for the line item, reported in the filing currency.
The exempt amount for the line item, reported in the filing currency.
The nontaxable amount for the line item, reported in the filing currency.
The recoverable amount for the VAT line item, reported in the filing currency.
The taxable amount for the line item, reported in the filing currency.
The unrecoverable amount for the VAT line item, reported in the filing currency.
Returns invoice text information when an invoice text rule is hit for the tax calculation.
The invoice text code that is associated with the invoice text rule.
The invoice text rule id.
The invoice text that is associated with the invoice text rule.
Indicates if the invoice text rule is user-defined or not.
Specifies the applicable tax structure when the transaction includes a flat fee or quantity-based fee. Valid values are BRACKET, FLAT_TAX, QUANTITY, SINGLE_RATE, TIERED, QUANTITY_TIERED, QUANTITY_RATE_TIERED, TIERED_MODIFIER, QUANTITY_TIERED_MODIFIER, QUANTITY_RATE_TIERED_MODIFIER, QUANTITY_TIERED_FLAT, TIERED_FLAT, and QUANTITY_RATE_TIERED_EQUIVALENT.
Taxes calculated by the transaction processing system.
The percentage by which a basis amount is reduced in a tax calculation.
The recoverable override percentage of the blocking override on the Input Tax level.
The Registration ID for the buyer associated with this line item tax.
Amount of tax calculated by the calculation engine.
The Registration ID for the dispatcher associated with this line item tax.
For Buyer Input tax and Seller Import tax, this rate is calculated based on the Extended Price and Tax Amount (Import or Input) passed in the request message. If you total the Extended Price and Tax Amounts before passing them in, this rate is an average. For all other message types, this is the effective rate the system used to calculate tax.
Amount of the line item not subject to tax due to exempt status.
Provides additional classification of the transaction for tax returns and reporting. Codes are jurisdiction-specific. Note: For a tax with multiple tiers, this REST API returns the filing category code associated with the largest basis amount.
Indicator that alerts the host system of the need to add invoice text of a specific type to a line item. For a list of the codes and their meanings, see the Supporting Information section in the XML Integration Guide. Note: This transaction is considered to involve a VAT group if a value of 2 (Intra-EU Notice) is returned, the POS jurisdiction is an EU country, and the buyer and seller have the same registration number.
Indicates whether or not the product is a service.
The markup rate.
Indicates that max tax was applied to this line item of the invoice.
The original ICMS tax rate for origin and destination states.
Amount of the line item not subject to tax due to nontaxable status.
Indicates that the taxpayer company is not registered in the taxing jurisdiction.
The tax amount before applying a tax credit rule.
The Registration ID for the owner associated with this line item tax.
The recoverable percentage of a partial exemption. This field is populated only for transactions with a tax type of Value Added Tax.
A Vertex-defined classification of the applicable tax rule for returns filing purposes. Possible values are: Luxury Rate, Standard Rate, Reduced Rate 1, Reduced Rate 2, Reduced Rate 3, Reduced Rate 4, Reduced Rate 5, User Defined, Zero Rate, Outside the Scope.
A code that indicates the reason for the exception that was applied to this tax. Note: For a tax with multiple tiers, this REST API returns the reason code associated with the largest basis amount. Note: To pass a standard (i.e., not user-defined) single-digit reason code, pad the code to four digits. Refer to the Supporting Information section of the XML Integration Guide for information about exemption and deduction reason codes.
The Registration ID for the recipient associated with this line item tax.
The amount of input or import tax that the buyer is able to recover on a transaction. This is the amount that the buyer puts on returns to recover these funds.
The percent of the tax that is recoverable, as calculated based on passed in recoverable amount and tax. Expressed as a decimal: 1.0 for 100%, .8 for 80%, .5 for 50%, and so on.
The amount that is subject to reporting basis.
The Registration ID for the seller associated with this line item tax.
Additional information about a tax, to be returned to your host system after tax calculation. To supply a value for this field, you need to set up a post-calculation Tax Assist rule. Note: The text you add to this field is not stored in the Tax Journal.
The tax apportionment rate to apportion the calculated tax between two different locations.
A user-defined code for the tax, to be returned to your host system after tax calculation. To return a value for this field, set up a post-calculation Tax Assist rule.
Amount of the line item subject to tax.
The amount of input or import tax that the taxpayer is not able to recover. It is lost, which is a true cost to the taxpayer.
A code that can be used to classify the transaction at the tax level for reporting or tax return filing purposes. The code is generated by the Calculation Engine for each line item after tax calculation. It can be used as a filter for reports or as an input for post-calculation Tax Assist rules. For detailed information about the contents of the code, see the Supporting Information section of the XML Integration Guide.
Sale Response message.
A string to represent the accumulation customer identity.
A string to represent the accumulation invoice identity.
Indicates the billing documents that specify different business transactions that are involved in billing activities. Examples of billing documents include invoice, credit or debit memo, or cancellation document. This field is at the transaction level.
The document number in the host application that references the event.
Supports reporting and the document sequence identifier used by your ERP system. Some countries require that documents follow a unique sequential sequence number, depending on the registration type and the type of invoice. Use this field for audit purposes to track the sequence of your documents. This field is used in European Union (EU) countries.
Indicates the type of business transaction to be posted. This field is at the transaction level.
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.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
The key that identifies the purpose of the order. This field is at the transaction level.
The date on which the purchaser paid for the product. If the purchaser pays for the product but physically receives it at a later date, Vertex O Series uses this field for returns and reporting for your tax type. This field is also used in cash accounting.
Indicates whether the results of the transaction are posted to the Tax Journal. Defaults to true. This field is not applicable to Invoice and Quotation tax calculations.
Percentage passed from the billing system to calculate a remainder of an assessed tax or fee.
Indicates whether the response message should contain an additional structure that shows the elements and attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
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 posted 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.
The roundAtLineLevel attribute enables you to apply line-item level or invoice-level rounding to tax calculations. Set this attribute to true to set up line-item level rounding. With line-item level rounding, the calculation engine rounds amounts at the line-item level and then sums those amounts to calculate an invoice total. This method is useful for invoices that include line items with different taxing jurisdictions. The default value for this attribute is false. In this case, O Series applies an invoice-level rounding, where the calculation engine compares the sum of rounded line item-level totals to the rounded invoice-level total. When there is a difference between these totals, the calculation engine compares differences between rounded and unrounded amounts at each jurisdiction level and distributes the difference to the jurisdiction that results in the smallest total rounding difference amount. For more information about invoice-level rounding, contact Vertex Customer Support to obtain the Rounding Guide.
The date that drives the timing of when the VAT liability arises. In some countries, if the Tax Point Date (also called the Time of Supply) is different from the invoice date, this field is shown separately on an invoice. Use this field if you have reporting compliance in Spain, Poland, and/or Hungary.
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.
A code used to represent groups of recipients who have similar taxability. Note: If you pass a classCode, you should not pass a TaxRegistrationNumber because the registration number does not apply to the entire class.
Indicates whether or not the participant is a business.
Identifies the top-level legal entity for which tax exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. This should be a parameter that is configurable to data from the host system based on an individual company’s legal and tax requirements.
Identifies the low-level legal entity for which specific tax requirements and exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. Based on your legal and tax liabilities at this level, map the appropriate host system parameter to this data element. If all your tax exceptions are at the top- or mid-level entity, you may choose not to populate this data element. Note that this data element is also used to sort reports.
Identifies the mid-level legal entity for which tax exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. This should be a parameter that is configurable to data from the host system based on an individual company’s legal and tax requirements.
Line item declaration for Purchase Response message.
The recoverable override percentage of the blocking override for the line item.
This field is not applicable to Purchase Order tax calculation.
The calculated tax amount in the default currency code for a transaction.
The total taxable amount in the default currency code for a transaction.
A value that indicates a specific area of an organization generally related to functional or accounting areas.
The 3-digit ISO 3166 code of the country where the product was produced or manufactured.
A unique identifier that associates a line item to a department for purchasing purposes.
The export procedure (sales) or import procedure (purchases) that is applied for INTRASTAT purposes.
A value that is used with a company’s Chart of Accounts.
The amount of tax to be distributed. This field is applicable to Distribute Tax only.
Used to classify the goods and services. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
Indicates whether the calculation engine calculates component-level max tax, where applicable. Amounts at the child level of the multi-component item are used for tax calculation. Amounts at the parent level are ignored. Set this attribute to true for line items at the parent level only. Line items at the child level remain false. Defaults to false.
An identifier that further defines the line item and corresponds to the transaction stored in the host system. This parameter is needed to perform synchronization services, but it is not used for reporting purposes.
A line number for the line item. This number can be used as a reference in reports or in audits. If no line item number is supplied, a number will be assigned.
A sub-component (or child line item) of the transaction.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A value that represents a specific item or product.
The material origin type. Material origin applies to countries, such as Brazil and India, where taxation can vary based on where the goods were acquired before sale.
A code that indicates the type of vehicle that transported the product across the country border. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
A code that indicates the type of transaction being declared for Intrastat purposes. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
The mass of the product in kilograms.
When the difference between the line-item tax amount and the charged tax amount exceeds the threshold specified on the user interface. This field is applicable only to Invoice Verification tax calculations.
The recoverable percentage of a partial exemption. This field is populated only for transactions with a tax type of Value Added Tax.
A unique identifier that associates a line item to a project for purchasing purposes.
The date used to calculate Recoverable Input VAT.
The amount that is passed to Vertex O Series from your ERP or host system. Vertex O Series uses this amount to calculate the VAT withholding amount for a given line item. This field is used for Procurement messages. This field specifies the special tax basis of the line item.
The date on which the line item record was produced. This can also be represented as a PO line item date, a lease line item date, and so on. Defaults to the documentDate of the transaction.
Indicates whether tax is included in the Extended Price.
Directly identifies a usage by user-defined usage code.
Directly identifies a usage class by user-defined usage class code.
Difference between the total tax on an invoice and the Vertex-calculated amount. This amount can be used as the amount of tax to be partially accrued as Consumer’s Use Tax. This field is applicable only to Invoice Verification tax calculations.
A value that represents a specific item or product SKU number.
This field specifies the earnings total of the line item that is subject to VAT Social Security Withholding.
A code from the host system that identifies the product, material, service, or SKU number. You can use the user interface to map your purchase to purchase categories. If the supplied Purchase and Purchase Class information is not recognized by the calculation engine, a general category indicating TPP is assigned. Required (1) if no Purchase Class information is supplied. If both are supplied, Purchase information supersedes Purchase Class information.
A code used to represent groups or categories of products or services with similar taxability. You can use the user interface to map your products classes to purchase class categories. If the supplied Purchase and Purchase Class information is not recognized by the calculation engine, a general category indicating TPP is assigned. Required (1) if no Purchase information is supplied. If both are supplied, Purchase information supersedes Purchase Class information.
A code used to represent groups of vendors who have similar taxability. Note: If you pass a classCode, you should not pass a TaxRegistrationNumber because the registration number does not apply to the entire class.
The invoice-level total information that can be passed in for a tax imposition and a taxability category.
The city associated with the jurisdiction.
The country associated with the jurisdiction.
The main division associated with the jurisdiction.
The subdivision associated with the jurisdiction.
Purchase Response message.
A string to represent the accumulation customer identity.
A string to represent the accumulation invoice identity.
Indicates the billing documents that specify different business transactions that are involved in billing activities. Examples of billing documents include invoice, credit or debit memo, or cancellation document. This field is at the transaction level.
When set to true, this indicator causes the vendor-charged liability to be processed when determining the buyer’s self-accrual liability. This field is applicable to Purchase Order and Accrual tax calculations.
When set to true, the buyer’s self-accrual liability is processed when determining the vendor-charged liability. This field is applicable to Evaluated Receipts Settlement (ERS).
This field is not applicable to Purchase Order tax calculation.
The document number in the host application that references the event.
Supports reporting and the document sequence identifier used by your ERP system. Some countries require that documents follow a unique sequential sequence number, depending on the registration type and the type of invoice. Use this field for audit purposes to track the sequence of your documents. This field is used in European Union (EU) countries.
Indicates the type of business transaction to be posted. This field is at the transaction level.
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.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
The key that identifies the purpose of the order. This field is at the transaction level.
When the difference between the line-item tax amount and the charged tax amount exceeds the threshold specified on the user interface. This field is applicable only to Invoice Verification tax calculations.
The date on which the purchaser paid for the product. If the purchaser pays for the product but physically receives it at a later date, Vertex O Series uses this field for returns and reporting for your tax type. This field is also used in cash accounting.
Indicates whether the results of the transaction are written to the Tax Journal. Defaults to true. This field is not applicable to Purchase Order tax calculation.
Percentage passed from the billing system to calculate a remainder of an assessed tax or fee.
The date used to calculate Recoverable Input VAT.
Indicates whether the response message should contain an additional structure that shows the elements and attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
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 posted 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.
The roundAtLineLevel attribute enables you to apply line-item level or invoice-level rounding to tax calculations. Set this attribute to true to set up line-item level rounding. With line-item level rounding, the calculation engine rounds amounts at the line-item level and then sums those amounts to calculate an invoice total. This method is useful for invoices that include line items with different taxing jurisdictions. The default value for this attribute is false. In this case, O Series applies an invoice-level rounding, where the calculation engine compares the sum of rounded line item-level totals to the rounded invoice-level total. When there is a difference between these totals, the calculation engine compares differences between rounded and unrounded amounts at each jurisdiction level and distributes the difference to the jurisdiction that results in the smallest total rounding difference amount. For more information about invoice-level rounding, contact Vertex Customer Support to obtain the Rounding Guide.
The date that drives the timing of when the VAT liability arises. In some countries, if the Tax Point Date (also called the Time of Supply) is different from the invoice date, this field is shown separately on an invoice. Use this field if you have reporting compliance in Spain, Poland, and/or Hungary.
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.
Difference between the total tax on invoice and the Vertex-calculated amount. This amount can be used as the amount of tax to be partially accrued as Consumer’s Use Tax. This field is applicable only to Invoice Verification tax calculations.
Identifies the top-level legal entity for which tax exception may exist. Use the user interface to set up any taxability rules that apply at this level. This should be a parameter that is configurable to data from the host system based on an individual company’s legal and tax requirements.
Identifies the low-level legal entity for which specific tax requirements and exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. Based on your legal and tax liabilities at this level, map the appropriate host system parameter to this data element. If all your tax exceptions are at the top- or mid-level entity, you may choose not to populate this data element. Note that this data element is also used to sort reports.
Identifies the mid-level legal entity for which tax exceptions may exist. Use the user interface to set up any taxability rules that apply at this level. This should be a parameter that is configurable to data from the host system based on an individual company’s legal and tax requirements.
Line item declaration for Owner Response message.
The recoverable override percentage of the blocking override for the line item.
The calculated tax amount in the default currency code for a transaction.
The total taxable amount in the default currency code for a transaction.
The actual cost of the materials to the purchaser. In a manufacturing environment, this is the cost of the actual materials purchased for resale from outside suppliers. Wholesalers and retailers measure material cost by the cost of the property itself.
Cost less depreciation. The depreciation method is dependent on the state rules (straightline depreciation, declining depreciation, etc.).
The value of the raw materials plus all other costs such as direct labor, transportation, and indirect materials consumed and charged to the product overhead, etc. (a.k.a. Standard Cost, Manufactured Cost, Total Manufacturer’s Cost).
The price at which the property is sold to the public. (a.k.a. Selling Price, Value of the Product for Sale)
This is the rental value of the property on the open market.
A value that indicates a specific area of an organization generally related to functional or accounting areas.
The 3-digit ISO 3166 code of the country where the product was produced or manufactured.
A unique identifier that associates a line item to a department for purchasing purposes.
The export procedure (sales) or import procedure (purchases) that is applied for INTRASTAT purposes.
A value that is used with a company’s Chart of Accounts.
Used to classify the goods and services. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
Indicates whether the calculation engine calculates component-level max tax, where applicable. Amounts at the child level of the multi-component item are used for tax calculation. Amounts at the parent level are ignored. Set this attribute to true for line items at the parent level only. Line items at the child level remain false. Defaults to false.
An identifier that further defines the line item and corresponds to the transaction stored in the host system. This parameter is needed to perform synchronization services, but it is not used for reporting purposes.
A line number for the line item. This number can be used as a reference in reports or in audits. If no line item number is supplied, a number will be assigned.
A sub-component (or child line item) of the transaction.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A value that represents a specific item or product.
The material origin type. Material origin applies to countries, such as Brazil and India, where taxation can vary based on where the goods were acquired before sale.
A code that indicates the type of vehicle that transported the product across the country border. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
A code that indicates the type of transaction being declared for Intrastat purposes. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
The mass of the product in kilograms.
When the difference between the line-item tax amount and the charged tax amount exceeds the threshold specified on the user interface. This field is applicable only to Invoice Verification tax calculations.
The recoverable percentage of a partial exemption. This field is populated only for transactions with a tax type of Value Added Tax.
A unique identifier that associates a line item to a project for purchasing purposes.
The date used to calculate Recoverable Input VAT.
The amount that is passed to Vertex O Series from your ERP or host system. Vertex O Series uses this amount to calculate the VAT withholding amount for a given line item. This field is used for Procurement messages. This field specifies the special tax basis of the line item.
The amount of taxes paid previously on the asset. This information is needed to determine reciprocity rules between jurisdictions.
The date on which the line item record was produced. This can also be represented as a PO line item date, a lease line item date, and so on. Defaults to the documentDate of the transaction.
Indicates whether tax is included in the Extended Price.
Directly identifies a usage by user-defined usage code.
Directly identifies a usage class by user-defined usage class code.
A value that represents a specific item or product SKU number.
This field specifies the earnings total of the line item that is subject to VAT Social Security Withholding.
Owner Response message.
A string to represent the accumulation customer identity.
A string to represent the accumulation invoice identity.
Indicates the billing documents that specify different business transactions that are involved in billing activities. Examples of billing documents include invoice, credit or debit memo, or cancellation document. This field is at the transaction level.
The document number in the host application that references the event.
Supports reporting and the document sequence identifier used by your ERP system. Some countries require that documents follow a unique sequential sequence number, depending on the registration type and the type of invoice. Use this field for audit purposes to track the sequence of your documents. This field is used in European Union (EU) countries.
Indicates the type of business transaction to be posted. This field is at the transaction level.
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.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
The key that identifies the purpose of the order. This field is at the transaction level.
The date on which the purchaser paid for the product. If the purchaser pays for the product but physically receives it at a later date, Vertex O Series uses this field for returns and reporting for your tax type. This field is also used in cash accounting.
Indicates whether the results of the transaction are posted to the Tax Journal. Defaults to true. This field is not applicable to Purchase Order tax calculations.
Percentage passed from the billing system to calculate a remainder of an assessed tax or fee.
The date used to calculate Recoverable Input VAT.
Indicates whether the response message should contain an additional structure that shows the elements and attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
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 posted 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.
The roundAtLineLevel attribute enables you to apply line-item level or invoice-level rounding to tax calculations. Set this attribute to true to set up line-item level rounding. With line-item level rounding, the calculation engine rounds amounts at the line-item level and then sums those amounts to calculate an invoice total. This method is useful for invoices that include line items with different taxing jurisdictions. The default value for this attribute is false. In this case, O Series applies an invoice-level rounding, where the calculation engine compares the sum of rounded line item-level totals to the rounded invoice-level total. When there is a difference between these totals, the calculation engine compares differences between rounded and unrounded amounts at each jurisdiction level and distributes the difference to the jurisdiction that results in the smallest total rounding difference amount. For more information about invoice-level rounding, contact Vertex Customer Support to obtain the Rounding Guide.
The date that drives the timing of when the VAT liability arises. In some countries, if the Tax Point Date (also called the Time of Supply) is different from the invoice date, this field is shown separately on an invoice. Use this field if you have reporting compliance in Spain, Poland, and/or Hungary.
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.
Difference between the total tax on an invoice and the Vertex-calculated amount. This amount can be used as the amount of tax to be partially accrued as Consumer Use Tax. This field is applicable only to Invoice Verification tax calculations.
The application fulfilling the request.
The execution time of the API request in milliseconds.
The time the API request was received, reported in UTC.
A set of one or more key/value pairs that represent details of what composed the elapsed time, with the key being the detail name and the value being the elapsed time in milliseconds.
Object returned from a successful request.
Object returned from an unsuccessful API request
Collection of one or more errors resulting from the request.
Line item declaration for Purchase Request message.
The recoverable override percentage of the blocking override for the line item.
This field is not applicable to Purchase Order tax calculations.
The calculated tax amount in the default currency code for a transaction.
The total taxable amount in the default currency code for a transaction.
A value that indicates a specific area of an organization generally related to functional or accounting areas.
The 3-digit ISO 3166 code of the country where the product was produced or manufactured.
A unique identifier that associates a line item to a department for purchasing purposes.
The export procedure (sales) or import procedure (purchases) that is applied for INTRASTAT purposes.
A value that is used with a company’s Chart of Accounts.
The amount of tax to be distributed. This field is applicable to Distribute Tax only.
Used to classify the goods and services. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
Indicates whether the calculation engine calculates component-level max tax, where applicable. Amounts at the child level of the multi-component item are used for tax calculation. Amounts at the parent level are ignored. Set this attribute to true for line items at the parent level only. Line items at the child level remain false. Defaults to false.
An identifier that further defines the line item and corresponds to the transaction stored in the host system. This parameter is needed to perform synchronization services, but it is not used for reporting purposes.
A line number for the line item. This number can be used as a reference in reports or in audits. If no line item number is supplied, a number is assigned.
A subcomponent (or child line item) of the transaction.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A value that represents a specific item or product.
The material origin type. Material origin applies to countries, such as Brazil and India, where taxation can vary based on where the goods were acquired before sale.
A code that indicates the type of vehicle that transported the product across the country border. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
A code that indicates the type of transaction being declared for Intrastat purposes. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
The mass of the product in kilograms.
The recoverable percentage of a partial exemption. This field is populated only for transactions with a tax type of Value Added Tax.
A unique identifier that associates a line item to a project for purchasing purposes.
The date used to calculate Recoverable Input VAT.
The amount that is passed to Vertex O Series from your ERP or host system. Vertex O Series uses this amount to calculate the VAT withholding amount for a given line item. This field is used for Procurement messages. This field specifies the special tax basis of the line item.
The date on which the line item record was produced. This can also be represented as a PO line item date, a lease line item date, and so on. Defaults to the documentDate of the transaction.
Indicates whether tax is included in the Extended Price.
Directly identifies a usage by user-defined usage code.
Directly identifies a usage class by user-defined usage class code.
A value that represents a specific item or product SKU number.
The vendor supplied tax amounts to post.
The earnings total of the line item that is subject to VAT Social Security Withholding.
The proper name of the city used to determine the Tax Area ID (if none is supplied). Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The country used to determine the Tax Area ID (if none is supplied). You can use a data extract report to see the valid country values. (Refer to the Online Help for information about running data extract reports.) Defaults to the value of the Default Country Code For Address setting. The default value for this parameter is USA. (For details about this setting, refer to the Configuration Parameters Reference Guide.)
Jurisdiction code assigned by the relevant governmental authority.
A number representing the geographical latitude coordinate of the location.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A number representing the geographical longitude coordinate of the location.
The proper name or the postal abbreviation of the state, province, or territory used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The postal code used to determine the Tax Area ID (if none is supplied). For valid formats, see the Supporting Information section in the XML Integration Guide. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The first line of the street address.
The second line of the street address.
The name of the county used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
A Vertex-specific number that identifies a tax area. If the Tax Area ID exists in your host system, use that data to populate this data element in a request message.
Details about the Vendor Input Tax. This field is not applicable to Purchase Order or Invoice Verification.
The recoverable override percentage of the blocking override at the Input Tax level.
The amount of Input Tax to be distributed. Negative numbers are permitted so that corrections can be processed.
The tax rate as shown on the vendor invoice.
Indicates that the input tax is Import VAT. Defaults to false.
The recoverable percentage of a partial exemption. This field is populated only for transactions with a tax type of Value Added Tax.
Purchase Request message.
A string to represent the accumulation customer identity.
A string to represent the accumulation invoice identity.
Indicates the billing documents that specify different business transactions that are involved in billing activities. Examples of billing documents include invoice, credit or debit memo, or cancellation document. This field is at the transaction level.
When set to true, causes the vendor-charged liability to be processed when determining the buyer’s self-accrual liability. This field is applicable to Purchase Order and Accrual tax calculations.
When set to true, causes the buyer’s self-accrual liability to be processed when determining the vendor-charged liability. This field is applicable to Evaluated Receipts Settlement (ERS) only.
This field is not applicable to Purchase Order tax calculations.
The document number in the host application that references the event.
Supports reporting and the document sequence identifier used by your ERP system. Some countries require that documents follow a unique sequential sequence number, depending on the registration type and the type of invoice. Use this field for audit purposes to track the sequence of your documents. This field is used in European Union (EU) countries.
Indicates the type of business transaction to be posted. This field is at the transaction level.
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.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
The key that identifies the purpose of the order. This field is at the transaction level.
The date on which the purchaser paid for the product. If the purchaser pays for the product but physically receives it at a later date, Vertex O Series uses this field for returns and reporting for your tax type. This field is also used in cash accounting.
Indicates whether the results of the transaction are posted to the Tax Journal. Defaults to true. This field is not applicable to Purchase Order tax calculations.
Percentage passed from the billing system to calculate a remainder of an assessed tax or fee.
The date used to calculate Recoverable Input VAT.
Indicates whether the response message should contain an additional structure that shows the elements and attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
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 posted 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.
The roundAtLineLevel attribute enables you to apply line-item level or invoice-level rounding to tax calculations. Set this attribute to true to set up line-item level rounding. With line-item level rounding, the calculation engine rounds amounts at the line-item level and then sums those amounts to calculate an invoice total. This method is useful for invoices that include line items with different taxing jurisdictions. The default value for this attribute is false. In this case, O Series applies an invoice-level rounding, where the calculation engine compares the sum of rounded line item-level totals to the rounded invoice-level total. When there is a difference between these totals, the calculation engine compares differences between rounded and unrounded amounts at each jurisdiction level and distributes the difference to the jurisdiction that results in the smallest total rounding difference amount. For more information about invoice-level rounding, contact Vertex Customer Support to obtain the Rounding Guide.
The date that drives the timing of when the VAT liability arises. In some countries, if the Tax Point Date (also called the Time of Supply) is different from the invoice date, this field is shown separately on an invoice. Use this field if you have reporting compliance in Spain, Poland, and/or Hungary.
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.
Line item declaration for Owner Request message.
The recoverable override percentage of the blocking override for the line item.
The calculated tax amount in the default currency code for a transaction.
The total taxable amount in the default currency code for a transaction.
Cost less depreciation. The depreciation method is dependent on the state rules (straightline depreciation, declining depreciation, etc.).
The value of the raw materials plus all other costs such as direct labor, transportation, and indirect materials consumed and charged to the product overhead, etc. (a.k.a. Standard Cost, Manufactured Cost, Total Manufacturer’s Cost).
The price at which the property is sold to the public. (a.k.a. Selling Price, Value of the Product for Sale)
This is the rental value of the property on the open market.
A value that indicates a specific area of an organization generally related to functional or accounting areas.
The 3-digit ISO 3166 code of the country where the product was produced or manufactured.
A unique identifier that associates a line item to a department for purchasing purposes.
The export procedure (sales) or import procedure (purchases) that is applied for INTRASTAT purposes.
A value that is used with a company’s Chart of Accounts.
Used to classify the goods and services. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
Indicates whether the calculation engine calculates component-level max tax, where applicable. Amounts at the child level of the multi-component item are used for tax calculation. Amounts at the parent level are ignored. Set this attribute to true for line items at the parent level only. Line items at the child level remain false. Defaults to false.
An identifier that further defines the line item and corresponds to the transaction stored in the host system. This parameter is needed to perform synchronization services, but it is not used for reporting purposes.
A line number for the line item. This number can be used as a reference in reports or in audits. If no line item number is supplied, a number is assigned.
A subcomponent (or child line item) of the transaction.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
A value that represents a specific item or product.
The material origin type. Material origin applies to countries, such as Brazil and India, where taxation can vary based on where the goods were acquired before sale.
A code that indicates the type of vehicle that transported the product across the country border. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
A code that indicates the type of transaction being declared for Intrastat purposes. For a list of acceptable values, see the filing instructions for each country where you file an Intrastat report.
The mass of the product in kilograms.
The recoverable percentage of a partial exemption. This field is populated only for transactions with a tax type of Value Added Tax.
The amount of taxes paid previously on the asset. This information is needed to determine reciprocity rules between jurisdictions.
A unique identifier that associates a line item to a project for purchasing purposes.
The date used to calculate Recoverable Input VAT.
The amount that is passed to Vertex O Series from your ERP or host system. Vertex O Series uses this amount to calculate the VAT withholding amount for a given line item. This field is used for Procurement messages. This field specifies the special tax basis of the line item.
The date on which the line item record was produced. This can also be represented as a PO line item date, a lease line item date, and so on. Defaults to the documentDate of the transaction.
Indicates whether tax is included in the Extended Price.
Directly identifies a usage by user-defined usage code.
Directly identifies a usage class by user-defined usage class code.
A value that represents a specific item or product SKU number.
The earnings total of the line item that is subject to VAT Social Security Withholding.
Owner Request message.
A string to represent the accumulation customer identity.
A string to represent the accumulation invoice identity.
Indicates the billing documents that specify different business transactions that are involved in billing activities. Examples of billing documents include invoice, credit or debit memo, or cancellation document. This field is at the transaction level.
The document number in the host application that references the event.
Supports reporting and the document sequence identifier used by your ERP system. Some countries require that documents follow a unique sequential sequence number, depending on the registration type and the type of invoice. Use this field for audit purposes to track the sequence of your documents. This field is used in European Union (EU) countries.
Indicates the type of business transaction to be posted. This field is at the transaction level.
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.
A value that can be used for tax return filing in jurisdictions that require taxes to be filed for individual retail locations.
The key that identifies the purpose of the order. This field is at the transaction level.
The date on which the purchaser paid for the product. If the purchaser pays for the product but physically receives it at a later date, Vertex O Series uses this field for returns and reporting for your tax type. This field is also used in cash accounting.
Indicates whether the results of the transaction are posted to the Tax Journal. Defaults to true. This field is not applicable to Purchase Order tax calculations.
Percentage passed from the billing system to calculate a remainder of an assessed tax or fee.
The date used to calculate Recoverable Input VAT.
Indicates whether the response message should contain an additional structure that shows the elements and attributes that were changed by Tax Assist. This is for informational purposes only and contains no tax results.
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 posted 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.
Enables you to apply line-item level or invoice-level rounding to tax calculations. Set this attribute to true to set up line-item level rounding. With line-item level rounding, the calculation engine rounds amounts at the line-item level and then sums those amounts to calculate an invoice total. This method is useful for invoices that include line items with different taxing jurisdictions. The default value for this attribute is false. In this case, O Series applies an invoice-level rounding, where the calculation engine compares the sum of rounded line item-level totals to the rounded invoice-level total. When there is a difference between these totals, the calculation engine compares differences between rounded and unrounded amounts at each jurisdiction level and distributes the difference to the jurisdiction that results in the smallest total rounding difference amount. For more information about invoice-level rounding, contact Vertex Customer Support to obtain the Rounding Guide.
The date that drives the timing of when the VAT liability arises. In some countries, if the Tax Point Date (also called the Time of Supply) is different from the invoice date, this field is shown separately on an invoice. Use this field if you have reporting compliance in Spain, Poland, and/or Hungary.
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.
The Transaction ID of the deleted transaction from a successful request.
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.
An optional unique user-defined value to identify the new reversal document created by this operation. This will allow transaction operations (such as delete) on this new reversal document.
The document number in the host application that references the event.
Request message for a transaciton reversal.
Object returned from a successful transaction reversal request.
Transaction exist flag returned from a successful request.
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.
Indicates whether or not a transaction with the specified transactionId exists in the Tax Journal. Note: Transactions flagged as Deleted are considered to NOT exist in the Tax Journal.
Postal Address declaration.
The proper name of the city used to determine the Tax Area ID (if none is supplied). Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The country used to determine the Tax Area ID (if none is supplied). You can use a data extract report to see the valid country values. (Refer to the Online Help for information about running data extract reports.) Defaults to the value of the Default Country Code For Address setting. The default value for this setting is USA. (For details about this setting, refer to the Configuration Parameters Reference Guide.)
The proper name or the postal abbreviation of the state, province, or territory used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The postal code used to determine the Tax Area ID (if none is supplied). For valid formats, see the Supporting Information section in the XML Integration Guide. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
The first line of the street address.
The second line of the street address.
The name of the county or province used to determine the Tax Area ID if none is supplied. Optional (0…1) but recommended for greatest precision if no Tax Area ID is supplied.
A date that provides time perspective for a Tax Area Lookup. Tax Area IDs returned for the lookup are based on the jurisdiction boundaries in effect as of this date. Defaults to the current date.
Indicates whether the response message should contain details of what composed the elapsed time. The default value is false.
The result of the lookup process.
The status of the Tax Area Lookup.
The reason for the Address Cleansing failure.
A date that provides time perspective for a Tax Area Lookup. Tax Area IDs returned for the lookup are based on the jurisdiction boundaries in effect as of this date. Defaults to the current date.
Indicates the relative likelihood that a result of a Tax Area Lookup is correct based on the lookup criteria.
Represents the result of the lookup process.
A Vertex-specific number that identifies a tax area.
Tax Area Response type structure
A set of one or more geographic areas that correspond to a unique combination of tax jurisdictions where the tax area’s boundaries are derived from the overlay of the geographic areas that form the domain of those jurisdictions.
Object returned from a successful request.
Coordinates declaration.
A number representing the geographical latitude coordinate of the location.
A number representing the geographical longitude coordinate of the location.
A date that provides time perspective for a Tax Area Lookup. Tax Area IDs returned for the lookup are based on the jurisdiction boundaries in effect as of this date. Defaults to the current date.
A Vertex-specific number that identifies a tax area.
A date that provides time perspective for a Tax Area Lookup. Tax Area IDs returned for the lookup are based on the jurisdiction boundaries in effect as of this date. Defaults to the current date.
A jurisdiction identifier provided by a government authority.
The country associated with the external jurisdiction code. You can use a data extract report to see the valid country values. (Refer to the Online Help for information about running data extract reports.)
A date that provides time perspective for a Tax Area Lookup. Tax Area IDs returned for the lookup are based on the jurisdiction boundaries in effect as of this date. Defaults to the current date.
Internal identifier or sequence number for this lookup.
Internal identifier or sequence number for this lookup.
Object returned from a successful request.
An array of Tax Area IDs.
Object returned from a successful request.