Package com.blockchyp.client.dto

Class MerchantInvoiceDetailResponse

java.lang.Object
com.blockchyp.client.dto.MerchantInvoiceDetailResponse
All Implemented Interfaces:
IAbstractAcknowledgement
public class MerchantInvoiceDetailResponse extends Object implements IAbstractAcknowledgement
Models detailed merchant invoice or statement information.

  • Constructor Details

    • MerchantInvoiceDetailResponse

      public MerchantInvoiceDetailResponse()

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

    • setMerchantId

      public void setMerchantId(String value)
      Sets the id of the merchant associated with the statement.
      Parameters:
      value - the id of the merchant associated with the statement.

    • getMerchantId

      public String getMerchantId()
      Gets the id of the merchant associated with the statement.
      Returns:
      the id of the merchant associated with the statement.

    • setCorporateName

      public void setCorporateName(String value)
      Sets the corporate name of the merchant associated with the statement.
      Parameters:
      value - the corporate name of the merchant associated with the statement.

    • getCorporateName

      public String getCorporateName()
      Gets the corporate name of the merchant associated with the statement.
      Returns:
      the corporate name of the merchant associated with the statement.

    • setDbaName

      public void setDbaName(String value)
      Sets the dba name of the merchant associated with the statement.
      Parameters:
      value - the dba name of the merchant associated with the statement.

    • getDbaName

      public String getDbaName()
      Gets the dba name of the merchant associated with the statement.
      Returns:
      the dba name of the merchant associated with the statement.

    • setDateCreated

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

    • getDateCreated

      public Date getDateCreated()
      Gets the date the statement was generated.
      Returns:
      the date the statement was generated.

    • setStatus

      public void setStatus(String value)
      Sets the current status of the invoice.
      Parameters:
      value - the current status of the invoice.

    • getStatus

      public String getStatus()
      Gets the current status of the invoice.
      Returns:
      the current status of the invoice.

    • setInvoiceType

      public void setInvoiceType(String value)
      Sets the type of invoice (statement or invoice).
      Parameters:
      value - the type of invoice (statement or invoice).

    • getInvoiceType

      public String getInvoiceType()
      Gets the type of invoice (statement or invoice).
      Returns:
      the type of invoice (statement or invoice).

    • setPricingType

      public void setPricingType(String value)
      Sets the type of pricing used for the invoice (typically flat rate or or interchange plus).
      Parameters:
      value - the type of pricing used for the invoice (typically flat rate or or interchange plus).

    • getPricingType

      public String getPricingType()
      Gets the type of pricing used for the invoice (typically flat rate or or interchange plus).
      Returns:
      the type of pricing used for the invoice (typically flat rate or or interchange plus).

    • setPaid

      public void setPaid(boolean value)
      Sets whether or not the invoice has been paid.
      Parameters:
      value - whether or not the invoice has been paid.

    • isPaid

      public boolean isPaid()
      Gets whether or not the invoice has been paid.
      Returns:
      whether or not the invoice has been paid.

    • setGrandTotal

      public void setGrandTotal(float value)
      Sets the grand total.
      Parameters:
      value - the grand total.

    • getGrandTotal

      public float getGrandTotal()
      Gets the grand total.
      Returns:
      the grand total.

    • setGrandTotalFormatted

      public void setGrandTotalFormatted(String value)
      Sets the string formatted grand total.
      Parameters:
      value - the string formatted grand total.

    • getGrandTotalFormatted

      public String getGrandTotalFormatted()
      Gets the string formatted grand total.
      Returns:
      the string formatted grand total.

    • setSubtotal

      public void setSubtotal(float value)
      Sets the subtotal before shipping and tax.
      Parameters:
      value - the subtotal before shipping and tax.

    • getSubtotal

      public float getSubtotal()
      Gets the subtotal before shipping and tax.
      Returns:
      the subtotal before shipping and tax.

    • setSubotalFormatted

      public void setSubotalFormatted(String value)
      Sets the string formatted subtotal before shipping and tax.
      Parameters:
      value - the string formatted subtotal before shipping and tax.

    • getSubotalFormatted

      public String getSubotalFormatted()
      Gets the string formatted subtotal before shipping and tax.
      Returns:
      the string formatted subtotal before shipping and tax.

    • setTaxTotal

      public void setTaxTotal(float value)
      Sets the total sales tax.
      Parameters:
      value - the total sales tax.

    • getTaxTotal

      public float getTaxTotal()
      Gets the total sales tax.
      Returns:
      the total sales tax.

    • setTaxTotalFormatted

      public void setTaxTotalFormatted(String value)
      Sets the string formatted total sales tax.
      Parameters:
      value - the string formatted total sales tax.

    • getTaxTotalFormatted

      public String getTaxTotalFormatted()
      Gets the string formatted total sales tax.
      Returns:
      the string formatted total sales tax.

    • setShippingCost

      public void setShippingCost(float value)
      Sets the total cost of shipping.
      Parameters:
      value - the total cost of shipping.

    • getShippingCost

      public float getShippingCost()
      Gets the total cost of shipping.
      Returns:
      the total cost of shipping.

    • setShippingCostFormatted

      public void setShippingCostFormatted(String value)
      Sets the string formatted total cost of shipping.
      Parameters:
      value - the string formatted total cost of shipping.

    • getShippingCostFormatted

      public String getShippingCostFormatted()
      Gets the string formatted total cost of shipping.
      Returns:
      the string formatted total cost of shipping.

    • setBalanceDue

      public void setBalanceDue(float value)
      Sets the total unpaid balance on the invoice.
      Parameters:
      value - the total unpaid balance on the invoice.

    • getBalanceDue

      public float getBalanceDue()
      Gets the total unpaid balance on the invoice.
      Returns:
      the total unpaid balance on the invoice.

    • setBalanceDueFormatted

      public void setBalanceDueFormatted(String value)
      Sets the string formatted unpaid balance on the invoice.
      Parameters:
      value - the string formatted unpaid balance on the invoice.

    • getBalanceDueFormatted

      public String getBalanceDueFormatted()
      Gets the string formatted unpaid balance on the invoice.
      Returns:
      the string formatted unpaid balance on the invoice.

    • setShippingAddress

      public void setShippingAddress(Address value)
      Sets the shipping or physical address associated with the invoice.
      Parameters:
      value - the shipping or physical address associated with the invoice.

    • getShippingAddress

      public Address getShippingAddress()
      Gets the shipping or physical address associated with the invoice.
      Returns:
      the shipping or physical address associated with the invoice.

    • setBillingAddress

      public void setBillingAddress(Address value)
      Sets the billing or mailing address associated with the invoice.
      Parameters:
      value - the billing or mailing address associated with the invoice.

    • getBillingAddress

      public Address getBillingAddress()
      Gets the billing or mailing address associated with the invoice.
      Returns:
      the billing or mailing address associated with the invoice.

    • setLineItems

      public void setLineItems(Collection<InvoiceLineItem> value)
      Sets the list of line item details associated with the invoice.
      Parameters:
      value - the list of line item details associated with the invoice.

    • getLineItems

      public Collection<InvoiceLineItem> getLineItems()
      Gets the list of line item details associated with the invoice.
      Returns:
      the list of line item details associated with the invoice.

    • setPayments

      public void setPayments(Collection<InvoicePayment> value)
      Sets the list of payments collected against the invoice.
      Parameters:
      value - the list of payments collected against the invoice.

    • getPayments

      public Collection<InvoicePayment> getPayments()
      Gets the list of payments collected against the invoice.
      Returns:
      the list of payments collected against the invoice.

    • setDeposits

      public void setDeposits(Collection<StatementDeposit> value)
      Sets the list of merchant settlements disbursed during the statement period.
      Parameters:
      value - the list of merchant settlements disbursed during the statement period.

    • getDeposits

      public Collection<StatementDeposit> getDeposits()
      Gets the list of merchant settlements disbursed during the statement period.
      Returns:
      the list of merchant settlements disbursed during the statement period.

    • addLineItem

      public void addLineItem(InvoiceLineItem value)
      Adds a the list of line item details associated with the invoice.
      Parameters:
      value - the list of line item details associated with the invoice.

    • addPayment

      public void addPayment(InvoicePayment value)
      Adds a the list of payments collected against the invoice.
      Parameters:
      value - the list of payments collected against the invoice.

    • addDeposit

      public void addDeposit(StatementDeposit value)
      Adds a the list of merchant settlements disbursed during the statement period.
      Parameters:
      value - the list of merchant settlements disbursed during the statement period.