com.stripe.param.CreditNoteCreateParams Maven / Gradle / Ivy
// Generated by delombok at Wed Jun 10 17:29:56 PDT 2020
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class CreditNoteCreateParams extends ApiRequestParams {
/**
* The integer amount in %s representing the total amount of the credit note.
*/
@SerializedName("amount")
Long amount;
/**
* The integer amount in %s representing the amount to credit the customer's
* balance, which will be automatically applied to their next invoice.
*/
@SerializedName("credit_amount")
Long creditAmount;
/**
* Specifies which fields in the response should be expanded.
*/
@SerializedName("expand")
List expand;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* ID of the invoice.
*/
@SerializedName("invoice")
String invoice;
/**
* Line items that make up the credit note.
*/
@SerializedName("lines")
List lines;
/**
* The credit note's memo appears on the credit note PDF.
*/
@SerializedName("memo")
String memo;
/**
* Set of key-value pairs that you can attach to an object. This can be useful for storing
* additional information about the object in a structured format. Individual keys can be unset by
* posting an empty value to them. All keys can be unset by posting an empty value to {@code
* metadata}.
*/
@SerializedName("metadata")
Map metadata;
/**
* The integer amount in %s representing the amount that is credited outside of
* Stripe.
*/
@SerializedName("out_of_band_amount")
Long outOfBandAmount;
/**
* Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code
* order_change}, or {@code product_unsatisfactory}.
*/
@SerializedName("reason")
Reason reason;
/**
* ID of an existing refund to link this credit note to.
*/
@SerializedName("refund")
String refund;
/**
* The integer amount in %s representing the amount to refund. If set, a refund
* will be created for the charge associated with the invoice.
*/
@SerializedName("refund_amount")
Long refundAmount;
private CreditNoteCreateParams(Long amount, Long creditAmount, List expand, Map extraParams, String invoice, List lines, String memo, Map metadata, Long outOfBandAmount, Reason reason, String refund, Long refundAmount) {
this.amount = amount;
this.creditAmount = creditAmount;
this.expand = expand;
this.extraParams = extraParams;
this.invoice = invoice;
this.lines = lines;
this.memo = memo;
this.metadata = metadata;
this.outOfBandAmount = outOfBandAmount;
this.reason = reason;
this.refund = refund;
this.refundAmount = refundAmount;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private Long creditAmount;
private List expand;
private Map extraParams;
private String invoice;
private List lines;
private String memo;
private Map metadata;
private Long outOfBandAmount;
private Reason reason;
private String refund;
private Long refundAmount;
/**
* Finalize and obtain parameter instance from this builder.
*/
public CreditNoteCreateParams build() {
return new CreditNoteCreateParams(this.amount, this.creditAmount, this.expand, this.extraParams, this.invoice, this.lines, this.memo, this.metadata, this.outOfBandAmount, this.reason, this.refund, this.refundAmount);
}
/**
* The integer amount in %s representing the total amount of the credit note.
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* The integer amount in %s representing the amount to credit the customer's
* balance, which will be automatically applied to their next invoice.
*/
public Builder setCreditAmount(Long creditAmount) {
this.creditAmount = creditAmount;
return this;
}
/**
* Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* CreditNoteCreateParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link CreditNoteCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* ID of the invoice.
*/
public Builder setInvoice(String invoice) {
this.invoice = invoice;
return this;
}
/**
* Add an element to `lines` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#lines} for the field documentation.
*/
public Builder addLine(Line element) {
if (this.lines == null) {
this.lines = new ArrayList<>();
}
this.lines.add(element);
return this;
}
/**
* Add all elements to `lines` list. A list is initialized for the first `add/addAll` call, and
* subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams#lines} for the field documentation.
*/
public Builder addAllLine(List elements) {
if (this.lines == null) {
this.lines = new ArrayList<>();
}
this.lines.addAll(elements);
return this;
}
/**
* The credit note's memo appears on the credit note PDF.
*/
public Builder setMemo(String memo) {
this.memo = memo;
return this;
}
/**
* Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call,
* and subsequent calls add additional key/value pairs to the original map. See {@link
* CreditNoteCreateParams#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `metadata` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link CreditNoteCreateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/**
* The integer amount in %s representing the amount that is credited outside of
* Stripe.
*/
public Builder setOutOfBandAmount(Long outOfBandAmount) {
this.outOfBandAmount = outOfBandAmount;
return this;
}
/**
* Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code
* order_change}, or {@code product_unsatisfactory}.
*/
public Builder setReason(Reason reason) {
this.reason = reason;
return this;
}
/**
* ID of an existing refund to link this credit note to.
*/
public Builder setRefund(String refund) {
this.refund = refund;
return this;
}
/**
* The integer amount in %s representing the amount to refund. If set, a refund
* will be created for the charge associated with the invoice.
*/
public Builder setRefundAmount(Long refundAmount) {
this.refundAmount = refundAmount;
return this;
}
}
public static class Line {
/**
* The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item} and
* the referenced invoice line item does not have a quantity, only an amount.
*/
@SerializedName("amount")
Long amount;
/**
* The description of the credit note line item. Only valid when the {@code type} is {@code
* custom_line_item}.
*/
@SerializedName("description")
String description;
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* The invoice line item to credit. Only valid when the {@code type} is {@code
* invoice_line_item}.
*/
@SerializedName("invoice_line_item")
String invoiceLineItem;
/**
* The line item quantity to credit.
*/
@SerializedName("quantity")
Long quantity;
/**
* The tax rates which apply to the credit note line item. Only valid when the {@code type} is
* {@code custom_line_item}.
*/
@SerializedName("tax_rates")
Object taxRates;
/**
* Type of the credit note line item, one of {@code invoice_line_item} or {@code
* custom_line_item}.
*/
@SerializedName("type")
Type type;
/**
* The integer unit amount in %s of the credit note line item. This {@code
* unit_amount} will be multiplied by the quantity to get the full amount to credit for this
* line item. Only valid when {@code type} is {@code custom_line_item}.
*/
@SerializedName("unit_amount")
Long unitAmount;
/**
* Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only
* one of {@code unit_amount} and {@code unit_amount_decimal} can be set.
*/
@SerializedName("unit_amount_decimal")
BigDecimal unitAmountDecimal;
private Line(Long amount, String description, Map extraParams, String invoiceLineItem, Long quantity, Object taxRates, Type type, Long unitAmount, BigDecimal unitAmountDecimal) {
this.amount = amount;
this.description = description;
this.extraParams = extraParams;
this.invoiceLineItem = invoiceLineItem;
this.quantity = quantity;
this.taxRates = taxRates;
this.type = type;
this.unitAmount = unitAmount;
this.unitAmountDecimal = unitAmountDecimal;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private String description;
private Map extraParams;
private String invoiceLineItem;
private Long quantity;
private Object taxRates;
private Type type;
private Long unitAmount;
private BigDecimal unitAmountDecimal;
/**
* Finalize and obtain parameter instance from this builder.
*/
public Line build() {
return new Line(this.amount, this.description, this.extraParams, this.invoiceLineItem, this.quantity, this.taxRates, this.type, this.unitAmount, this.unitAmountDecimal);
}
/**
* The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item}
* and the referenced invoice line item does not have a quantity, only an amount.
*/
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* The description of the credit note line item. Only valid when the {@code type} is {@code
* custom_line_item}.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll`
* call, and subsequent calls add additional key/value pairs to the original map. See {@link
* CreditNoteCreateParams.Line#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* Add all map key/value pairs to `extraParams` map. A map is initialized for the first
* `put/putAll` call, and subsequent calls add additional key/value pairs to the original map.
* See {@link CreditNoteCreateParams.Line#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* The invoice line item to credit. Only valid when the {@code type} is {@code
* invoice_line_item}.
*/
public Builder setInvoiceLineItem(String invoiceLineItem) {
this.invoiceLineItem = invoiceLineItem;
return this;
}
/**
* The line item quantity to credit.
*/
public Builder setQuantity(Long quantity) {
this.quantity = quantity;
return this;
}
/**
* Add an element to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams.Line#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addTaxRate(String element) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).add(element);
return this;
}
/**
* Add all elements to `taxRates` list. A list is initialized for the first `add/addAll` call,
* and subsequent calls adds additional elements to the original list. See {@link
* CreditNoteCreateParams.Line#taxRates} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder addAllTaxRate(List elements) {
if (this.taxRates == null || this.taxRates instanceof EmptyParam) {
this.taxRates = new ArrayList();
}
((List) this.taxRates).addAll(elements);
return this;
}
/**
* The tax rates which apply to the credit note line item. Only valid when the {@code type} is
* {@code custom_line_item}.
*/
public Builder setTaxRates(EmptyParam taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* The tax rates which apply to the credit note line item. Only valid when the {@code type} is
* {@code custom_line_item}.
*/
public Builder setTaxRates(List taxRates) {
this.taxRates = taxRates;
return this;
}
/**
* Type of the credit note line item, one of {@code invoice_line_item} or {@code
* custom_line_item}.
*/
public Builder setType(Type type) {
this.type = type;
return this;
}
/**
* The integer unit amount in %s of the credit note line item. This {@code
* unit_amount} will be multiplied by the quantity to get the full amount to credit for this
* line item. Only valid when {@code type} is {@code custom_line_item}.
*/
public Builder setUnitAmount(Long unitAmount) {
this.unitAmount = unitAmount;
return this;
}
/**
* Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places.
* Only one of {@code unit_amount} and {@code unit_amount_decimal} can be set.
*/
public Builder setUnitAmountDecimal(BigDecimal unitAmountDecimal) {
this.unitAmountDecimal = unitAmountDecimal;
return this;
}
}
public enum Type implements ApiRequestParams.EnumParam {
@SerializedName("custom_line_item")
CUSTOM_LINE_ITEM("custom_line_item"), @SerializedName("invoice_line_item")
INVOICE_LINE_ITEM("invoice_line_item");
private final String value;
Type(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
/**
* The line item amount to credit. Only valid when {@code type} is {@code invoice_line_item} and
* the referenced invoice line item does not have a quantity, only an amount.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getAmount() {
return this.amount;
}
/**
* The description of the credit note line item. Only valid when the {@code type} is {@code
* custom_line_item}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getDescription() {
return this.description;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* The invoice line item to credit. Only valid when the {@code type} is {@code
* invoice_line_item}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getInvoiceLineItem() {
return this.invoiceLineItem;
}
/**
* The line item quantity to credit.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getQuantity() {
return this.quantity;
}
/**
* The tax rates which apply to the credit note line item. Only valid when the {@code type} is
* {@code custom_line_item}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Object getTaxRates() {
return this.taxRates;
}
/**
* Type of the credit note line item, one of {@code invoice_line_item} or {@code
* custom_line_item}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Type getType() {
return this.type;
}
/**
* The integer unit amount in %s of the credit note line item. This {@code
* unit_amount} will be multiplied by the quantity to get the full amount to credit for this
* line item. Only valid when {@code type} is {@code custom_line_item}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getUnitAmount() {
return this.unitAmount;
}
/**
* Same as {@code unit_amount}, but accepts a decimal value with at most 12 decimal places. Only
* one of {@code unit_amount} and {@code unit_amount_decimal} can be set.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public BigDecimal getUnitAmountDecimal() {
return this.unitAmountDecimal;
}
}
public enum Reason implements ApiRequestParams.EnumParam {
@SerializedName("duplicate")
DUPLICATE("duplicate"), @SerializedName("fraudulent")
FRAUDULENT("fraudulent"), @SerializedName("order_change")
ORDER_CHANGE("order_change"), @SerializedName("product_unsatisfactory")
PRODUCT_UNSATISFACTORY("product_unsatisfactory");
private final String value;
Reason(String value) {
this.value = value;
}
@Override
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getValue() {
return this.value;
}
}
/**
* The integer amount in %s representing the total amount of the credit note.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getAmount() {
return this.amount;
}
/**
* The integer amount in %s representing the amount to credit the customer's
* balance, which will be automatically applied to their next invoice.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getCreditAmount() {
return this.creditAmount;
}
/**
* Specifies which fields in the response should be expanded.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getExpand() {
return this.expand;
}
/**
* Map of extra parameters for custom features not available in this client library. The content
* in this map is not serialized under this field's {@code @SerializedName} value. Instead, each
* key/value pair is serialized as if the key is a root-level field (serialized) name in this
* param object. Effectively, this map is flattened to its parent instance.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getExtraParams() {
return this.extraParams;
}
/**
* ID of the invoice.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getInvoice() {
return this.invoice;
}
/**
* Line items that make up the credit note.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public List getLines() {
return this.lines;
}
/**
* The credit note's memo appears on the credit note PDF.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getMemo() {
return this.memo;
}
/**
* Set of key-value pairs that you can attach to an object. This can be useful for storing
* additional information about the object in a structured format. Individual keys can be unset by
* posting an empty value to them. All keys can be unset by posting an empty value to {@code
* metadata}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Map getMetadata() {
return this.metadata;
}
/**
* The integer amount in %s representing the amount that is credited outside of
* Stripe.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getOutOfBandAmount() {
return this.outOfBandAmount;
}
/**
* Reason for issuing this credit note, one of {@code duplicate}, {@code fraudulent}, {@code
* order_change}, or {@code product_unsatisfactory}.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Reason getReason() {
return this.reason;
}
/**
* ID of an existing refund to link this credit note to.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public String getRefund() {
return this.refund;
}
/**
* The integer amount in %s representing the amount to refund. If set, a refund
* will be created for the charge associated with the invoice.
*/
@java.lang.SuppressWarnings("all")
@lombok.Generated
public Long getRefundAmount() {
return this.refundAmount;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy