org.openapitools.client.model.CreditMemoCreateRequest 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
/*
* Quickstart API Reference
* Zuora Quickstart API is the API that helps you achieve fundamental use cases.
* It provides a much simplified object model and improved performance, enabling developers to easily learn and use.
*/
package org.openapitools.client.model;
import java.util.Objects;
import java.util.Arrays;
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 io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.openapitools.client.model.CreditMemoItemCreateRequest;
import org.threeten.bp.LocalDate;
import org.openapitools.client.JSON.CustomFieldAdapter;
import org.openapitools.client.JSON.NullableFieldAdapter;
/**
* CreditMemoCreateRequest
*/
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class CreditMemoCreateRequest {
public static final String SERIALIZED_NAME_ACCOUNT_ID = "account_id";
@SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
private String accountId;
public static final String SERIALIZED_NAME_ACCOUNT_NUMBER = "account_number";
@SerializedName(SERIALIZED_NAME_ACCOUNT_NUMBER)
private String accountNumber;
public static final String SERIALIZED_NAME_DESCRIPTION = "description";
@SerializedName(SERIALIZED_NAME_DESCRIPTION)
private String description;
public static final String SERIALIZED_NAME_DOCUMENT_DATE = "document_date";
@SerializedName(SERIALIZED_NAME_DOCUMENT_DATE)
private LocalDate documentDate;
public static final String SERIALIZED_NAME_REASON_CODE = "reason_code";
@SerializedName(SERIALIZED_NAME_REASON_CODE)
private String reasonCode;
public static final String SERIALIZED_NAME_INVOICE_ID = "invoice_id";
@SerializedName(SERIALIZED_NAME_INVOICE_ID)
private String invoiceId;
public static final String SERIALIZED_NAME_TRANSFER_TO_ACCOUNTING = "transfer_to_accounting";
@SerializedName(SERIALIZED_NAME_TRANSFER_TO_ACCOUNTING)
private Boolean transferToAccounting;
public static final String SERIALIZED_NAME_CUSTOM_FIELDS = "custom_fields";
@SerializedName(SERIALIZED_NAME_CUSTOM_FIELDS)
@JsonAdapter(CustomFieldAdapter.class)
private Map customFields = null;
public static final String SERIALIZED_NAME_EXCLUDE_FROM_AUTO_APPLY_RULES = "exclude_from_auto_apply_rules";
@SerializedName(SERIALIZED_NAME_EXCLUDE_FROM_AUTO_APPLY_RULES)
private Boolean excludeFromAutoApplyRules;
public static final String SERIALIZED_NAME_CURRENCY = "currency";
@SerializedName(SERIALIZED_NAME_CURRENCY)
private String currency;
public static final String SERIALIZED_NAME_ITEMS = "items";
@SerializedName(SERIALIZED_NAME_ITEMS)
private List items = null;
public static final String SERIALIZED_NAME_APPLY = "apply";
@SerializedName(SERIALIZED_NAME_APPLY)
private Boolean apply;
public static final String SERIALIZED_NAME_POST = "post";
@SerializedName(SERIALIZED_NAME_POST)
private Boolean post;
public CreditMemoCreateRequest() {
}
public CreditMemoCreateRequest accountId(String accountId) {
this.accountId = accountId;
return this;
}
/**
* Identifier of the account that owns the credit memo. **Either this field or `account_number` is required when creating credit memos from a price(charge in the v1 API).**
* @return accountId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Identifier of the account that owns the credit memo. **Either this field or `account_number` is required when creating credit memos from a price(charge in the v1 API).**")
public String getAccountId() {
return accountId;
}
public void setAccountId(String accountId) {
this.accountId = accountId;
}
public CreditMemoCreateRequest accountNumber(String accountNumber) {
this.accountNumber = accountNumber;
return this;
}
/**
* Human-readable identifier of the account that owns the credit memo. **Either this field or `account_id` is required when creating credit memos from a price(charge in the v1 API).**
* @return accountNumber
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "RC-00020831", value = "Human-readable identifier of the account that owns the credit memo. **Either this field or `account_id` is required when creating credit memos from a price(charge in the v1 API).**")
public String getAccountNumber() {
return accountNumber;
}
public void setAccountNumber(String accountNumber) {
this.accountNumber = accountNumber;
}
public CreditMemoCreateRequest description(String description) {
this.description = description;
return this;
}
/**
* An arbitrary string associated with the object. Often useful for displaying to users.
* @return description
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "An arbitrary string associated with the object. Often useful for displaying to users.")
public String getDescription() {
return description;
}
public void setDescription(String description) {
this.description = description;
}
public CreditMemoCreateRequest documentDate(LocalDate documentDate) {
this.documentDate = documentDate;
return this;
}
/**
* The date when the credit memo takes effect.
* @return documentDate
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "Sun Jan 01 00:00:00 GMT 2023", value = "The date when the credit memo takes effect.")
public LocalDate getDocumentDate() {
return documentDate;
}
public void setDocumentDate(LocalDate documentDate) {
this.documentDate = documentDate;
}
public CreditMemoCreateRequest reasonCode(String reasonCode) {
this.reasonCode = reasonCode;
return this;
}
/**
* Reason for issuing this credit memo
* @return reasonCode
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Reason for issuing this credit memo")
public String getReasonCode() {
return reasonCode;
}
public void setReasonCode(String reasonCode) {
this.reasonCode = reasonCode;
}
public CreditMemoCreateRequest invoiceId(String invoiceId) {
this.invoiceId = invoiceId;
return this;
}
/**
* The identifier of the invoice billing document from which this credit memo is created. **Required when creating credit memos from an invoice.**
* @return invoiceId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The identifier of the invoice billing document from which this credit memo is created. **Required when creating credit memos from an invoice.**")
public String getInvoiceId() {
return invoiceId;
}
public void setInvoiceId(String invoiceId) {
this.invoiceId = invoiceId;
}
public CreditMemoCreateRequest transferToAccounting(Boolean transferToAccounting) {
this.transferToAccounting = transferToAccounting;
return this;
}
/**
* Whether to transfer to an external accounting system.
* @return transferToAccounting
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Whether to transfer to an external accounting system.")
public Boolean getTransferToAccounting() {
return transferToAccounting;
}
public void setTransferToAccounting(Boolean transferToAccounting) {
this.transferToAccounting = transferToAccounting;
}
public CreditMemoCreateRequest customFields(Map customFields) {
this.customFields = customFields;
return this;
}
public CreditMemoCreateRequest putCustomFieldsItem(String key, String customFieldsItem) {
if (this.customFields == null) {
this.customFields = new HashMap();
}
this.customFields.put(key, customFieldsItem);
return this;
}
/**
* Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.
* @return customFields
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Set of user-defined fields associated with this object. Useful for storing additional information about the object in a structured format.")
public Map getCustomFields() {
return customFields;
}
public void setCustomFields(Map customFields) {
this.customFields = customFields;
}
public CreditMemoCreateRequest excludeFromAutoApplyRules(Boolean excludeFromAutoApplyRules) {
this.excludeFromAutoApplyRules = excludeFromAutoApplyRules;
return this;
}
/**
* Indicates whether to exclude this credit memo from the rule of automatically applying it to invoices.
* @return excludeFromAutoApplyRules
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Indicates whether to exclude this credit memo from the rule of automatically applying it to invoices.")
public Boolean getExcludeFromAutoApplyRules() {
return excludeFromAutoApplyRules;
}
public void setExcludeFromAutoApplyRules(Boolean excludeFromAutoApplyRules) {
this.excludeFromAutoApplyRules = excludeFromAutoApplyRules;
}
public CreditMemoCreateRequest currency(String currency) {
this.currency = currency;
return this;
}
/**
* 3-letter ISO 4217 currency code. This field is available only if you have the [Multiple Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies) feature enabled and are creating a credit memo from a charge.
* @return currency
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "3-letter ISO 4217 currency code. This field is available only if you have the [Multiple Currencies](https://knowledgecenter.zuora.com/Zuora_Billing/Bill_your_customers/Flexible_Billing/Multiple_Currencies) feature enabled and are creating a credit memo from a charge.")
public String getCurrency() {
return currency;
}
public void setCurrency(String currency) {
this.currency = currency;
}
public CreditMemoCreateRequest items(List items) {
this.items = items;
return this;
}
public CreditMemoCreateRequest addItemsItem(CreditMemoItemCreateRequest itemsItem) {
if (this.items == null) {
this.items = new ArrayList();
}
this.items.add(itemsItem);
return this;
}
/**
* Information of all credit memo items.
* @return items
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Information of all credit memo items.")
public List getItems() {
return items;
}
public void setItems(List items) {
this.items = items;
}
public CreditMemoCreateRequest apply(Boolean apply) {
this.apply = apply;
return this;
}
/**
* Whether to automatically apply the billing document upon posting.
* @return apply
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Whether to automatically apply the billing document upon posting.")
public Boolean getApply() {
return apply;
}
public void setApply(Boolean apply) {
this.apply = apply;
}
public CreditMemoCreateRequest post(Boolean post) {
this.post = post;
return this;
}
/**
* Whether to automatically post a billing document after it is created.
* @return post
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Whether to automatically post a billing document after it is created.")
public Boolean getPost() {
return post;
}
public void setPost(Boolean post) {
this.post = post;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
CreditMemoCreateRequest creditMemoCreateRequest = (CreditMemoCreateRequest) o;
return Objects.equals(this.accountId, creditMemoCreateRequest.accountId) &&
Objects.equals(this.accountNumber, creditMemoCreateRequest.accountNumber) &&
Objects.equals(this.description, creditMemoCreateRequest.description) &&
Objects.equals(this.documentDate, creditMemoCreateRequest.documentDate) &&
Objects.equals(this.reasonCode, creditMemoCreateRequest.reasonCode) &&
Objects.equals(this.invoiceId, creditMemoCreateRequest.invoiceId) &&
Objects.equals(this.transferToAccounting, creditMemoCreateRequest.transferToAccounting) &&
Objects.equals(this.customFields, creditMemoCreateRequest.customFields) &&
Objects.equals(this.excludeFromAutoApplyRules, creditMemoCreateRequest.excludeFromAutoApplyRules) &&
Objects.equals(this.currency, creditMemoCreateRequest.currency) &&
Objects.equals(this.items, creditMemoCreateRequest.items) &&
Objects.equals(this.apply, creditMemoCreateRequest.apply) &&
Objects.equals(this.post, creditMemoCreateRequest.post);
}
@Override
public int hashCode() {
return Objects.hash(accountId, accountNumber, description, documentDate, reasonCode, invoiceId, transferToAccounting, customFields, excludeFromAutoApplyRules, currency, items, apply, post);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class CreditMemoCreateRequest {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" accountNumber: ").append(toIndentedString(accountNumber)).append("\n");
sb.append(" description: ").append(toIndentedString(description)).append("\n");
sb.append(" documentDate: ").append(toIndentedString(documentDate)).append("\n");
sb.append(" reasonCode: ").append(toIndentedString(reasonCode)).append("\n");
sb.append(" invoiceId: ").append(toIndentedString(invoiceId)).append("\n");
sb.append(" transferToAccounting: ").append(toIndentedString(transferToAccounting)).append("\n");
sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n");
sb.append(" excludeFromAutoApplyRules: ").append(toIndentedString(excludeFromAutoApplyRules)).append("\n");
sb.append(" currency: ").append(toIndentedString(currency)).append("\n");
sb.append(" items: ").append(toIndentedString(items)).append("\n");
sb.append(" apply: ").append(toIndentedString(apply)).append("\n");
sb.append(" post: ").append(toIndentedString(post)).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 ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy