org.killbill.billing.invoice.api

Interface InvoiceUserApi

All Superinterfaces:

KillbillApi

public interface InvoiceUserApi
extends KillbillApi

Method Summary

Modifier and Type	Method and Description
void	commitInvoice(java.util.UUID invoiceId, CallContext context) Move the invoice status from DRAFT to COMMITTED
void	consumeExistingCBAOnAccountWithUnpaidInvoices(java.util.UUID accountId, CallContext context) Rebalance CBA for account which have credit and unpaid invoices-- only needed if system is configured to not rebalance automatically.
java.util.UUID	createMigrationInvoice(java.util.UUID accountId, org.joda.time.LocalDate invoiceDate, java.lang.Iterable<InvoiceItem> items, CallContext context)
void	deleteCBA(java.util.UUID accountId, java.util.UUID invoiceId, java.util.UUID invoiceItemId, CallContext context) Delete a CBA item.
java.math.BigDecimal	getAccountBalance(java.util.UUID accountId, TenantContext context) Retrieve the account balance.
java.math.BigDecimal	getAccountCBA(java.util.UUID accountId, TenantContext context) Retrieve the account CBA.
InvoiceItem	getCreditById(java.util.UUID creditId, TenantContext context) Retrieve a credit by id.
InvoiceItem	getExternalChargeById(java.util.UUID externalChargeId, TenantContext context) Retrieve an external charge by id.
Invoice	getInvoice(java.util.UUID invoiceId, TenantContext context) Retrieve an invoice by id.
java.lang.String	getInvoiceAsHTML(java.util.UUID invoiceId, TenantContext context) Retrieve the invoice formatted in HTML.
Invoice	getInvoiceByInvoiceItem(java.util.UUID invoiceItemId, TenantContext context)
Invoice	getInvoiceByNumber(java.lang.Integer number, TenantContext context) Retrieve an invoice by invoice number.
Invoice	getInvoiceByPayment(java.util.UUID paymentId, TenantContext context) Get all invoices for a given payment.
java.util.List<InvoiceItem>	getInvoiceItemsByParentInvoice(java.util.UUID parentInvoiceId, TenantContext context) Retrieve invoice items details associated to Parent SUMMARY invoice item
Pagination<Invoice>	getInvoices(java.lang.Long offset, java.lang.Long limit, TenantContext context)
java.util.List<Invoice>	getInvoicesByAccount(java.util.UUID accountId, boolean includesMigrated, boolean includeVoidedInvoices, TenantContext context) Get all invoices for a given account.
java.util.List<Invoice>	getInvoicesByAccount(java.util.UUID accountId, org.joda.time.LocalDate fromDate, boolean includeVoidedInvoices, TenantContext context) Find invoices from a given day, for a given account.
java.util.Collection<Invoice>	getUnpaidInvoicesByAccountId(java.util.UUID accountId, org.joda.time.LocalDate upToDate, TenantContext context) Find unpaid invoices for a given account, up to a given day.
InvoiceItem	insertCredit(java.util.UUID accountId, java.math.BigDecimal amount, org.joda.time.LocalDate effectiveDate, Currency currency, boolean autoCommit, java.lang.String description, java.lang.String itemDetails, java.lang.Iterable<PluginProperty> properties, CallContext context) Add a credit to an account.
InvoiceItem	insertCreditForInvoice(java.util.UUID accountId, java.util.UUID invoiceId, java.math.BigDecimal amount, org.joda.time.LocalDate effectiveDate, Currency currency, java.lang.String description, java.lang.String itemDetails, java.lang.Iterable<PluginProperty> properties, CallContext context) Add a credit to an invoice.
java.util.List<InvoiceItem>	insertExternalCharges(java.util.UUID accountId, org.joda.time.LocalDate effectiveDate, java.lang.Iterable<InvoiceItem> charges, boolean autoCommit, java.lang.Iterable<PluginProperty> properties, CallContext context) Add one or multiple external charges to an account.
InvoiceItem	insertInvoiceItemAdjustment(java.util.UUID accountId, java.util.UUID invoiceId, java.util.UUID invoiceItemId, org.joda.time.LocalDate effectiveDate, java.math.BigDecimal amount, Currency currency, java.lang.String description, java.lang.String itemDetails, java.lang.Iterable<PluginProperty> properties, CallContext context) Adjust partially a given invoice item.
InvoiceItem	insertInvoiceItemAdjustment(java.util.UUID accountId, java.util.UUID invoiceId, java.util.UUID invoiceItemId, org.joda.time.LocalDate effectiveDate, java.lang.String description, java.lang.String itemDetails, java.lang.Iterable<PluginProperty> properties, CallContext context) Adjust fully a given invoice item.
java.util.List<InvoiceItem>	insertTaxItems(java.util.UUID accountId, org.joda.time.LocalDate effectiveDate, java.lang.Iterable<InvoiceItem> taxes, boolean autoCommit, java.lang.Iterable<PluginProperty> properties, CallContext context) Add one or multiple tax items to one invoice.
Pagination<Invoice>	searchInvoices(java.lang.String searchKey, java.lang.Long offset, java.lang.Long limit, TenantContext context) Find all invoices having their id, number, account id or currency matching the search key
void	tagInvoiceAsNotWrittenOff(java.util.UUID invoiceId, CallContext context) Unmark an invoice as written off.
void	tagInvoiceAsWrittenOff(java.util.UUID invoiceId, CallContext context) Mark an invoice as written off.
void	transferChildCreditToParent(java.util.UUID childAccountId, CallContext context) Move a given child credit to the parent level
Invoice	triggerDryRunInvoiceGeneration(java.util.UUID accountId, org.joda.time.LocalDate targetDate, DryRunArguments dryRunArguments, CallContext context) Trigger an invoice for a given account and a given day.
Invoice	triggerInvoiceGeneration(java.util.UUID accountId, org.joda.time.LocalDate targetDate, CallContext context) Trigger an invoice for a given account and a given day.
void	voidInvoice(java.util.UUID invoiceId, CallContext context) Move the invoice status from DRAFT or COMMITTED to VOID

Method Detail

getInvoicesByAccount

java.util.List<Invoice> getInvoicesByAccount(java.util.UUID accountId,
                                             boolean includesMigrated,
                                             boolean includeVoidedInvoices,
                                             TenantContext context)

Get all invoices for a given account.

Parameters:

accountId - account id

context - the tenant context

Returns:

all invoices

getInvoicesByAccount

java.util.List<Invoice> getInvoicesByAccount(java.util.UUID accountId,
                                             org.joda.time.LocalDate fromDate,
                                             boolean includeVoidedInvoices,
                                             TenantContext context)

Find invoices from a given day, for a given account.

Parameters:

accountId - account id

fromDate - the earliest target day to consider, in the account timezone

context - the tenant context

Returns:

a list of invoices

getInvoices

Pagination<Invoice> getInvoices(java.lang.Long offset,
                                java.lang.Long limit,
                                TenantContext context)

Parameters:

context - the user context

offset - the offset of the first result

limit - the maximum number of results to retrieve

Returns:

the list of invoices for that tenant

searchInvoices

Pagination<Invoice> searchInvoices(java.lang.String searchKey,
                                   java.lang.Long offset,
                                   java.lang.Long limit,
                                   TenantContext context)

Find all invoices having their id, number, account id or currency matching the search key

Parameters:

searchKey - the search key

offset - the offset of the first result

limit - the maximum number of results to retrieve

context - the user context

Returns:

the list of invoices matching this search key for that tenant

getAccountBalance

java.math.BigDecimal getAccountBalance(java.util.UUID accountId,
                                       TenantContext context)

Retrieve the account balance.

Parameters:

accountId - account id

context - the tenant context

Returns:

the account balance

getAccountCBA

java.math.BigDecimal getAccountCBA(java.util.UUID accountId,
                                   TenantContext context)

Retrieve the account CBA.

Parameters:

accountId - account id

context - the tenant context

Returns:

the account CBA

getInvoice

Invoice getInvoice(java.util.UUID invoiceId,
                   TenantContext context)
            throws InvoiceApiException

Retrieve an invoice by id.

Parameters:

invoiceId - invoice id

context - the tenant context

Returns:

the invoice

Throws:

InvoiceApiException

getInvoiceByPayment

Invoice getInvoiceByPayment(java.util.UUID paymentId,
                            TenantContext context)
                     throws InvoiceApiException

Get all invoices for a given payment.

Parameters:

paymentId - payment id

context - the tenant context

Returns:

the invoice

Throws:

InvoiceApiException

getInvoiceByNumber

Invoice getInvoiceByNumber(java.lang.Integer number,
                           TenantContext context)
                    throws InvoiceApiException

Retrieve an invoice by invoice number.

Parameters:

number - invoice number

context - the tenant context

Returns:

the invoice

Throws:

InvoiceApiException

getInvoiceByInvoiceItem

Invoice getInvoiceByInvoiceItem(java.util.UUID invoiceItemId,
                                TenantContext context)
                         throws InvoiceApiException

Parameters:

invoiceItemId - invoice item id

context - the tenant context

Returns:

Throws:

InvoiceApiException

getUnpaidInvoicesByAccountId

java.util.Collection<Invoice> getUnpaidInvoicesByAccountId(java.util.UUID accountId,
                                                           org.joda.time.LocalDate upToDate,
                                                           TenantContext context)

Find unpaid invoices for a given account, up to a given day.

Parameters:

accountId - account id

upToDate - the latest target day to consider, in the account timezone

context - the tenant context

Returns:

a collection of invoices

triggerInvoiceGeneration

Invoice triggerInvoiceGeneration(java.util.UUID accountId,
                                 org.joda.time.LocalDate targetDate,
                                 CallContext context)
                          throws InvoiceApiException

Trigger an invoice for a given account and a given day.

Parameters:

accountId - account id

targetDate - the target day, in the account timezone

context - the call context

Returns:

the invoice generated

Throws:

InvoiceApiException

triggerDryRunInvoiceGeneration

Invoice triggerDryRunInvoiceGeneration(java.util.UUID accountId,
                                       org.joda.time.LocalDate targetDate,
                                       DryRunArguments dryRunArguments,
                                       CallContext context)
                                throws InvoiceApiException

Trigger an invoice for a given account and a given day.

Parameters:

accountId - account id

targetDate - the target day, in the account timezone

dryRunArguments - dry run arguments

context - the call context

Returns:

the invoice generated

Throws:

InvoiceApiException

tagInvoiceAsWrittenOff

void tagInvoiceAsWrittenOff(java.util.UUID invoiceId,
                            CallContext context)
                     throws TagApiException,
                            InvoiceApiException

Mark an invoice as written off.

Parameters:

invoiceId - invoice id

context - call context

Throws:

TagApiException

InvoiceApiException

tagInvoiceAsNotWrittenOff

void tagInvoiceAsNotWrittenOff(java.util.UUID invoiceId,
                               CallContext context)
                        throws TagApiException,
                               InvoiceApiException

Unmark an invoice as written off.

Parameters:

invoiceId - invoice id

context - call context

Throws:

TagApiException

InvoiceApiException

getExternalChargeById

InvoiceItem getExternalChargeById(java.util.UUID externalChargeId,
                                  TenantContext context)
                           throws InvoiceApiException

Retrieve an external charge by id.

Parameters:

externalChargeId - external charge id

context - the tenant context

Returns:

the external charge

Throws:

InvoiceApiException

insertExternalCharges

java.util.List<InvoiceItem> insertExternalCharges(java.util.UUID accountId,
                                                  org.joda.time.LocalDate effectiveDate,
                                                  java.lang.Iterable<InvoiceItem> charges,
                                                  boolean autoCommit,
                                                  java.lang.Iterable<PluginProperty> properties,
                                                  CallContext context)
                                           throws InvoiceApiException

Add one or multiple external charges to an account.

Parameters:

accountId - account id

effectiveDate - the effective date for newly created invoices (in the account timezone)

charges - the charges

autoCommit - the flag to indicate if the invoice is set to COMMITTED or DRAFT and events are sent

context - the call context

Returns:

the external charges invoice items

Throws:

InvoiceApiException

insertTaxItems

java.util.List<InvoiceItem> insertTaxItems(java.util.UUID accountId,
                                           org.joda.time.LocalDate effectiveDate,
                                           java.lang.Iterable<InvoiceItem> taxes,
                                           boolean autoCommit,
                                           java.lang.Iterable<PluginProperty> properties,
                                           CallContext context)
                                    throws InvoiceApiException

Add one or multiple tax items to one invoice.

Parameters:

accountId - account id

effectiveDate - the effective date for newly created invoice (in the account timezone)

taxes - the tax items

autoCommit - the flag to indicate if the invoice is set to COMMITTED or DRAFT and events are sent

context - the call context

Returns:

the tax invoice items

Throws:

InvoiceApiException

getCreditById

InvoiceItem getCreditById(java.util.UUID creditId,
                          TenantContext context)
                   throws InvoiceApiException

Retrieve a credit by id.

Parameters:

creditId - credit id

context - the tenant context

Returns:

the credit

Throws:

InvoiceApiException

insertCredit

InvoiceItem insertCredit(java.util.UUID accountId,
                         java.math.BigDecimal amount,
                         org.joda.time.LocalDate effectiveDate,
                         Currency currency,
                         boolean autoCommit,
                         java.lang.String description,
                         java.lang.String itemDetails,
                         java.lang.Iterable<PluginProperty> properties,
                         CallContext context)
                  throws InvoiceApiException

Add a credit to an account.

Parameters:

accountId - account id

amount - the credit amount

effectiveDate - the day to grant the credit, in the account timezone

currency - the credit currency

autoCommit - the flag to indicate if the invoice is set to COMMITTED or DRAFT and events are sent

context - the call context

description - the item description

itemDetails - the item details

properties - the plugin specific properties

Returns:

the credit invoice item

Throws:

InvoiceApiException

insertCreditForInvoice

InvoiceItem insertCreditForInvoice(java.util.UUID accountId,
                                   java.util.UUID invoiceId,
                                   java.math.BigDecimal amount,
                                   org.joda.time.LocalDate effectiveDate,
                                   Currency currency,
                                   java.lang.String description,
                                   java.lang.String itemDetails,
                                   java.lang.Iterable<PluginProperty> properties,
                                   CallContext context)
                            throws InvoiceApiException

Add a credit to an invoice. This can be used to adjust invoices.

Parameters:

accountId - account id

invoiceId - invoice id

amount - the credit amount

effectiveDate - the day to grant the credit, in the account timezone

currency - the credit currency

description - the item description

itemDetails - the item details

properties - the plugin specific properties

context - the call context

Returns:

the credit invoice item

Throws:

InvoiceApiException

insertInvoiceItemAdjustment

InvoiceItem insertInvoiceItemAdjustment(java.util.UUID accountId,
                                        java.util.UUID invoiceId,
                                        java.util.UUID invoiceItemId,
                                        org.joda.time.LocalDate effectiveDate,
                                        java.lang.String description,
                                        java.lang.String itemDetails,
                                        java.lang.Iterable<PluginProperty> properties,
                                        CallContext context)
                                 throws InvoiceApiException

Adjust fully a given invoice item.

Parameters:

accountId - account id

invoiceId - invoice id

invoiceItemId - invoice item id

effectiveDate - the effective date for this adjustment invoice item (in the account timezone)

description - the item description

itemDetails - the item details

properties - the plugin specific properties

context - the call context

Returns:

the adjustment invoice item

Throws:

InvoiceApiException

insertInvoiceItemAdjustment

InvoiceItem insertInvoiceItemAdjustment(java.util.UUID accountId,
                                        java.util.UUID invoiceId,
                                        java.util.UUID invoiceItemId,
                                        org.joda.time.LocalDate effectiveDate,
                                        java.math.BigDecimal amount,
                                        Currency currency,
                                        java.lang.String description,
                                        java.lang.String itemDetails,
                                        java.lang.Iterable<PluginProperty> properties,
                                        CallContext context)
                                 throws InvoiceApiException

Adjust partially a given invoice item.

Parameters:

accountId - account id

invoiceId - invoice id

invoiceItemId - invoice item id

effectiveDate - the effective date for this adjustment invoice item (in the account timezone)

amount - the adjustment amount

currency - adjustment currency

description - the item description

itemDetails - the item details

properties - the plugin specific properties

context - the call context

Returns:

the adjustment invoice item

Throws:

InvoiceApiException

deleteCBA

void deleteCBA(java.util.UUID accountId,
               java.util.UUID invoiceId,
               java.util.UUID invoiceItemId,
               CallContext context)
        throws InvoiceApiException

Delete a CBA item.

Parameters:

accountId - account id

invoiceId - invoice id

invoiceItemId - invoice item id (must be of type CBA_ADJ)

context - the call context

Throws:

InvoiceApiException

getInvoiceAsHTML

java.lang.String getInvoiceAsHTML(java.util.UUID invoiceId,
                                  TenantContext context)
                           throws AccountApiException,
                                  java.io.IOException,
                                  InvoiceApiException

Retrieve the invoice formatted in HTML.

Parameters:

invoiceId - invoice id

context - the tenant context

Returns:

the invoice in HTML format

Throws:

AccountApiException

java.io.IOException

InvoiceApiException

consumeExistingCBAOnAccountWithUnpaidInvoices

void consumeExistingCBAOnAccountWithUnpaidInvoices(java.util.UUID accountId,
                                                   CallContext context)

Rebalance CBA for account which have credit and unpaid invoices-- only needed if system is configured to not rebalance automatically.

Parameters:

accountId - account id

context - the call context

commitInvoice

void commitInvoice(java.util.UUID invoiceId,
                   CallContext context)
            throws InvoiceApiException

Move the invoice status from DRAFT to COMMITTED

Parameters:

invoiceId - invoice id

context - the tenant context

Throws:

InvoiceApiException

createMigrationInvoice

java.util.UUID createMigrationInvoice(java.util.UUID accountId,
                                      org.joda.time.LocalDate invoiceDate,
                                      java.lang.Iterable<InvoiceItem> items,
                                      CallContext context)

Parameters:

accountId - account id

invoiceDate - maximum billing event day to consider (in the account timezone)

items - items to be placed on the migration invoice

context - call call context

Returns:

The UUID of the created invoice

transferChildCreditToParent

void transferChildCreditToParent(java.util.UUID childAccountId,
                                 CallContext context)
                          throws InvoiceApiException

Move a given child credit to the parent level

Parameters:

childAccountId - child account id

context - the tenant context

Throws:

InvoiceApiException

getInvoiceItemsByParentInvoice

java.util.List<InvoiceItem> getInvoiceItemsByParentInvoice(java.util.UUID parentInvoiceId,
                                                           TenantContext context)
                                                    throws InvoiceApiException

Retrieve invoice items details associated to Parent SUMMARY invoice item

Parameters:

parentInvoiceId - the parent invoice id

context - the tenant context

Returns:

a list of invoice items associated with a parent invoice

Throws:

InvoiceApiException - if any unexpected error occurs

voidInvoice

void voidInvoice(java.util.UUID invoiceId,
                 CallContext context)
          throws InvoiceApiException

Move the invoice status from DRAFT or COMMITTED to VOID

Parameters:

invoiceId - invoice id

context - the tenant context

Throws:

InvoiceApiException