Audit Report Input Parameters

Use these input parameters to specify the information that is included in the report.

These are used for the Audit Report and the Schedule Report request.

Online Commerce

FieldTypeFormatMaxMinRequiredDescription
report-typeStringN/AN/AN/AYesSpecify Audit to generate an audit report.
formatStringN/AN/AN/ANoSpecify csv to generate an uncompressed report file or csv.gz to generate a compressed report file.
product-classesString or Null^(S|P|D)\*N/AN/ANoFilter the report by product class. Specify P to include only physical goods. If omitted, the report includes all product classes.
end-dateString^\\d{4}-\\d{2}-\\d{2}$N/AN/AYesSpecify the last date to include in the report.
fx-sourceStringN/AN/AN/AYesSpecify the exchange rate source to use for currency conversions.
tax-country-subdivision-codeString or Null\\w\\w-\\w\\w55NoFilter the report by country subdivision. For example, specify US-FL to include only transactions associated with Florida.
tax-country-codeString or NullN/A22NoFilter the report by country. Specify a two-letter country code.
currency-codeString or Null^\\w{3}$33NoConvert all monetary amounts in the report to the specified currency. If omitted, the report uses the country's default currency.
fx-date-typeStringN/AN/AN/AYesSpecify the date used to determine exchange rates for currency conversions. Valid values are day, prev-day, and end. Required when currency-code is specified.
tax-region-keyString or Null^[A-Z]{2}$22NoFilter the report by tax region. For example, specify EU to include only transactions within the European Union.
report-scopeString or NullN/AN/AN/ANoSpecify the scope of transactions to include in the report. See Report Scope Values.
transaction-typeString or NullN/AN/AN/ANoFilter the report by transaction type. Specify Sale to include sales transactions or Refund to include refund transactions. If omitted, both are included.
start-dateString^\\d{4}-\\d{2}-\\d{2}$N/AN/AYesSpecify the first date to include in the report.
fx-date-fieldString or NullN/AN/AN/ANoSpecify which transaction date to use when determining the exchange rate. Use tax-timestamp to use the tax calculation timestamp or invoice-timestamp to use the invoice timestamp. If omitted, tax-timestamp is used.

Standalone Vertex Validator

ParameterTypeFormatMaxMinRequiredDescription
start-dateString^\\d{4}-\\d{2}-\\d{2}$N/AN/AYesSpecify the first date in the reporting period.
end-dateString^\\d{4}-\\d{2}-\\d{2}$N/AN/AYesSpecify the last date in the reporting period.
tax-idsString and Nulln/aN/A1NoFilter the report to include only the specified Tax IDs. You can provide one or more Tax IDs.
region-keysString and Null^[A-Z]{2}$22NoFilter the report by region. For example, specify EU to include only records associated with the European Union. Specify Unknown to include records where the region could not be determined. If omitted, all regions are included.
validation-statusesStringn/aN/AN/ANoFilter the report by validation status. See Validation Status Values.
result-changedBoolean and Nulltrue or falseN/AN/ANoSpecify true to include only Tax IDs whose validation result changed during the reporting period. If false or omitted, all matching records are included.