AvaTax for VAT

Version v2
APConfigSetting
Accounts
Addresses
AvaFileForms
Batches
CertExpressInvites
Certificates
Clerk
CommunicationCertificates
Companies
Compliance
Contacts
CostCenter
Customers
DataSources
Definitions
DistanceThresholds
DomainControlVerification
ECommerceToken
EcmEventNotifications
EcoNexusThreshold
FirmClientLinkages
FormTypeMapping
FundingRequests
GLAccount
Items
ItemsReverseSync
Jobs
JurisdictionOverrides
Locations
MultiDocument
Nexus
Notices
Notifications
Provisioning
Registrar
Reports
Settings
Subscriptions
TaxCodes
TaxContent
TaxRules
Transactions
Upcs
UserDefinedFields
Users
Utilities
VendorCertificates
Vendors

ExportDocumentLineModel

An input model for executing a report detailed to the document line level

This model is used in the following APIs:

Parameters
formatOptional
string

The file format.

Enum: CSV, JSON
startDateOptional
string

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

endDateOptional
string

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

countryOptional
string

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

stateOptional
string

The state associated with the transactions you wish to run a report. Use "ALL" for all states or 2-char state code.

dateFilterOptional
string

The type of date to filter your transactions

Enum: DocumentDate, ModifiedDate, PaymentDate, ReportingDate, TaxDate
docTypeOptional
string

The transaction type you want to run a report on

Enum: All, ConsumerUse, Sales
currencyCodeOptional
string

The currency your report is displayed in. Accepts "USD" or leave this blank to get all the documents with all the currencies

numberOfPartitionsOptional
integer

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.

partitionOptional
integer

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.

isLockedOptional
boolean

If true, include only documents that are locked. If false, include only documents that are not locked. Defaults to false if not specified.

merchantSellerIdentifierOptional
string

If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.

documentStatusOptional
string

DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled

Enum: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval, Uncommitted, Any
isModifiedDateSameAsDocumentDateOptional
boolean

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.

taxGroupOptional
string

TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc

taxNameOptional
string

The description of the tax

taxCodeOptional
string

The AvaTax tax code or customer tax code associated with the item or SKU in the transaction

customerVendorCodeOptional
string

The code your business application uses to identify a customer or vendor

taxSubTypeOptional
string

Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.

reportSourceOptional
string

Defines report source.

Enum: SNOWFLAKE, MONGODB, RETURNSAPI, TAXREGION, APDOCUMENT, APDOCUMENTLINEDETAIL, DOCUMENTLINEDETAILALLTAXES, DOCUMENTSUMMARY, DOCUMENT
liabilityParametersOptional
LiabilityParametersModel

Liability Parameters to access Returns API

compressionOptional
string

Defines the compression mode of the result file For compression, the accepted values are: NONE, GZIP

Enum: NONE, GZIP
includeDocumentLineDetailsOptional
boolean

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.

includeMultiTaxLineDetailsOptional
boolean

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.

incorrectCurrencyOnlyOptional
boolean

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.

includeAdditionalAttributesOptional
boolean

If true, shows all additional transaction attributes. If false, hides all additional transaction attributes. Defaults to false if not specified.

includeUserDefinedFieldsOptional
boolean

If true, shows all user defined fields. If false, hides all user defined fields. Defaults to false if not specified.

importIdOptional
string

Sets the ImportId for Accounts Payable reports. Defaults to an empty string if not specified.

filterAtLineLevelOptional
boolean

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.

udfFilterOptional
object

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.

jurisdictionNamesOptional
array

The names of the jurisdictions for which document lines are fetched. Defaults to null if not specified.

includePOAandPOOOptional
boolean

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.

companyIdsOptional
array

List of company IDs to include in the report. If not specified, only the current company is included.