com.zuora.model.InvoiceScheduleItem 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.InvoiceScheduleItemStatus;
import java.io.IOException;
import java.math.BigDecimal;
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;
/**
* InvoiceScheduleItem
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.6.0")
public class InvoiceScheduleItem {
public static final String SERIALIZED_NAME_ACTUAL_AMOUNT = "actualAmount";
@SerializedName(SERIALIZED_NAME_ACTUAL_AMOUNT)
private BigDecimal actualAmount;
public static final String SERIALIZED_NAME_AMOUNT = "amount";
@SerializedName(SERIALIZED_NAME_AMOUNT)
private BigDecimal amount;
public static final String SERIALIZED_NAME_CREDIT_MEMO_ID = "creditMemoId";
@SerializedName(SERIALIZED_NAME_CREDIT_MEMO_ID)
private String creditMemoId;
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private String id;
public static final String SERIALIZED_NAME_INVOICE_ID = "invoiceId";
@SerializedName(SERIALIZED_NAME_INVOICE_ID)
private String invoiceId;
public static final String SERIALIZED_NAME_NAME = "name";
@SerializedName(SERIALIZED_NAME_NAME)
private String name;
public static final String SERIALIZED_NAME_PERCENTAGE = "percentage";
@SerializedName(SERIALIZED_NAME_PERCENTAGE)
private BigDecimal percentage;
public static final String SERIALIZED_NAME_RUN_DATE = "runDate";
@SerializedName(SERIALIZED_NAME_RUN_DATE)
private LocalDate runDate;
public static final String SERIALIZED_NAME_STATUS = "status";
@SerializedName(SERIALIZED_NAME_STATUS)
private InvoiceScheduleItemStatus status;
public static final String SERIALIZED_NAME_TARGET_DATE_FOR_ADDITIONAL_SUBSCRIPTIONS = "targetDateForAdditionalSubscriptions";
@SerializedName(SERIALIZED_NAME_TARGET_DATE_FOR_ADDITIONAL_SUBSCRIPTIONS)
private LocalDate targetDateForAdditionalSubscriptions;
public InvoiceScheduleItem() {
}
public InvoiceScheduleItem actualAmount(BigDecimal actualAmount) {
this.actualAmount = actualAmount;
return this;
}
/**
* The actual amount that needs to be billed during the processing of the invoice schedule item. By default, the actual amount is the same as the total amount. Even if order changes occur like Remove Product or Cancel Subscription, the value of the `amount` field keeps unchanged. The value of the `actualAmount` field reflects the actual amount to be billed.
* @return actualAmount
*/
@javax.annotation.Nullable
public BigDecimal getActualAmount() {
return actualAmount;
}
public void setActualAmount(BigDecimal actualAmount) {
this.actualAmount = actualAmount;
}
public InvoiceScheduleItem amount(BigDecimal amount) {
this.amount = amount;
return this;
}
/**
* The amount of the invoice generated during the processing of the invoice schedule item. The value of this field keeps unchanged once invoice schedule items are created.
* @return amount
*/
@javax.annotation.Nullable
public BigDecimal getAmount() {
return amount;
}
public void setAmount(BigDecimal amount) {
this.amount = amount;
}
public InvoiceScheduleItem creditMemoId(String creditMemoId) {
this.creditMemoId = creditMemoId;
return this;
}
/**
* The ID of the credit memo that is generated during the processing of the invoice schedule item.
* @return creditMemoId
*/
@javax.annotation.Nullable
public String getCreditMemoId() {
return creditMemoId;
}
public void setCreditMemoId(String creditMemoId) {
this.creditMemoId = creditMemoId;
}
public InvoiceScheduleItem id(String id) {
this.id = id;
return this;
}
/**
* The unique ID of the invoice schedule item.
* @return id
*/
@javax.annotation.Nullable
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public InvoiceScheduleItem invoiceId(String invoiceId) {
this.invoiceId = invoiceId;
return this;
}
/**
* The ID of the invoice that is generated during the processing of the invoice schedule item.
* @return invoiceId
*/
@javax.annotation.Nullable
public String getInvoiceId() {
return invoiceId;
}
public void setInvoiceId(String invoiceId) {
this.invoiceId = invoiceId;
}
public InvoiceScheduleItem name(String name) {
this.name = name;
return this;
}
/**
* The name of the invoice schedule item.
* @return name
*/
@javax.annotation.Nullable
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public InvoiceScheduleItem percentage(BigDecimal percentage) {
this.percentage = percentage;
return this;
}
/**
* The percentage of the total amount to be generated during the processing of the invoice schedule item.
* @return percentage
*/
@javax.annotation.Nullable
public BigDecimal getPercentage() {
return percentage;
}
public void setPercentage(BigDecimal percentage) {
this.percentage = percentage;
}
public InvoiceScheduleItem runDate(LocalDate runDate) {
this.runDate = runDate;
return this;
}
/**
* The date in the tenant’s time zone when the invoice schedule item is processed to generate an invoice.
* @return runDate
*/
@javax.annotation.Nullable
public LocalDate getRunDate() {
return runDate;
}
public void setRunDate(LocalDate runDate) {
this.runDate = runDate;
}
public InvoiceScheduleItem status(InvoiceScheduleItemStatus status) {
this.status = status;
return this;
}
/**
* Get status
* @return status
*/
@javax.annotation.Nullable
public InvoiceScheduleItemStatus getStatus() {
return status;
}
public void setStatus(InvoiceScheduleItemStatus status) {
this.status = status;
}
public InvoiceScheduleItem targetDateForAdditionalSubscriptions(LocalDate targetDateForAdditionalSubscriptions) {
this.targetDateForAdditionalSubscriptions = targetDateForAdditionalSubscriptions;
return this;
}
/**
* The date in the tenant's time zone used by the invoice schedule to determine which fixed-period regular charges to be billed together with the invoice schedule item. The regular charges must come from the subscriptions specified in the `additionalSubscriptionsToBill` field.
* @return targetDateForAdditionalSubscriptions
*/
@javax.annotation.Nullable
public LocalDate getTargetDateForAdditionalSubscriptions() {
return targetDateForAdditionalSubscriptions;
}
public void setTargetDateForAdditionalSubscriptions(LocalDate targetDateForAdditionalSubscriptions) {
this.targetDateForAdditionalSubscriptions = targetDateForAdditionalSubscriptions;
}
/**
* 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 InvoiceScheduleItem instance itself
*/
public InvoiceScheduleItem 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;
}
InvoiceScheduleItem invoiceScheduleItem = (InvoiceScheduleItem) o;
return Objects.equals(this.actualAmount, invoiceScheduleItem.actualAmount) &&
Objects.equals(this.amount, invoiceScheduleItem.amount) &&
Objects.equals(this.creditMemoId, invoiceScheduleItem.creditMemoId) &&
Objects.equals(this.id, invoiceScheduleItem.id) &&
Objects.equals(this.invoiceId, invoiceScheduleItem.invoiceId) &&
Objects.equals(this.name, invoiceScheduleItem.name) &&
Objects.equals(this.percentage, invoiceScheduleItem.percentage) &&
Objects.equals(this.runDate, invoiceScheduleItem.runDate) &&
Objects.equals(this.status, invoiceScheduleItem.status) &&
Objects.equals(this.targetDateForAdditionalSubscriptions, invoiceScheduleItem.targetDateForAdditionalSubscriptions)&&
Objects.equals(this.additionalProperties, invoiceScheduleItem.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(actualAmount, amount, creditMemoId, id, invoiceId, name, percentage, runDate, status, targetDateForAdditionalSubscriptions, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class InvoiceScheduleItem {\n");
sb.append(" actualAmount: ").append(toIndentedString(actualAmount)).append("\n");
sb.append(" amount: ").append(toIndentedString(amount)).append("\n");
sb.append(" creditMemoId: ").append(toIndentedString(creditMemoId)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" invoiceId: ").append(toIndentedString(invoiceId)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" percentage: ").append(toIndentedString(percentage)).append("\n");
sb.append(" runDate: ").append(toIndentedString(runDate)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" targetDateForAdditionalSubscriptions: ").append(toIndentedString(targetDateForAdditionalSubscriptions)).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("actualAmount");
openapiFields.add("amount");
openapiFields.add("creditMemoId");
openapiFields.add("id");
openapiFields.add("invoiceId");
openapiFields.add("name");
openapiFields.add("percentage");
openapiFields.add("runDate");
openapiFields.add("status");
openapiFields.add("targetDateForAdditionalSubscriptions");
// 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 InvoiceScheduleItem
*/
public static void validateJsonElement(JsonElement jsonElement) throws IOException {
if (jsonElement == null) {
if (!InvoiceScheduleItem.openapiRequiredFields.isEmpty()) { // has required fields but JSON element is null
throw new IllegalArgumentException(String.format("The required field(s) %s in InvoiceScheduleItem is not found in the empty JSON string", InvoiceScheduleItem.openapiRequiredFields.toString()));
}
}
JsonObject jsonObj = jsonElement.getAsJsonObject();
if ((jsonObj.get("creditMemoId") != null && !jsonObj.get("creditMemoId").isJsonNull()) && !jsonObj.get("creditMemoId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `creditMemoId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("creditMemoId").toString()));
}
if ((jsonObj.get("id") != null && !jsonObj.get("id").isJsonNull()) && !jsonObj.get("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString()));
}
if ((jsonObj.get("invoiceId") != null && !jsonObj.get("invoiceId").isJsonNull()) && !jsonObj.get("invoiceId").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `invoiceId` to be a primitive type in the JSON string but got `%s`", jsonObj.get("invoiceId").toString()));
}
if ((jsonObj.get("name") != null && !jsonObj.get("name").isJsonNull()) && !jsonObj.get("name").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `name` to be a primitive type in the JSON string but got `%s`", jsonObj.get("name").toString()));
}
if ((jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) && !jsonObj.get("status").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `status` to be a primitive type in the JSON string but got `%s`", jsonObj.get("status").toString()));
}
// validate the optional field `status`
if (jsonObj.get("status") != null && !jsonObj.get("status").isJsonNull()) {
InvoiceScheduleItemStatus.validateJsonElement(jsonObj.get("status"));
}
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!InvoiceScheduleItem.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'InvoiceScheduleItem' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(InvoiceScheduleItem.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, InvoiceScheduleItem 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 InvoiceScheduleItem read(JsonReader in) throws IOException {
JsonElement jsonElement = elementAdapter.read(in);
validateJsonElement(jsonElement);
JsonObject jsonObj = jsonElement.getAsJsonObject();
// store additional fields in the deserialized instance
InvoiceScheduleItem 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 InvoiceScheduleItem given an JSON string
*
* @param jsonString JSON string
* @return An instance of InvoiceScheduleItem
* @throws IOException if the JSON string is invalid with respect to InvoiceScheduleItem
*/
public static InvoiceScheduleItem fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, InvoiceScheduleItem.class);
}
/**
* Convert an instance of InvoiceScheduleItem to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy