org.killbill.billing.jaxrs.resources

Class InvoiceResource

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

org.killbill.billing.jaxrs.resources.InvoiceResource

All Implemented Interfaces:

JaxrsResource

public class InvoiceResource
extends JaxRsResourceBase

Field Summary

Fields inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase

accountUserApi, auditUserApi, clock, context, customFieldUserApi, DATE_TIME_FORMATTER, LOCAL_DATE_FORMATTER, mapper, tagUserApi, uriBuilder

Fields inherited from interface org.killbill.billing.jaxrs.resources.JaxrsResource

ACCOUNTS, ACCOUNTS_PATH, ANALYTICS, ANALYTICS_PATH, ANYTHING_PATTERN, API_POSTFIX, API_PREFIX, API_VERSION, BUNDLES, BUNDLES_PATH, CATALOG, CATALOG_PATH, CBA_REBALANCING, CHARGEBACKS, CHARGEBACKS_PATH, CHARGES, CHARGES_PATH, CREDITS, CREDITS_PATH, CUSTOM_FIELDS, CUSTOM_FIELDS_PATH, EMAIL_NOTIFICATIONS, EMAILS, ENTITLEMENTS, ENTITLEMENTS_PATH, EXPORT, EXPORT_PATH, HDR_API_KEY, HDR_API_SECRET, HDR_COMMENT, HDR_CREATED_BY, HDR_PAGINATION_CURRENT_OFFSET, HDR_PAGINATION_MAX_NB_RECORDS, HDR_PAGINATION_NEXT_OFFSET, HDR_PAGINATION_NEXT_PAGE_URI, HDR_PAGINATION_TOTAL_NB_RECORDS, HDR_REASON, INVOICES, INVOICES_PATH, NUMBER_PATTERN, OVERDUE, OVERDUE_PATH, PAGINATION, PAUSE, PAYMENT_METHODS, PAYMENT_METHODS_DEFAULT_PATH_POSTFIX, PAYMENT_METHODS_PATH, PAYMENTS, PAYMENTS_PATH, PLUGINS, PLUGINS_PATH, PREFIX, QUERY_ACCOUNT_ID, QUERY_ACCOUNT_WITH_BALANCE, QUERY_ACCOUNT_WITH_BALANCE_AND_CBA, QUERY_API_KEY, QUERY_AUDIT, QUERY_BILLING_POLICY, QUERY_BUNDLE_TRANSFER_ADDON, QUERY_BUNDLE_TRANSFER_CANCEL_IMM, QUERY_CALL_COMPLETION, QUERY_CALL_TIMEOUT, QUERY_CUSTOM_FIELDS, QUERY_DELETE_DEFAULT_PM_WITH_AUTO_PAY_OFF, QUERY_DRY_RUN, QUERY_END_TIME, QUERY_ENTITLEMENT_POLICY, QUERY_EXTERNAL_KEY, QUERY_INVOICE_WITH_ITEMS, QUERY_NOTIFICATION_CALLBACK, QUERY_PAY_ALL_UNPAID_INVOICES, QUERY_PAY_INVOICE, QUERY_PAYMENT_EXTERNAL, QUERY_PAYMENT_METHOD_IS_DEFAULT, QUERY_PAYMENT_METHOD_PLUGIN_INFO, QUERY_PAYMENT_METHOD_PLUGIN_NAME, QUERY_PAYMENT_PLUGIN_NAME, QUERY_PAYMENT_WITH_REFUNDS_AND_CHARGEBACKS, QUERY_REQUESTED_DT, QUERY_SEARCH_LIMIT, QUERY_SEARCH_OFFSET, QUERY_START_TIME, QUERY_TAGS, QUERY_TAGS_INCLUDED_DELETED, QUERY_TARGET_DATE, QUERY_UNPAID_INVOICES_ONLY, QUERY_USE_REQUESTED_DATE_FOR_BILLING, REFUNDS, REFUNDS_PATH, REGISTER_NOTIFICATION_CALLBACK, RESUME, SEARCH, SECURITY, SECURITY_PATH, STRING_PATTERN, SUBSCRIPTIONS, SUBSCRIPTIONS_PATH, TAG_DEFINITIONS, TAG_DEFINITIONS_PATH, TAGS, TAGS_PATH, TENANTS, TENANTS_PATH, TIMELINE, USAGES, USAGES_PATH, UUID_PATTERN

Constructor Summary

Constructors

Constructor and Description
InvoiceResource(AccountUserApi accountUserApi, InvoiceUserApi invoiceApi, PaymentApi paymentApi, InvoiceNotifier invoiceNotifier, org.killbill.clock.Clock clock, JaxrsUriBuilder uriBuilder, org.killbill.billing.util.api.TagUserApi tagUserApi, org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi, org.killbill.billing.util.api.AuditUserApi auditUserApi, Context context)

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	adjustInvoiceItem(InvoiceItemJson json, String invoiceId, String requestedDateTimeString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createCustomFields(String id, List<CustomFieldJson> customFields, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createExternalCharge(InvoiceItemJson externalChargeJson, String requestedDateTimeString, Boolean payInvoice, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createExternalChargeForInvoice(InvoiceItemJson externalChargeJson, String invoiceIdString, String requestedDateTimeString, Boolean payInvoice, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createFutureInvoice(String accountId, String targetDateTime, Boolean dryRun, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createInstantPayment(PaymentJson payment, Boolean externalPayment, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createTags(String id, String tagList, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteCBA(String invoiceId, String invoiceItemId, String accountId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteCustomFields(String id, String customFieldList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteTags(String id, String tagList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getCustomFields(String id, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoice(String invoiceId, boolean withItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoiceAsHTML(String invoiceId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoiceByNumber(Integer invoiceNumber, boolean withItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoices(Long offset, Long limit, Boolean withItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
protected org.killbill.billing.ObjectType	getObjectType()
javax.ws.rs.core.Response	getPayments(String invoiceId, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getTags(String invoiceIdString, AuditMode auditMode, Boolean includedDeleted, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	searchInvoices(String searchKey, Long offset, Long limit, Boolean withItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	triggerEmailNotificationForInvoice(String invoiceId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase

buildStreamingPaginationResponse, createCustomFields, createTags, deleteCustomFields, deleteTags, getCustomFields, getTagDefinitionUUIDs, getTags, toLocalDate, toLocalDate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InvoiceResource

@Inject
public InvoiceResource(AccountUserApi accountUserApi,
                      InvoiceUserApi invoiceApi,
                      PaymentApi paymentApi,
                      InvoiceNotifier invoiceNotifier,
                      org.killbill.clock.Clock clock,
                      JaxrsUriBuilder uriBuilder,
                      org.killbill.billing.util.api.TagUserApi tagUserApi,
                      org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi,
                      org.killbill.billing.util.api.AuditUserApi auditUserApi,
                      Context context)

Method Detail

getInvoice

public javax.ws.rs.core.Response getInvoice(String invoiceId,
                                   boolean withItems,
                                   AuditMode auditMode,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws InvoiceApiException

Throws:

InvoiceApiException

getInvoiceByNumber

public javax.ws.rs.core.Response getInvoiceByNumber(Integer invoiceNumber,
                                           boolean withItems,
                                           AuditMode auditMode,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)
                                             throws InvoiceApiException

Throws:

InvoiceApiException

getInvoiceAsHTML

public javax.ws.rs.core.Response getInvoiceAsHTML(String invoiceId,
                                         @Context
                                         javax.servlet.http.HttpServletRequest request)
                                           throws InvoiceApiException,
                                                  IOException,
                                                  AccountApiException

Throws:

InvoiceApiException

IOException

AccountApiException

getInvoices

public javax.ws.rs.core.Response getInvoices(Long offset,
                                    Long limit,
                                    Boolean withItems,
                                    AuditMode auditMode,
                                    @Context
                                    javax.servlet.http.HttpServletRequest request)
                                      throws InvoiceApiException

Throws:

InvoiceApiException

searchInvoices

public javax.ws.rs.core.Response searchInvoices(String searchKey,
                                       Long offset,
                                       Long limit,
                                       Boolean withItems,
                                       AuditMode auditMode,
                                       @Context
                                       javax.servlet.http.HttpServletRequest request)
                                         throws SubscriptionApiException

Throws:

SubscriptionApiException

createFutureInvoice

public javax.ws.rs.core.Response createFutureInvoice(String accountId,
                                            String targetDateTime,
                                            Boolean dryRun,
                                            @HeaderParam(value="X-Killbill-CreatedBy")
                                            String createdBy,
                                            @HeaderParam(value="X-Killbill-Reason")
                                            String reason,
                                            @HeaderParam(value="X-Killbill-Comment")
                                            String comment,
                                            @Context
                                            javax.servlet.http.HttpServletRequest request,
                                            @Context
                                            javax.ws.rs.core.UriInfo uriInfo)
                                              throws AccountApiException,
                                                     InvoiceApiException

Throws:

AccountApiException

InvoiceApiException

deleteCBA

public javax.ws.rs.core.Response deleteCBA(String invoiceId,
                                  String invoiceItemId,
                                  String accountId,
                                  @HeaderParam(value="X-Killbill-CreatedBy")
                                  String createdBy,
                                  @HeaderParam(value="X-Killbill-Reason")
                                  String reason,
                                  @HeaderParam(value="X-Killbill-Comment")
                                  String comment,
                                  @Context
                                  javax.servlet.http.HttpServletRequest request)
                                    throws AccountApiException,
                                           InvoiceApiException

Throws:

AccountApiException

InvoiceApiException

adjustInvoiceItem

public javax.ws.rs.core.Response adjustInvoiceItem(InvoiceItemJson json,
                                          String invoiceId,
                                          String requestedDateTimeString,
                                          @HeaderParam(value="X-Killbill-CreatedBy")
                                          String createdBy,
                                          @HeaderParam(value="X-Killbill-Reason")
                                          String reason,
                                          @HeaderParam(value="X-Killbill-Comment")
                                          String comment,
                                          @Context
                                          javax.servlet.http.HttpServletRequest request,
                                          @Context
                                          javax.ws.rs.core.UriInfo uriInfo)
                                            throws AccountApiException,
                                                   InvoiceApiException

Throws:

AccountApiException

InvoiceApiException

createExternalCharge

public javax.ws.rs.core.Response createExternalCharge(InvoiceItemJson externalChargeJson,
                                             String requestedDateTimeString,
                                             Boolean payInvoice,
                                             @HeaderParam(value="X-Killbill-CreatedBy")
                                             String createdBy,
                                             @HeaderParam(value="X-Killbill-Reason")
                                             String reason,
                                             @HeaderParam(value="X-Killbill-Comment")
                                             String comment,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request)
                                               throws AccountApiException,
                                                      InvoiceApiException,
                                                      PaymentApiException

Throws:

AccountApiException

InvoiceApiException

PaymentApiException

createExternalChargeForInvoice

public javax.ws.rs.core.Response createExternalChargeForInvoice(InvoiceItemJson externalChargeJson,
                                                       String invoiceIdString,
                                                       String requestedDateTimeString,
                                                       Boolean payInvoice,
                                                       @HeaderParam(value="X-Killbill-CreatedBy")
                                                       String createdBy,
                                                       @HeaderParam(value="X-Killbill-Reason")
                                                       String reason,
                                                       @HeaderParam(value="X-Killbill-Comment")
                                                       String comment,
                                                       @Context
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       @Context
                                                       javax.servlet.http.HttpServletRequest request)
                                                         throws AccountApiException,
                                                                InvoiceApiException,
                                                                PaymentApiException

Throws:

AccountApiException

InvoiceApiException

PaymentApiException

getPayments

public javax.ws.rs.core.Response getPayments(String invoiceId,
                                    AuditMode auditMode,
                                    @Context
                                    javax.servlet.http.HttpServletRequest request)
                                      throws PaymentApiException

Throws:

PaymentApiException

createInstantPayment

public javax.ws.rs.core.Response createInstantPayment(PaymentJson payment,
                                             Boolean externalPayment,
                                             @HeaderParam(value="X-Killbill-CreatedBy")
                                             String createdBy,
                                             @HeaderParam(value="X-Killbill-Reason")
                                             String reason,
                                             @HeaderParam(value="X-Killbill-Comment")
                                             String comment,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)
                                               throws AccountApiException,
                                                      PaymentApiException

Throws:

AccountApiException

PaymentApiException

triggerEmailNotificationForInvoice

public javax.ws.rs.core.Response triggerEmailNotificationForInvoice(String invoiceId,
                                                           @HeaderParam(value="X-Killbill-CreatedBy")
                                                           String createdBy,
                                                           @HeaderParam(value="X-Killbill-Reason")
                                                           String reason,
                                                           @HeaderParam(value="X-Killbill-Comment")
                                                           String comment,
                                                           @Context
                                                           javax.servlet.http.HttpServletRequest request)
                                                             throws InvoiceApiException,
                                                                    AccountApiException

Throws:

InvoiceApiException

AccountApiException

getCustomFields

public javax.ws.rs.core.Response getCustomFields(String id,
                                        AuditMode auditMode,
                                        @Context
                                        javax.servlet.http.HttpServletRequest request)

createCustomFields

public javax.ws.rs.core.Response createCustomFields(String id,
                                           List<CustomFieldJson> customFields,
                                           @HeaderParam(value="X-Killbill-CreatedBy")
                                           String createdBy,
                                           @HeaderParam(value="X-Killbill-Reason")
                                           String reason,
                                           @HeaderParam(value="X-Killbill-Comment")
                                           String comment,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request,
                                           @Context
                                           javax.ws.rs.core.UriInfo uriInfo)
                                             throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

deleteCustomFields

public javax.ws.rs.core.Response deleteCustomFields(String id,
                                           String customFieldList,
                                           @HeaderParam(value="X-Killbill-CreatedBy")
                                           String createdBy,
                                           @HeaderParam(value="X-Killbill-Reason")
                                           String reason,
                                           @HeaderParam(value="X-Killbill-Comment")
                                           String comment,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)
                                             throws org.killbill.billing.util.api.CustomFieldApiException

Throws:

org.killbill.billing.util.api.CustomFieldApiException

getTags

public javax.ws.rs.core.Response getTags(String invoiceIdString,
                                AuditMode auditMode,
                                Boolean includedDeleted,
                                @Context
                                javax.servlet.http.HttpServletRequest request)
                                  throws org.killbill.billing.util.api.TagDefinitionApiException,
                                         InvoiceApiException

Throws:

org.killbill.billing.util.api.TagDefinitionApiException

InvoiceApiException

createTags

public javax.ws.rs.core.Response createTags(String id,
                                   String tagList,
                                   @HeaderParam(value="X-Killbill-CreatedBy")
                                   String createdBy,
                                   @HeaderParam(value="X-Killbill-Reason")
                                   String reason,
                                   @HeaderParam(value="X-Killbill-Comment")
                                   String comment,
                                   @Context
                                   javax.ws.rs.core.UriInfo uriInfo,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws org.killbill.billing.util.api.TagApiException

Throws:

org.killbill.billing.util.api.TagApiException

deleteTags

public javax.ws.rs.core.Response deleteTags(String id,
                                   String tagList,
                                   @HeaderParam(value="X-Killbill-CreatedBy")
                                   String createdBy,
                                   @HeaderParam(value="X-Killbill-Reason")
                                   String reason,
                                   @HeaderParam(value="X-Killbill-Comment")
                                   String comment,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws org.killbill.billing.util.api.TagApiException

Throws:

org.killbill.billing.util.api.TagApiException

getObjectType

protected org.killbill.billing.ObjectType getObjectType()

Overrides:

getObjectType in class JaxRsResourceBase