Class PartnerStatementDetailResponse

java.lang.Object
com.blockchyp.client.dto.PartnerStatementDetailResponse
All Implemented Interfaces:
IAbstractAcknowledgement

public class PartnerStatementDetailResponse extends Object implements IAbstractAcknowledgement
Models a response to retrieve detailed partner statement information.
  • Constructor Details

    • PartnerStatementDetailResponse

      public PartnerStatementDetailResponse()
  • Method Details

    • setSuccess

      public void setSuccess(boolean value)
      Sets whether or not the request succeeded.
      Parameters:
      value - whether or not the request succeeded.
    • isSuccess

      public boolean isSuccess()
      Gets whether or not the request succeeded.
      Specified by:
      isSuccess in interface IAbstractAcknowledgement
      Returns:
      whether or not the request succeeded.
    • setError

      public void setError(String value)
      Sets the error, if an error occurred.
      Parameters:
      value - the error, if an error occurred.
    • getError

      public String getError()
      Gets the error, if an error occurred.
      Specified by:
      getError in interface IAbstractAcknowledgement
      Returns:
      the error, if an error occurred.
    • setResponseDescription

      public void setResponseDescription(String value)
      Sets a narrative description of the transaction result.
      Parameters:
      value - a narrative description of the transaction result.
    • getResponseDescription

      public String getResponseDescription()
      Gets a narrative description of the transaction result.
      Specified by:
      getResponseDescription in interface IAbstractAcknowledgement
      Returns:
      a narrative description of the transaction result.
    • setId

      public void setId(String value)
      Sets optional start date filter for batch history.
      Parameters:
      value - optional start date filter for batch history.
    • getId

      public String getId()
      Gets optional start date filter for batch history.
      Returns:
      optional start date filter for batch history.
    • setPartnerId

      public void setPartnerId(String value)
      Sets the id of the partner associated with the statement.
      Parameters:
      value - the id of the partner associated with the statement.
    • getPartnerId

      public String getPartnerId()
      Gets the id of the partner associated with the statement.
      Returns:
      the id of the partner associated with the statement.
    • setPartnerName

      public void setPartnerName(String value)
      Sets the name of the partner associated with the statement.
      Parameters:
      value - the name of the partner associated with the statement.
    • getPartnerName

      public String getPartnerName()
      Gets the name of the partner associated with the statement.
      Returns:
      the name of the partner associated with the statement.
    • setStatementDate

      public void setStatementDate(Date value)
      Sets the date the statement was generated.
      Parameters:
      value - the date the statement was generated.
    • getStatementDate

      public Date getStatementDate()
      Gets the date the statement was generated.
      Returns:
      the date the statement was generated.
    • setTotalVolume

      public void setTotalVolume(float value)
      Sets total volume in numeric format.
      Parameters:
      value - total volume in numeric format.
    • getTotalVolume

      public float getTotalVolume()
      Gets total volume in numeric format.
      Returns:
      total volume in numeric format.
    • setTotalVolumeFormatted

      public void setTotalVolumeFormatted(String value)
      Sets the string formatted total volume on the statement.
      Parameters:
      value - the string formatted total volume on the statement.
    • getTotalVolumeFormatted

      public String getTotalVolumeFormatted()
      Gets the string formatted total volume on the statement.
      Returns:
      the string formatted total volume on the statement.
    • setTransactionCount

      public void setTransactionCount(int value)
      Sets the total volume on the statement.
      Parameters:
      value - the total volume on the statement.
    • getTransactionCount

      public int getTransactionCount()
      Gets the total volume on the statement.
      Returns:
      the total volume on the statement.
    • setPartnerCommission

      public void setPartnerCommission(float value)
      Sets the commission earned on the portfolio during the statement period.
      Parameters:
      value - the commission earned on the portfolio during the statement period.
    • getPartnerCommission

      public float getPartnerCommission()
      Gets the commission earned on the portfolio during the statement period.
      Returns:
      the commission earned on the portfolio during the statement period.
    • setPartnerCommissionFormatted

      public void setPartnerCommissionFormatted(String value)
      Sets the string formatted partner commission on the statement.
      Parameters:
      value - the string formatted partner commission on the statement.
    • getPartnerCommissionFormatted

      public String getPartnerCommissionFormatted()
      Gets the string formatted partner commission on the statement.
      Returns:
      the string formatted partner commission on the statement.
    • setPartnerCommissionsOnVolume

      public void setPartnerCommissionsOnVolume(float value)
      Sets the partner commission earned on the portfolio during the statement period as a ratio against volume.
      Parameters:
      value - the partner commission earned on the portfolio during the statement period as a ratio against volume.
    • getPartnerCommissionsOnVolume

      public float getPartnerCommissionsOnVolume()
      Gets the partner commission earned on the portfolio during the statement period as a ratio against volume.
      Returns:
      the partner commission earned on the portfolio during the statement period as a ratio against volume.
    • setPartnerCommissionsOnVolumeFormatted

      public void setPartnerCommissionsOnVolumeFormatted(String value)
      Sets the string formatted version of partner commissions as a percentage of volume.
      Parameters:
      value - the string formatted version of partner commissions as a percentage of volume.
    • getPartnerCommissionsOnVolumeFormatted

      public String getPartnerCommissionsOnVolumeFormatted()
      Gets the string formatted version of partner commissions as a percentage of volume.
      Returns:
      the string formatted version of partner commissions as a percentage of volume.
    • setStatus

      public void setStatus(String value)
      Sets the status of the statement.
      Parameters:
      value - the status of the statement.
    • getStatus

      public String getStatus()
      Gets the status of the statement.
      Returns:
      the status of the statement.
    • setLineItems

      public void setLineItems(Collection<PartnerStatementLineItem> value)
      Sets the line item detail associated with the statement.
      Parameters:
      value - the line item detail associated with the statement.
    • getLineItems

      public Collection<PartnerStatementLineItem> getLineItems()
      Gets the line item detail associated with the statement.
      Returns:
      the line item detail associated with the statement.
    • setAdjustments

      public void setAdjustments(Collection<PartnerStatementAdjustment> value)
      Sets the list of adjustments made against the statement, if any.
      Parameters:
      value - the list of adjustments made against the statement, if any.
    • getAdjustments

      public Collection<PartnerStatementAdjustment> getAdjustments()
      Gets the list of adjustments made against the statement, if any.
      Returns:
      the list of adjustments made against the statement, if any.
    • setDisbursements

      public void setDisbursements(Collection<PartnerStatementDisbursement> value)
      Sets the list of partner disbursements made against the partner statement.
      Parameters:
      value - the list of partner disbursements made against the partner statement.
    • getDisbursements

      public Collection<PartnerStatementDisbursement> getDisbursements()
      Gets the list of partner disbursements made against the partner statement.
      Returns:
      the list of partner disbursements made against the partner statement.
    • addLineItem

      public void addLineItem(PartnerStatementLineItem value)
      Adds a the line item detail associated with the statement.
      Parameters:
      value - the line item detail associated with the statement.
    • addAdjustment

      public void addAdjustment(PartnerStatementAdjustment value)
      Adds a the list of adjustments made against the statement, if any.
      Parameters:
      value - the list of adjustments made against the statement, if any.
    • addDisbursement

      public void addDisbursement(PartnerStatementDisbursement value)
      Adds a the list of partner disbursements made against the partner statement.
      Parameters:
      value - the list of partner disbursements made against the partner statement.