org.killbill.billing.invoice.api

Interface Invoice

All Superinterfaces:

Entity

All Known Subinterfaces:

InvoiceFormatter

public interface Invoice
extends Entity

Method Summary

Modifier and Type	Method and Description
boolean	addInvoiceItem(InvoiceItem item)
boolean	addInvoiceItems(java.util.Collection<InvoiceItem> items)
boolean	addPayment(InvoicePayment payment)
boolean	addPayments(java.util.Collection<InvoicePayment> payments)
java.util.UUID	getAccountId()
java.math.BigDecimal	getBalance()
java.math.BigDecimal	getChargedAmount()
java.math.BigDecimal	getCreditedAmount()
Currency	getCurrency()
org.joda.time.LocalDate	getInvoiceDate()
java.util.List<InvoiceItem>	getInvoiceItems()
<T extends InvoiceItem> java.util.List<InvoiceItem>	getInvoiceItems(java.lang.Class<T> clazz)
java.lang.Integer	getInvoiceNumber()
int	getNumberOfItems()
int	getNumberOfPayments()
java.math.BigDecimal	getOriginalChargedAmount()
java.math.BigDecimal	getPaidAmount()
java.util.UUID	getParentAccountId()
java.util.UUID	getParentInvoiceId()
java.util.List<InvoicePayment>	getPayments()
java.math.BigDecimal	getRefundedAmount()
InvoiceStatus	getStatus()
org.joda.time.LocalDate	getTargetDate() The target day is the latest day to consider for billing events.
boolean	isMigrationInvoice()
boolean	isParentInvoice()

Methods inherited from interface org.killbill.billing.util.entity.Entity

getCreatedDate, getId, getUpdatedDate

Method Detail

addInvoiceItem

boolean addInvoiceItem(InvoiceItem item)

Parameters:

item - the invoice ietm to add

Returns:

true if successful

addInvoiceItems

boolean addInvoiceItems(java.util.Collection<InvoiceItem> items)

Parameters:

items - the list of ietms to add

Returns:

true is successful

getInvoiceItems

java.util.List<InvoiceItem> getInvoiceItems()

Returns:

the list of items on that invoice

getInvoiceItems

<T extends InvoiceItem> java.util.List<InvoiceItem> getInvoiceItems(java.lang.Class<T> clazz)

Type Parameters:

T - a InvoiceItem type

Parameters:

clazz - the filter class for the items

Returns:

the list of invoice ietms on that invoice for that type

getNumberOfItems

int getNumberOfItems()

Returns:

the number of items on that invoice

addPayment

boolean addPayment(InvoicePayment payment)

Parameters:

payment - the successful payment for that invoice

Returns:

true if we were able to add the payment

addPayments

boolean addPayments(java.util.Collection<InvoicePayment> payments)

Parameters:

payments - the list of payments to add on that invoice

Returns:

true if we were able to add the payments

getPayments

java.util.List<InvoicePayment> getPayments()

Returns:

the list of payments associated with that invoice

getNumberOfPayments

int getNumberOfPayments()

Returns:

the number of payments on that invoice

getAccountId

java.util.UUID getAccountId()

Returns:

the accountId

getInvoiceNumber

java.lang.Integer getInvoiceNumber()

Returns:

the invoice number

getInvoiceDate

org.joda.time.LocalDate getInvoiceDate()

Returns:

the day the invoice was generated, in the account timezone

getTargetDate

org.joda.time.LocalDate getTargetDate()

The target day is the latest day to consider for billing events.

Returns:

the target day in the account timezone

getCurrency

Currency getCurrency()

Returns:

the currency associated with that invoice

getPaidAmount

java.math.BigDecimal getPaidAmount()

Returns:

the sum of all successful payment amounts for that invoice

getOriginalChargedAmount

java.math.BigDecimal getOriginalChargedAmount()

Returns:

the sum of all EXTERNAL_CHARGE, FIXED and RECURRING item amounts when the invoice was created

getChargedAmount

java.math.BigDecimal getChargedAmount()

Returns:

the sum of all charges (EXTERNAL_CHARGE, FIXED, RECURRING) and adjustments (item or invoice adjustment) amounts

getCreditedAmount

java.math.BigDecimal getCreditedAmount()

Returns:

the sum of all CBA_ADJ items

getRefundedAmount

java.math.BigDecimal getRefundedAmount()

Returns:

the sum of all refunds and chargebacks for payments associated with that invoice

getBalance

java.math.BigDecimal getBalance()

Returns:

the current balance on that invoice

isMigrationInvoice

boolean isMigrationInvoice()

Returns:

true if this is a migration invoice

getStatus

InvoiceStatus getStatus()

Returns:

the current status of the invoice

isParentInvoice

boolean isParentInvoice()

Returns:

true if this is a parent invoice

getParentAccountId

java.util.UUID getParentAccountId()

Returns:

the parent accountId or null

getParentInvoiceId

java.util.UUID getParentInvoiceId()

Returns:

the parent invoiceId or null