com.zuora.model.TaxInfo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of zuora-sdk-java Show documentation
Show all versions of zuora-sdk-java Show documentation
The SDK of JAVA language for Zuora pricing system
/*
* Zuora API Reference
* REST API reference for the Zuora Billing, Payments, and Central Platform! Check out the [REST API Overview](https://www.zuora.com/developer/api-references/api/overview/).
*
* The version of the OpenAPI document: 2024-05-20
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.zuora.model;
import java.util.Objects;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import com.zuora.model.TaxExemptStatus;
import java.io.IOException;
import java.time.LocalDate;
import java.util.Arrays;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import com.google.gson.TypeAdapter;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import java.io.IOException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import com.zuora.JSON;
/**
* Information about the tax exempt status of a customer account.
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class TaxInfo {
public static final String SERIALIZED_NAME_COMPANY_CODE = "companyCode";
@SerializedName(SERIALIZED_NAME_COMPANY_CODE)
private String companyCode;
public static final String SERIALIZED_NAME_EXEMPT_ENTITY_USE_CODE = "exemptEntityUseCode";
@SerializedName(SERIALIZED_NAME_EXEMPT_ENTITY_USE_CODE)
private String exemptEntityUseCode;
public static final String SERIALIZED_NAME_EXEMPT_CERTIFICATE_ID = "exemptCertificateId";
@SerializedName(SERIALIZED_NAME_EXEMPT_CERTIFICATE_ID)
private String exemptCertificateId;
public static final String SERIALIZED_NAME_EXEMPT_CERTIFICATE_TYPE = "exemptCertificateType";
@SerializedName(SERIALIZED_NAME_EXEMPT_CERTIFICATE_TYPE)
private String exemptCertificateType;
public static final String SERIALIZED_NAME_EXEMPT_DESCRIPTION = "exemptDescription";
@SerializedName(SERIALIZED_NAME_EXEMPT_DESCRIPTION)
private String exemptDescription;
public static final String SERIALIZED_NAME_EXEMPT_EFFECTIVE_DATE = "exemptEffectiveDate";
@SerializedName(SERIALIZED_NAME_EXEMPT_EFFECTIVE_DATE)
private LocalDate exemptEffectiveDate;
public static final String SERIALIZED_NAME_EXEMPT_EXPIRATION_DATE = "exemptExpirationDate";
@SerializedName(SERIALIZED_NAME_EXEMPT_EXPIRATION_DATE)
private LocalDate exemptExpirationDate;
public static final String SERIALIZED_NAME_EXEMPT_ISSUING_JURISDICTION = "exemptIssuingJurisdiction";
@SerializedName(SERIALIZED_NAME_EXEMPT_ISSUING_JURISDICTION)
private String exemptIssuingJurisdiction;
public static final String SERIALIZED_NAME_EXEMPT_STATUS = "exemptStatus";
@SerializedName(SERIALIZED_NAME_EXEMPT_STATUS)
private TaxExemptStatus exemptStatus = TaxExemptStatus.NO;
public static final String SERIALIZED_NAME_VA_T_ID = "VATId";
@SerializedName(SERIALIZED_NAME_VA_T_ID)
private String vaTId;
public TaxInfo() {
}
public TaxInfo companyCode(String companyCode) {
this.companyCode = companyCode;
return this;
}
/**
* Unique code that identifies a company account in Avalara. Use this field to calculate taxes based on origin and sold-to addresses in Avalara. **Note:** This feature is in Limited Availability. If you wish to have access to the feature, submit a request at [Zuora Global Support](https://support.zuora.com).a
* @return companyCode
*/
@javax.annotation.Nullable
public String getCompanyCode() {
return companyCode;
}
public void setCompanyCode(String companyCode) {
this.companyCode = companyCode;
}
public TaxInfo exemptEntityUseCode(String exemptEntityUseCode) {
this.exemptEntityUseCode = exemptEntityUseCode;
return this;
}
/**
* A unique entity use code to apply exemptions in Avalara AvaTax. This account-level field is required only when you choose Avalara as your tax engine. See [Exempt Transactions](https://developer.avalara.com/avatax/handling-tax-exempt-customers/)for more details.
* @return exemptEntityUseCode
*/
@javax.annotation.Nullable
public String getExemptEntityUseCode() {
return exemptEntityUseCode;
}
public void setExemptEntityUseCode(String exemptEntityUseCode) {
this.exemptEntityUseCode = exemptEntityUseCode;
}
public TaxInfo exemptCertificateId(String exemptCertificateId) {
this.exemptCertificateId = exemptCertificateId;
return this;
}
/**
* ID of the customer tax exemption certificate. Applicable if you use Zuora Tax or Connect tax engines.
* @return exemptCertificateId
*/
@javax.annotation.Nullable
public String getExemptCertificateId() {
return exemptCertificateId;
}
public void setExemptCertificateId(String exemptCertificateId) {
this.exemptCertificateId = exemptCertificateId;
}
public TaxInfo exemptCertificateType(String exemptCertificateType) {
this.exemptCertificateType = exemptCertificateType;
return this;
}
/**
* Type of tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.
* @return exemptCertificateType
*/
@javax.annotation.Nullable
public String getExemptCertificateType() {
return exemptCertificateType;
}
public void setExemptCertificateType(String exemptCertificateType) {
this.exemptCertificateType = exemptCertificateType;
}
public TaxInfo exemptDescription(String exemptDescription) {
this.exemptDescription = exemptDescription;
return this;
}
/**
* Description of the tax exemption certificate that the customer holds. Applicable if you use Zuora Tax or Connect tax engines.
* @return exemptDescription
*/
@javax.annotation.Nullable
public String getExemptDescription() {
return exemptDescription;
}
public void setExemptDescription(String exemptDescription) {
this.exemptDescription = exemptDescription;
}
public TaxInfo exemptEffectiveDate(LocalDate exemptEffectiveDate) {
this.exemptEffectiveDate = exemptEffectiveDate;
return this;
}
/**
* Date when the customer tax exemption starts, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.
* @return exemptEffectiveDate
*/
@javax.annotation.Nullable
public LocalDate getExemptEffectiveDate() {
return exemptEffectiveDate;
}
public void setExemptEffectiveDate(LocalDate exemptEffectiveDate) {
this.exemptEffectiveDate = exemptEffectiveDate;
}
public TaxInfo exemptExpirationDate(LocalDate exemptExpirationDate) {
this.exemptExpirationDate = exemptExpirationDate;
return this;
}
/**
* Date when the customer tax exemption expires, in YYYY-MM-DD format. Applicable if you use Zuora Tax or Connect tax engines.
* @return exemptExpirationDate
*/
@javax.annotation.Nullable
public LocalDate getExemptExpirationDate() {
return exemptExpirationDate;
}
public void setExemptExpirationDate(LocalDate exemptExpirationDate) {
this.exemptExpirationDate = exemptExpirationDate;
}
public TaxInfo exemptIssuingJurisdiction(String exemptIssuingJurisdiction) {
this.exemptIssuingJurisdiction = exemptIssuingJurisdiction;
return this;
}
/**
* Jurisdiction in which the customer tax exemption certificate was issued.
* @return exemptIssuingJurisdiction
*/
@javax.annotation.Nullable
public String getExemptIssuingJurisdiction() {
return exemptIssuingJurisdiction;
}
public void setExemptIssuingJurisdiction(String exemptIssuingJurisdiction) {
this.exemptIssuingJurisdiction = exemptIssuingJurisdiction;
}
public TaxInfo exemptStatus(TaxExemptStatus exemptStatus) {
this.exemptStatus = exemptStatus;
return this;
}
/**
* Get exemptStatus
* @return exemptStatus
*/
@javax.annotation.Nullable
public TaxExemptStatus getExemptStatus() {
return exemptStatus;
}
public void setExemptStatus(TaxExemptStatus exemptStatus) {
this.exemptStatus = exemptStatus;
}
public TaxInfo vaTId(String vaTId) {
this.vaTId = vaTId;
return this;
}
/**
* Get vaTId
* @return vaTId
*/
@javax.annotation.Nullable
public String getVaTId() {
return vaTId;
}
public void setVaTId(String vaTId) {
this.vaTId = vaTId;
}
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
private Map additionalProperties;
/**
* Set the additional (undeclared) property with the specified name and value.
* If the property does not already exist, create it otherwise replace it.
*
* @param key name of the property
* @param value value of the property
* @return the TaxInfo instance itself
*/
public TaxInfo putAdditionalProperty(String key, Object value) {
if (this.additionalProperties == null) {
this.additionalProperties = new HashMap();
}
this.additionalProperties.put(key, value);
return this;
}
/**
* Return the additional (undeclared) property.
*
* @return a map of objects
*/
public Map getAdditionalProperties() {
return additionalProperties;
}
/**
* Return the additional (undeclared) property with the specified name.
*
* @param key name of the property
* @return an object
*/
public Object getAdditionalProperty(String key) {
if (this.additionalProperties == null) {
return null;
}
return this.additionalProperties.get(key);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
TaxInfo taxInfo = (TaxInfo) o;
return Objects.equals(this.companyCode, taxInfo.companyCode) &&
Objects.equals(this.exemptEntityUseCode, taxInfo.exemptEntityUseCode) &&
Objects.equals(this.exemptCertificateId, taxInfo.exemptCertificateId) &&
Objects.equals(this.exemptCertificateType, taxInfo.exemptCertificateType) &&
Objects.equals(this.exemptDescription, taxInfo.exemptDescription) &&
Objects.equals(this.exemptEffectiveDate, taxInfo.exemptEffectiveDate) &&
Objects.equals(this.exemptExpirationDate, taxInfo.exemptExpirationDate) &&
Objects.equals(this.exemptIssuingJurisdiction, taxInfo.exemptIssuingJurisdiction) &&
Objects.equals(this.exemptStatus, taxInfo.exemptStatus) &&
Objects.equals(this.vaTId, taxInfo.vaTId)&&
Objects.equals(this.additionalProperties, taxInfo.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(companyCode, exemptEntityUseCode, exemptCertificateId, exemptCertificateType, exemptDescription, exemptEffectiveDate, exemptExpirationDate, exemptIssuingJurisdiction, exemptStatus, vaTId, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class TaxInfo {\n");
sb.append(" companyCode: ").append(toIndentedString(companyCode)).append("\n");
sb.append(" exemptEntityUseCode: ").append(toIndentedString(exemptEntityUseCode)).append("\n");
sb.append(" exemptCertificateId: ").append(toIndentedString(exemptCertificateId)).append("\n");
sb.append(" exemptCertificateType: ").append(toIndentedString(exemptCertificateType)).append("\n");
sb.append(" exemptDescription: ").append(toIndentedString(exemptDescription)).append("\n");
sb.append(" exemptEffectiveDate: ").append(toIndentedString(exemptEffectiveDate)).append("\n");
sb.append(" exemptExpirationDate: ").append(toIndentedString(exemptExpirationDate)).append("\n");
sb.append(" exemptIssuingJurisdiction: ").append(toIndentedString(exemptIssuingJurisdiction)).append("\n");
sb.append(" exemptStatus: ").append(toIndentedString(exemptStatus)).append("\n");
sb.append(" vaTId: ").append(toIndentedString(vaTId)).append("\n");
sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("companyCode");
openapiFields.add("exemptEntityUseCode");
openapiFields.add("exemptCertificateId");
openapiFields.add("exemptCertificateType");
openapiFields.add("exemptDescription");
openapiFields.add("exemptEffectiveDate");
openapiFields.add("exemptExpirationDate");
openapiFields.add("exemptIssuingJurisdiction");
openapiFields.add("exemptStatus");
openapiFields.add("VATId");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
}
/**
* Validates the JSON Element and throws an exception if issues found
*
* @param jsonElement JSON Element
* @throws IOException if the JSON Element is invalid with respect to TaxInfo
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!TaxInfo.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in TaxInfo is not found in the empty JSON string", TaxInfo.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("companyCode") != null && !jsonObj.get("companyCode").isJsonNull()) && !jsonObj.get("companyCode").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `companyCode` to be a primitive type in the JSON string but got `%s`", jsonObj.get("companyCode").toString()));
}
if ((jsonObj.get("exemptEntityUseCode") != null && !jsonObj.get("exemptEntityUseCode").isJsonNull()) && !jsonObj.get("exemptEntityUseCode").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `exemptEntityUseCode` to be a primitive type in the JSON string but got `%s`", jsonObj.get("exemptEntityUseCode").toString()));
}
if ((jsonObj.get("exemptCertificateId") != null && !jsonObj.get("exemptCertificateId").isJsonNull()) && !jsonObj.get("exemptCertificateId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `exemptCertificateId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("exemptCertificateId").toString()));
}
if ((jsonObj.get("exemptCertificateType") != null && !jsonObj.get("exemptCertificateType").isJsonNull()) && !jsonObj.get("exemptCertificateType").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `exemptCertificateType` to be a primitive type in the JSON string but got `%s`", jsonObj.get("exemptCertificateType").toString()));
}
if ((jsonObj.get("exemptDescription") != null && !jsonObj.get("exemptDescription").isJsonNull()) && !jsonObj.get("exemptDescription").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `exemptDescription` to be a primitive type in the JSON string but got `%s`", jsonObj.get("exemptDescription").toString()));
}
if ((jsonObj.get("exemptIssuingJurisdiction") != null && !jsonObj.get("exemptIssuingJurisdiction").isJsonNull()) && !jsonObj.get("exemptIssuingJurisdiction").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `exemptIssuingJurisdiction` to be a primitive type in the JSON string but got `%s`", jsonObj.get("exemptIssuingJurisdiction").toString()));
}
// validate the optional field `exemptStatus`
if (jsonObj.get("exemptStatus") != null && !jsonObj.get("exemptStatus").isJsonNull()) {
TaxExemptStatus.validateJsonElement(jsonObj.get("exemptStatus"));
}
if ((jsonObj.get("VATId") != null && !jsonObj.get("VATId").isJsonNull()) && !jsonObj.get("VATId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `VATId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("VATId").toString()));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!TaxInfo.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'TaxInfo' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(TaxInfo.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, TaxInfo value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// support null values
out.beginObject();
Iterator iterator = obj.entrySet().iterator();
while(iterator.hasNext()) {
Map.Entry e = (Map.Entry) iterator.next();
out.name((String)e.getKey());
elementAdapter.write(out, e.getValue());
}
// end
// serialize additional properties
if (value.getAdditionalProperties() != null) {
// support null values
boolean oldSerializeNulls = out.getSerializeNulls();
out.setSerializeNulls(true); //force serialize
// end
for (Map.Entry entry : value.getAdditionalProperties().entrySet()) {
if (entry.getValue() instanceof String)
obj.addProperty(entry.getKey(), (String) entry.getValue());
else if (entry.getValue() instanceof Number)
obj.addProperty(entry.getKey(), (Number) entry.getValue());
else if (entry.getValue() instanceof Boolean)
obj.addProperty(entry.getKey(), (Boolean) entry.getValue());
else if (entry.getValue() instanceof Character)
obj.addProperty(entry.getKey(), (Character) entry.getValue());
else if (entry.getValue() == null)
obj.add(entry.getKey(), null);
else {
JsonElement jsonElement = gson.toJsonTree(entry.getValue());
if (jsonElement.isJsonArray()) {
obj.add(entry.getKey(), jsonElement.getAsJsonArray());
} else {
obj.add(entry.getKey(), jsonElement.getAsJsonObject());
}
}
out.name((String)entry.getKey());
elementAdapter.write(out, obj.get(entry.getKey()));
}
out.setSerializeNulls(oldSerializeNulls); //restore
}
out.endObject();
}
@Override
public TaxInfo read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
TaxInfo instance = thisAdapter.fromJsonTree(jsonObj);
for (Map.Entry entry : jsonObj.entrySet()) {
if (!openapiFields.contains(entry.getKey())) {
if (entry.getValue().isJsonPrimitive()) { // primitive type
if (entry.getValue().getAsJsonPrimitive().isString())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString());
else if (entry.getValue().getAsJsonPrimitive().isNumber())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber());
else if (entry.getValue().getAsJsonPrimitive().isBoolean())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean());
else
throw new IllegalArgumentException(String.format("The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString()));
} else if (entry.getValue().isJsonArray()) {
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class));
} else { // JSON object
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class));
}
}
}
return instance;
}
}.nullSafe();
}
}
/**
* Create an instance of TaxInfo given an JSON string
*
* @param jsonString JSON string
* @return An instance of TaxInfo
* @throws IOException if the JSON string is invalid with respect to TaxInfo
*/
public static TaxInfo fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, TaxInfo.class);
}
/**
* Convert an instance of TaxInfo to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy