java.lang.Object
- org.killbill.billing.jaxrs.resources.JaxRsResourceBase
- - org.killbill.billing.jaxrs.resources.InvoiceResource

All Implemented Interfaces:: JaxrsResource

@Singleton
@Path("/1.0/kb/invoices")
public class InvoiceResource
extends JaxRsResourceBase

Field Summary
- Fields inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase
  accountUserApi, auditUserApi, catalogName, clock, context, customFieldUserApi, DATE_TIME_FORMATTER, invoicePaymentApi, LOCAL_DATE_FORMATTER, mapper, paymentApi, subscriptionApi, tagUserApi, uriBuilder
- Fields inherited from interface org.killbill.billing.jaxrs.resources.JaxrsResource
  ACCOUNTS, ACCOUNTS_PATH, ADMIN, ADMIN_PATH, ALL_CUSTOM_FIELDS, ALL_TAGS, ANALYTICS, ANALYTICS_PATH, ANYTHING_PATTERN, API_POSTFIX, API_PREFIX, API_VERSION, ATTEMPTS, AUDIT_LOG, AUDIT_LOG_WITH_HISTORY, AUTHORIZATION, BCD, BLOCK, BUNDLES, BUNDLES_PATH, CACHE, CANCEL_SCHEDULED_PAYMENT_TRANSACTION, CAPTURE, CATALOG, CATALOG_PATH, CBA_REBALANCING, CHARGEBACK_REVERSALS, CHARGEBACK_REVERSALS_PATH, CHARGEBACKS, CHARGEBACKS_PATH, CHARGES, CHARGES_PATH, CHILDREN, COMBO, COMMIT_INVOICE, CREDITS, CREDITS_PATH, CUSTOM_FIELDS, CUSTOM_FIELDS_PATH, DRY_RUN, EMAIL_NOTIFICATIONS, EMAILS, ENTITLEMENTS, ENTITLEMENTS_PATH, EVENTS, EXPORT, EXPORT_PATH, FORM, GROUP, 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, HEALTHCHECK, HOSTED, INVOICE_CATALOG_TRANSLATION, INVOICE_ITEMS, INVOICE_MP_TEMPLATE, INVOICE_PAYMENTS, INVOICE_PAYMENTS_PATH, INVOICE_TEMPLATE, INVOICE_TRANSLATION, INVOICES, INVOICES_ITEMS_PATH, INVOICES_PATH, MIGRATION, NODES_INFO, NODES_INFO_PATH, NOTIFICATION, NUMBER_PATTERN, OVERDUE, OVERDUE_PATH, PAGINATION, PATH_PAYMENT_PLUGIN_NAME, PAUSE, PAYMENT_GATEWAYS, PAYMENT_GATEWAYS_PATH, PAYMENT_METHODS, PAYMENT_METHODS_DEFAULT_PATH_POSTFIX, PAYMENT_METHODS_PATH, PAYMENT_TRANSACTIONS, PAYMENT_TRANSACTIONS_PATH, PAYMENTS, PAYMENTS_PATH, PLUGINS, PLUGINS_INFO, PLUGINS_INFO_PATH, PLUGINS_PATH, PREFIX, QUANTITY, QUERY_ACCOUNT_ID, QUERY_ACCOUNT_TREAT_NULL_AS_RESET, QUERY_ACCOUNT_WITH_BALANCE, QUERY_ACCOUNT_WITH_BALANCE_AND_CBA, QUERY_API_KEY, QUERY_AUDIT, QUERY_AUTO_COMMIT, QUERY_BCD_TRANSFER, QUERY_BILLING_POLICY, QUERY_BILLING_REQUESTED_DT, QUERY_BLOCKING_STATE_SVCS, QUERY_BLOCKING_STATE_TYPES, QUERY_BUNDLES_FILTER, QUERY_BUNDLES_RENAME_KEY_IF_EXIST_UNUSED, QUERY_CALL_COMPLETION, QUERY_CALL_TIMEOUT, QUERY_CANCEL_ALL_SUBSCRIPTIONS, QUERY_CUSTOM_FIELD, QUERY_DELETE_DEFAULT_PM_WITH_AUTO_PAY_OFF, QUERY_DELETE_IF_EXISTS, QUERY_END_DATE, QUERY_ENTITLEMENT_EFFECTIVE_FROM_DT, QUERY_ENTITLEMENT_POLICY, QUERY_ENTITLEMENT_REQUESTED_DT, QUERY_EXTERNAL_KEY, QUERY_FORCE_DEFAULT_PM_DELETION, QUERY_FORCE_NEW_BCD_WITH_PAST_EFFECTIVE_DATE, QUERY_FORCE_NEW_QUANTITY_WITH_PAST_EFFECTIVE_DATE, QUERY_INCLUDE_INVOICE_COMPONENTS, QUERY_INCLUDE_VOIDED_INVOICES, QUERY_INCLUDED_DELETED, QUERY_INVOICE_WITH_CHILDREN_ITEMS, QUERY_INVOICES_FILTER, QUERY_ITEM_ADJUST_UNPAID_INVOICES, QUERY_LOCAL_NODE_ONLY, QUERY_MIGRATED, QUERY_NOTIFICATION_CALLBACK, QUERY_OBJECT_TYPE, QUERY_PARALLEL, QUERY_PAY_ALL_UNPAID_INVOICES, QUERY_PAY_INVOICE, QUERY_PAYMENT_AMOUNT, QUERY_PAYMENT_CONTROL_PLUGIN_NAME, QUERY_PAYMENT_EXTERNAL, QUERY_PAYMENT_EXTERNAL_KEY, QUERY_PAYMENT_METHOD_ID, QUERY_PAYMENT_METHOD_IS_DEFAULT, QUERY_PAYMENT_METHOD_PLUGIN_NAME, QUERY_PAYMENT_PLUGIN_NAME, QUERY_PAYMENT_WITH_REFUNDS_AND_CHARGEBACKS, QUERY_PLUGIN_PROPERTY, QUERY_REMOVE_FUTURE_NOTIFICATIONS, QUERY_REQUESTED_DT, QUERY_SEARCH_LIMIT, QUERY_SEARCH_OFFSET, QUERY_SKIP_RESPONSE, QUERY_START_DATE, QUERY_TAG, QUERY_TAGS_INCLUDED_DELETED, QUERY_TARGET_DATE, QUERY_TENANT_USE_GLOBAL_DEFAULT, QUERY_TRANSACTION_EXTERNAL_KEY, QUERY_UNPAID_INVOICES_ONLY, QUERY_USE_REQUESTED_DATE_FOR_BILLING, QUERY_WITH_ATTEMPTS, QUERY_WITH_MIGRATION_INVOICES, QUERY_WITH_PLUGIN_INFO, QUERY_WRITE_OFF_UNPAID_INVOICES, REFUNDS, REGISTER_NOTIFICATION_CALLBACK, RENAME_KEY, RESUME, SEARCH, SECURITY, SECURITY_PATH, STRING_PATTERN, SUBSCRIPTIONS, SUBSCRIPTIONS_PATH, TAG_DEFINITIONS, TAG_DEFINITIONS_PATH, TAGS, TAGS_PATH, TAXES, TENANTS, TENANTS_PATH, TEST, TEST_PATH, TIMELINE, TRANSFER_CREDIT, UNDO_CANCEL, UNDO_CHANGE_PLAN, UPLOAD_PER_TENANT_CONFIG, UPLOAD_PLUGIN_CONFIG, UPLOAD_PLUGIN_PAYMENT_STATE_MACHINE_CONFIG, USAGES, USAGES_PATH, USER_KEY_VALUE, UUID_PATTERN, VOID_INVOICE

Constructor Summary

Constructors
Constructor	Description
`InvoiceResource(AccountUserApi accountUserApi, InvoiceUserApi invoiceApi, PaymentApi paymentApi, InvoicePaymentApi invoicePaymentApi, 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, TenantUserApi tenantApi, Context context)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.ws.rs.core.Response`	`adjustInvoiceItem(UUID invoiceId, InvoiceItemJson json, String requestedDateTimeString, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`commitInvoice(UUID invoiceId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`createExternalCharges(UUID accountId, List<InvoiceItemJson> externalChargesJson, String requestedDateTimeString, Boolean autoCommit, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`createFutureInvoice(UUID accountId, String targetDate, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`createFutureInvoiceGroup(UUID accountId, String targetDate, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`createInstantPayment(UUID invoiceId, InvoicePaymentJson payment, Boolean externalPayment, List<String> paymentControlPluginNames, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`createInvoiceCustomFields(UUID 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`	`createInvoiceTags(UUID id, List<UUID> tagList, String createdBy, String reason, String comment, javax.ws.rs.core.UriInfo uriInfo, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`createMigrationInvoice(UUID accountId, List<InvoiceItemJson> items, String targetDate, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`createTaxItems(UUID accountId, List<InvoiceItemJson> taxItemJson, Boolean autoCommit, String requestedDateTimeString, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`deleteCBA(UUID invoiceId, UUID invoiceItemId, UUID accountId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`deleteInvoiceCustomFields(UUID id, List<UUID> customFieldList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`deleteInvoiceTags(UUID id, List<UUID> tagList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`generateDryRunInvoice(InvoiceDryRunJson dryRunSubscriptionSpec, UUID accountId, String targetDate, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`getCatalogTranslation(String localeStr, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getCustomFields(UUID id, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoice(UUID invoiceId, boolean withChildrenItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoiceAsHTML(UUID invoiceId, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoiceAuditLogsWithHistory(UUID invoiceId, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoiceByItemId(UUID invoiceItemId, boolean withChildrenItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoiceByNumber(Integer invoiceNumber, boolean withChildrenItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoiceMPTemplate(String localeStr, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoices(Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoicesGroup(UUID groupId, UUID accountId, boolean withChildrenItems, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoiceTemplate(javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getInvoiceTranslation(String localeStr, javax.servlet.http.HttpServletRequest request)`
`protected org.killbill.billing.ObjectType`	`getObjectType()`
`javax.ws.rs.core.Response`	`getPaymentsForInvoice(UUID invoiceId, Boolean withPluginInfo, Boolean withAttempts, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`getTags(UUID invoiceId, Boolean includedDeleted, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`modifyInvoiceCustomFields(UUID id, List<CustomFieldJson> customFields, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`searchInvoices(String searchKey, Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)`
`javax.ws.rs.core.Response`	`uploadCatalogTranslation(String localeStr, String catalogTranslation, boolean deleteIfExists, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`uploadInvoiceMPTemplate(String catalogTranslation, boolean deleteIfExists, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`uploadInvoiceTemplate(String catalogTranslation, boolean deleteIfExists, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`uploadInvoiceTranslation(String localeStr, String invoiceTranslation, boolean deleteIfExists, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`
`javax.ws.rs.core.Response`	`voidInvoice(UUID invoiceId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)`

Methods inherited from class org.killbill.billing.jaxrs.resources.JaxRsResourceBase
addBlockingState, buildStreamingPaginationResponse, completeTransactionInternal, createControlPluginApiPaymentOptions, createControlPluginApiPaymentOptions, createCustomFieldResponse, createCustomFields, createInvoicePaymentControlPluginApiPaymentOptions, createPaymentResponse, createPurchaseForInvoice, createPurchaseForInvoice, createTagResponse, createTags, deleteCustomFields, deleteTags, extractPluginProperties, extractPluginProperties, getAuditLogsWithHistory, getCustomFields, getInvoiceId, getPaymentByIdOrKey, getPaymentTransactions, getTagDefinitionUUIDs, getTags, isDateTime, lookupPendingOrSuccessTransaction, modifyCustomFields, toDateTime, toLocalDate, toLocalDateDefaultToday, toLocalDateDefaultToday, validatePaymentMethodForAccount, validateSanitizeAndTranformInputItems, verifyNonNull, verifyNonNullOrEmpty

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,
                       InvoicePaymentApi invoicePaymentApi,
                       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,
                       TenantUserApi tenantApi,
                       Context context)

Method Detail

getInvoice

@GET
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoice(@PathParam("invoiceId")
                                            UUID invoiceId,
                                            @QueryParam("withChildrenItems") @DefaultValue("false")
                                            boolean withChildrenItems,
                                            @QueryParam("audit") @DefaultValue("NONE")
                                            AuditMode auditMode,
                                            @Context
                                            javax.servlet.http.HttpServletRequest request)
                                     throws InvoiceApiException

Throws:: InvoiceApiException

getInvoicesGroup

@GET
@Path("/{groupId:\\w+-\\w+-\\w+-\\w+-\\w+}/group")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoicesGroup(@PathParam("groupId")
                                                  UUID groupId,
                                                  @QueryParam("accountId")
                                                  UUID accountId,
                                                  @QueryParam("withChildrenItems") @DefaultValue("false")
                                                  boolean withChildrenItems,
                                                  @QueryParam("audit") @DefaultValue("NONE")
                                                  AuditMode auditMode,
                                                  @Context
                                                  javax.servlet.http.HttpServletRequest request)
                                           throws InvoiceApiException

Throws:: InvoiceApiException

getInvoiceAuditLogsWithHistory

@GET
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/auditLogsWithHistory")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoiceAuditLogsWithHistory(@PathParam("invoiceId")
                                                                UUID invoiceId,
                                                                @Context
                                                                javax.servlet.http.HttpServletRequest request)

getInvoiceByNumber

@GET
@Path("/byNumber/{invoiceNumber:[0-9]+}/")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoiceByNumber(@PathParam("invoiceNumber")
                                                    Integer invoiceNumber,
                                                    @QueryParam("withChildrenItems") @DefaultValue("false")
                                                    boolean withChildrenItems,
                                                    @QueryParam("audit") @DefaultValue("NONE")
                                                    AuditMode auditMode,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws InvoiceApiException

Throws:: InvoiceApiException

getInvoiceByItemId

@GET
@Path("/byItemId/{itemId:\\w+-\\w+-\\w+-\\w+-\\w+}/")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoiceByItemId(@PathParam("itemId")
                                                    UUID invoiceItemId,
                                                    @QueryParam("withChildrenItems") @DefaultValue("false")
                                                    boolean withChildrenItems,
                                                    @QueryParam("audit") @DefaultValue("NONE")
                                                    AuditMode auditMode,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws InvoiceApiException

Throws:: InvoiceApiException

getInvoiceAsHTML

@GET
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/html")
@Produces("text/html")
public javax.ws.rs.core.Response getInvoiceAsHTML(@PathParam("invoiceId")
                                                  UUID invoiceId,
                                                  @Context
                                                  javax.servlet.http.HttpServletRequest request)
                                           throws InvoiceApiException,
                                                  IOException,
                                                  AccountApiException

Throws:: InvoiceApiException; IOException; AccountApiException

getInvoices

@GET
@Path("/pagination")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoices(@QueryParam("offset") @DefaultValue("0")
                                             Long offset,
                                             @QueryParam("limit") @DefaultValue("100")
                                             Long limit,
                                             @QueryParam("audit") @DefaultValue("NONE")
                                             AuditMode auditMode,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request)
                                      throws InvoiceApiException

Throws:: InvoiceApiException

searchInvoices

@GET
@Path("/search/{searchKey:.*}")
@Produces("application/json")
public javax.ws.rs.core.Response searchInvoices(@PathParam("searchKey")
                                                String searchKey,
                                                @QueryParam("offset") @DefaultValue("0")
                                                Long offset,
                                                @QueryParam("limit") @DefaultValue("100")
                                                Long limit,
                                                @QueryParam("audit") @DefaultValue("NONE")
                                                AuditMode auditMode,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request)
                                         throws SubscriptionApiException

Throws:: SubscriptionApiException

createFutureInvoice

@POST
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createFutureInvoice(@QueryParam("accountId")
                                                     UUID accountId,
                                                     @QueryParam("targetDate")
                                                     String targetDate,
                                                     @QueryParam("pluginProperty")
                                                     List<String> pluginPropertiesString,
                                                     @HeaderParam("X-Killbill-CreatedBy")
                                                     String createdBy,
                                                     @HeaderParam("X-Killbill-Reason")
                                                     String reason,
                                                     @HeaderParam("X-Killbill-Comment")
                                                     String comment,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     @Context
                                                     javax.ws.rs.core.UriInfo uriInfo)
                                              throws AccountApiException,
                                                     InvoiceApiException

Throws:: AccountApiException; InvoiceApiException

createFutureInvoiceGroup

@POST
@Path("/group")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createFutureInvoiceGroup(@QueryParam("accountId")
                                                          UUID accountId,
                                                          @QueryParam("targetDate")
                                                          String targetDate,
                                                          @QueryParam("pluginProperty")
                                                          List<String> pluginPropertiesString,
                                                          @HeaderParam("X-Killbill-CreatedBy")
                                                          String createdBy,
                                                          @HeaderParam("X-Killbill-Reason")
                                                          String reason,
                                                          @HeaderParam("X-Killbill-Comment")
                                                          String comment,
                                                          @Context
                                                          javax.servlet.http.HttpServletRequest request,
                                                          @Context
                                                          javax.ws.rs.core.UriInfo uriInfo)
                                                   throws AccountApiException,
                                                          InvoiceApiException

Throws:: AccountApiException; InvoiceApiException

createMigrationInvoice

@POST
@Path("/migration/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createMigrationInvoice(@PathParam("accountId")
                                                        UUID accountId,
                                                        List<InvoiceItemJson> items,
                                                        @Nullable @QueryParam("targetDate")
                                                        String targetDate,
                                                        @HeaderParam("X-Killbill-CreatedBy")
                                                        String createdBy,
                                                        @HeaderParam("X-Killbill-Reason")
                                                        String reason,
                                                        @HeaderParam("X-Killbill-Comment")
                                                        String comment,
                                                        @Context
                                                        javax.servlet.http.HttpServletRequest request,
                                                        @Context
                                                        javax.ws.rs.core.UriInfo uriInfo)
                                                 throws AccountApiException,
                                                        InvoiceApiException

Throws:: AccountApiException; InvoiceApiException

generateDryRunInvoice

@POST
@Path("/dryRun")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response generateDryRunInvoice(@Nullable
                                                       InvoiceDryRunJson dryRunSubscriptionSpec,
                                                       @QueryParam("accountId")
                                                       UUID accountId,
                                                       @Nullable @QueryParam("targetDate")
                                                       String targetDate,
                                                       @QueryParam("pluginProperty")
                                                       List<String> pluginPropertiesString,
                                                       @HeaderParam("X-Killbill-CreatedBy")
                                                       String createdBy,
                                                       @HeaderParam("X-Killbill-Reason")
                                                       String reason,
                                                       @HeaderParam("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

@DELETE
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/{invoiceItemId:\\w+-\\w+-\\w+-\\w+-\\w+}/cba")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response deleteCBA(@PathParam("invoiceId")
                                           UUID invoiceId,
                                           @PathParam("invoiceItemId")
                                           UUID invoiceItemId,
                                           @QueryParam("accountId")
                                           UUID accountId,
                                           @HeaderParam("X-Killbill-CreatedBy")
                                           String createdBy,
                                           @HeaderParam("X-Killbill-Reason")
                                           String reason,
                                           @HeaderParam("X-Killbill-Comment")
                                           String comment,
                                           @Context
                                           javax.servlet.http.HttpServletRequest request)
                                    throws AccountApiException,
                                           InvoiceApiException

Throws:: AccountApiException; InvoiceApiException

adjustInvoiceItem

@POST
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response adjustInvoiceItem(@PathParam("invoiceId")
                                                   UUID invoiceId,
                                                   InvoiceItemJson json,
                                                   @QueryParam("requestedDate")
                                                   String requestedDateTimeString,
                                                   @QueryParam("pluginProperty")
                                                   List<String> pluginPropertiesString,
                                                   @HeaderParam("X-Killbill-CreatedBy")
                                                   String createdBy,
                                                   @HeaderParam("X-Killbill-Reason")
                                                   String reason,
                                                   @HeaderParam("X-Killbill-Comment")
                                                   String comment,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   @Context
                                                   javax.ws.rs.core.UriInfo uriInfo)
                                            throws AccountApiException,
                                                   InvoiceApiException

Throws:: AccountApiException; InvoiceApiException

createExternalCharges

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/charges/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}")
public javax.ws.rs.core.Response createExternalCharges(@PathParam("accountId")
                                                       UUID accountId,
                                                       List<InvoiceItemJson> externalChargesJson,
                                                       @QueryParam("requestedDate")
                                                       String requestedDateTimeString,
                                                       @QueryParam("autoCommit") @DefaultValue("false")
                                                       Boolean autoCommit,
                                                       @QueryParam("pluginProperty")
                                                       List<String> pluginPropertiesString,
                                                       @HeaderParam("X-Killbill-CreatedBy")
                                                       String createdBy,
                                                       @HeaderParam("X-Killbill-Reason")
                                                       String reason,
                                                       @HeaderParam("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

createTaxItems

@POST
@Consumes("application/json")
@Produces("application/json")
@Path("/taxes/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}")
public javax.ws.rs.core.Response createTaxItems(@PathParam("accountId")
                                                UUID accountId,
                                                List<InvoiceItemJson> taxItemJson,
                                                @QueryParam("autoCommit") @DefaultValue("false")
                                                Boolean autoCommit,
                                                @QueryParam("requestedDate")
                                                String requestedDateTimeString,
                                                @QueryParam("pluginProperty")
                                                List<String> pluginPropertiesString,
                                                @HeaderParam("X-Killbill-CreatedBy")
                                                String createdBy,
                                                @HeaderParam("X-Killbill-Reason")
                                                String reason,
                                                @HeaderParam("X-Killbill-Comment")
                                                String comment,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request,
                                                @Context
                                                javax.ws.rs.core.UriInfo uriInfo)
                                         throws AccountApiException,
                                                InvoiceApiException

Throws:: AccountApiException; InvoiceApiException

getPaymentsForInvoice

@GET
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/payments")
@Produces("application/json")
public javax.ws.rs.core.Response getPaymentsForInvoice(@PathParam("invoiceId")
                                                       UUID invoiceId,
                                                       @QueryParam("withPluginInfo") @DefaultValue("false")
                                                       Boolean withPluginInfo,
                                                       @QueryParam("withAttempts") @DefaultValue("false")
                                                       Boolean withAttempts,
                                                       @QueryParam("audit") @DefaultValue("NONE")
                                                       AuditMode auditMode,
                                                       @Context
                                                       javax.servlet.http.HttpServletRequest request)
                                                throws PaymentApiException,
                                                       InvoiceApiException

Throws:: PaymentApiException; InvoiceApiException

createInstantPayment

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/payments")
public javax.ws.rs.core.Response createInstantPayment(@PathParam("invoiceId")
                                                      UUID invoiceId,
                                                      InvoicePaymentJson payment,
                                                      @QueryParam("externalPayment") @DefaultValue("false")
                                                      Boolean externalPayment,
                                                      @QueryParam("controlPluginName")
                                                      List<String> paymentControlPluginNames,
                                                      @QueryParam("pluginProperty")
                                                      List<String> pluginPropertiesString,
                                                      @HeaderParam("X-Killbill-CreatedBy")
                                                      String createdBy,
                                                      @HeaderParam("X-Killbill-Reason")
                                                      String reason,
                                                      @HeaderParam("X-Killbill-Comment")
                                                      String comment,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest request,
                                                      @Context
                                                      javax.ws.rs.core.UriInfo uriInfo)
                                               throws AccountApiException,
                                                      PaymentApiException

Throws:: AccountApiException; PaymentApiException

getInvoiceTranslation

@GET
@Path("/translation/{locale:.*}/")
@Produces("text/plain")
public javax.ws.rs.core.Response getInvoiceTranslation(@PathParam("locale")
                                                       String localeStr,
                                                       @Context
                                                       javax.servlet.http.HttpServletRequest request)
                                                throws InvoiceApiException,
                                                       TenantApiException

Throws:: InvoiceApiException; TenantApiException

uploadInvoiceTranslation

@POST
@Produces("text/plain")
@Consumes("text/plain")
@Path("/translation/{locale:.*}/")
public javax.ws.rs.core.Response uploadInvoiceTranslation(@PathParam("locale")
                                                          String localeStr,
                                                          String invoiceTranslation,
                                                          @QueryParam("deleteIfExists") @DefaultValue("false")
                                                          boolean deleteIfExists,
                                                          @HeaderParam("X-Killbill-CreatedBy")
                                                          String createdBy,
                                                          @HeaderParam("X-Killbill-Reason")
                                                          String reason,
                                                          @HeaderParam("X-Killbill-Comment")
                                                          String comment,
                                                          @Context
                                                          javax.servlet.http.HttpServletRequest request,
                                                          @Context
                                                          javax.ws.rs.core.UriInfo uriInfo)
                                                   throws Exception

Throws:: Exception

getCatalogTranslation

@GET
@Path("/catalogTranslation/{locale:.*}/")
@Produces("text/plain")
public javax.ws.rs.core.Response getCatalogTranslation(@PathParam("locale")
                                                       String localeStr,
                                                       @Context
                                                       javax.servlet.http.HttpServletRequest request)
                                                throws InvoiceApiException,
                                                       TenantApiException

Throws:: InvoiceApiException; TenantApiException

uploadCatalogTranslation

@POST
@Produces("text/plain")
@Consumes("text/plain")
@Path("/catalogTranslation/{locale:.*}/")
public javax.ws.rs.core.Response uploadCatalogTranslation(@PathParam("locale")
                                                          String localeStr,
                                                          String catalogTranslation,
                                                          @QueryParam("deleteIfExists") @DefaultValue("false")
                                                          boolean deleteIfExists,
                                                          @HeaderParam("X-Killbill-CreatedBy")
                                                          String createdBy,
                                                          @HeaderParam("X-Killbill-Reason")
                                                          String reason,
                                                          @HeaderParam("X-Killbill-Comment")
                                                          String comment,
                                                          @Context
                                                          javax.servlet.http.HttpServletRequest request,
                                                          @Context
                                                          javax.ws.rs.core.UriInfo uriInfo)
                                                   throws Exception

Throws:: Exception

getInvoiceTemplate

@GET
@Path("/template")
@Produces("text/html")
public javax.ws.rs.core.Response getInvoiceTemplate(@Context
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws InvoiceApiException,
                                                    TenantApiException

Throws:: InvoiceApiException; TenantApiException

uploadInvoiceTemplate

@POST
@Produces("text/html")
@Consumes("text/html")
@Path("/template")
public javax.ws.rs.core.Response uploadInvoiceTemplate(String catalogTranslation,
                                                       @QueryParam("deleteIfExists") @DefaultValue("false")
                                                       boolean deleteIfExists,
                                                       @HeaderParam("X-Killbill-CreatedBy")
                                                       String createdBy,
                                                       @HeaderParam("X-Killbill-Reason")
                                                       String reason,
                                                       @HeaderParam("X-Killbill-Comment")
                                                       String comment,
                                                       @Context
                                                       javax.servlet.http.HttpServletRequest request,
                                                       @Context
                                                       javax.ws.rs.core.UriInfo uriInfo)
                                                throws Exception

Throws:: Exception

getInvoiceMPTemplate

@GET
@Path("/manualPayTemplate/{locale:.*}/")
@Produces("text/html")
public javax.ws.rs.core.Response getInvoiceMPTemplate(@PathParam("locale")
                                                      String localeStr,
                                                      @Context
                                                      javax.servlet.http.HttpServletRequest request)
                                               throws InvoiceApiException,
                                                      TenantApiException

Throws:: InvoiceApiException; TenantApiException

uploadInvoiceMPTemplate

@POST
@Produces("text/html")
@Consumes("text/html")
@Path("/manualPayTemplate")
public javax.ws.rs.core.Response uploadInvoiceMPTemplate(String catalogTranslation,
                                                         @QueryParam("deleteIfExists") @DefaultValue("false")
                                                         boolean deleteIfExists,
                                                         @HeaderParam("X-Killbill-CreatedBy")
                                                         String createdBy,
                                                         @HeaderParam("X-Killbill-Reason")
                                                         String reason,
                                                         @HeaderParam("X-Killbill-Comment")
                                                         String comment,
                                                         @Context
                                                         javax.servlet.http.HttpServletRequest request,
                                                         @Context
                                                         javax.ws.rs.core.UriInfo uriInfo)
                                                  throws Exception

Throws:: Exception

getCustomFields

@GET
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields")
@Produces("application/json")
public javax.ws.rs.core.Response getCustomFields(@PathParam("invoiceId")
                                                 UUID id,
                                                 @QueryParam("audit") @DefaultValue("NONE")
                                                 AuditMode auditMode,
                                                 @Context
                                                 javax.servlet.http.HttpServletRequest request)

createInvoiceCustomFields

@POST
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createInvoiceCustomFields(@PathParam("invoiceId")
                                                           UUID id,
                                                           List<CustomFieldJson> customFields,
                                                           @HeaderParam("X-Killbill-CreatedBy")
                                                           String createdBy,
                                                           @HeaderParam("X-Killbill-Reason")
                                                           String reason,
                                                           @HeaderParam("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

modifyInvoiceCustomFields

@PUT
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response modifyInvoiceCustomFields(@PathParam("invoiceId")
                                                           UUID id,
                                                           List<CustomFieldJson> customFields,
                                                           @HeaderParam("X-Killbill-CreatedBy")
                                                           String createdBy,
                                                           @HeaderParam("X-Killbill-Reason")
                                                           String reason,
                                                           @HeaderParam("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

deleteInvoiceCustomFields

@DELETE
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response deleteInvoiceCustomFields(@PathParam("invoiceId")
                                                           UUID id,
                                                           @QueryParam("customField")
                                                           List<UUID> customFieldList,
                                                           @HeaderParam("X-Killbill-CreatedBy")
                                                           String createdBy,
                                                           @HeaderParam("X-Killbill-Reason")
                                                           String reason,
                                                           @HeaderParam("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

@GET
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags")
@Produces("application/json")
public javax.ws.rs.core.Response getTags(@PathParam("invoiceId")
                                         UUID invoiceId,
                                         @QueryParam("includedDeleted") @DefaultValue("false")
                                         Boolean includedDeleted,
                                         @QueryParam("audit") @DefaultValue("NONE")
                                         AuditMode auditMode,
                                         @Context
                                         javax.servlet.http.HttpServletRequest request)
                                  throws org.killbill.billing.util.api.TagDefinitionApiException,
                                         InvoiceApiException

Throws:: org.killbill.billing.util.api.TagDefinitionApiException; InvoiceApiException

createInvoiceTags

@POST
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createInvoiceTags(@PathParam("invoiceId")
                                                   UUID id,
                                                   List<UUID> tagList,
                                                   @HeaderParam("X-Killbill-CreatedBy")
                                                   String createdBy,
                                                   @HeaderParam("X-Killbill-Reason")
                                                   String reason,
                                                   @HeaderParam("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

deleteInvoiceTags

@DELETE
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response deleteInvoiceTags(@PathParam("invoiceId")
                                                   UUID id,
                                                   @QueryParam("tagDef")
                                                   List<UUID> tagList,
                                                   @HeaderParam("X-Killbill-CreatedBy")
                                                   String createdBy,
                                                   @HeaderParam("X-Killbill-Reason")
                                                   String reason,
                                                   @HeaderParam("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

commitInvoice

@PUT
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/commitInvoice")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response commitInvoice(@PathParam("invoiceId")
                                               UUID invoiceId,
                                               @HeaderParam("X-Killbill-CreatedBy")
                                               String createdBy,
                                               @HeaderParam("X-Killbill-Reason")
                                               String reason,
                                               @HeaderParam("X-Killbill-Comment")
                                               String comment,
                                               @Context
                                               javax.servlet.http.HttpServletRequest request,
                                               @Context
                                               javax.ws.rs.core.UriInfo uriInfo)
                                        throws InvoiceApiException

Throws:: InvoiceApiException

voidInvoice

@PUT
@Path("/{invoiceId:\\w+-\\w+-\\w+-\\w+-\\w+}/voidInvoice")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response voidInvoice(@PathParam("invoiceId")
                                             UUID invoiceId,
                                             @HeaderParam("X-Killbill-CreatedBy")
                                             String createdBy,
                                             @HeaderParam("X-Killbill-Reason")
                                             String reason,
                                             @HeaderParam("X-Killbill-Comment")
                                             String comment,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request,
                                             @Context
                                             javax.ws.rs.core.UriInfo uriInfo)
                                      throws InvoiceApiException

Throws:: InvoiceApiException

getObjectType
```
protected org.killbill.billing.ObjectType getObjectType()
```
Overrides:

getObjectType in class JaxRsResourceBase

Class InvoiceResource

Field Summary

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

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

InvoiceResource

Method Detail

getInvoice

getInvoicesGroup

getInvoiceAuditLogsWithHistory

getInvoiceByNumber

getInvoiceByItemId

getInvoiceAsHTML

getInvoices

searchInvoices

createFutureInvoice

createFutureInvoiceGroup

createMigrationInvoice

generateDryRunInvoice

deleteCBA

adjustInvoiceItem

createExternalCharges

createTaxItems

getPaymentsForInvoice

createInstantPayment

getInvoiceTranslation

uploadInvoiceTranslation

getCatalogTranslation

uploadCatalogTranslation

getInvoiceTemplate

uploadInvoiceTemplate

getInvoiceMPTemplate

uploadInvoiceMPTemplate

getCustomFields

createInvoiceCustomFields

modifyInvoiceCustomFields

deleteInvoiceCustomFields

getTags

createInvoiceTags

deleteInvoiceTags

commitInvoice

voidInvoice

getObjectType