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
Parameter | Type | Pattern | Max | Min | Required | Description |
---|---|---|---|---|---|---|
report-type | String | n/a | n/a | n/a | Yes | You must use Audit . |
format | String | n/a | n/a | n/a | No | You must use csv for an uncompressed file or csv.gz for a compressed file. |
product-classes | String or Null | ^(S|P|D)\* | n/a | n/a | No | Specify P for Physical goods. If you do not specify a value, all Product Classes are returned. |
end-date | String | ^\\d{4}-\\d{2}-\\d{2}$ | n/a | n/a | Yes | Specify the end date. |
fx-source | String | n/a | n/a | n/a | Yes | Select a source for currency conversions. See Currency Conversion Source Values. |
tax-country-subdivision-code | String or Null | \\w\\w-\\w\\w | 5 | 5 | No | Specify a country subdivision. For example, US-FL for Florida. |
tax-country-code | String or Null | n/a | 2 | 2 | No | Specify a country code if you want the report to be for a specific country. |
currency-code | String or Null | ^\\w{3}$ | 3 | 3 | No | Specify 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-type | String | n/a | n/a | n/a | Yes | This 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-key | String or Null | ^[A-Z]{2}$ | 2 | 2 | No | You can use this to filter for specific values. For example, if you specify EU , only EU transactions will be included in the report. |
report-scope | String or Null | n/a | n/a | n/a | No | Specify the scope of the report. Values are explained in the Report Scope Values topic. |
transaction-type | String or Null | n/a | n/a | n/a | No | Choose either Sale for sales or Refund for refunds. If you choose neither, both are included in the report. |
start-date | String | ^\\d{4}-\\d{2}-\\d{2}$ | n/a | n/a | Yes | Specify the date the report will start from. |
fx-date-field | String or Null | n/a | n/a | n/a | No | Choose 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
Parameter | Type | Pattern | Max | Min | Required | Description |
---|---|---|---|---|---|---|
start-date | String | ^\\d{4}-\\d{2}-\\d{2}$ | n/a | n/a | Yes | Specify when the period covered by the report starts. |
end-date | String | ^\\d{4}-\\d{2}-\\d{2}$ | n/a | n/a | Yes | Specify when the period covered by the report ends. |
tax-ids | String and Null | n/a | n/a | 1 | No | You can specify a list of Tax IDs to return in the report. |
region-keys | String and Null | ^[A-Z]{2}$ | 2 | 2 | No | Specify 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-statuses | String | n/a | n/a | n/a | No | See Validation Status Values |
result-changed | Boolean and Null | true or false | n/a | n/a | No | If set to true , only Tax IDs where the validation result changed are included. |
Updated about 1 month ago