Class ExportDocumentLineModel
- java.lang.Object
-
- net.avalara.avatax.rest.client.models.ExportDocumentLineModel
-
public class ExportDocumentLineModel extends java.lang.Object
An input model for executing a report detailed to the document line level
-
-
Constructor Summary
Constructors Constructor Description ExportDocumentLineModel()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Compression
getCompression()
Getter for compression Defines the compression mode of the result file For compression, the accepted values are: NONE, GZIPjava.lang.String
getCountry()
Getter for country The transactions in the country you wish to run a report.java.lang.String
getCurrencyCode()
Getter for currencyCode The currency your report is displayed in.java.lang.String
getCustomerVendorCode()
Getter for customerVendorCode The code your business application uses to identify a customer or vendorReportDateFilter
getDateFilter()
Getter for dateFilter The type of date to filter your transactionsReportDocType
getDocType()
Getter for docType The transaction type you want to run a report onDocumentStatus
getDocumentStatus()
Getter for documentStatus DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelledjava.util.Date
getEndDate()
Getter for endDate The end date filter for report execution.ReportFormat
getFormat()
Getter for format The file format.java.lang.Boolean
getIncludeDocumentLineDetails()
Getter for includeDocumentLineDetails If true, include document line details in the generated report.java.lang.Boolean
getIsLocked()
Getter for isLocked If true, include only documents that are locked.java.lang.Boolean
getIsModifiedDateSameAsDocumentDate()
Getter for isModifiedDateSameAsDocumentDate Use this parameter when dateFilter = ModifiedDate.java.lang.String
getMerchantSellerIdentifier()
Getter for merchantSellerIdentifier If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.java.lang.Integer
getNumberOfPartitions()
Getter for numberOfPartitions Number of partitions (2 - 250) to split the report into.java.lang.Integer
getPartition()
Getter for partition The zero-based partition number to retrieve in this export request.ReportSource
getReportSource()
Getter for reportSource Defines report source.java.util.Date
getStartDate()
Getter for startDate The start date filter for report execution.java.lang.String
getState()
Getter for state The state associated with the transactions you wish to run a report.java.lang.String
getTaxCode()
Getter for taxCode The AvaTax tax code or customer tax code associated with the item or SKU in the transactionjava.lang.String
getTaxGroup()
Getter for taxGroup TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output).java.lang.String
getTaxName()
Getter for taxName The description of the taxjava.lang.String
getTaxSubType()
Getter for taxSubType Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.void
setCompression(Compression value)
Setter for compression Defines the compression mode of the result file For compression, the accepted values are: NONE, GZIPvoid
setCountry(java.lang.String value)
Setter for country The transactions in the country you wish to run a report.void
setCurrencyCode(java.lang.String value)
Setter for currencyCode The currency your report is displayed in.void
setCustomerVendorCode(java.lang.String value)
Setter for customerVendorCode The code your business application uses to identify a customer or vendorvoid
setDateFilter(ReportDateFilter value)
Setter for dateFilter The type of date to filter your transactionsvoid
setDocType(ReportDocType value)
Setter for docType The transaction type you want to run a report onvoid
setDocumentStatus(DocumentStatus value)
Setter for documentStatus DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelledvoid
setEndDate(java.util.Date value)
Setter for endDate The end date filter for report execution.void
setFormat(ReportFormat value)
Setter for format The file format.void
setIncludeDocumentLineDetails(java.lang.Boolean value)
Setter for includeDocumentLineDetails If true, include document line details in the generated report.void
setIsLocked(java.lang.Boolean value)
Setter for isLocked If true, include only documents that are locked.void
setIsModifiedDateSameAsDocumentDate(java.lang.Boolean value)
Setter for isModifiedDateSameAsDocumentDate Use this parameter when dateFilter = ModifiedDate.void
setMerchantSellerIdentifier(java.lang.String value)
Setter for merchantSellerIdentifier If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.void
setNumberOfPartitions(java.lang.Integer value)
Setter for numberOfPartitions Number of partitions (2 - 250) to split the report into.void
setPartition(java.lang.Integer value)
Setter for partition The zero-based partition number to retrieve in this export request.void
setReportSource(ReportSource value)
Setter for reportSource Defines report source.void
setStartDate(java.util.Date value)
Setter for startDate The start date filter for report execution.void
setState(java.lang.String value)
Setter for state The state associated with the transactions you wish to run a report.void
setTaxCode(java.lang.String value)
Setter for taxCode The AvaTax tax code or customer tax code associated with the item or SKU in the transactionvoid
setTaxGroup(java.lang.String value)
Setter for taxGroup TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output).void
setTaxName(java.lang.String value)
Setter for taxName The description of the taxvoid
setTaxSubType(java.lang.String value)
Setter for taxSubType Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.java.lang.String
toString()
Returns a JSON string representation of ExportDocumentLineModel
-
-
-
Method Detail
-
getFormat
public ReportFormat getFormat()
Getter for format The file format.
-
setFormat
public void setFormat(ReportFormat value)
Setter for format The file format.
-
getStartDate
public java.util.Date getStartDate()
Getter for startDate 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
-
setStartDate
public void setStartDate(java.util.Date value)
Setter for startDate 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
-
getEndDate
public java.util.Date getEndDate()
Getter for endDate 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
-
setEndDate
public void setEndDate(java.util.Date value)
Setter for endDate 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
-
getCountry
public java.lang.String getCountry()
Getter for country 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
-
setCountry
public void setCountry(java.lang.String value)
Setter for country 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
-
getState
public java.lang.String getState()
Getter for state The state associated with the transactions you wish to run a report. Use "ALL" for all states or 2-char state code.
-
setState
public void setState(java.lang.String value)
Setter for state The state associated with the transactions you wish to run a report. Use "ALL" for all states or 2-char state code.
-
getDateFilter
public ReportDateFilter getDateFilter()
Getter for dateFilter The type of date to filter your transactions
-
setDateFilter
public void setDateFilter(ReportDateFilter value)
Setter for dateFilter The type of date to filter your transactions
-
getDocType
public ReportDocType getDocType()
Getter for docType The transaction type you want to run a report on
-
setDocType
public void setDocType(ReportDocType value)
Setter for docType The transaction type you want to run a report on
-
getCurrencyCode
public java.lang.String getCurrencyCode()
Getter for currencyCode The currency your report is displayed in. Accepts "USD" or leave this blank to get all the documents with all the currencies
-
setCurrencyCode
public void setCurrencyCode(java.lang.String value)
Setter for currencyCode The currency your report is displayed in. Accepts "USD" or leave this blank to get all the documents with all the currencies
-
getNumberOfPartitions
public java.lang.Integer getNumberOfPartitions()
Getter for numberOfPartitions 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.
-
setNumberOfPartitions
public void setNumberOfPartitions(java.lang.Integer value)
Setter for numberOfPartitions 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.
-
getPartition
public java.lang.Integer getPartition()
Getter for partition 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.
-
setPartition
public void setPartition(java.lang.Integer value)
Setter for partition 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.
-
getIsLocked
public java.lang.Boolean getIsLocked()
Getter for isLocked If true, include only documents that are locked. If false, include only documents that are not locked. Defaults to false if not specified.
-
setIsLocked
public void setIsLocked(java.lang.Boolean value)
Setter for isLocked If true, include only documents that are locked. If false, include only documents that are not locked. Defaults to false if not specified.
-
getMerchantSellerIdentifier
public java.lang.String getMerchantSellerIdentifier()
Getter for merchantSellerIdentifier If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.
-
setMerchantSellerIdentifier
public void setMerchantSellerIdentifier(java.lang.String value)
Setter for merchantSellerIdentifier If set, include only documents associated with these merchantSellerIds.Multiple merchantSellerIds should be sent by comma separated values.
-
getDocumentStatus
public DocumentStatus getDocumentStatus()
Getter for documentStatus DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled
-
setDocumentStatus
public void setDocumentStatus(DocumentStatus value)
Setter for documentStatus DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled
-
getIsModifiedDateSameAsDocumentDate
public java.lang.Boolean getIsModifiedDateSameAsDocumentDate()
Getter for isModifiedDateSameAsDocumentDate 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.
-
setIsModifiedDateSameAsDocumentDate
public void setIsModifiedDateSameAsDocumentDate(java.lang.Boolean value)
Setter for isModifiedDateSameAsDocumentDate 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.
-
getTaxGroup
public java.lang.String getTaxGroup()
Getter for taxGroup TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc
-
setTaxGroup
public void setTaxGroup(java.lang.String value)
Setter for taxGroup TaxGroup is required to support Sales tax (Sales + SellersUse) and VAT (Input+ Output). TaxTypes, such as Lodging, Bottle, LandedCost, Ewaste, BevAlc, etc
-
getTaxName
public java.lang.String getTaxName()
Getter for taxName The description of the tax
-
setTaxName
public void setTaxName(java.lang.String value)
Setter for taxName The description of the tax
-
getTaxCode
public java.lang.String getTaxCode()
Getter for taxCode The AvaTax tax code or customer tax code associated with the item or SKU in the transaction
-
setTaxCode
public void setTaxCode(java.lang.String value)
Setter for taxCode The AvaTax tax code or customer tax code associated with the item or SKU in the transaction
-
getCustomerVendorCode
public java.lang.String getCustomerVendorCode()
Getter for customerVendorCode The code your business application uses to identify a customer or vendor
-
setCustomerVendorCode
public void setCustomerVendorCode(java.lang.String value)
Setter for customerVendorCode The code your business application uses to identify a customer or vendor
-
getTaxSubType
public java.lang.String getTaxSubType()
Getter for taxSubType Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.
-
setTaxSubType
public void setTaxSubType(java.lang.String value)
Setter for taxSubType Defines the individual taxes associated with a TaxType category, such as Lodging TaxType which supports numerous TaxSubTypes, including Hotel, Occupancy, ConventionCenter, Accommotations, etc.
-
getReportSource
public ReportSource getReportSource()
Getter for reportSource Defines report source.
-
setReportSource
public void setReportSource(ReportSource value)
Setter for reportSource Defines report source.
-
getCompression
public Compression getCompression()
Getter for compression Defines the compression mode of the result file For compression, the accepted values are: NONE, GZIP
-
setCompression
public void setCompression(Compression value)
Setter for compression Defines the compression mode of the result file For compression, the accepted values are: NONE, GZIP
-
getIncludeDocumentLineDetails
public java.lang.Boolean getIncludeDocumentLineDetails()
Getter for includeDocumentLineDetails 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.
-
setIncludeDocumentLineDetails
public void setIncludeDocumentLineDetails(java.lang.Boolean value)
Setter for includeDocumentLineDetails 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.
-
toString
public java.lang.String toString()
Returns a JSON string representation of ExportDocumentLineModel- Overrides:
toString
in classjava.lang.Object
-
-