Class ExportDocumentLineModel


  • public class ExportDocumentLineModel
    extends java.lang.Object
    An input model for executing a report detailed to the document line level
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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
      java.lang.String getCulture()
      Getter for culture In which culture your report is produced with.
      java.lang.String getCurrencyCode()
      Getter for currencyCode The currency your report is displayed in.
      ReportDateFilter getDateFilter()
      Getter for dateFilter The type of date to filter your transactions
      java.lang.String getDateFormat()
      Getter for dateFormat Format of dates in your rendered report.
      ReportDocType getDocType()
      Getter for docType The transaction type you want to run a report on
      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.Integer getMerchantSellerId()
      Getter for merchantSellerId If set, include only documents associated with this merchantSellerId.
      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 on: use "ALL" for all states.
      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
      void setCulture​(java.lang.String value)
      Setter for culture In which culture your report is produced with.
      void setCurrencyCode​(java.lang.String value)
      Setter for currencyCode The currency your report is displayed in.
      void setDateFilter​(ReportDateFilter value)
      Setter for dateFilter The type of date to filter your transactions
      void setDateFormat​(java.lang.String value)
      Setter for dateFormat Format of dates in your rendered report.
      void setDocType​(ReportDocType value)
      Setter for docType The transaction type you want to run a report on
      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 setMerchantSellerId​(java.lang.Integer 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 (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 on: use "ALL" for all states.
      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 Detail

      • ExportDocumentLineModel

        public 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.
      • 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.
      • 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.
      • 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.
      • 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 on: use "ALL" for all states.
      • setState

        public void setState​(java.lang.String value)
        Setter for state The state associated with the transactions you wish to run a report on: use "ALL" for all states.
      • 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
      • getDateFormat

        public java.lang.String getDateFormat()
        Getter for dateFormat Format of dates in your rendered report. Example: "MM/dd/yyyy"
      • setDateFormat

        public void setDateFormat​(java.lang.String value)
        Setter for dateFormat Format of dates in your rendered report. Example: "MM/dd/yyyy"
      • getCulture

        public java.lang.String getCulture()
        Getter for culture In which culture your report is produced with. Example: "en-US"
      • setCulture

        public void setCulture​(java.lang.String value)
        Setter for culture In which culture your report is produced with. Example: "en-US"
      • getCurrencyCode

        public java.lang.String getCurrencyCode()
        Getter for currencyCode The currency your report is displayed in. Example: "USD"
      • setCurrencyCode

        public void setCurrencyCode​(java.lang.String value)
        Setter for currencyCode The currency your report is displayed in. Example: "USD"
      • 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.
      • getMerchantSellerId

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

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

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