Class PreferredProgramModel


  • public class PreferredProgramModel
    extends java.lang.Object
    A preferred program is a customs and/or duty program that can be used to handle cross-border transactions. Customers who sign up for a preferred program may obtain better terms for their customs and duty payments. To indicate that your company has signed up for a preferred program, specify the `code` value from this object as the value for the `AvaTax.LC.PreferredProgram` parameter in your transaction.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCode()
      Getter for code A code that identifies this preferred program.
      java.lang.String getDestinationCountry()
      Getter for destinationCountry The ISO 3166 country code for the destination permitted by this program
      java.util.Date getEffectiveDate()
      Getter for effectiveDate The earliest date for which this preferred program can be used in AvaTax.
      java.util.Date getEndDate()
      Getter for endDate The latest date for which this preferred program can be used in AvaTax.
      java.lang.Integer getId()
      Getter for id The unique ID number representing this preferred program.
      java.lang.String getOriginCountry()
      Getter for originCountry The ISO 3166 country code for the origin permitted by this program
      void setCode​(java.lang.String value)
      Setter for code A code that identifies this preferred program.
      void setDestinationCountry​(java.lang.String value)
      Setter for destinationCountry The ISO 3166 country code for the destination permitted by this program
      void setEffectiveDate​(java.util.Date value)
      Setter for effectiveDate The earliest date for which this preferred program can be used in AvaTax.
      void setEndDate​(java.util.Date value)
      Setter for endDate The latest date for which this preferred program can be used in AvaTax.
      void setId​(java.lang.Integer value)
      Setter for id The unique ID number representing this preferred program.
      void setOriginCountry​(java.lang.String value)
      Setter for originCountry The ISO 3166 country code for the origin permitted by this program
      java.lang.String toString()
      Returns a JSON string representation of PreferredProgramModel
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PreferredProgramModel

        public PreferredProgramModel()
    • Method Detail

      • getId

        public java.lang.Integer getId()
        Getter for id The unique ID number representing this preferred program.
      • setId

        public void setId​(java.lang.Integer value)
        Setter for id The unique ID number representing this preferred program.
      • getCode

        public java.lang.String getCode()
        Getter for code A code that identifies this preferred program. To select this program, specify this code value in the `AvaTax.LC.PreferredProgram` parameter.
      • setCode

        public void setCode​(java.lang.String value)
        Setter for code A code that identifies this preferred program. To select this program, specify this code value in the `AvaTax.LC.PreferredProgram` parameter.
      • getOriginCountry

        public java.lang.String getOriginCountry()
        Getter for originCountry The ISO 3166 country code for the origin permitted by this program
      • setOriginCountry

        public void setOriginCountry​(java.lang.String value)
        Setter for originCountry The ISO 3166 country code for the origin permitted by this program
      • getDestinationCountry

        public java.lang.String getDestinationCountry()
        Getter for destinationCountry The ISO 3166 country code for the destination permitted by this program
      • setDestinationCountry

        public void setDestinationCountry​(java.lang.String value)
        Setter for destinationCountry The ISO 3166 country code for the destination permitted by this program
      • getEffectiveDate

        public java.util.Date getEffectiveDate()
        Getter for effectiveDate The earliest date for which this preferred program can be used in AvaTax. If `null`, this preferred program is valid for all dates earlier than `endDate`.
      • setEffectiveDate

        public void setEffectiveDate​(java.util.Date value)
        Setter for effectiveDate The earliest date for which this preferred program can be used in AvaTax. If `null`, this preferred program is valid for all dates earlier than `endDate`.
      • getEndDate

        public java.util.Date getEndDate()
        Getter for endDate The latest date for which this preferred program can be used in AvaTax. If `null`, this preferred program is valid for all dates later than `effectiveDate`.
      • setEndDate

        public void setEndDate​(java.util.Date value)
        Setter for endDate The latest date for which this preferred program can be used in AvaTax. If `null`, this preferred program is valid for all dates later than `effectiveDate`.
      • toString

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