com.zuora.model.DebitMemoItemWriteOffRequest 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.DebitMemoTaxationItemWriteOffRequest;
import java.io.IOException;
import java.math.BigDecimal;
import java.time.LocalDate;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
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;
/**
* DebitMemoItemWriteOffRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class DebitMemoItemWriteOffRequest {
public static final String SERIALIZED_NAME_COMMENT = "comment";
@SerializedName(SERIALIZED_NAME_COMMENT)
private String comment;
public static final String SERIALIZED_NAME_AMOUNT_WITHOUT_TAX = "amountWithoutTax";
@SerializedName(SERIALIZED_NAME_AMOUNT_WITHOUT_TAX)
private BigDecimal amountWithoutTax;
public static final String SERIALIZED_NAME_DEBIT_MEMO_ITEM_ID = "debitMemoItemId";
@SerializedName(SERIALIZED_NAME_DEBIT_MEMO_ITEM_ID)
private String debitMemoItemId;
public static final String SERIALIZED_NAME_SERVICE_END_DATE = "serviceEndDate";
@SerializedName(SERIALIZED_NAME_SERVICE_END_DATE)
private LocalDate serviceEndDate;
public static final String SERIALIZED_NAME_SERVICE_START_DATE = "serviceStartDate";
@SerializedName(SERIALIZED_NAME_SERVICE_START_DATE)
private LocalDate serviceStartDate;
public static final String SERIALIZED_NAME_SKU_NAME = "skuName";
@SerializedName(SERIALIZED_NAME_SKU_NAME)
private String skuName;
public static final String SERIALIZED_NAME_UNIT_OF_MEASURE = "unitOfMeasure";
@SerializedName(SERIALIZED_NAME_UNIT_OF_MEASURE)
private String unitOfMeasure;
public static final String SERIALIZED_NAME_EXCLUDE_ITEM_BILLING_FROM_REVENUE_ACCOUNTING = "excludeItemBillingFromRevenueAccounting";
@SerializedName(SERIALIZED_NAME_EXCLUDE_ITEM_BILLING_FROM_REVENUE_ACCOUNTING)
private Boolean excludeItemBillingFromRevenueAccounting;
public static final String SERIALIZED_NAME_TAXATION_ITEMS = "taxationItems";
@SerializedName(SERIALIZED_NAME_TAXATION_ITEMS)
private List taxationItems;
public DebitMemoItemWriteOffRequest() {
}
public DebitMemoItemWriteOffRequest comment(String comment) {
this.comment = comment;
return this;
}
/**
* Comments about the credit memo item.
* @return comment
*/
@javax.annotation.Nullable
public String getComment() {
return comment;
}
public void setComment(String comment) {
this.comment = comment;
}
public DebitMemoItemWriteOffRequest amountWithoutTax(BigDecimal amountWithoutTax) {
this.amountWithoutTax = amountWithoutTax;
return this;
}
/**
* Get amountWithoutTax
* @return amountWithoutTax
*/
@javax.annotation.Nullable
public BigDecimal getAmountWithoutTax() {
return amountWithoutTax;
}
public void setAmountWithoutTax(BigDecimal amountWithoutTax) {
this.amountWithoutTax = amountWithoutTax;
}
public DebitMemoItemWriteOffRequest debitMemoItemId(String debitMemoItemId) {
this.debitMemoItemId = debitMemoItemId;
return this;
}
/**
* The ID of the debit memo item.
* @return debitMemoItemId
*/
@javax.annotation.Nullable
public String getDebitMemoItemId() {
return debitMemoItemId;
}
public void setDebitMemoItemId(String debitMemoItemId) {
this.debitMemoItemId = debitMemoItemId;
}
public DebitMemoItemWriteOffRequest serviceEndDate(LocalDate serviceEndDate) {
this.serviceEndDate = serviceEndDate;
return this;
}
/**
* The service end date of the credit memo item.
* @return serviceEndDate
*/
@javax.annotation.Nullable
public LocalDate getServiceEndDate() {
return serviceEndDate;
}
public void setServiceEndDate(LocalDate serviceEndDate) {
this.serviceEndDate = serviceEndDate;
}
public DebitMemoItemWriteOffRequest serviceStartDate(LocalDate serviceStartDate) {
this.serviceStartDate = serviceStartDate;
return this;
}
/**
* The service start date of the credit memo item.
* @return serviceStartDate
*/
@javax.annotation.Nullable
public LocalDate getServiceStartDate() {
return serviceStartDate;
}
public void setServiceStartDate(LocalDate serviceStartDate) {
this.serviceStartDate = serviceStartDate;
}
public DebitMemoItemWriteOffRequest skuName(String skuName) {
this.skuName = skuName;
return this;
}
/**
* The name of the charge associated with the invoice.
* @return skuName
*/
@javax.annotation.Nullable
public String getSkuName() {
return skuName;
}
public void setSkuName(String skuName) {
this.skuName = skuName;
}
public DebitMemoItemWriteOffRequest unitOfMeasure(String unitOfMeasure) {
this.unitOfMeasure = unitOfMeasure;
return this;
}
/**
* The definable unit that you measure when determining charges.
* @return unitOfMeasure
*/
@javax.annotation.Nullable
public String getUnitOfMeasure() {
return unitOfMeasure;
}
public void setUnitOfMeasure(String unitOfMeasure) {
this.unitOfMeasure = unitOfMeasure;
}
public DebitMemoItemWriteOffRequest excludeItemBillingFromRevenueAccounting(Boolean excludeItemBillingFromRevenueAccounting) {
this.excludeItemBillingFromRevenueAccounting = excludeItemBillingFromRevenueAccounting;
return this;
}
/**
* Get excludeItemBillingFromRevenueAccounting
* @return excludeItemBillingFromRevenueAccounting
*/
@javax.annotation.Nullable
public Boolean getExcludeItemBillingFromRevenueAccounting() {
return excludeItemBillingFromRevenueAccounting;
}
public void setExcludeItemBillingFromRevenueAccounting(Boolean excludeItemBillingFromRevenueAccounting) {
this.excludeItemBillingFromRevenueAccounting = excludeItemBillingFromRevenueAccounting;
}
public DebitMemoItemWriteOffRequest taxationItems(List taxationItems) {
this.taxationItems = taxationItems;
return this;
}
public DebitMemoItemWriteOffRequest addTaxationItemsItem(DebitMemoTaxationItemWriteOffRequest taxationItemsItem) {
if (this.taxationItems == null) {
this.taxationItems = new ArrayList<>();
}
this.taxationItems.add(taxationItemsItem);
return this;
}
/**
* Get taxationItems
* @return taxationItems
*/
@javax.annotation.Nullable
public List getTaxationItems() {
return taxationItems;
}
public void setTaxationItems(List taxationItems) {
this.taxationItems = taxationItems;
}
/**
* 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 DebitMemoItemWriteOffRequest instance itself
*/
public DebitMemoItemWriteOffRequest 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;
}
DebitMemoItemWriteOffRequest debitMemoItemWriteOffRequest = (DebitMemoItemWriteOffRequest) o;
return Objects.equals(this.comment, debitMemoItemWriteOffRequest.comment) &&
Objects.equals(this.amountWithoutTax, debitMemoItemWriteOffRequest.amountWithoutTax) &&
Objects.equals(this.debitMemoItemId, debitMemoItemWriteOffRequest.debitMemoItemId) &&
Objects.equals(this.serviceEndDate, debitMemoItemWriteOffRequest.serviceEndDate) &&
Objects.equals(this.serviceStartDate, debitMemoItemWriteOffRequest.serviceStartDate) &&
Objects.equals(this.skuName, debitMemoItemWriteOffRequest.skuName) &&
Objects.equals(this.unitOfMeasure, debitMemoItemWriteOffRequest.unitOfMeasure) &&
Objects.equals(this.excludeItemBillingFromRevenueAccounting, debitMemoItemWriteOffRequest.excludeItemBillingFromRevenueAccounting) &&
Objects.equals(this.taxationItems, debitMemoItemWriteOffRequest.taxationItems)&&
Objects.equals(this.additionalProperties, debitMemoItemWriteOffRequest.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(comment, amountWithoutTax, debitMemoItemId, serviceEndDate, serviceStartDate, skuName, unitOfMeasure, excludeItemBillingFromRevenueAccounting, taxationItems, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class DebitMemoItemWriteOffRequest {\n");
sb.append(" comment: ").append(toIndentedString(comment)).append("\n");
sb.append(" amountWithoutTax: ").append(toIndentedString(amountWithoutTax)).append("\n");
sb.append(" debitMemoItemId: ").append(toIndentedString(debitMemoItemId)).append("\n");
sb.append(" serviceEndDate: ").append(toIndentedString(serviceEndDate)).append("\n");
sb.append(" serviceStartDate: ").append(toIndentedString(serviceStartDate)).append("\n");
sb.append(" skuName: ").append(toIndentedString(skuName)).append("\n");
sb.append(" unitOfMeasure: ").append(toIndentedString(unitOfMeasure)).append("\n");
sb.append(" excludeItemBillingFromRevenueAccounting: ").append(toIndentedString(excludeItemBillingFromRevenueAccounting)).append("\n");
sb.append(" taxationItems: ").append(toIndentedString(taxationItems)).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("comment");
openapiFields.add("amountWithoutTax");
openapiFields.add("debitMemoItemId");
openapiFields.add("serviceEndDate");
openapiFields.add("serviceStartDate");
openapiFields.add("skuName");
openapiFields.add("unitOfMeasure");
openapiFields.add("excludeItemBillingFromRevenueAccounting");
openapiFields.add("taxationItems");
// 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 DebitMemoItemWriteOffRequest
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!DebitMemoItemWriteOffRequest.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in DebitMemoItemWriteOffRequest is not found in the empty JSON string", DebitMemoItemWriteOffRequest.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("comment") != null && !jsonObj.get("comment").isJsonNull()) && !jsonObj.get("comment").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `comment` to be a primitive type in the JSON string but got `%s`", jsonObj.get("comment").toString()));
}
if ((jsonObj.get("debitMemoItemId") != null && !jsonObj.get("debitMemoItemId").isJsonNull()) && !jsonObj.get("debitMemoItemId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `debitMemoItemId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("debitMemoItemId").toString()));
}
if ((jsonObj.get("skuName") != null && !jsonObj.get("skuName").isJsonNull()) && !jsonObj.get("skuName").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `skuName` to be a primitive type in the JSON string but got `%s`", jsonObj.get("skuName").toString()));
}
if ((jsonObj.get("unitOfMeasure") != null && !jsonObj.get("unitOfMeasure").isJsonNull()) && !jsonObj.get("unitOfMeasure").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `unitOfMeasure` to be a primitive type in the JSON string but got `%s`", jsonObj.get("unitOfMeasure").toString()));
}
if (jsonObj.get("taxationItems") != null && !jsonObj.get("taxationItems").isJsonNull()) {
JsonArray jsonArraytaxationItems = jsonObj.getAsJsonArray("taxationItems");
if (jsonArraytaxationItems != null) {
// ensure the json data is an array
if (!jsonObj.get("taxationItems").isJsonArray()) {
throw new IllegalArgumentException(String.format("Expected the field `taxationItems` to be an array in the JSON string but got `%s`", jsonObj.get("taxationItems").toString()));
}
// validate the optional field `taxationItems` (array)
for (int i = 0; i < jsonArraytaxationItems.size(); i++) {
DebitMemoTaxationItemWriteOffRequest.validateJsonElement(jsonArraytaxationItems.get(i));
};
}
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!DebitMemoItemWriteOffRequest.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'DebitMemoItemWriteOffRequest' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(DebitMemoItemWriteOffRequest.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, DebitMemoItemWriteOffRequest 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 DebitMemoItemWriteOffRequest read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
DebitMemoItemWriteOffRequest 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 DebitMemoItemWriteOffRequest given an JSON string
*
* @param jsonString JSON string
* @return An instance of DebitMemoItemWriteOffRequest
* @throws IOException if the JSON string is invalid with respect to DebitMemoItemWriteOffRequest
*/
public static DebitMemoItemWriteOffRequest fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, DebitMemoItemWriteOffRequest.class);
}
/**
* Convert an instance of DebitMemoItemWriteOffRequest to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy