Invoice (ChargeBee Java 2.28.0 API)

java.lang.Object
- com.chargebee.internal.Resource<Invoice>
- - com.chargebee.models.Invoice

public class Invoice
extends Resource<Invoice>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Invoice.AddAddonChargeRequest`
`static class`	`Invoice.AddChargeItemRequest`
`static class`	`Invoice.AddChargeRequest`
`static class`	`Invoice.AdjustmentCreditNote`
`static class`	`Invoice.AppliedCredit`
`static class`	`Invoice.ApplyCreditsRequest`
`static class`	`Invoice.ApplyPaymentsRequest`
`static class`	`Invoice.BillingAddress`
`static class`	`Invoice.ChargeAddonRequest`
`static class`	`Invoice.ChargeRequest`
`static class`	`Invoice.CloseRequest`
`static class`	`Invoice.CollectPaymentRequest`
`static class`	`Invoice.CreateForChargeItemRequest`
`static class`	`Invoice.CreateForChargeItemsAndChargesRequest`
`static class`	`Invoice.CreateRequest`
`static class`	`Invoice.DeleteLineItemsRequest`
`static class`	`Invoice.DeleteRequest`
`static class`	`Invoice.Discount`
`static class`	`Invoice.DunningAttempt`
`static class`	`Invoice.DunningStatus`
`static class`	`Invoice.Einvoice`
`static class`	`Invoice.ImportInvoiceRequest`
`static class`	`Invoice.InvoiceListPaymentReferenceNumbersRequest`
`static class`	`Invoice.InvoiceListRequest`
`static class`	`Invoice.IssuedCreditNote`
`static class`	`Invoice.LineItem`
`static class`	`Invoice.LineItemDiscount`
`static class`	`Invoice.LineItemTax`
`static class`	`Invoice.LineItemTier`
`static class`	`Invoice.LinkedOrder`
`static class`	`Invoice.LinkedPayment`
`static class`	`Invoice.Note`
`static class`	`Invoice.PdfRequest`
`static class`	`Invoice.RecordPaymentRequest`
`static class`	`Invoice.RecordRefundRequest`
`static class`	`Invoice.RecordTaxWithheldRequest`
`static class`	`Invoice.RefundRequest`
`static class`	`Invoice.RemoveCreditNoteRequest`
`static class`	`Invoice.RemovePaymentRequest`
`static class`	`Invoice.RemoveTaxWithheldRequest`
`static class`	`Invoice.ShippingAddress`
`static class`	`Invoice.Status`
`static class`	`Invoice.StopDunningRequest`
`static class`	`Invoice.Tax`
`static class`	`Invoice.UpdateDetailsRequest`
`static class`	`Invoice.VoidInvoiceRequest`
`static class`	`Invoice.WriteOffRequest`

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

Constructor Summary

Constructors
Constructor and Description

Invoice(org.json.JSONObject jsonObj)

Invoice(String jsonStr)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Invoice.AddAddonChargeRequest`	`addAddonCharge(String id)`
`static Invoice.AddChargeRequest`	`addCharge(String id)`
`static Invoice.AddChargeItemRequest`	`addChargeItem(String id)`
`List<Invoice.AdjustmentCreditNote>`	`adjustmentCreditNotes()`
`Integer`	`amountAdjusted()`
`Integer`	`amountDue()`
`Integer`	`amountPaid()`
`Integer`	`amountToCollect()`
`List<Invoice.AppliedCredit>`	`appliedCredits()`
`static Invoice.ApplyCreditsRequest`	`applyCredits(String id)`
`static Invoice.ApplyPaymentsRequest`	`applyPayments(String id)`
`Invoice.BillingAddress`	`billingAddress()`
`String`	`businessEntityId()`
`Channel`	`channel()`
`static Invoice.ChargeRequest`	`charge()`
`static Invoice.ChargeAddonRequest`	`chargeAddon()`
`static Invoice.CloseRequest`	`close(String id)`
`static Invoice.CollectPaymentRequest`	`collectPayment(String id)`
`static Invoice.CreateRequest`	`create()`
`static Invoice.CreateForChargeItemRequest`	`createForChargeItem()` Deprecated.
`static Invoice.CreateForChargeItemsAndChargesRequest`	`createForChargeItemsAndCharges()`
`Integer`	`creditsApplied()`
`String`	`currencyCode()`
`String`	`customerId()`
`Timestamp`	`date()`
`static Invoice.DeleteRequest`	`delete(String id)`
`Boolean`	`deleted()`
`static Invoice.DeleteLineItemsRequest`	`deleteLineItems(String id)`
`List<Invoice.Discount>`	`discounts()`
`static Request`	`downloadEinvoice(String id)`
`Timestamp`	`dueDate()`
`List<Invoice.DunningAttempt>`	`dunningAttempts()`
`Invoice.DunningStatus`	`dunningStatus()`
`Invoice.Einvoice`	`einvoice()`
`BigDecimal`	`exchangeRate()`
`Timestamp`	`expectedPaymentDate()`
`Boolean`	`firstInvoice()`
`Timestamp`	`generatedAt()`
`Boolean`	`hasAdvanceCharges()`
`String`	`id()`
`static Invoice.ImportInvoiceRequest`	`importInvoice()`
`static ListRequest`	`invoicesForCustomer(String id)` Deprecated.
`static ListRequest`	`invoicesForSubscription(String id)` Deprecated.
`Boolean`	`isGifted()`
`List<Invoice.IssuedCreditNote>`	`issuedCreditNotes()`
`List<Invoice.LineItemDiscount>`	`lineItemDiscounts()`
`List<Invoice.LineItem>`	`lineItems()`
`List<Invoice.LineItemTax>`	`lineItemTaxes()`
`List<Invoice.LineItemTier>`	`lineItemTiers()`
`List<Invoice.LinkedOrder>`	`linkedOrders()`
`List<Invoice.LinkedPayment>`	`linkedPayments()`
`static Invoice.InvoiceListRequest`	`list()`
`static Invoice.InvoiceListPaymentReferenceNumbersRequest`	`listPaymentReferenceNumbers()`
`String`	`localCurrencyCode()`
`BigDecimal`	`localCurrencyExchangeRate()`
`Integer`	`netTermDays()`
`Integer`	`newSalesAmount()`
`Timestamp`	`nextRetryAt()`
`List<Invoice.Note>`	`notes()`
`Timestamp`	`paidAt()`
`String`	`paymentOwner()`
`static Invoice.PdfRequest`	`pdf(String id)`
`String`	`poNumber()`
`PriceType`	`priceType()`
`static Invoice.RecordPaymentRequest`	`recordPayment(String id)`
`static Invoice.RecordRefundRequest`	`recordRefund(String id)`
`static Invoice.RecordTaxWithheldRequest`	`recordTaxWithheld(String id)`
`Boolean`	`recurring()`
`static Invoice.RefundRequest`	`refund(String id)`
`static Invoice.RemoveCreditNoteRequest`	`removeCreditNote(String id)`
`static Invoice.RemovePaymentRequest`	`removePayment(String id)`
`static Invoice.RemoveTaxWithheldRequest`	`removeTaxWithheld(String id)`
`static Request`	`resendEinvoice(String id)`
`Long`	`resourceVersion()`
`static Request`	`retrieve(String id)`
`Integer`	`roundOffAmount()`
`static Request`	`sendEinvoice(String id)`
`Invoice.ShippingAddress`	`shippingAddress()`
`Invoice.Status`	`status()`
`static Invoice.StopDunningRequest`	`stopDunning(String id)`
`String`	`subscriptionId()`
`Integer`	`subTotal()`
`Integer`	`subTotalInLocalCurrency()`
`static Request`	`syncUsages(String id)`
`Integer`	`tax()`
`List<Invoice.Tax>`	`taxes()`
`Boolean`	`termFinalized()`
`Integer`	`total()`
`Integer`	`totalInLocalCurrency()`
`Timestamp`	`updatedAt()`
`static Invoice.UpdateDetailsRequest`	`updateDetails(String id)`
`String`	`vatNumber()`
`String`	`vatNumberPrefix()`
`Timestamp`	`voidedAt()`
`static Invoice.VoidInvoiceRequest`	`voidInvoice(String id)`
`String`	`voidReasonCode()`
`static Invoice.WriteOffRequest`	`writeOff(String id)`
`Integer`	`writeOffAmount()`

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

Invoice
```
public Invoice(String jsonStr)
```

Invoice

public Invoice(org.json.JSONObject jsonObj)

Method Detail

id
```
public String id()
```

poNumber
```
public String poNumber()
```

customerId
```
public String customerId()
```

subscriptionId
```
public String subscriptionId()
```

recurring
```
public Boolean recurring()
```

status
```
public Invoice.Status status()
```

vatNumber
```
public String vatNumber()
```

priceType
```
public PriceType priceType()
```

date
```
public Timestamp date()
```

dueDate
```
public Timestamp dueDate()
```

netTermDays
```
public Integer netTermDays()
```

exchangeRate
```
public BigDecimal exchangeRate()
```

currencyCode
```
public String currencyCode()
```

total
```
public Integer total()
```

amountPaid
```
public Integer amountPaid()
```

amountAdjusted
```
public Integer amountAdjusted()
```

writeOffAmount
```
public Integer writeOffAmount()
```

creditsApplied
```
public Integer creditsApplied()
```

amountDue
```
public Integer amountDue()
```

paidAt
```
public Timestamp paidAt()
```

dunningStatus

public Invoice.DunningStatus dunningStatus()

nextRetryAt
```
public Timestamp nextRetryAt()
```

voidedAt
```
public Timestamp voidedAt()
```

resourceVersion
```
public Long resourceVersion()
```

updatedAt
```
public Timestamp updatedAt()
```

subTotal
```
public Integer subTotal()
```

subTotalInLocalCurrency

public Integer subTotalInLocalCurrency()

totalInLocalCurrency
```
public Integer totalInLocalCurrency()
```

localCurrencyCode
```
public String localCurrencyCode()
```

tax
```
public Integer tax()
```

localCurrencyExchangeRate

public BigDecimal localCurrencyExchangeRate()

firstInvoice
```
public Boolean firstInvoice()
```

newSalesAmount
```
public Integer newSalesAmount()
```

hasAdvanceCharges
```
public Boolean hasAdvanceCharges()
```

termFinalized
```
public Boolean termFinalized()
```

isGifted
```
public Boolean isGifted()
```

generatedAt
```
public Timestamp generatedAt()
```

expectedPaymentDate

public Timestamp expectedPaymentDate()

amountToCollect
```
public Integer amountToCollect()
```

roundOffAmount
```
public Integer roundOffAmount()
```

lineItems

public List<Invoice.LineItem> lineItems()

discounts

public List<Invoice.Discount> discounts()

lineItemDiscounts

public List<Invoice.LineItemDiscount> lineItemDiscounts()

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

lineItemTaxes

public List<Invoice.LineItemTax> lineItemTaxes()

lineItemTiers

public List<Invoice.LineItemTier> lineItemTiers()

linkedPayments

public List<Invoice.LinkedPayment> linkedPayments()

dunningAttempts

public List<Invoice.DunningAttempt> dunningAttempts()

appliedCredits

public List<Invoice.AppliedCredit> appliedCredits()

adjustmentCreditNotes

public List<Invoice.AdjustmentCreditNote> adjustmentCreditNotes()

issuedCreditNotes

public List<Invoice.IssuedCreditNote> issuedCreditNotes()

linkedOrders

public List<Invoice.LinkedOrder> linkedOrders()

notes
```
public List<Invoice.Note> notes()
```

shippingAddress

public Invoice.ShippingAddress shippingAddress()

billingAddress

public Invoice.BillingAddress billingAddress()

einvoice
```
public Invoice.Einvoice einvoice()
```

paymentOwner
```
public String paymentOwner()
```

voidReasonCode
```
public String voidReasonCode()
```

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

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

channel
```
public Channel channel()
```

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

create

public static Invoice.CreateRequest create()

createForChargeItemsAndCharges

public static Invoice.CreateForChargeItemsAndChargesRequest createForChargeItemsAndCharges()

charge

public static Invoice.ChargeRequest charge()

chargeAddon

public static Invoice.ChargeAddonRequest chargeAddon()

createForChargeItem

@Deprecated
public static Invoice.CreateForChargeItemRequest createForChargeItem()

Deprecated.

stopDunning

public static Invoice.StopDunningRequest stopDunning(String id)

importInvoice

public static Invoice.ImportInvoiceRequest importInvoice()

applyPayments

public static Invoice.ApplyPaymentsRequest applyPayments(String id)

syncUsages

public static Request syncUsages(String id)

deleteLineItems

public static Invoice.DeleteLineItemsRequest deleteLineItems(String id)

applyCredits

public static Invoice.ApplyCreditsRequest applyCredits(String id)

list

public static Invoice.InvoiceListRequest list()

invoicesForCustomer

@Deprecated
public static ListRequest invoicesForCustomer(String id)

Deprecated.

invoicesForSubscription

@Deprecated
public static ListRequest invoicesForSubscription(String id)

Deprecated.

retrieve

public static Request retrieve(String id)

pdf

public static Invoice.PdfRequest pdf(String id)

downloadEinvoice

public static Request downloadEinvoice(String id)

listPaymentReferenceNumbers

public static Invoice.InvoiceListPaymentReferenceNumbersRequest listPaymentReferenceNumbers()

addCharge

public static Invoice.AddChargeRequest addCharge(String id)

addAddonCharge

public static Invoice.AddAddonChargeRequest addAddonCharge(String id)

addChargeItem

public static Invoice.AddChargeItemRequest addChargeItem(String id)

close

public static Invoice.CloseRequest close(String id)

collectPayment

public static Invoice.CollectPaymentRequest collectPayment(String id)

recordPayment

public static Invoice.RecordPaymentRequest recordPayment(String id)

recordTaxWithheld

public static Invoice.RecordTaxWithheldRequest recordTaxWithheld(String id)

removeTaxWithheld

public static Invoice.RemoveTaxWithheldRequest removeTaxWithheld(String id)

refund

public static Invoice.RefundRequest refund(String id)

recordRefund

public static Invoice.RecordRefundRequest recordRefund(String id)

removePayment

public static Invoice.RemovePaymentRequest removePayment(String id)

removeCreditNote

public static Invoice.RemoveCreditNoteRequest removeCreditNote(String id)

voidInvoice

public static Invoice.VoidInvoiceRequest voidInvoice(String id)

writeOff

public static Invoice.WriteOffRequest writeOff(String id)

delete

public static Invoice.DeleteRequest delete(String id)

updateDetails

public static Invoice.UpdateDetailsRequest updateDetails(String id)

resendEinvoice

public static Request resendEinvoice(String id)

sendEinvoice

public static Request sendEinvoice(String id)

Class Invoice

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

Invoice

Invoice

Method Detail

id

poNumber

customerId

subscriptionId

recurring

status

vatNumber

priceType

date

dueDate

netTermDays

exchangeRate

currencyCode

total

amountPaid

amountAdjusted

writeOffAmount

creditsApplied

amountDue

paidAt

dunningStatus

nextRetryAt

voidedAt

resourceVersion

updatedAt

subTotal

subTotalInLocalCurrency

totalInLocalCurrency

localCurrencyCode

tax

localCurrencyExchangeRate

firstInvoice

newSalesAmount

hasAdvanceCharges

termFinalized

isGifted

generatedAt

expectedPaymentDate

amountToCollect

roundOffAmount

lineItems

discounts

lineItemDiscounts

taxes

lineItemTaxes

lineItemTiers

linkedPayments

dunningAttempts

appliedCredits

adjustmentCreditNotes

issuedCreditNotes

linkedOrders

notes

shippingAddress

billingAddress

einvoice

paymentOwner

voidReasonCode

deleted

vatNumberPrefix

channel

businessEntityId

create

createForChargeItemsAndCharges

charge

chargeAddon

createForChargeItem

stopDunning