AvaTax for VAT
ExportDocumentLineModel
An input model for executing a report detailed to the document line level
This model is used in the following APIs:
The file format.
The start date filter for report execution. If no date provided, same date of last month will be used as the startDate. Accepts date in short format yyyy-mm-dd as well as date time stamp
The end date filter for report execution. If no date provided, today's date will be used as the endDate. Accepts date in short format yyyy-mm-dd as well as date time stamp
The transactions in the country you wish to run a report. Use "ALL" for all countries Use "ALL Non-US" for all international countries Or use a single 2-char ISO country code
The state associated with the transactions you wish to run a report. Use "ALL" for all states or 2-char state code.
The type of date to filter your transactions
The transaction type you want to run a report on
The currency your report is displayed in. Accepts "USD" or leave this blank to get all the documents with all the currencies
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 (2 - 250) to split the report into. If a value is provided for this property, a value must also be provided for the partition property.
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 a value is provided for this property, a value must also be provided for the numberOfPartitions property.
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 these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.
DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled
Use this parameter when dateFilter = ModifiedDate. For dateFilter = DocumentDate, PaymentDate, TaxDate or ReportingDate, the isModifiedDateSameAsDocumentDate parameter is ignored. Set this parameter to true when you would like to get Documents which have the Document Date same as Modified 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.
Defines report source.
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 to include in the report. If not specified, only the current company is included.