Package com.chargebee.models

Class CreditNote

java.lang.Object

com.chargebee.internal.Resource<CreditNote>

com.chargebee.models.CreditNote

public class CreditNote
extends Resource<CreditNote>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreditNote.Allocation
static class	CreditNote.BillingAddress
static class	CreditNote.CreateRequest
static class	CreditNote.CreditNoteListRequest
static class	CreditNote.DeleteRequest
static class	CreditNote.Discount
static class	CreditNote.Einvoice
static class	CreditNote.ImportCreditNoteRequest
static class	CreditNote.LineItem
static class	CreditNote.LineItemAddress
static class	CreditNote.LineItemDiscount
static class	CreditNote.LineItemTax
static class	CreditNote.LineItemTier
static class	CreditNote.LinkedRefund
static class	CreditNote.PdfRequest
static enum	CreditNote.ReasonCode
static class	CreditNote.RecordRefundRequest
static class	CreditNote.RefundRequest
static class	CreditNote.RemoveTaxWithheldRefundRequest
static class	CreditNote.RetrieveRequest
static class	CreditNote.ShippingAddress
static class	CreditNote.SiteDetailsAtCreation
static enum	CreditNote.Status
static class	CreditNote.Tax
static class	CreditNote.TaxOrigin
static enum	CreditNote.Type
static class	CreditNote.VoidCreditNoteRequest

Field Summary

Fields inherited from class com.chargebee.internal.Resource

jsonObj

Constructor Summary

Constructors

Constructor	Description
CreditNote(String jsonStr)
CreditNote(org.json.JSONObject jsonObj)

Method Summary

Modifier and Type	Method	Description
List<CreditNote.Allocation>	allocations()
Long	amountAllocated()
Long	amountAvailable()
Long	amountRefunded()
CreditNote.BillingAddress	billingAddress()
String	businessEntityId()
Channel	channel()
static CreditNote.CreateRequest	create()
String	createReasonCode()
static ListRequest	creditNotesForCustomer(String id)	Deprecated.
String	currencyCode()
String	customerId()
Timestamp	date()
static CreditNote.DeleteRequest	delete(String id)
Boolean	deleted()
List<CreditNote.Discount>	discounts()
static Request	downloadEinvoice(String id)
CreditNote.Einvoice	einvoice()
Long	fractionalCorrection()
Timestamp	generatedAt()
String	id()
static CreditNote.ImportCreditNoteRequest	importCreditNote()
List<CreditNote.LineItemAddress>	lineItemAddresses()
List<CreditNote.LineItemDiscount>	lineItemDiscounts()
List<CreditNote.LineItem>	lineItems()
String	lineItemsNextOffset()
List<CreditNote.LineItemTax>	lineItemTaxes()
List<CreditNote.LineItemTier>	lineItemTiers()
List<CreditNote.LinkedRefund>	linkedRefunds()
static CreditNote.CreditNoteListRequest	list()
String	localCurrencyCode()
BigDecimal	localCurrencyExchangeRate()
static CreditNote.PdfRequest	pdf(String id)
PriceType	priceType()
CreditNote.ReasonCode	reasonCode()
static CreditNote.RecordRefundRequest	recordRefund(String id)
String	referenceInvoiceId()
static CreditNote.RefundRequest	refund(String id)
Timestamp	refundedAt()
static CreditNote.RemoveTaxWithheldRefundRequest	removeTaxWithheldRefund(String id)
static Request	resendEinvoice(String id)
Long	resourceVersion()
static CreditNote.RetrieveRequest	retrieve(String id)
Long	roundOffAmount()
static Request	sendEinvoice(String id)
CreditNote.ShippingAddress	shippingAddress()
CreditNote.SiteDetailsAtCreation	siteDetailsAtCreation()
CreditNote.Status	status()
String	subscriptionId()
Long	subTotal()
Long	subTotalInLocalCurrency()
String	taxCategory()
List<CreditNote.Tax>	taxes()
CreditNote.TaxOrigin	taxOrigin()
Long	total()
Long	totalInLocalCurrency()
CreditNote.Type	type()
Timestamp	updatedAt()
String	vatNumber()
String	vatNumberPrefix()
static CreditNote.VoidCreditNoteRequest	voidCreditNote(String id)
Timestamp	voidedAt()

Methods inherited from class com.chargebee.internal.Resource

apiVersionCheck, nullCheck, nullCheckWithoutEncoding, optBigDecimal, optBoolean, optDouble, optEnum, optInteger, optJSONArray, optJSONObject, optList, optLong, optMap, optString, optSubResource, optTimestamp, reqBigDecimal, reqBoolean, reqDouble, reqEnum, reqInteger, reqJSONArray, reqJSONObject, reqList, reqLong, reqMap, reqString, reqSubResource, reqTimestamp, toJson, toString, uri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

CreditNote

public CreditNote(String jsonStr)

CreditNote

public CreditNote(org.json.JSONObject jsonObj)

Method Details

id

public String id()

customerId

public String customerId()

subscriptionId

public String subscriptionId()

referenceInvoiceId

public String referenceInvoiceId()

type

public CreditNote.Type type()

reasonCode

public CreditNote.ReasonCode reasonCode()

status

public CreditNote.Status status()

vatNumber

public String vatNumber()

date

public Timestamp date()

priceType

public PriceType priceType()

currencyCode

public String currencyCode()

total

public Long total()

amountAllocated

public Long amountAllocated()

amountRefunded

public Long amountRefunded()

amountAvailable

public Long amountAvailable()

refundedAt

public Timestamp refundedAt()

voidedAt

public Timestamp voidedAt()

generatedAt

public Timestamp generatedAt()

resourceVersion

public Long resourceVersion()

updatedAt

public Timestamp updatedAt()

channel

public Channel channel()

lineItemsNextOffset

public String lineItemsNextOffset()

subTotal

public Long subTotal()

subTotalInLocalCurrency

public Long subTotalInLocalCurrency()

totalInLocalCurrency

public Long totalInLocalCurrency()

localCurrencyCode

public String localCurrencyCode()

roundOffAmount

public Long roundOffAmount()

fractionalCorrection

public Long fractionalCorrection()

lineItems

public List<CreditNote.LineItem> lineItems()

lineItemTiers

public List<CreditNote.LineItemTier> lineItemTiers()

lineItemDiscounts

public List<CreditNote.LineItemDiscount> lineItemDiscounts()

lineItemTaxes

public List<CreditNote.LineItemTax> lineItemTaxes()

lineItemAddresses

public List<CreditNote.LineItemAddress> lineItemAddresses()

discounts

public List<CreditNote.Discount> discounts()

taxes

public List<CreditNote.Tax> taxes()

taxOrigin

public CreditNote.TaxOrigin taxOrigin()

linkedRefunds

public List<CreditNote.LinkedRefund> linkedRefunds()

allocations

public List<CreditNote.Allocation> allocations()

deleted

public Boolean deleted()

taxCategory

public String taxCategory()

localCurrencyExchangeRate

public BigDecimal localCurrencyExchangeRate()

createReasonCode

public String createReasonCode()

vatNumberPrefix

public String vatNumberPrefix()

businessEntityId

public String businessEntityId()

shippingAddress

public CreditNote.ShippingAddress shippingAddress()

billingAddress

public CreditNote.BillingAddress billingAddress()

einvoice

public CreditNote.Einvoice einvoice()

siteDetailsAtCreation

public CreditNote.SiteDetailsAtCreation siteDetailsAtCreation()

create

public static CreditNote.CreateRequest create()

retrieve

public static CreditNote.RetrieveRequest retrieve(String id)

pdf

public static CreditNote.PdfRequest pdf(String id)

downloadEinvoice

public static Request downloadEinvoice(String id)

refund

public static CreditNote.RefundRequest refund(String id)

recordRefund

public static CreditNote.RecordRefundRequest recordRefund(String id)

voidCreditNote

public static CreditNote.VoidCreditNoteRequest voidCreditNote(String id)

list

public static CreditNote.CreditNoteListRequest list()

creditNotesForCustomer

@Deprecated
public static ListRequest creditNotesForCustomer(String id)

Deprecated.

delete

public static CreditNote.DeleteRequest delete(String id)

removeTaxWithheldRefund

public static CreditNote.RemoveTaxWithheldRefundRequest removeTaxWithheldRefund(String id)

resendEinvoice

public static Request resendEinvoice(String id)

sendEinvoice

public static Request sendEinvoice(String id)

importCreditNote

public static CreditNote.ImportCreditNoteRequest importCreditNote()