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

Class RefundTransactionModel

  • public class RefundTransactionModel
extends java.lang.Object
    Refund a committed transaction

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getReferenceCode()
      Getter for referenceCode A user-defined reference field containing information about this refund.
      java.util.Date getRefundDate()
      Getter for refundDate The date of the refund.
      java.util.ArrayList<java.lang.String> getRefundLines()
      Getter for refundLines If you chose a refund of type `Partial`, this indicates which lines from the original transaction are being refunded.
      java.math.BigDecimal getRefundPercentage()
      Getter for refundPercentage The percentage for refund.
      java.lang.String getRefundTransactionCode()
      Getter for refundTransactionCode The transaction code for the refund.
      RefundType getRefundType()
      Getter for refundType Type of this refund.
      void setReferenceCode​(java.lang.String value)
      Setter for referenceCode A user-defined reference field containing information about this refund.
      void setRefundDate​(java.util.Date value)
      Setter for refundDate The date of the refund.
      void setRefundLines​(java.util.ArrayList<java.lang.String> value)
      Setter for refundLines If you chose a refund of type `Partial`, this indicates which lines from the original transaction are being refunded.
      void setRefundPercentage​(java.math.BigDecimal value)
      Setter for refundPercentage The percentage for refund.
      void setRefundTransactionCode​(java.lang.String value)
      Setter for refundTransactionCode The transaction code for the refund.
      void setRefundType​(RefundType value)
      Setter for refundType Type of this refund.
      java.lang.String toString()
      Returns a JSON string representation of RefundTransactionModel

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • RefundTransactionModel

        public RefundTransactionModel()

    • Method Detail

      • getRefundTransactionCode

        public java.lang.String getRefundTransactionCode()
        Getter for refundTransactionCode The transaction code for the refund. This code will be saved to the `ReturnInvoice` transaction, and does not need to match the code of the original sale.

      • setRefundTransactionCode

        public void setRefundTransactionCode​(java.lang.String value)
        Setter for refundTransactionCode The transaction code for the refund. This code will be saved to the `ReturnInvoice` transaction, and does not need to match the code of the original sale.

      • getRefundDate

        public java.util.Date getRefundDate()
        Getter for refundDate The date of the refund. For customers using Avalara's Managed Returns Service, this date controls the month in which the refund transaction will be reported on a tax filing.

      • setRefundDate

        public void setRefundDate​(java.util.Date value)
        Setter for refundDate The date of the refund. For customers using Avalara's Managed Returns Service, this date controls the month in which the refund transaction will be reported on a tax filing.

      • getRefundType

        public RefundType getRefundType()
        Getter for refundType Type of this refund. To submit a full refund, specify `Full`. To refund only specific lines from the transaction, specify `Partial` and indicate the lines you wish to apply in the `refundLines` field. To refund the tax that was paid in the previous transaction, specify `TaxOnly`. To issue a percentage-based discount, specify `Percentage`.

      • setRefundType

        public void setRefundType​(RefundType value)
        Setter for refundType Type of this refund. To submit a full refund, specify `Full`. To refund only specific lines from the transaction, specify `Partial` and indicate the lines you wish to apply in the `refundLines` field. To refund the tax that was paid in the previous transaction, specify `TaxOnly`. To issue a percentage-based discount, specify `Percentage`.

      • getRefundPercentage

        public java.math.BigDecimal getRefundPercentage()
        Getter for refundPercentage The percentage for refund. This value only applies if you choose `refundType = Percentage` or `refundType = Partial`.

      • setRefundPercentage

        public void setRefundPercentage​(java.math.BigDecimal value)
        Setter for refundPercentage The percentage for refund. This value only applies if you choose `refundType = Percentage` or `refundType = Partial`.

      • getRefundLines

        public java.util.ArrayList<java.lang.String> getRefundLines()
        Getter for refundLines If you chose a refund of type `Partial`, this indicates which lines from the original transaction are being refunded.

      • setRefundLines

        public void setRefundLines​(java.util.ArrayList<java.lang.String> value)
        Setter for refundLines If you chose a refund of type `Partial`, this indicates which lines from the original transaction are being refunded.

      • getReferenceCode

        public java.lang.String getReferenceCode()
        Getter for referenceCode A user-defined reference field containing information about this refund.

      • setReferenceCode

        public void setReferenceCode​(java.lang.String value)
        Setter for referenceCode A user-defined reference field containing information about this refund.

      • toString

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