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.

Option 1

ParameterTypePatternMaxMinRequiredDescription
report-typeStringn/an/an/aYesYou must use Audit.
formatStringn/an/an/aNoYou must use csv for an uncompressed file or csv.gz for a compressed file.
product-classesString or Null^(S|P|D)\*n/an/aNoSpecify P for Physical goods. If you do not specify a value, all Product Classes are returned.
end-dateString^\\d{4}-\\d{2}-\\d{2}$n/an/aYesSpecify the end date.
fx-sourceStringn/an/an/aYesSelect a source for currency conversions. See Currency Conversion Source Values.
tax-country-subdivision-codeString or Null\\w\\w-\\w\\w55NoSpecify a country subdivision. For example, US-FL for Florida.
tax-country-codeString or Nulln/a22NoSpecify a country code if you want the report to be for a specific country.
currency-codeString or Null^\\w{3}$33NoSpecify a currency. All amounts will be converted into this currency in the report. If you do not, the default currency for the country is used.
fx-date-typeStringn/an/an/aYesThis controls the date that will be used for any currency conversions. Select one of day, prev-day, or end. This is required if you specify a value for currency-code.
tax-region-keyString or Null^[A-Z]{2}$22NoYou can use this to filter for specific values. For example, if you specify EU, only EU transactions will be included in the report.
report-scopeString or Nulln/an/an/aNoSpecify the scope of the report. Values are explained in the Report Scope Values topic.
transaction-typeString or Nulln/an/an/aNoChoose either Sale for sales or Refund for refunds. If you choose neither, both are included in the report.
start-dateString^\\d{4}-\\d{2}-\\d{2}$n/an/aYesSpecify the date the report will start from.
fx-date-fieldString or Nulln/an/an/aNoChoose tax-timestamp to use the Tax timestamp for the FX date. Choose invoice-timestamp to use the invoice timestamp for the FX date. If no value is specified, the tax-timestamp is used.

Option 2

ParameterTypePatternMaxMinRequiredDescription
start-dateString^\\d{4}-\\d{2}-\\d{2}$n/an/aYesSpecify when the period covered by the report starts.
end-dateString^\\d{4}-\\d{2}-\\d{2}$n/an/aYesSpecify when the period covered by the report ends.
tax-idsString and Nulln/an/a1NoYou can specify a list of Tax IDs to return in the report.
region-keysString and Null^[A-Z]{2}$22NoSpecify a region. For example, EU. The report results will be filtered for this region. You can also specify Unknown if you do not know the region. If you specify no value,
validation-statusesStringn/an/an/aNoSee Validation Status Values
result-changedBoolean and Nulltrue or falsen/an/aNoIf set to true, only Tax IDs where the validation result changed are included.