Package com.chargebee.v4.models.creditNote

Class CreditNote

java.lang.Object

com.chargebee.v4.models.creditNote.CreditNote

public class CreditNote
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreditNote.Allocations
static class	CreditNote.BillingAddress
static enum	CreditNote.Channel
static class	CreditNote.Discounts
static class	CreditNote.Einvoice
static class	CreditNote.LineItemAddresses
static class	CreditNote.LineItemDiscounts
static class	CreditNote.LineItems
static class	CreditNote.LineItemTaxes
static class	CreditNote.LineItemTiers
static class	CreditNote.LinkedRefunds
static enum	CreditNote.PriceType
static enum	CreditNote.ReasonCode
static class	CreditNote.ShippingAddress
static class	CreditNote.SiteDetailsAtCreation
static enum	CreditNote.Status
static class	CreditNote.Taxes
static class	CreditNote.TaxOrigin
static enum	CreditNote.Type

Constructor Summary

Constructors

Constructor	Description
CreditNote()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static CreditNote	fromJson(com.google.gson.JsonObject jsonObj)
static CreditNote	fromJson(String json)
static CreditNote	fromJson(Map<String,Object> map)
List<CreditNote.Allocations>	getAllocations()
Long	getAmountAllocated()
Long	getAmountAvailable()
Long	getAmountRefunded()
CreditNote.BillingAddress	getBillingAddress()
String	getBusinessEntityId()
CreditNote.Channel	getChannel()
String	getCreateReasonCode()
String	getCurrencyCode()
String	getCustomerId()
String	getCustomField(String fieldName)	Returns the value of a specific custom field.
Map<String,String>	getCustomFields()	Returns a map of custom fields.
Timestamp	getDate()
Boolean	getDeleted()
List<CreditNote.Discounts>	getDiscounts()
CreditNote.Einvoice	getEinvoice()
Long	getFractionalCorrection()
Timestamp	getGeneratedAt()
String	getId()
List<CreditNote.LineItemAddresses>	getLineItemAddresses()
List<CreditNote.LineItemDiscounts>	getLineItemDiscounts()
List<CreditNote.LineItems>	getLineItems()
String	getLineItemsNextOffset()
List<CreditNote.LineItemTaxes>	getLineItemTaxes()
List<CreditNote.LineItemTiers>	getLineItemTiers()
List<CreditNote.LinkedRefunds>	getLinkedRefunds()
String	getLocalCurrencyCode()
BigDecimal	getLocalCurrencyExchangeRate()
List<String>	getNotes()
CreditNote.PriceType	getPriceType()
CreditNote.ReasonCode	getReasonCode()
String	getReferenceInvoiceId()
Timestamp	getRefundedAt()
Long	getResourceVersion()
Long	getRoundOffAmount()
CreditNote.ShippingAddress	getShippingAddress()
CreditNote.SiteDetailsAtCreation	getSiteDetailsAtCreation()
CreditNote.Status	getStatus()
String	getSubscriptionId()
Long	getSubTotal()
Long	getSubTotalInLocalCurrency()
String	getTaxCategory()
List<CreditNote.Taxes>	getTaxes()
CreditNote.TaxOrigin	getTaxOrigin()
Long	getTotal()
Long	getTotalInLocalCurrency()
CreditNote.Type	getType()
Timestamp	getUpdatedAt()
String	getVatNumber()
String	getVatNumberPrefix()
Timestamp	getVoidedAt()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CreditNote

public CreditNote()

Method Details

getId

public String getId()

getCustomerId

public String getCustomerId()

getSubscriptionId

public String getSubscriptionId()

getReferenceInvoiceId

public String getReferenceInvoiceId()

getType

public CreditNote.Type getType()

getReasonCode

public CreditNote.ReasonCode getReasonCode()

getStatus

public CreditNote.Status getStatus()

getVatNumber

public String getVatNumber()

getDate

public Timestamp getDate()

getPriceType

public CreditNote.PriceType getPriceType()

getCurrencyCode

public String getCurrencyCode()

getTotal

public Long getTotal()

getAmountAllocated

public Long getAmountAllocated()

getAmountRefunded

public Long getAmountRefunded()

getAmountAvailable

public Long getAmountAvailable()

getRefundedAt

public Timestamp getRefundedAt()

getVoidedAt

public Timestamp getVoidedAt()

getGeneratedAt

public Timestamp getGeneratedAt()

getResourceVersion

public Long getResourceVersion()

getUpdatedAt

public Timestamp getUpdatedAt()

getChannel

public CreditNote.Channel getChannel()

getLineItemsNextOffset

public String getLineItemsNextOffset()

getSubTotal

public Long getSubTotal()

getSubTotalInLocalCurrency

public Long getSubTotalInLocalCurrency()

getTotalInLocalCurrency

public Long getTotalInLocalCurrency()

getLocalCurrencyCode

public String getLocalCurrencyCode()

getRoundOffAmount

public Long getRoundOffAmount()

getFractionalCorrection

public Long getFractionalCorrection()

getNotes

public List<String> getNotes()

getDeleted

public Boolean getDeleted()

getTaxCategory

public String getTaxCategory()

getLocalCurrencyExchangeRate

public BigDecimal getLocalCurrencyExchangeRate()

getCreateReasonCode

public String getCreateReasonCode()

getVatNumberPrefix

public String getVatNumberPrefix()

getBusinessEntityId

public String getBusinessEntityId()

getLineItems

public List<CreditNote.LineItems> getLineItems()

getLineItemTiers

public List<CreditNote.LineItemTiers> getLineItemTiers()

getLineItemDiscounts

public List<CreditNote.LineItemDiscounts> getLineItemDiscounts()

getLineItemTaxes

public List<CreditNote.LineItemTaxes> getLineItemTaxes()

getLineItemAddresses

public List<CreditNote.LineItemAddresses> getLineItemAddresses()

getDiscounts

public List<CreditNote.Discounts> getDiscounts()

getTaxes

public List<CreditNote.Taxes> getTaxes()

getTaxOrigin

public CreditNote.TaxOrigin getTaxOrigin()

getLinkedRefunds

public List<CreditNote.LinkedRefunds> getLinkedRefunds()

getAllocations

public List<CreditNote.Allocations> getAllocations()

getShippingAddress

public CreditNote.ShippingAddress getShippingAddress()

getBillingAddress

public CreditNote.BillingAddress getBillingAddress()

getEinvoice

public CreditNote.Einvoice getEinvoice()

getSiteDetailsAtCreation

public CreditNote.SiteDetailsAtCreation getSiteDetailsAtCreation()

getCustomFields

public Map<String,String> getCustomFields()

Returns a map of custom fields. Custom fields are dynamic properties that follow the pattern cf_* (e.g., cf_custom_field_name).

Returns:

map containing all custom fields

getCustomField

public String getCustomField(String fieldName)

Returns the value of a specific custom field.

Parameters:

fieldName - the name of the custom field (e.g., "cf_custom_field_name")

Returns:

the value of the custom field, or null if not present

fromJson

public static CreditNote fromJson(String json)

fromJson

public static CreditNote fromJson(Map<String,Object> map)

fromJson

public static CreditNote fromJson(com.google.gson.JsonObject jsonObj)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object