AvaTax
ReportParametersModel
The output model for report parameter definitions
The start date filter used for your report
The end date filter used for your report
The country filter used for your report
The state filter used for your report
The date type filter used for your report
The doc type filter used for your report
The date format used for your report
The currency code used for your report
DEPRECATED - Date: 02/18/2026, Version: 26.3.0, Message: This field is deprecated. Please do not use it. This will be removed from the model on 08/18/2027. Number of partitions to split the report into.
DEPRECATED - Date: 02/18/2026, Version: 26.3.0, Message: This field is deprecated. Please do not use it. This will be removed from the model on 08/18/2027. The zero-based partition number to retrieve in this export request.
If true, include only documents that are locked. If false, include only documents that are not locked. Defaults to false if not specified.
If set, include only documents associated with this merchantSellerId.
The Document status filter used for report For documentStatus, accepted values are: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval
If true, modified date will be same as document date If false, modified date will not be same as document date Defaults to false if not specified.
TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc
The description of the tax
The AvaTax tax code or customer tax code associated with the item or SKU in the transaction
The code your business application uses to identify a customer or vendor
Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.
Liability Parameters to access Returns API
Defines the compression mode of the result file For compression, the accepted values are: NONE, GZIP
If true, include document line details in the generated report. If false, include only document line in the generated report. Defaults to false if not specified.
If true, include multi tax line details in the generated report. If false, include document or document line in the generated report based on includeDocumentLineDetails. Defaults to false if not specified.
If true, shows all transactions that are in the incorrect currency. If false, hides all transactions that are in the incorrect currency. Defaults to false if not specified.
If true, shows all additional transaction attributes. If false, hides all additional transaction attributes. Defaults to false if not specified.
If true, shows all user defined fields. If false, hides all user defined fields. Defaults to false if not specified.
Sets the ImportId for Accounts Payable reports. Defaults to an empty string if not specified.
If true, filter using the user-defined field at the document line level. If false, filter using the user-defined field at the document level. Defaults to true if not specified.
Sets a user-defined field filter as a name/value pair. Only one name/value pair is allowed. Returns null if both name and value are not set.
The names of the jurisdictions for which document lines are fetched. Defaults to null if not specified.
If true, include Point of Order Acceptance (POA) and Point of Order Origin (POO) in the generated report. If false, exclude POA and POO from the generated report. Defaults to false if not specified.
List of company IDs included in the report.