These field references describe the fields in the Schedule Report request.

Integrated services

The following fields are available for integrated services, including Vertex for e-Commerce, Vertex for Marketplaces, and Vertex O Series Online Commerce:

Field	Type	Pattern	Min	Max	Required	Description
`report-type`	String	—	—	—	Yes	The report type. Possible values are `Audit` and `Tax-ID`.
`format`	String	—	—	—	No	Specifies `csv` for an uncompressed file or `csv.gz` for a compressed file.
`product-classes`	String	`^(S\|P\|D)\*`	—	—	No	Specifies `S` for all product classes, `P` for physical goods, or `D` for digital goods. If you do not specify a value, the report includes all product classes. The value can be null.
`end-date`	String	`^\\d{4}-\\d{2}-\\d{2}$`	—	—	Yes	The end date for the report.
`fx-source`	String	—	—	—	Yes	The source for currency conversions.
`tax-country-subdivision-code`	String	`\\w\\w-\\w\\w`	5	5	No	The country subdivision code. For example, use `CA-QC` for Quebec. The value can be null.
`tax-country-code`	String	—	2	2	No	The two-letter ISO country code. The value can be null.
`currency-code`	String	`^\\w{3}$`	3	3	No	The currency for the report. The report converts all amounts to this currency. If you do not specify a value, the service uses the country's default currency. The value can be null.
`fx-date-type`	String	—	—	—	Yes	The date used for currency conversions. Select `day`, `prev-day`, or `end`. This parameter is required when you specify `currency-code`.
`tax-region-key`	String	`^[A-Z]{2}$`	2	2	No	The value to filter the report by country or region. For example, specify `CA` to include only transactions within Canada. The value can be null.
`report-scope`	String	—	—	—	No	See Report Scope Values.
`transaction-type`	String	—	—	—	No	Specifies `Sale` for sales or `Refund` for refunds. If you do not specify a value, the report includes both. The value can be null.
`start-date`	String	`^\\d{4}-\\d{2}-\\d{2}$`	—	—	Yes	The start date for the report.
`fx-date-field`	String	—	—	—	No	Specifies `tax-timestamp` to use the tax timestamp as the FX date, or `invoice-timestamp` to use the invoice timestamp. If you do not specify a value, the service uses `tax-timestamp`. The value can be null.

Standalone services

The following fields are available for Standalone Vertex Validator:

Field	Type	Pattern	Min	Max	Required	Description
`start-date`	String	`^\\d{4}-\\d{2}-\\d{2}$`	—	—	Yes	The start date for the report period.
`end-date`	String	`^\\d{4}-\\d{2}-\\d{2}$`	—	—	Yes	The end date for the report period.
`tax-ids`	String	—	1	—	No	The list of tax numbers to include in the report. The value can be null.
`region-keys`	String	`^[A-Z]{2}$`	2	2	No	The value to filter the report by country or region. For example, specify `CA` to include only transactions within Canada. The value can be null.
`validation-statuses`	String	—	—	—	No	See Validation Status Values.
`result-changed`	Boolean	`true` or `false`	—	—	No	Specifies `true` to include only tax numbers whose validation results changed.