Package org.killbill.billing.jaxrs.resources

Class AccountResource

java.lang.Object

org.killbill.billing.jaxrs.resources.JaxRsResourceBase

org.killbill.billing.jaxrs.resources.AccountResource

All Implemented Interfaces:

JaxrsResource

@Singleton
@Path("/1.0/kb/accounts")
public class AccountResource
extends JaxRsResourceBase

Field Summary

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

accountUserApi, auditUserApi, catalogName, clock, context, customFieldUserApi, DATE_TIME_FORMATTER, LOCAL_DATE_FORMATTER, mapper, paymentApi, 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

AccountResource(JaxrsUriBuilder uriBuilder, AccountUserApi accountApi, InvoiceUserApi invoiceApi, InvoicePaymentApi invoicePaymentApi, PaymentApi paymentApi, org.killbill.billing.util.api.TagUserApi tagUserApi, org.killbill.billing.util.api.AuditUserApi auditUserApi, org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi, SubscriptionApi subscriptionApi, OverdueApi overdueApi, org.killbill.clock.Clock clock, JaxrsExecutors jaxrsExecutors, JaxrsConfig jaxrsConfig, Context context, org.killbill.billing.util.api.RecordIdApi recordIdApi, org.killbill.notificationq.api.NotificationQueueService notificationQueueService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	addAccountBlockingState(UUID id, BlockingStateJson json, String requestedDate, 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	addEmail(UUID accountId, AccountEmailJson json, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	closeAccount(UUID accountId, Boolean cancelAllSubscriptions, Boolean writeOffUnpaidInvoices, Boolean itemAdjustUnpaidInvoices, Boolean removeFutureNotifications, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	createAccount(AccountJson json, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	createAccountCustomFields(UUID accountId, 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	createAccountTags(UUID accountId, 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	createPaymentMethod(UUID accountId, PaymentMethodJson json, Boolean isDefault, Boolean payAllUnpaidInvoices, List<String> paymentControlPluginNames, 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	deleteAccountCustomFields(UUID accountId, List<UUID> customFieldList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	deleteAccountTags(UUID accountId, List<UUID> tagList, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccount(UUID accountId, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountAuditLogs(UUID accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountAuditLogsWithHistory(UUID accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountBundles(UUID accountId, String externalKey, String bundlesFilter, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountBundlesPaginated(UUID accountId, Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountByKey(String externalKey, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountEmailAuditLogsWithHistory(UUID accountId, UUID accountEmailId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccounts(Long offset, Long limit, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAccountTimeline(UUID accountId, Boolean parallel, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAllCustomFields(UUID accountId, org.killbill.billing.ObjectType objectType, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getAllTags(UUID accountId, org.killbill.billing.ObjectType objectType, Boolean includedDeleted, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getBlockingStateAuditLogsWithHistory(UUID blockingId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getBlockingStates(UUID accountId, List<BlockingStateType> typeFilter, List<String> svcsFilter, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getChildrenAccounts(UUID parentAccountId, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getCustomFields(UUID accountId, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getEmails(UUID accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoicePayments(UUID accountId, Boolean withPluginInfo, Boolean withAttempts, List<String> pluginPropertiesString, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoicesForAccount(UUID accountId, String startDateStr, String endDateStr, boolean withMigrationInvoices, boolean unpaidInvoicesOnly, boolean includeVoidedInvoices, boolean includeInvoiceComponents, String invoicesFilter, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getInvoicesForAccountPaginated(UUID accountId, Long offset, Long limit, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
protected org.killbill.billing.ObjectType	getObjectType()
javax.ws.rs.core.Response	getOverdueAccount(UUID accountId, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getPaymentMethodsForAccount(UUID accountId, Boolean withPluginInfo, Boolean includedDeleted, List<String> pluginPropertiesString, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getPaymentsForAccount(UUID accountId, Boolean withAttempts, Boolean withPluginInfo, List<String> pluginPropertiesString, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	getTags(UUID accountId, Boolean includedDeleted, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	modifyAccountCustomFields(UUID accountId, List<CustomFieldJson> customFields, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	payAllInvoices(UUID accountId, UUID inputPaymentMethodId, Boolean externalPayment, BigDecimal paymentAmount, 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	processPayment(UUID accountId, PaymentTransactionJson json, UUID inputPaymentMethodId, List<String> paymentControlPluginNames, 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	processPaymentByExternalKey(PaymentTransactionJson json, String externalKey, UUID paymentMethodId, List<String> paymentControlPluginNames, 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	rebalanceExistingCBAOnAccount(UUID accountId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	refreshPaymentMethods(UUID accountId, String pluginName, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	removeEmail(UUID accountId, String email, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	searchAccounts(String searchKey, Long offset, Long limit, Boolean accountWithBalance, Boolean accountWithBalanceAndCBA, AuditMode auditMode, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	setDefaultPaymentMethod(UUID accountId, UUID paymentMethodId, Boolean payAllUnpaidInvoices, List<String> pluginPropertiesString, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)
javax.ws.rs.core.Response	transferChildCreditToParent(UUID childAccountId, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request, javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	updateAccount(UUID accountId, AccountJson json, Boolean treatNullValueAsReset, String createdBy, String reason, String comment, javax.servlet.http.HttpServletRequest request)

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

AccountResource

@Inject
public AccountResource(JaxrsUriBuilder uriBuilder,
                       AccountUserApi accountApi,
                       InvoiceUserApi invoiceApi,
                       InvoicePaymentApi invoicePaymentApi,
                       PaymentApi paymentApi,
                       org.killbill.billing.util.api.TagUserApi tagUserApi,
                       org.killbill.billing.util.api.AuditUserApi auditUserApi,
                       org.killbill.billing.util.api.CustomFieldUserApi customFieldUserApi,
                       SubscriptionApi subscriptionApi,
                       OverdueApi overdueApi,
                       org.killbill.clock.Clock clock,
                       JaxrsExecutors jaxrsExecutors,
                       JaxrsConfig jaxrsConfig,
                       Context context,
                       org.killbill.billing.util.api.RecordIdApi recordIdApi,
                       org.killbill.notificationq.api.NotificationQueueService notificationQueueService)

Method Detail

getAccount

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}")
@Produces("application/json")
public javax.ws.rs.core.Response getAccount(@PathParam("accountId")
                                            UUID accountId,
                                            @QueryParam("accountWithBalance") @DefaultValue("false")
                                            Boolean accountWithBalance,
                                            @QueryParam("accountWithBalanceAndCBA") @DefaultValue("false")
                                            Boolean accountWithBalanceAndCBA,
                                            @QueryParam("audit") @DefaultValue("NONE")
                                            AuditMode auditMode,
                                            @Context
                                            javax.servlet.http.HttpServletRequest request)
                                     throws AccountApiException

Throws:

AccountApiException

getAccounts

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

Throws:

AccountApiException

searchAccounts

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

Throws:

AccountApiException

getAccountBundles

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/bundles")
@Produces("application/json")
public javax.ws.rs.core.Response getAccountBundles(@PathParam("accountId")
                                                   UUID accountId,
                                                   @QueryParam("externalKey")
                                                   String externalKey,
                                                   @QueryParam("bundlesFilter")
                                                   String bundlesFilter,
                                                   @QueryParam("audit") @DefaultValue("NONE")
                                                   AuditMode auditMode,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest request)
                                            throws AccountApiException,
                                                   SubscriptionApiException,
                                                   CatalogApiException

Throws:

AccountApiException

SubscriptionApiException

CatalogApiException

getAccountBundlesPaginated

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/bundles/pagination")
@Produces("application/json")
public javax.ws.rs.core.Response getAccountBundlesPaginated(@PathParam("accountId")
                                                            UUID accountId,
                                                            @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 AccountApiException,
                                                            SubscriptionApiException,
                                                            CatalogApiException

Throws:

AccountApiException

SubscriptionApiException

CatalogApiException

getAccountByKey

@GET
@Produces("application/json")
public javax.ws.rs.core.Response getAccountByKey(@QueryParam("externalKey")
                                                 String externalKey,
                                                 @QueryParam("accountWithBalance") @DefaultValue("false")
                                                 Boolean accountWithBalance,
                                                 @QueryParam("accountWithBalanceAndCBA") @DefaultValue("false")
                                                 Boolean accountWithBalanceAndCBA,
                                                 @QueryParam("audit") @DefaultValue("NONE")
                                                 AuditMode auditMode,
                                                 @Context
                                                 javax.servlet.http.HttpServletRequest request)
                                          throws AccountApiException

Throws:

AccountApiException

createAccount

@POST
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createAccount(AccountJson json,
                                               @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

Throws:

AccountApiException

updateAccount

@PUT
@Consumes("application/json")
@Produces("application/json")
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}")
public javax.ws.rs.core.Response updateAccount(@PathParam("accountId")
                                               UUID accountId,
                                               AccountJson json,
                                               @QueryParam("treatNullAsReset") @DefaultValue("false")
                                               Boolean treatNullValueAsReset,
                                               @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

Throws:

AccountApiException

closeAccount

@DELETE
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}")
@Produces("application/json")
public javax.ws.rs.core.Response closeAccount(@PathParam("accountId")
                                              UUID accountId,
                                              @QueryParam("cancelAllSubscriptions") @DefaultValue("false")
                                              Boolean cancelAllSubscriptions,
                                              @QueryParam("writeOffUnpaidInvoices") @DefaultValue("false")
                                              Boolean writeOffUnpaidInvoices,
                                              @QueryParam("itemAdjustUnpaidInvoices") @DefaultValue("false")
                                              Boolean itemAdjustUnpaidInvoices,
                                              @QueryParam("removeFutureNotifications") @DefaultValue("true")
                                              Boolean removeFutureNotifications,
                                              @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 SubscriptionApiException,
                                              AccountApiException,
                                              EntitlementApiException,
                                              InvoiceApiException,
                                              org.killbill.billing.util.api.TagApiException

Throws:

SubscriptionApiException

AccountApiException

EntitlementApiException

InvoiceApiException

org.killbill.billing.util.api.TagApiException

getAccountTimeline

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/timeline")
@Produces("application/json")
public javax.ws.rs.core.Response getAccountTimeline(@PathParam("accountId")
                                                    UUID accountId,
                                                    @QueryParam("parallel") @DefaultValue("false")
                                                    Boolean parallel,
                                                    @QueryParam("audit") @DefaultValue("NONE")
                                                    AuditMode auditMode,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws AccountApiException,
                                                    PaymentApiException,
                                                    SubscriptionApiException,
                                                    InvoiceApiException,
                                                    CatalogApiException

Throws:

AccountApiException

PaymentApiException

SubscriptionApiException

InvoiceApiException

CatalogApiException

rebalanceExistingCBAOnAccount

@PUT
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/cbaRebalancing")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response rebalanceExistingCBAOnAccount(@PathParam("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

Throws:

AccountApiException

getInvoicesForAccount

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/invoices")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoicesForAccount(@PathParam("accountId")
                                                       UUID accountId,
                                                       @QueryParam("startDate")
                                                       String startDateStr,
                                                       @QueryParam("endDate")
                                                       String endDateStr,
                                                       @QueryParam("withMigrationInvoices") @DefaultValue("false")
                                                       boolean withMigrationInvoices,
                                                       @QueryParam("unpaidInvoicesOnly") @DefaultValue("false")
                                                       boolean unpaidInvoicesOnly,
                                                       @QueryParam("includeVoidedInvoices") @DefaultValue("false")
                                                       boolean includeVoidedInvoices,
                                                       @QueryParam("includeInvoiceComponents") @DefaultValue("false")
                                                       boolean includeInvoiceComponents,
                                                       @QueryParam("invoicesFilter")
                                                       String invoicesFilter,
                                                       @QueryParam("audit") @DefaultValue("NONE")
                                                       AuditMode auditMode,
                                                       @Context
                                                       javax.servlet.http.HttpServletRequest request)
                                                throws AccountApiException

Throws:

AccountApiException

getInvoicesForAccountPaginated

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/invoices/pagination")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoicesForAccountPaginated(@PathParam("accountId")
                                                                UUID accountId,
                                                                @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 AccountApiException

Throws:

AccountApiException

getInvoicePayments

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/invoicePayments")
@Produces("application/json")
public javax.ws.rs.core.Response getInvoicePayments(@PathParam("accountId")
                                                    UUID accountId,
                                                    @QueryParam("withPluginInfo") @DefaultValue("false")
                                                    Boolean withPluginInfo,
                                                    @QueryParam("withAttempts") @DefaultValue("false")
                                                    Boolean withAttempts,
                                                    @QueryParam("pluginProperty")
                                                    List<String> pluginPropertiesString,
                                                    @QueryParam("audit") @DefaultValue("NONE")
                                                    AuditMode auditMode,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)
                                             throws PaymentApiException,
                                                    AccountApiException

Throws:

PaymentApiException

AccountApiException

payAllInvoices

@POST
@Produces("application/json")
@Consumes("application/json")
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/invoicePayments")
public javax.ws.rs.core.Response payAllInvoices(@PathParam("accountId")
                                                UUID accountId,
                                                @QueryParam("paymentMethodId")
                                                UUID inputPaymentMethodId,
                                                @QueryParam("externalPayment") @DefaultValue("false")
                                                Boolean externalPayment,
                                                @QueryParam("paymentAmount")
                                                BigDecimal paymentAmount,
                                                @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,
                                                PaymentApiException,
                                                InvoiceApiException

Throws:

AccountApiException

PaymentApiException

InvoiceApiException

createPaymentMethod

@POST
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/paymentMethods")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createPaymentMethod(@PathParam("accountId")
                                                     UUID accountId,
                                                     PaymentMethodJson json,
                                                     @QueryParam("isDefault") @DefaultValue("false")
                                                     Boolean isDefault,
                                                     @QueryParam("payAllUnpaidInvoices") @DefaultValue("false")
                                                     Boolean payAllUnpaidInvoices,
                                                     @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.ws.rs.core.UriInfo uriInfo,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest request)
                                              throws AccountApiException,
                                                     PaymentApiException

Throws:

AccountApiException

PaymentApiException

getPaymentMethodsForAccount

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/paymentMethods")
@Produces("application/json")
public javax.ws.rs.core.Response getPaymentMethodsForAccount(@PathParam("accountId")
                                                             UUID accountId,
                                                             @QueryParam("withPluginInfo") @DefaultValue("false")
                                                             Boolean withPluginInfo,
                                                             @QueryParam("includedDeleted") @DefaultValue("false")
                                                             Boolean includedDeleted,
                                                             @QueryParam("pluginProperty")
                                                             List<String> pluginPropertiesString,
                                                             @QueryParam("audit") @DefaultValue("NONE")
                                                             AuditMode auditMode,
                                                             @Context
                                                             javax.servlet.http.HttpServletRequest request)
                                                      throws AccountApiException,
                                                             PaymentApiException

Throws:

AccountApiException

PaymentApiException

refreshPaymentMethods

@PUT
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/paymentMethods/refresh")
@Produces("application/json")
public javax.ws.rs.core.Response refreshPaymentMethods(@PathParam("accountId")
                                                       UUID accountId,
                                                       @QueryParam("pluginName")
                                                       String pluginName,
                                                       @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)
                                                throws AccountApiException,
                                                       PaymentApiException

Throws:

AccountApiException

PaymentApiException

setDefaultPaymentMethod

@PUT
@Consumes("application/json")
@Produces("application/json")
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/paymentMethods/{paymentMethodId:\\w+-\\w+-\\w+-\\w+-\\w+}/setDefault")
public javax.ws.rs.core.Response setDefaultPaymentMethod(@PathParam("accountId")
                                                         UUID accountId,
                                                         @PathParam("paymentMethodId")
                                                         UUID paymentMethodId,
                                                         @QueryParam("payAllUnpaidInvoices") @DefaultValue("false")
                                                         Boolean payAllUnpaidInvoices,
                                                         @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)
                                                  throws AccountApiException,
                                                         PaymentApiException

Throws:

AccountApiException

PaymentApiException

getPaymentsForAccount

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

Throws:

PaymentApiException

processPaymentByExternalKey

@POST
@Path("/payments")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response processPaymentByExternalKey(PaymentTransactionJson json,
                                                             @QueryParam("externalKey")
                                                             String externalKey,
                                                             @QueryParam("paymentMethodId")
                                                             UUID paymentMethodId,
                                                             @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.ws.rs.core.UriInfo uriInfo,
                                                             @Context
                                                             javax.servlet.http.HttpServletRequest request)
                                                      throws PaymentApiException,
                                                             AccountApiException

Throws:

PaymentApiException

AccountApiException

processPayment

@POST
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/payments")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response processPayment(@PathParam("accountId")
                                                UUID accountId,
                                                PaymentTransactionJson json,
                                                @QueryParam("paymentMethodId")
                                                UUID inputPaymentMethodId,
                                                @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.ws.rs.core.UriInfo uriInfo,
                                                @Context
                                                javax.servlet.http.HttpServletRequest request)
                                         throws PaymentApiException,
                                                AccountApiException

Throws:

PaymentApiException

AccountApiException

getOverdueAccount

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/overdue")
@Produces("application/json")
public javax.ws.rs.core.Response getOverdueAccount(@PathParam("accountId")
                                                   UUID accountId,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest request)
                                            throws AccountApiException,
                                                   OverdueException,
                                                   OverdueApiException

Throws:

AccountApiException

OverdueException

OverdueApiException

getBlockingStates

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/block")
@Produces("application/json")
public javax.ws.rs.core.Response getBlockingStates(@PathParam("accountId")
                                                   UUID accountId,
                                                   @QueryParam("blockingStateTypes")
                                                   List<BlockingStateType> typeFilter,
                                                   @QueryParam("blockingStateSvcs")
                                                   List<String> svcsFilter,
                                                   @QueryParam("audit") @DefaultValue("NONE")
                                                   AuditMode auditMode,
                                                   @Context
                                                   javax.servlet.http.HttpServletRequest request)
                                            throws EntitlementApiException

Throws:

EntitlementApiException

getBlockingStateAuditLogsWithHistory

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

addAccountBlockingState

@POST
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/block")
@Consumes("application/json")
public javax.ws.rs.core.Response addAccountBlockingState(@PathParam("accountId")
                                                         UUID id,
                                                         BlockingStateJson json,
                                                         @QueryParam("requestedDate")
                                                         String requestedDate,
                                                         @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 SubscriptionApiException,
                                                         EntitlementApiException,
                                                         AccountApiException

Throws:

SubscriptionApiException

EntitlementApiException

AccountApiException

getCustomFields

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

getAllCustomFields

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/allCustomFields")
@Produces("application/json")
public javax.ws.rs.core.Response getAllCustomFields(@PathParam("accountId")
                                                    UUID accountId,
                                                    @QueryParam("objectType")
                                                    org.killbill.billing.ObjectType objectType,
                                                    @QueryParam("audit") @DefaultValue("NONE")
                                                    AuditMode auditMode,
                                                    @Context
                                                    javax.servlet.http.HttpServletRequest request)

createAccountCustomFields

@POST
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createAccountCustomFields(@PathParam("accountId")
                                                           UUID accountId,
                                                           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

modifyAccountCustomFields

@PUT
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response modifyAccountCustomFields(@PathParam("accountId")
                                                           UUID accountId,
                                                           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

deleteAccountCustomFields

@DELETE
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/customFields")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response deleteAccountCustomFields(@PathParam("accountId")
                                                           UUID accountId,
                                                           @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("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags")
@Produces("application/json")
public javax.ws.rs.core.Response getTags(@PathParam("accountId")
                                         UUID accountId,
                                         @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

Throws:

org.killbill.billing.util.api.TagDefinitionApiException

getAllTags

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/allTags")
@Produces("application/json")
public javax.ws.rs.core.Response getAllTags(@PathParam("accountId")
                                            UUID accountId,
                                            @QueryParam("objectType")
                                            org.killbill.billing.ObjectType objectType,
                                            @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

Throws:

org.killbill.billing.util.api.TagDefinitionApiException

createAccountTags

@POST
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response createAccountTags(@PathParam("accountId")
                                                   UUID accountId,
                                                   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

deleteAccountTags

@DELETE
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/tags")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response deleteAccountTags(@PathParam("accountId")
                                                   UUID accountId,
                                                   @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,
                                                   AccountApiException

Throws:

org.killbill.billing.util.api.TagApiException

AccountApiException

getEmails

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

addEmail

@POST
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/emails")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response addEmail(@PathParam("accountId")
                                          UUID accountId,
                                          AccountEmailJson json,
                                          @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

Throws:

AccountApiException

removeEmail

@DELETE
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/emails/{email}")
@Produces("application/json")
public javax.ws.rs.core.Response removeEmail(@PathParam("accountId")
                                             UUID accountId,
                                             @PathParam("email")
                                             String email,
                                             @HeaderParam("X-Killbill-CreatedBy")
                                             String createdBy,
                                             @HeaderParam("X-Killbill-Reason")
                                             String reason,
                                             @HeaderParam("X-Killbill-Comment")
                                             String comment,
                                             @Context
                                             javax.servlet.http.HttpServletRequest request)

getAccountEmailAuditLogsWithHistory

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

Throws:

AccountApiException

getObjectType

protected org.killbill.billing.ObjectType getObjectType()

Overrides:

getObjectType in class JaxRsResourceBase

getChildrenAccounts

@GET
@Path("/{accountId:\\w+-\\w+-\\w+-\\w+-\\w+}/children")
@Produces("application/json")
public javax.ws.rs.core.Response getChildrenAccounts(@PathParam("accountId")
                                                     UUID parentAccountId,
                                                     @QueryParam("accountWithBalance") @DefaultValue("false")
                                                     Boolean accountWithBalance,
                                                     @QueryParam("accountWithBalanceAndCBA") @DefaultValue("false")
                                                     Boolean accountWithBalanceAndCBA,
                                                     @QueryParam("audit") @DefaultValue("NONE")
                                                     AuditMode auditMode,
                                                     @Context
                                                     javax.servlet.http.HttpServletRequest request)
                                              throws AccountApiException

Throws:

AccountApiException

transferChildCreditToParent

@PUT
@Path("/{childAccountId:\\w+-\\w+-\\w+-\\w+-\\w+}/transferCredit")
@Consumes("application/json")
@Produces("application/json")
public javax.ws.rs.core.Response transferChildCreditToParent(@PathParam("childAccountId")
                                                             UUID childAccountId,
                                                             @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

getAccountAuditLogs

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

Throws:

AccountApiException

getAccountAuditLogsWithHistory

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

Throws:

AccountApiException