CreditNote (ChargeBee Java 3.2.0 API)

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 and 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.LineItemDiscount`
`static class`	`CreditNote.LineItemTax`
`static class`	`CreditNote.LineItemTier`
`static class`	`CreditNote.LinkedRefund`
`static class`	`CreditNote.PdfRequest`
`static class`	`CreditNote.ReasonCode`
`static class`	`CreditNote.RecordRefundRequest`
`static class`	`CreditNote.RefundRequest`
`static class`	`CreditNote.RemoveTaxWithheldRefundRequest`
`static class`	`CreditNote.ShippingAddress`
`static class`	`CreditNote.Status`
`static class`	`CreditNote.Tax`
`static class`	`CreditNote.Type`
`static class`	`CreditNote.VoidCreditNoteRequest`

Field Summary
- Fields inherited from class com.chargebee.internal.Resource
  jsonObj

Constructor Summary

Constructors
Constructor and Description

CreditNote(org.json.JSONObject jsonObj)

CreditNote(String jsonStr)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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.LineItemDiscount>`	`lineItemDiscounts()`
`List<CreditNote.LineItem>`	`lineItems()`
`List<CreditNote.LineItemTax>`	`lineItemTaxes()`
`List<CreditNote.LineItemTier>`	`lineItemTiers()`
`List<CreditNote.LinkedRefund>`	`linkedRefunds()`
`static CreditNote.CreditNoteListRequest`	`list()`
`String`	`localCurrencyCode()`
`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 Request`	`retrieve(String id)`
`Long`	`roundOffAmount()`
`CreditNote.ShippingAddress`	`shippingAddress()`
`CreditNote.Status`	`status()`
`String`	`subscriptionId()`
`Long`	`subTotal()`
`Long`	`subTotalInLocalCurrency()`
`List<CreditNote.Tax>`	`taxes()`
`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, optBigDecimal, optBoolean, optDouble, optEnum, optInteger, optJSONArray, optJSONObject, optList, optLong, optString, optSubResource, optTimestamp, reqBigDecimal, reqBoolean, reqDouble, reqEnum, reqInteger, reqJSONArray, reqJSONObject, reqList, reqLong, reqString, reqSubResource, reqTimestamp, toJson, toString, uri

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CreditNote
```
public CreditNote(String jsonStr)
```

CreditNote

public CreditNote(org.json.JSONObject jsonObj)

Method Detail

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()
```

einvoice
```
public CreditNote.Einvoice einvoice()
```

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()

discounts

public List<CreditNote.Discount> discounts()

lineItemDiscounts

public List<CreditNote.LineItemDiscount> lineItemDiscounts()

lineItemTiers

public List<CreditNote.LineItemTier> lineItemTiers()

taxes
```
public List<CreditNote.Tax> taxes()
```

lineItemTaxes

public List<CreditNote.LineItemTax> lineItemTaxes()

linkedRefunds

public List<CreditNote.LinkedRefund> linkedRefunds()

allocations

public List<CreditNote.Allocation> allocations()

deleted
```
public Boolean deleted()
```

createReasonCode
```
public String createReasonCode()
```

vatNumberPrefix
```
public String vatNumberPrefix()
```

businessEntityId
```
public String businessEntityId()
```

shippingAddress

public CreditNote.ShippingAddress shippingAddress()

billingAddress

public CreditNote.BillingAddress billingAddress()

create

public static CreditNote.CreateRequest create()

retrieve

public static Request 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)

importCreditNote

public static CreditNote.ImportCreditNoteRequest importCreditNote()

Class CreditNote

Nested Class Summary

Field Summary

Fields inherited from class com.chargebee.internal.Resource

Constructor Summary

Method Summary

Methods inherited from class com.chargebee.internal.Resource

Methods inherited from class java.lang.Object

Constructor Detail

CreditNote

CreditNote

Method Detail

id

customerId

subscriptionId

referenceInvoiceId

type

reasonCode

status

vatNumber

date

priceType

currencyCode

total

amountAllocated

amountRefunded

amountAvailable

refundedAt

voidedAt

generatedAt

resourceVersion

updatedAt

channel

einvoice

subTotal

subTotalInLocalCurrency

totalInLocalCurrency

localCurrencyCode

roundOffAmount

fractionalCorrection

lineItems

discounts

lineItemDiscounts

lineItemTiers

taxes

lineItemTaxes

linkedRefunds

allocations

deleted

createReasonCode

vatNumberPrefix

businessEntityId

shippingAddress

billingAddress

create

retrieve

pdf

downloadEinvoice

refund

recordRefund

voidCreditNote

list

creditNotesForCustomer

delete

removeTaxWithheldRefund

resendEinvoice

importCreditNote