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

Class ReportParametersModel

java.lang.Object
net.avalara.avatax.rest.client.models.ReportParametersModel
public class ReportParametersModel
extends java.lang.Object
The output model for report parameter definitions

  • Constructor Summary

    Constructors 
    Constructor Description
    ReportParametersModel()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getCountry()
    Getter for country The country filter used for your report
    java.lang.String getCurrencyCode()
    Getter for currencyCode The currency code used for your report
    java.lang.String getCustomerVendorCode()
    Getter for customerVendorCode The code your business application uses to identify a customer or vendor
    java.lang.String getDateFilter()
    Getter for dateFilter The date type filter used for your report
    java.lang.String getDateFormat()
    Getter for dateFormat The date format used for your report
    java.lang.String getDocType()
    Getter for docType The doc type filter used for your report
    java.lang.String getDocumentStatus()
    Getter for documentStatus The Document status filter used for report For documentStatus, accepted values are: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval
    java.util.Date getEndDate()
    Getter for endDate The end date filter used for your report
    java.lang.Boolean getIsLocked()
    Getter for isLocked If true, include only documents that are locked.
    java.lang.Boolean getIsModifiedDateSameAsDocumentDate()
    Getter for isModifiedDateSameAsDocumentDate 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.
    java.lang.String getMerchantSellerId()
    Getter for merchantSellerId If set, include only documents associated with this merchantSellerId.
    java.lang.Integer getNumberOfPartitions()
    Getter for numberOfPartitions Number of partitions 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 used for your report
    java.lang.String getState()
    Getter for state The state filter used for your 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 country filter used for your report
    void setCurrencyCode​(java.lang.String value)
    Setter for currencyCode The currency code used for your report
    void setCustomerVendorCode​(java.lang.String value)
    Setter for customerVendorCode The code your business application uses to identify a customer or vendor
    void setDateFilter​(java.lang.String value)
    Setter for dateFilter The date type filter used for your report
    void setDateFormat​(java.lang.String value)
    Setter for dateFormat The date format used for your report
    void setDocType​(java.lang.String value)
    Setter for docType The doc type filter used for your report
    void setDocumentStatus​(java.lang.String value)
    Setter for documentStatus The Document status filter used for report For documentStatus, accepted values are: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval
    void setEndDate​(java.util.Date value)
    Setter for endDate The end date filter used for your 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 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.
    void setMerchantSellerId​(java.lang.String value)
    Setter for merchantSellerId If set, include only documents associated with this merchantSellerId.
    void setNumberOfPartitions​(java.lang.Integer value)
    Setter for numberOfPartitions Number of partitions 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 used for your report
    void setState​(java.lang.String value)
    Setter for state The state filter used for your 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 ReportParametersModel

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getStartDate

      public java.util.Date getStartDate()
      Getter for startDate The start date filter used for your report

    • setStartDate

      public void setStartDate​(java.util.Date value)
      Setter for startDate The start date filter used for your report

    • getEndDate

      public java.util.Date getEndDate()
      Getter for endDate The end date filter used for your report

    • setEndDate

      public void setEndDate​(java.util.Date value)
      Setter for endDate The end date filter used for your report

    • getCountry

      public java.lang.String getCountry()
      Getter for country The country filter used for your report

    • setCountry

      public void setCountry​(java.lang.String value)
      Setter for country The country filter used for your report

    • getState

      public java.lang.String getState()
      Getter for state The state filter used for your report

    • setState

      public void setState​(java.lang.String value)
      Setter for state The state filter used for your report

    • getDateFilter

      public java.lang.String getDateFilter()
      Getter for dateFilter The date type filter used for your report

    • setDateFilter

      public void setDateFilter​(java.lang.String value)
      Setter for dateFilter The date type filter used for your report

    • getDocType

      public java.lang.String getDocType()
      Getter for docType The doc type filter used for your report

    • setDocType

      public void setDocType​(java.lang.String value)
      Setter for docType The doc type filter used for your report

    • getDateFormat

      public java.lang.String getDateFormat()
      Getter for dateFormat The date format used for your report

    • setDateFormat

      public void setDateFormat​(java.lang.String value)
      Setter for dateFormat The date format used for your report

    • getCurrencyCode

      public java.lang.String getCurrencyCode()
      Getter for currencyCode The currency code used for your report

    • setCurrencyCode

      public void setCurrencyCode​(java.lang.String value)
      Setter for currencyCode The currency code used for your report

    • getNumberOfPartitions

      public java.lang.Integer getNumberOfPartitions()
      Getter for numberOfPartitions Number of partitions to split the report into.

    • setNumberOfPartitions

      public void setNumberOfPartitions​(java.lang.Integer value)
      Setter for numberOfPartitions Number of partitions to split the report into.

    • getPartition

      public java.lang.Integer getPartition()
      Getter for partition The zero-based partition number to retrieve in this export request.

    • setPartition

      public void setPartition​(java.lang.Integer value)
      Setter for partition The zero-based partition number to retrieve in this export request.

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

    • getMerchantSellerId

      public java.lang.String getMerchantSellerId()
      Getter for merchantSellerId If set, include only documents associated with this merchantSellerId.

    • setMerchantSellerId

      public void setMerchantSellerId​(java.lang.String value)
      Setter for merchantSellerId If set, include only documents associated with this merchantSellerId.

    • getDocumentStatus

      public java.lang.String getDocumentStatus()
      Getter for documentStatus The Document status filter used for report For documentStatus, accepted values are: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval

    • setDocumentStatus

      public void setDocumentStatus​(java.lang.String value)
      Setter for documentStatus The Document status filter used for report For documentStatus, accepted values are: Temporary, Saved, Posted, Committed, Cancelled, Adjusted, Queued, PendingApproval

    • getIsModifiedDateSameAsDocumentDate

      public java.lang.Boolean getIsModifiedDateSameAsDocumentDate()
      Getter for isModifiedDateSameAsDocumentDate 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.

    • setIsModifiedDateSameAsDocumentDate

      public void setIsModifiedDateSameAsDocumentDate​(java.lang.Boolean value)
      Setter for isModifiedDateSameAsDocumentDate 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.

    • 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 ReportParametersModel
      Overrides:
      toString in class java.lang.Object