Package net.avalara.avatax.rest.client.models

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

    Modifier and Type Method Description
    java.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 vendor
    ReportDateFilter getDateFilter()
    Getter for dateFilter The type of date to filter your transactions
    ReportDocType getDocType()
    Getter for docType The transaction type you want to run a report on
    DocumentStatus getDocumentStatus()
    Getter for documentStatus DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled
    java.util.Date getEndDate()
    Getter for endDate The end date filter for report execution.
    ReportFormat getFormat()
    Getter for format The file format.
    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.
    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 transaction
    java.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 tax
    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.
    void 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 vendor
    void setDateFilter​(ReportDateFilter value)
    Setter for dateFilter The type of date to filter your transactions
    void setDocType​(ReportDocType value)
    Setter for docType The transaction type you want to run a report on
    void setDocumentStatus​(DocumentStatus value)
    Setter for documentStatus DocumentStatus For documentStatus, accepted values are: Saved, Posted, Committed, Cancelled
    void 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 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 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 transaction
    void 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 tax
    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.
    java.lang.String toString()
    Returns a JSON string representation of ExportDocumentLineModel

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Constructor Details

  • Method Details

    • 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.

    • toString

      public java.lang.String toString()
      Returns a JSON string representation of ExportDocumentLineModel
      Overrides:
      toString in class java.lang.Object