Batch Level Output XML Elements
The following elements are found in the <OUTDATA>
In the table(s) below, dependency is show by indentation. For example:
<PARENT_ELEMENT>
<CHILD_ELEMENT>
<GRANDCHILD_ELEMENT>
|
Element Name |
Type |
Aud? |
Description |
|---|---|---|---|
|
<REQUEST_STATUS> |
structural |
No |
A structure which contains a summary of the status of the entire request, included aggregation of severe errors. |
|
<IS_SUCCESS> |
boolean |
No |
Indicates whether the request was successful. All invoices must process successfully for this tag to be set to true. |
|
<IS_PARTIAL_SUCCESS> |
boolean |
No |
Indicates whether the request was partially successful. At least one invoice, but not all, must process successfully for this tag to be set to true. |
|
<ERROR> |
structural |
No |
A structure containing one or more severe errors associated with the request. If no severe errors are encountered, this structure will not be returned. |
|
<CODE> |
string |
No |
The severe error's code. |
|
<DESCRIPTION> |
string |
No |
The severe error's description. |
|
<ERROR_LOCATION_PATH> |
string |
No |
An XML path to the element containing the severe error. The path is composed according the XML Path (XPath) standards and describes an Invoice element, a Line element or a Tax element in the Output XML. |
|
<COMPANY_ID> |
number |
No |
The internal Determination ID of the merchant. |
|
<COMPANY_NAME> |
varchar2(100) |
Yes |
The name of the company running the transaction. ONESOURCE Indirect Tax Determination uses this element to apply the correct company-specific settings for the transaction. Returned if EXTERNAL_COMPANY_ID is not populated. |
|
<COMPANY_ROLE> |
varchar2(1) |
Yes |
The company's role as a buyer, seller, or middleman for this transaction. Each have different tax and reporting requirements for any transaction. |
|
<EXTERNAL_COMPANY_ID> |
varchar2(100) |
No |
The unique identifier used by your business application to indicate which company to use in ONESOURCE Indirect Tax Determination. This identifier also distinguishes between different calling applications that may be used by your company. |
|
<HOST_REQUEST_INFO> |
structural |
No |
Contains pass-through elements used to identify the originating request from the ERP source. |
|
<HOST_REQUEST_ID> |
varchar2(100) |
No |
A pass-through element used to identify the document with the originating request from the ERP source. |
|
<MESSAGE> |
structural |
N/A |
A message related to this batch. There can be multiple MESSAGE elements returned with each batch. For a complete description of this structure, see Message Level Output XML Elements. |
|
<SCENARIO_NAME> |
varchar2(100) |
No |
This is the name of the Determination Workbench scenario. |
|
<INVOICE> |
structural - See the Invoice Level Output XML Elements table. |
N/A |
The INVOICE and /INVOICE elements are structural. They serve as the container for an individual invoice. Each batch can contain multiple invoices. |