Line Level Input XML Elements
The following elements are found in the <INDATA><INVOICE><LINE>
To enable compatibility with previous releases, all elements that require true or false also support Y and N. The XML Output will always return true or false, regardless of whether the new- or old-style contents are passed in.
In the table(s) below, dependency is show by indentation. For example:
<PARENT_ELEMENT>
<CHILD_ELEMENT>
<GRANDCHILD_ELEMENT>
Element Name |
Type |
Req? |
Description |
---|---|---|---|
<ACCOUNTING_CODE> |
varchar2(100) |
No |
The Accounting Code (or GL Code) passed in by the ERP system. |
<ALLOCATION_GROUP_NAME> |
varchar2(100) |
No |
Name of the Allocation Group to use for this line. Named Allocations will be looked up in this group. |
<ALLOCATION_GROUP_OWNER> |
varchar2(100) |
No |
Name of the company owning the Allocation Group to use for this line. The named Allocation Group will be looked up in this company's data. |
<ALLOCATION_NAME> |
varchar2(100) |
No |
Name of the Allocation to use for this line. Named Allocations will be looked up in the specified group owned by the specified company (see above). Company default owner and group will be used if not specified in the transaction. Allocations are dated, so the named version active as of the <INVOICE_DATE> will be used. If none match, a message will be added to output indicating an active named Allocation was not found. Allocation processing can be overridden at the line level. See <LINE>.<IS_ALLOCATABLE> . |
<BASIS_PERCENT> |
number |
No |
A percentage of the gross amount of the line used in tax calculation. .5 is equal to 50%, .6 is equal to 60%, and so on. If this element is provided, it overrides any data found on a tax rule or exemption certificate applied to this transaction. |
<BILL_TO> |
structural |
No |
The Bill To address. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<BUYER_PRIMARY> |
structural |
No |
The buyer company's home or primary address. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<CALCULATED_UNIT_AMOUNT> |
number |
No |
This element is typically calculated by Determination; it should not be populated except under the circumstances listed in the description below: This value is calculated by Determination, and the element populated, when a rate tier includes a graduated rate. The calculated amount is the item value divided by quantity, or gross amount divided by quantity if item value does not exist. For example, an item value of 2400 and a quantity of three would result in a calculated unit amount of 800. Item value always takes precedence over gross amount if both are present in the transaction. This element should never be populated in the Input XML. It can be populated by a TransEditor when one of the following scenarios is true:
|
<COMMODITY_CODE> |
varchar2(50) |
No |
A code that can be assigned to a product by a particular authority. In the EU, many member states have moved to using Harmonized Codes (similar to Commodity Codes) which can also be stored in this element. Commodity Codes provide an alternate way (in addition to product mappings) to match ONESOURCE Indirect Tax Determination products. When commodity codes are evaluated by the calculation engine, it first attempts to match the full code, and then strips off characters from the end of the code, one at a time, until a match is made or no code remains. |
<COUNTRY_OF_ORIGIN> |
varchar2(100) |
No |
The country where the goods were manufactured. Used in Intrastat reporting. |
<CUSTOMER_GROUP_NAME> |
varchar2(100) |
No |
Name of the Customer Group to use for this transaction. Customers will be looked up in this group, overriding the settings of the transacting company's Company Preferences. Note that the list of valid groups for this element consists of Customer Groups owned by the transacting company and its ancestors. |
<CUSTOMER_GROUP_OWNER> |
varchar2(100) |
No |
Name of the company owning the Customer Group to use for this transaction. This company must be a parent or grandparent of the transacting company. |
<CUSTOMER_NAME> |
varchar2(100) |
No |
See <INVOICE>.<CUSTOMER_NAME> for details. |
<CUSTOMER_NUMBER> |
varchar2(100) |
No |
See <INVOICE>.<CUSTOMER_NUMBER> for details. |
<DELIVERY_TERMS> |
varchar2(100) |
No |
Indicates how goods were shipped and where title was transferred. Valid values include Incoterms 2000 codes and any other customer-defined codes. |
<DEPT_OF_CONSIGN> |
varchar2(100) |
No |
Department of consignment. Used in Intrastat reporting. |
<DESCRIPTION> |
varchar2(200) |
No |
A description of a particular product. This data is primarily used to retrieve and reference records from the audit data. |
<DISCOUNT_AMOUNT> |
number |
No |
In some situations volume or other discounts must be taken into account when calculating tax. For these situations, <DISCOUNT_AMOUNT> can be used to indicate that amount. When <DISCOUNT_AMOUNT> is passed, Determination will reduce the <GROSS_AMOUNT> by that discount amount as the new <TAXABLE_BASIS>. For example, if the <GROSS_AMOUNT> is 100 and a <DISCOUNT_AMOUNT> of 20 is passed, the tax engine uses a <TAXABLE_BASIS> of 80. |
<END_USE> |
varchar2(100) |
No |
End use of the product. Intended for use by Rule Qualifiers to govern the applicability of a rule. |
<ESTABLISHMENTS> |
structural |
No |
List of established locations. |
structural |
No |
List of buyer's established locations. |
|
<BILL_TO> <BUYER_PRIMARY> <MIDDLEMAN> <ORDER_ACCEPTANCE> <ORDER_ORIGIN> <SELLER_PRIMARY> <SHIP_FROM> <SHIP_TO> <SUPPLY> |
boolean |
No |
Establishment status for the indicated location type: true or false. |
<MIDDLEMAN_ROLE> |
structural |
No |
List of middleman's established locations. |
<BILL_TO> <BUYER_PRIMARY> <MIDDLEMAN> <ORDER_ACCEPTANCE> <ORDER_ORIGIN> <SELLER_PRIMARY> <SHIP_FROM> <SHIP_TO> <SUPPLY> |
boolean |
No |
Establishment for the location type: true or false. |
<SELLER_ROLE> |
structural |
No |
List of seller's established locations. |
<BILL_TO> <BUYER_PRIMARY> <MIDDLEMAN> <ORDER_ACCEPTANCE> <ORDER_ORIGIN> <SELLER_PRIMARY> <SHIP_FROM> <SHIP_TO> <SUPPLY> |
boolean |
No |
Establishment for the location type: true or false. |
<EXEMPT_AMOUNT> |
structural |
No |
Forces an exempt amount for a transaction in one or more specified jurisdictions. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
number |
No |
Amount at this zone level. |
<EXEMPT_CERTIFICATE> |
structural |
No |
The exemption certificate number, which is used to look up the specific exemption certificate for this line. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
varchar2(100) |
No |
Certificate number at this zone level. |
<EXEMPT_REASON> |
structural |
No |
Limits the search for an applicable certificate to ones with this exempt reason (either short code or long code). Also, if no certificate is found and auto-create certificates is turned on, the transaction must have either a valid exempt reason or certificate number at the address level at which a given authority is trying to apply tax. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
varchar2(20) |
No |
Exempt reason at this zone level. |
<GROSS_AMOUNT> |
number |
Yes* |
This is the amount that is required to compute tax in forward calculations (see the invoice-level input element <CALCULATION_DIRECTION>). When you execute reverse calculations, the value of GROSS_AMOUNT is affected by the values of two Configuration parameters:
If you set the value for these parameters to Y, Determination inserts the calculated gross amount into the gross amount XML output element. For example, if there is no gross amount in the XML input, the gross amount in the XML output contains the calculated gross amount value. If there is a gross amount in the XML input, then it is replaced by the value of calculated gross amount in the XML output. If you accept the default and do not set these parameters (or set them to N), the gross amount in the XML output is the value you provided in the input. For information about gross amounts containing non-taxable amounts such as fees, see the description for <ITEM_VALUE>. (*) Gross amount is required in forward calculations, as well as in reverse-from-tax transactions using tiered rates.
|
<GROSS_PLUS_TAX> |
number |
No |
This element is used in reverse-from-total calculations instead of <GROSS_AMOUNT> and <TAX_AMOUNT> in cases where only the sum of the two is known. Determination calculates which portion of the total is tax and which part is gross, and then distributes the calculated tax amounts to the appropriate authorities. See <INVOICE>.<CALCULATION_DIRECTION>. |
<INCLUSIVE_TAX_INDICATORS> |
structural |
No |
Contains information on whether to treat some or all authority taxes for this invoice as inclusive, regardless of the selected rule.
For more information, see the Inclusive Taxes topic in Help. |
<AUTHORITY_TYPE> |
varchar2(100) |
No |
If the authority selected for a transaction matches the type indicated here, all taxes for that authority are considered as inclusive. You can have multiple <AUTHORITY_TYPE> elements in an <INCLUSIVE_TAX_INDICATORS> structure. |
<FULLY_INCLUSIVE> |
boolean |
No |
If set to true, indicates that all authorities that Determination will select for taxing will be considered as Inclusive Tax. This element overrides the calculation method set for the selected rule by forcing inclusive tax. |
<INPUT_RECOVERY_AMOUNT> |
number |
No |
Overrides any Input Recovery Amount specified by the transaction's rule. |
<INPUT_RECOVERY_PERCENT> |
number |
No |
Overrides the Input Recovery Percentage specified by the transaction's rule. |
<INPUT_RECOVERY_TYPE> |
varchar2(50) |
No |
A pass-through element which has been deprecated in favor of enhanced VAT calculation logic. See <INPUT_RECOVERY_AMOUNT/PERCENT> |
<INVOICE_DATE> |
date |
No |
The date of the invoice as stored on this line. |
<IS_ALLOCATABLE> |
boolean |
No |
If set to false, no allocation will be applied to the line, even if one is specified by name for the Line or at the Invoice level. The default behavior (null) is true. |
<IS_BUSINESS_SUPPLY> |
boolean |
No |
Indicates whether a supply is being used for business. For some transaction types, whether a supply is being used for business or not impacts the tax and reporting requirements of the buyer and the seller. Valid values are true and false. |
<IS_CREDIT> |
boolean |
No |
Indicates whether the current line is a credit as identified by your ERP system. true indicates a credit for both auditing and reporting purposes. When set to true, any amount on the line should be passed in as a negative value. Valid values are true and false. |
<IS_EXEMPT> |
structural |
No |
Forces exemption from tax for a line in the specified jurisdictions. Exemption is different from zero tax for VAT authorities, as exemption completely excludes the transaction from VAT accounting. In the case of a sale, VAT paid to make the supply cannot be recovered if the supply is exempt. In Sales Tax countries such as the US, the exempt indicator prevents tax from being charged. If false is explicitly passed the exemption certificate lookup is suppressed; tax will be charged even though an apparently valid certificate may exist in Determination. |
<ALL> |
boolean |
No |
Forces exemption from tax for all jurisdictions. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
boolean |
No |
Exemption status at this zone level. |
<IS_MANUFACTURING> |
boolean |
No |
Indicates that the goods or services are for manufacturing purposes. |
<IS_NO_TAX> |
structural |
No |
Forces no tax for a particular invoice in the specified jurisdictions. To select all jurisdictions, set ALL to true. The default is behavior is (null) which is the same as explicitly specifying false. If <IS_NO_TAX> is set for a given level, and an <OVERRIDE_RATE> or <OVERRIDE_AMOUNT> are specified at that level, the <IS_NO_TAX> setting is ignored. |
<ALL> |
boolean |
No |
No tax in all jurisdictions for this line. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
boolean |
No |
No tax at this zone level. |
<IS_SIMPLIFICATION> |
boolean |
No |
Indicates an override to any triangulation simplification determinations. Valid values are true and false. If set to true, you must pass registrations in for the Buyer, Seller, and Middleman in the transaction or a warning message will be returned. |
<ITEM_VALUE> |
number |
No |
The total value of all items on this line. This is distinct from the gross amount because it does not contain costs such as landed costs, insurance, freight and other associated costs that gross amount does contain. If an item value is present in a transaction, it is used instead of taxable basis. Item value is used in many VAT and EU Intrastat reports. |
<LICENSES> |
structural |
No |
Contains data for one or more licenses applying to the document. |
<CUSTOMER_LICENSE> |
structural |
No |
Contains data pertaining to a single license, consisting of a number-type pair. |
<NUMBER> |
varchar2(100) |
No |
The number of the license to be created. |
<TYPE> |
varchar2(100) |
No |
The type of license to be created. |
<NUMBER_TYPE> |
not applicable |
No |
A pseudo-element which enables the getting and setting a number and type pair within TransEditors and Rule Qualifiers. The format is Name|Type, with the pipe character separating the license number from license type. |
<LINE_NUMBER> |
number |
Yes |
<LINE_NUMBER> is a required element for each line. Used in combination with <INVOICE_NUMBER>, it is used to specify and reference a particular line on a particular invoice. |
<LOCATION> |
structural |
No |
Specifies a location that you pre-configured on the Locations page. The seven available location types are listed below. Addresses specified in the transaction override Locations, and Locations specified override Location Sets. |
<BILL_TO> |
varchar2(30) |
No |
Bill To location. |
<MIDDLEMAN> |
varchar2(30) |
No |
Middleman location. |
<ORDER_ACCEPTANCE> |
varchar2(30) |
No |
Order Acceptance location. |
<ORDER_ORIGIN> |
varchar2(30) |
No |
Order Origin location. |
<SHIP_FROM> |
varchar2(30) |
No |
Ship From location. |
<SHIP_TO> |
varchar2(30) |
No |
Ship To location. |
<SUPPLY> |
varchar2(30) |
No |
Supply location. |
<LOCATION_SET> |
varchar2(60) |
No |
A named set of pre-defined locations defined by the <LOCATION> element. Instead of specifying several locations using the <LOCATION> element, you can specify all the locations in a transaction using a single <LOCATION_SET> element.
|
<MASS> |
number |
No |
The Mass of a supply. Used for Intrastat reporting purposes in the EU. |
<MIDDLEMAN> |
structural |
No |
The Middleman address. The presence of middleman address data can trigger triangulation processing in the EU. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<MODE_OF_TRANSPORT> |
varchar2(50) |
No |
The method of transport. Used for Intrastat reporting in the EU. |
<MOVEMENT_DATE> |
date |
No |
Indicates the date of a movement of goods, such as via a pipeline, or the data of issue. Used in rule qualifiers and in date determination rules. |
<MOVEMENT_TYPE> |
varchar2(100) |
No |
Indicates the type of movement, such as a pipeline. Used in rule qualifiers and in date determination rules. |
<ORDER_ACCEPTANCE> |
structural |
No |
The Order Acceptance address. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<ORDER_ORIGIN> |
structural |
No |
The Order Origin address. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<ORIGINAL_DOCUMENT_ID> |
varchar2(100) |
No |
The original document id as shown on the document in the ERP system. Not used in calculations. |
<ORIGINAL_DOCUMENT_ITEM> |
varchar2(100) |
No |
The original document item as shown on the document in the ERP system. Not used in calculations. |
<ORIGINAL_DOCUMENT_TYPE> |
varchar2(100) |
No |
The original document type as shown on the document in the ERP system. Not used in calculations. |
<ORIGINAL_INVOICE_DATE> |
date |
No |
The date of the original invoice. Used in Date Determination Rules. |
<ORIGINAL_MOVEMENT_DATE> |
date |
No |
The date of the original movement. Used in Date Determination Rules. |
<OVERRIDE_AMOUNT> |
structural |
No |
Override Amount allows you to specify an amount that Determination will use to override the tax result. The override amount is applied to a specific authority level such as Country, State or City. Determination will identify none, one, or more authorities at the specified level (effective zone level in XML or effective tax level in Determination). The specified amount will apply to all authorities returned with the transaction. Allocation that may occur for amount is an override for all authorities. If no authority is returned, the override amount is not applied to the transaction or recorded for the specified authority level. This same behavior applies when Override Rate is used. As a best practice, you must first calculate normally and then use the returned authority levels when using the overrides. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
number |
No |
Amount at this zone level. |
<OVERRIDE_RATE> |
structural |
No |
Forces the rate of tax assessed for a particular invoice for a particular authority. The override value must be positive. <OVERRIDE_AMOUNT>s take precedence over any configured override rates. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
number |
No |
Rate at this zone level. |
<PART_NUMBER> |
varchar2(100) |
No |
The part number used by your ERP system. This element is stored in the audit tables and does not affect calculation. |
<POINT_OF_TITLE_TRANSFER> |
varchar2(1) |
No |
The Point of Title Transfer location. Valid values are:
If no <POINT_OF_TITLE_TRANSFER> or <DELIVERY_TERMS> element is passed in at either the Invoice or Line level, the default for the Invoice is set to In Transit.
|
<PORT_OF_ENTRY> |
varchar2(100) |
No |
The Port of Entry, used for Intrastat reporting in the EU. |
<PORT_OF_LOADING> |
varchar2(5) |
No |
The Port or Airport of Departure; used for Intrastat reporting in the EU. |
<PRODUCT_CODE> |
varchar2(100) |
No |
Your ERP system's product code for the product on this line. Product Codes are mapped to the Product Tree using Product Mappings. |
<QUANTITIES> |
structural |
No |
Contains a list of analogous quantities differing in their units of measure. |
<QUANTITY> |
structural |
No |
An individual quantity consisting of an amount (such as 50) and a unit of measure such as L (liters). |
<AMOUNT> |
number |
No |
The number of the quantity (for example, 50 for 50 L). |
<UOM> |
varchar2(25) |
No |
The unit of measure for the quantity (for example, KG for 50 L). |
<DEFAULT> |
boolean |
No |
Indicates that this quantity should be used as the default quantity in the transaction when multiple quantities are specified. |
<AMOUNT_UOM> |
not applicable |
No |
A pseudo-element which enables the getting and setting an Amount and Unit of Measure pair within TransEditors and Rule Qualifiers. The format consists of AMOUNT|UOM, with the pipe character separating the amount from the unit of measure. |
<AMOUNT_UOM_DEFAULT> |
not applicable |
No |
A pseudo-element which enables the getting and setting an Amount, Unit of Measure, and Default triplet within TransEditors and Rule Qualifiers. The format consists of AMOUNT|UOM|DEFAULT, with the pipe character separating the elements DEFAULT is either true or false. |
<REGIME> |
varchar2(100) |
No |
The Regime, used for French Intrastat reports. |
<REGISTRATIONS> |
structural |
No |
List of registrations for role. |
<BUYER_ROLE> |
varchar2(25) |
No |
Buyer role registrations. Audited if used in calculation. When a buyer passes a registration in the Input XML, other configured registrations for the company are ignored.
|
<MIDDLEMAN_ROLE> |
varchar2(25) |
No |
Middleman role registrations. Audited if used in calculation.
|
<SELLER_ROLE> |
varchar2(25) |
No |
Seller role registrations. Audited if used in calculation. When a seller passes a registration in the Input XML, other configured registrations for the company are ignored. |
<SELLER_PRIMARY> |
structural |
No |
The seller company's home or primary address. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<RELATED_LINE_NUMBER> |
number |
No |
Identifies that this line should have the same tax treatment as the product on the related line. |
<SHIP_FROM> |
structural |
No |
The Ship From address. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<SHIP_TO> |
structural |
No |
The Ship To address. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<SUPPLEMENTARY_UNIT> |
varchar2(5) |
No |
The size of a supply. For Intrastat reports in the EU, some commodities require an additional measuring unit other than or in addition to mass for reporting purposes. EU rules determine the unit to be used for various supplies. |
<SUPPLY> |
structural |
No |
The Supply address. Most tax authorities around the world, including many in the United States, rely on the supply location as the central address in determining tax liability for services transactions. See Address Level Input XML Elements for a description of the individual elements in this structure. |
<SUPPLY_EXEMPT_PERCENT> |
structural |
No |
A pass-through element which has been deprecated in favor of enhanced VAT calculation logic. See <INPUT_RECOVERY_AMOUNT/PERCENT> |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
number |
No |
See above. |
<TAX_AMOUNT> |
number |
No |
When reverse-from-tax calculations are run, you provide this amount so Determination can determine how to spread the tax amounts across the authorities. Also, it computes a calculated gross amount. See the invoice-level input element <CALCULATION_DIRECTION>. |
<TAX_CODE> |
varchar2(50) |
No |
An optional code which can be specified in the transaction to match a Tax Code specified on a Rule. |
<TAX_DETERMINATION_DATE> |
date |
No |
The date used in selecting all applicable system configuration including tax rates and rules. Overrides any Determination-calculated date. |
<TAX_EXCHANGE_RATE_DATE> |
date |
No |
The date used in selecting currency conversion data. Overrides Determination-calculated date. |
<TAX_POINT_DATE> |
date |
No |
The date the signifies when the liability for tax arises. Overrides any Determination-calculated date. |
<TAX_TREATMENT> |
varchar2(100) |
No |
The flag that indicates alternative tax treatment after Determination performs its calculation:
For more information, see Deferred Taxes in Help. |
structural |
No |
The type of tax applied to a tax result. For example: sales, consumer use, or zero rate. By default, the tax type is determined automatically. You can override it with configuration or in the input XML. Some tax types are specific to US or International transactions. For a list of tax types and their descriptions, see Tax Types Quick Reference. |
|
<ALL> |
varchar2(20) |
No |
Sets tax type on all jurisdictions for this line. |
<COUNTRY> <PROVINCE> <STATE> <COUNTY> <CITY> <POSTCODE> <GEOCODE> |
varchar2(20) |
No |
Tax type at this zone level. |
<TITLE_TRANSFER_LOCATION> |
varchar2(1) |
No |
A pass-through element used in conjunction with the <DELIVERY_TERMS> element to enable meeting the "named place" requirement for the point of title transfer as defined by ICC Incoterms. |
<TRANSACTION_TYPE> |
varchar2(2) |
Yes* |
The transaction type, which is required to apply the correct type of taxes to the transaction. Valid types are:
For a complete description of these transaction types, see Transaction Types (*) This is required on the line level only if it is not specified on the invoice level. |
<UNIQUE_LINE_NUMBER> |
varchar2(100) |
No |
The ERP system's primary key for this line number. |
<UNIT_OF_MEASURE> |
varchar2(25) |
No |
A description of the unit of measure used to match a Rule's specified Unit of Measure. The ampersand character (&) cannot be used in a unit of measure. To take advantage of Determination's built-in Units of Measures and Conversion Factors, use the <QUANTITIES> structure instead. |
<USER_ELEMENT> |
structural |
No |
A structure that enables companies to submit, and have returned, user-defined elements that are not directly supported in Determination. These elements can be used in conjunction TransEditors to enable custom tax calculations. Each <USER_ELEMENT> structure contains a single <NAME>/<VALUE> pair. |
<NAME> |
varchar2(200) |
No |
The name of the user element. Currently restricted to the values ATTRIBUTE1 through ATTRIBUTE50. |
<VALUE> |
varchar2(200) |
No |
The value to be passed into Determination's audit tables and returned to your business application. |
<VAT_GROUP_REGISTRATION> |
varchar2(25) |
No |
The value of the VAT Group registration number for the line. Used as the primary way of looking up VAT Registration Groups during calculation. |
<VENDOR_NAME> |
varchar2(100) |
No |
The vendor's name. If this is a B2B transaction and the Company is the buyer, the Company becomes the Customer and the Vendor becomes the Company for the transaction. |
<VENDOR_NUMBER> |
varchar2(20) |
No |
The vendor's number. If this is a B2B transaction and the Company is the buyer, the Company becomes the Customer and the Vendor becomes the Company for the transaction. |
<VENDOR_TAX> |
number |
No |
The amount of tax charged by the Vendor on an Accounts Payable invoice. |