Audit Report Fields
Learn about required fields and additional requirements for audit reports.
Here is a breakdown of how the audit report populates each field based on the Vertex O Series Online Commerce request and response.
Vertex O Series Online Commerce does not populate some fields, as indicated below. The audit report can populate some fields with information that has no clear correspondence to the O Series Online Commerce request or response, for example:
- The Key uses an internal transaction identifier that is partially based on the
transactionIdin the request. The response does not return this identifier. - The Invoice number appears on the invoice document available through
documentImageUrl, but the response does not return it as a separate field. - Vertex O Series Online Commerce does not populate the Import country code field.
| Field | Notes |
|---|---|
| Transaction type | This field depends on the INVOICE type. A standard request represents a SALE, while a refund request represents a REFUND. |
| Product class | This field is based on lineItems[].product.value and lineItems[].product.productClass when product delivery is configured. |
| Transaction kind | This field is based on customer.taxRegistrations[] and lineItems[].taxes[].buyerRegistrationId. |
| Import country code | Not applicable. This field is not set for the service. |
| Tax liability owner | This field is based on lineItems[].taxes[].taxLiabilityOwnerCode, but uses the related internal identifier. |
| Invoice number | — |
| Seller platform name | — |
| Seller platform code | — |
| Seller customs id | Not applicable. This field is not set for the service. |
| Invoice date | The documentDate of the refund request, if provided. |
| Refund date | The documentDate of the refund request, if provided. |
| Currency code | currency.isoCurrencyCodeAlpha |
| Target currency code | — |
| Tax country code | customer.destination.country |
| Tax country code subdivision code | customer.destination.mainDivision |
| Tax country name | customer.destination.country |
| FX source | — |
| Exchange rate | — |
| Exchange rate date | — |
| Product CN Code | Not applicable. This field is not set for the service. |
| Product Tax Identifier | lineItems[].product.productClass |
| Product reference number | Not applicable. This field is not set for the service. |
| Amount | lineItems[].extendedPrice |
| Discounted amount | Not applicable. This field is not set for the service. |
| Tax amount | — |
| Discounted tax amount | Not applicable. This field is not set for the service. |
| FX converted amount | — |
| FX converted tax amount | — |
| Total amount | This field is based on lineItems[].extendedPrice and lineItems[].totalTax. |
| Discounted total amount | Not applicable. This field is not set for the service. |
| Buyer tax number | This field is based on customer.taxRegistrations[] and lineItems[].taxes[].buyerRegistrationsId. |
| Buyer tax number valid | The value is true if the service determines a valid tax registration. |
| Reverse charge | — |
| Tax exempt | lineItems[].taxes[].exempt |
| FX converted total amount | — |
| Liability rule applied | custom |
| IOSS/OSS | This field is based on the liability determination results. |
| Special tax scheme | This field is based on the liability determination results. |
| Transaction description | Not applicable. This field is not set for the service. |
| Line description | lineItems[].lineItemDescription |
| Carrier id | Not applicable. This field is not set for the service. |
| Consignment id | lineItems[].consignmentId |
| Parcel reference | Not applicable. This field is not set for the service. |
| Goods shipped from country code | seller.physicalOrigin.country |
| Goods shipped from country subdivision code | seller.physicalOrigin.mainDivision |
| Goods shipped from country name | seller.physicalOrigin.country |
| Ship to address country code | customer.destination.country |
| Ship to address country subdivision code | customer.destination.mainDivision |
| Ship to address | customer.destination |
| Ship to address country name | customer.destination.country |
| Billing address country code | customer.administrativeDestination.country |
| Billing address country subdivision code | customer.administrativeDestination.mainDivision |
| Billing address | customer.administrativeDestination |
| Billing address country name | customer.administrativeDestination.country |
| Key | — |
| Line key | — |
| Referenced key | — |
| Invoice url | lineItems[].documentImageUrl |
| Tax name | lineItems[].taxes[].imposition.value |
| Tax component tax rate | This field is based on lineItems[].taxes[].nominalRate and lineItems[].taxes[].effectiveRate. |
| Tax jurisdiction code | lineItems[].taxes[].jurisdiction.jurisdictionId |
| Tax jurisdiction type | lineItems[].taxes[].jurisdiction.jurisdictionType |
| Tax authority id | lineItems[].taxes[].jurisdiction.jurisdictionId |
| Tax authority name | lineItems[].taxes[].jurisdiction.value |
| Tax component country subdivision code | This field is based on lineItems[].taxes[].jurisdiction.jurisdictionType and value. |
| Tax taxable ratio | This field is based on lineItems[].taxes[].taxable and lineItems[].extendedPrice. |
| Tax imposition | lineItems[].taxes[].imposition.value |
| Tax imposition type | lineItems[].taxes[].impositionType.value |
| Tax type | lineItems[].taxes[].taxType |
| Admin Destination Tax Area ID | customer.administrativeDestination.taxAreaId |
| Admin Origin Tax Area ID | seller.administrativeOrigin.taxAreaId |
| Destination Tax Area ID | customer.destination.taxAreaId |
| Physical Origin Tax Area ID | seller.physicalOrigin.taxAreaId |
| Delivery Term | Not applicable. This field is not set for the service. |
| Transaction stored | — |
| Transaction confirmed | — |
| IP address | customer.locationEvidence.ipAddress |
| Credit card number prefix | customer.locationEvidence.bin |
| Self declared address | customer.locationEvidence.selfDeclaration |
| Evidence #1 type | This field is based on customer.locationEvidence.{evidence-type}, where locationEvidenceRank is 0. |
| Evidence #1 country code | customer.locationEvidence.{evidence-type}.resolvedLocation.country |
| Evidence #2 type | This field is based on customer.locationEvidence.{evidence-type}, where locationEvidenceRank is 1. |
| Evidence #2 country code | customer.locationEvidence.{evidence-type}.resolvedLocation.country |
| Evidence #3 type | This field is based on customer.locationEvidence.{evidence-type}, where locationEvidenceRank is 2. |
| Evidence #3 country code | customer.locationEvidence.{evidence-type}.resolvedLocation.country |
| Tax component tax amount | lineItems[].taxes[].calculatedTax |
| Tax component FX converted tax amount | — |
| Exempt amount | lineItems[].taxes[].exempt |
| Taxable amount | lineItems[].taxes[].taxable |
| Nontaxable amount | lineItems[].taxes[].nonTaxable |
| Ship to address postal code | customer.destination.postalCode |
| Marketplace business entity code | — |
| Seller business entity code | — |
| Product commodity code | lineItems\[].commodityCode.value |
| Product commodity code type | lineItems\[].commodityCode.commodityCodeType |
Updated 11 days ago
Did this page help you?