com.chargebee.models.CreditNote Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of chargebee-java Show documentation
Show all versions of chargebee-java Show documentation
Java client library for ChargeBee API
package com.chargebee.models;
import com.chargebee.*;
import com.chargebee.internal.*;
import com.chargebee.filters.*;
import com.chargebee.filters.enums.SortOrder;
import com.chargebee.internal.HttpUtil.Method;
import com.chargebee.models.enums.*;
import org.json.*;
import java.io.*;
import java.sql.Timestamp;
import java.util.*;
public class CreditNote extends Resource {
public enum Type {
ADJUSTMENT,
REFUNDABLE,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public enum ReasonCode {
WRITE_OFF,
SUBSCRIPTION_CHANGE,
SUBSCRIPTION_CANCELLATION,
CHARGEBACK,
PRODUCT_UNSATISFACTORY,
SERVICE_UNSATISFACTORY,
ORDER_CHANGE,
ORDER_CANCELLATION,
WAIVER,
OTHER,
FRAUDULENT,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public enum Status {
ADJUSTED,
REFUNDED,
REFUND_DUE,
VOIDED,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public static class LineItem extends Resource {
public enum EntityType {
PLAN_SETUP,PLAN,ADDON,ADHOC,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public LineItem(JSONObject jsonObj) {
super(jsonObj);
}
public String id() {
return optString("id");
}
public String subscriptionId() {
return optString("subscription_id");
}
public Timestamp dateFrom() {
return reqTimestamp("date_from");
}
public Timestamp dateTo() {
return reqTimestamp("date_to");
}
public Integer unitAmount() {
return reqInteger("unit_amount");
}
public Integer quantity() {
return optInteger("quantity");
}
public Boolean isTaxed() {
return reqBoolean("is_taxed");
}
public Integer taxAmount() {
return optInteger("tax_amount");
}
public Double taxRate() {
return optDouble("tax_rate");
}
public Integer amount() {
return reqInteger("amount");
}
public Integer discountAmount() {
return optInteger("discount_amount");
}
public Integer itemLevelDiscountAmount() {
return optInteger("item_level_discount_amount");
}
public String description() {
return reqString("description");
}
public EntityType entityType() {
return reqEnum("entity_type", EntityType.class);
}
public TaxExemptReason taxExemptReason() {
return optEnum("tax_exempt_reason", TaxExemptReason.class);
}
public String entityId() {
return optString("entity_id");
}
}
public static class Discount extends Resource {
public enum EntityType {
ITEM_LEVEL_COUPON,DOCUMENT_LEVEL_COUPON,PROMOTIONAL_CREDITS,PRORATED_CREDITS,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public Discount(JSONObject jsonObj) {
super(jsonObj);
}
public Integer amount() {
return reqInteger("amount");
}
public String description() {
return optString("description");
}
public EntityType entityType() {
return reqEnum("entity_type", EntityType.class);
}
public String entityId() {
return optString("entity_id");
}
}
public static class LineItemDiscount extends Resource {
public enum DiscountType {
ITEM_LEVEL_COUPON,DOCUMENT_LEVEL_COUPON,PROMOTIONAL_CREDITS,PRORATED_CREDITS,
_UNKNOWN; /*Indicates unexpected value for this enum. You can get this when there is a
java-client version incompatibility. We suggest you to upgrade to the latest version */
}
public LineItemDiscount(JSONObject jsonObj) {
super(jsonObj);
}
public String lineItemId() {
return reqString("line_item_id");
}
public DiscountType discountType() {
return reqEnum("discount_type", DiscountType.class);
}
public String couponId() {
return optString("coupon_id");
}
public Integer discountAmount() {
return reqInteger("discount_amount");
}
}
public static class Tax extends Resource {
public Tax(JSONObject jsonObj) {
super(jsonObj);
}
public String name() {
return reqString("name");
}
public Integer amount() {
return reqInteger("amount");
}
public String description() {
return optString("description");
}
}
public static class LineItemTax extends Resource {
public LineItemTax(JSONObject jsonObj) {
super(jsonObj);
}
public String lineItemId() {
return optString("line_item_id");
}
public String taxName() {
return reqString("tax_name");
}
public Double taxRate() {
return reqDouble("tax_rate");
}
public Integer taxAmount() {
return reqInteger("tax_amount");
}
public TaxJurisType taxJurisType() {
return optEnum("tax_juris_type", TaxJurisType.class);
}
public String taxJurisName() {
return optString("tax_juris_name");
}
public String taxJurisCode() {
return optString("tax_juris_code");
}
}
public static class LinkedRefund extends Resource {
public LinkedRefund(JSONObject jsonObj) {
super(jsonObj);
}
public String txnId() {
return reqString("txn_id");
}
public Integer appliedAmount() {
return reqInteger("applied_amount");
}
public Timestamp appliedAt() {
return reqTimestamp("applied_at");
}
public Transaction.Status txnStatus() {
return optEnum("txn_status", Transaction.Status.class);
}
public Timestamp txnDate() {
return optTimestamp("txn_date");
}
public Integer txnAmount() {
return optInteger("txn_amount");
}
}
public static class Allocation extends Resource {
public Allocation(JSONObject jsonObj) {
super(jsonObj);
}
public String invoiceId() {
return reqString("invoice_id");
}
public Integer allocatedAmount() {
return reqInteger("allocated_amount");
}
public Timestamp allocatedAt() {
return reqTimestamp("allocated_at");
}
public Timestamp invoiceDate() {
return optTimestamp("invoice_date");
}
public Invoice.Status invoiceStatus() {
return reqEnum("invoice_status", Invoice.Status.class);
}
}
//Constructors
//============
public CreditNote(String jsonStr) {
super(jsonStr);
}
public CreditNote(JSONObject jsonObj) {
super(jsonObj);
}
// Fields
//=======
public String id() {
return reqString("id");
}
public String customerId() {
return reqString("customer_id");
}
public String subscriptionId() {
return optString("subscription_id");
}
public String referenceInvoiceId() {
return reqString("reference_invoice_id");
}
public Type type() {
return reqEnum("type", Type.class);
}
public ReasonCode reasonCode() {
return reqEnum("reason_code", ReasonCode.class);
}
public Status status() {
return reqEnum("status", Status.class);
}
public String vatNumber() {
return optString("vat_number");
}
public Timestamp date() {
return optTimestamp("date");
}
public PriceType priceType() {
return reqEnum("price_type", PriceType.class);
}
public String currencyCode() {
return reqString("currency_code");
}
public Integer total() {
return optInteger("total");
}
public Integer amountAllocated() {
return optInteger("amount_allocated");
}
public Integer amountRefunded() {
return optInteger("amount_refunded");
}
public Integer amountAvailable() {
return optInteger("amount_available");
}
public Timestamp refundedAt() {
return optTimestamp("refunded_at");
}
public Timestamp voidedAt() {
return optTimestamp("voided_at");
}
public Long resourceVersion() {
return optLong("resource_version");
}
public Timestamp updatedAt() {
return optTimestamp("updated_at");
}
public Integer subTotal() {
return reqInteger("sub_total");
}
public Integer roundOffAmount() {
return optInteger("round_off_amount");
}
public List lineItems() {
return optList("line_items", CreditNote.LineItem.class);
}
public List discounts() {
return optList("discounts", CreditNote.Discount.class);
}
public List lineItemDiscounts() {
return optList("line_item_discounts", CreditNote.LineItemDiscount.class);
}
public List taxes() {
return optList("taxes", CreditNote.Tax.class);
}
public List lineItemTaxes() {
return optList("line_item_taxes", CreditNote.LineItemTax.class);
}
public List linkedRefunds() {
return optList("linked_refunds", CreditNote.LinkedRefund.class);
}
public List allocations() {
return optList("allocations", CreditNote.Allocation.class);
}
public Boolean deleted() {
return reqBoolean("deleted");
}
// Operations
//===========
public static CreateRequest create() throws IOException {
String uri = uri("credit_notes");
return new CreateRequest(Method.POST, uri);
}
public static Request retrieve(String id) throws IOException {
String uri = uri("credit_notes", nullCheck(id));
return new Request(Method.GET, uri);
}
public static PdfRequest pdf(String id) throws IOException {
String uri = uri("credit_notes", nullCheck(id), "pdf");
return new PdfRequest(Method.POST, uri);
}
public static RecordRefundRequest recordRefund(String id) throws IOException {
String uri = uri("credit_notes", nullCheck(id), "record_refund");
return new RecordRefundRequest(Method.POST, uri);
}
public static VoidCreditNoteRequest voidCreditNote(String id) throws IOException {
String uri = uri("credit_notes", nullCheck(id), "void");
return new VoidCreditNoteRequest(Method.POST, uri);
}
public static CreditNoteListRequest list() throws IOException {
String uri = uri("credit_notes");
return new CreditNoteListRequest(uri);
}
@Deprecated
public static ListRequest creditNotesForCustomer(String id) throws IOException {
String uri = uri("customers", nullCheck(id), "credit_notes");
return new ListRequest(uri);
}
public static DeleteRequest delete(String id) throws IOException {
String uri = uri("credit_notes", nullCheck(id), "delete");
return new DeleteRequest(Method.POST, uri);
}
// Operation Request Classes
//==========================
public static class CreateRequest extends Request {
private CreateRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public CreateRequest referenceInvoiceId(String referenceInvoiceId) {
params.add("reference_invoice_id", referenceInvoiceId);
return this;
}
public CreateRequest total(Integer total) {
params.addOpt("total", total);
return this;
}
public CreateRequest type(CreditNote.Type type) {
params.add("type", type);
return this;
}
public CreateRequest reasonCode(CreditNote.ReasonCode reasonCode) {
params.add("reason_code", reasonCode);
return this;
}
public CreateRequest date(Timestamp date) {
params.addOpt("date", date);
return this;
}
public CreateRequest customerNotes(String customerNotes) {
params.addOpt("customer_notes", customerNotes);
return this;
}
public CreateRequest lineItemReferenceLineItemId(int index, String lineItemReferenceLineItemId) {
params.add("line_items[reference_line_item_id][" + index + "]", lineItemReferenceLineItemId);
return this;
}
public CreateRequest lineItemUnitAmount(int index, Integer lineItemUnitAmount) {
params.add("line_items[unit_amount][" + index + "]", lineItemUnitAmount);
return this;
}
public CreateRequest lineItemQuantity(int index, Integer lineItemQuantity) {
params.add("line_items[quantity][" + index + "]", lineItemQuantity);
return this;
}
public CreateRequest lineItemDescription(int index, String lineItemDescription) {
params.addOpt("line_items[description][" + index + "]", lineItemDescription);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class PdfRequest extends Request {
private PdfRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public PdfRequest dispositionType(com.chargebee.models.enums.DispositionType dispositionType) {
params.addOpt("disposition_type", dispositionType);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class RecordRefundRequest extends Request {
private RecordRefundRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public RecordRefundRequest comment(String comment) {
params.addOpt("comment", comment);
return this;
}
public RecordRefundRequest transactionAmount(Integer transactionAmount) {
params.addOpt("transaction[amount]", transactionAmount);
return this;
}
public RecordRefundRequest transactionPaymentMethod(com.chargebee.models.enums.PaymentMethod transactionPaymentMethod) {
params.add("transaction[payment_method]", transactionPaymentMethod);
return this;
}
public RecordRefundRequest transactionReferenceNumber(String transactionReferenceNumber) {
params.addOpt("transaction[reference_number]", transactionReferenceNumber);
return this;
}
public RecordRefundRequest transactionDate(Timestamp transactionDate) {
params.add("transaction[date]", transactionDate);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class VoidCreditNoteRequest extends Request {
private VoidCreditNoteRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public VoidCreditNoteRequest comment(String comment) {
params.addOpt("comment", comment);
return this;
}
@Override
public Params params() {
return params;
}
}
public static class CreditNoteListRequest extends ListRequest {
private CreditNoteListRequest(String uri) {
super(uri);
}
public CreditNoteListRequest includeDeleted(Boolean includeDeleted) {
params.addOpt("include_deleted", includeDeleted);
return this;
}
public StringFilter id() {
return new StringFilter("id",this).supportsMultiOperators(true);
}
public StringFilter customerId() {
return new StringFilter("customer_id",this).supportsMultiOperators(true);
}
public StringFilter subscriptionId() {
return new StringFilter("subscription_id",this).supportsMultiOperators(true).supportsPresenceOperator(true);
}
public StringFilter referenceInvoiceId() {
return new StringFilter("reference_invoice_id",this).supportsMultiOperators(true);
}
public EnumFilter type() {
return new EnumFilter("type",this);
}
public EnumFilter reasonCode() {
return new EnumFilter("reason_code",this);
}
public EnumFilter status() {
return new EnumFilter("status",this);
}
public TimestampFilter date() {
return new TimestampFilter("date",this);
}
public NumberFilter total() {
return new NumberFilter("total",this);
}
public EnumFilter priceType() {
return new EnumFilter("price_type",this);
}
public NumberFilter amountAllocated() {
return new NumberFilter("amount_allocated",this);
}
public NumberFilter amountRefunded() {
return new NumberFilter("amount_refunded",this);
}
public NumberFilter amountAvailable() {
return new NumberFilter("amount_available",this);
}
public TimestampFilter voidedAt() {
return new TimestampFilter("voided_at",this);
}
public TimestampFilter updatedAt() {
return new TimestampFilter("updated_at",this);
}
public CreditNoteListRequest sortByDate(SortOrder order) {
params.addOpt("sort_by["+order.name().toLowerCase()+"]","date");
return this;
}
@Override
public Params params() {
return params;
}
}
public static class DeleteRequest extends Request {
private DeleteRequest(Method httpMeth, String uri) {
super(httpMeth, uri);
}
public DeleteRequest comment(String comment) {
params.addOpt("comment", comment);
return this;
}
@Override
public Params params() {
return params;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy