| Modifier and Type | Method and Description |
|---|---|
void |
AccountUserApi.addEmail(UUID accountId,
AccountEmail email,
CallContext context) |
Account |
AccountUserApi.createAccount(AccountData data,
CallContext context) |
void |
AccountUserApi.removeEmail(UUID accountId,
AccountEmail email,
CallContext context) |
void |
AccountUserApi.updateAccount(Account account,
CallContext context)
Updates the account by specifying the destination
Account object
|
void |
AccountUserApi.updateAccount(String key,
AccountData accountData,
CallContext context)
Updates the account by specifying the
AccountData object
|
void |
AccountUserApi.updateAccount(UUID accountId,
AccountData accountData,
CallContext context)
Updates the account by specifying the
AccountData object
|
| Modifier and Type | Method and Description |
|---|---|
Entitlement |
EntitlementApi.addEntitlement(UUID bundleId,
PlanPhaseSpecifier spec,
org.joda.time.LocalDate effectiveDate,
CallContext context)
Adds an ADD_ON entitlement to previously created entitlement.
|
Entitlement |
Entitlement.cancelEntitlementWithDate(org.joda.time.LocalDate effectiveDate,
boolean overrideBillingEffectiveDate,
CallContext context)
Cancels the
Entitlement at the specified date. |
Entitlement |
Entitlement.cancelEntitlementWithDateOverrideBillingPolicy(org.joda.time.LocalDate effectiveDate,
BillingActionPolicy billingPolicy,
CallContext context)
Cancels the
Entitlement at the specified date
After this operation, the existing object becomes stale. |
Entitlement |
Entitlement.cancelEntitlementWithPolicy(Entitlement.EntitlementActionPolicy policy,
CallContext context)
Cancel the
Entitlement with a policy. |
Entitlement |
Entitlement.cancelEntitlementWithPolicyOverrideBillingPolicy(Entitlement.EntitlementActionPolicy policy,
BillingActionPolicy billingPolicy,
CallContext context)
Cancels the
Entitlement at the specified date and overrides the default billing policy. |
Entitlement |
Entitlement.changePlan(String productName,
BillingPeriod billingPeriod,
String priceList,
CallContext context)
Change
Entitlement plan using default policy. |
Entitlement |
Entitlement.changePlanOverrideBillingPolicy(String productName,
BillingPeriod billingPeriod,
String priceList,
org.joda.time.LocalDate effectiveDate,
BillingActionPolicy billingPolicy,
CallContext context)
Change
Entitlement plan at the specified date and overrides the billing policy. |
Entitlement |
Entitlement.changePlanWithDate(String productName,
BillingPeriod billingPeriod,
String priceList,
org.joda.time.LocalDate effectiveDate,
CallContext context)
Change
Entitlement plan at the specified date. |
Entitlement |
EntitlementApi.createBaseEntitlement(UUID accountId,
PlanPhaseSpecifier spec,
String externalKey,
org.joda.time.LocalDate effectiveDate,
CallContext context)
Create a new entitlement for that account.
|
void |
EntitlementApi.pause(UUID bundleId,
org.joda.time.LocalDate effectiveDate,
CallContext context)
Will pause all entitlements associated with the base entitlement.
|
void |
EntitlementApi.resume(UUID bundleId,
org.joda.time.LocalDate effectiveDate,
CallContext context)
Will resume all entitlements associated with the base entitlement.
|
UUID |
EntitlementApi.transferEntitlements(UUID sourceAccountId,
UUID destAccountId,
String externalKey,
org.joda.time.LocalDate effectiveDate,
CallContext context)
Transfer all the
Entitlement For the source account and matching the external key to the destination account. |
UUID |
EntitlementApi.transferEntitlementsOverrideBillingPolicy(UUID sourceAccountId,
UUID destAccountId,
String externalKey,
org.joda.time.LocalDate effectiveDate,
BillingActionPolicy billingPolicy,
CallContext context)
Transfer all the
Entitlement for the source account and matching the external key to the destination account. |
void |
Entitlement.uncancelEntitlement(CallContext context)
Removes a pending future cancellation on an entitlement.
|
void |
SubscriptionApi.updateExternalKey(UUID bundleId,
String newExternalKey,
CallContext context)
Update the externalKey for a given bundle
|
| Modifier and Type | Method and Description |
|---|---|
void |
InvoiceUserApi.consumeExstingCBAOnAccountWithUnpaidInvoices(UUID accountId,
CallContext context)
Rebalance CBA for account which have credit and unpaid invoices-- only needed if system is configured to not rebalance automatically.
|
void |
InvoiceUserApi.deleteCBA(UUID accountId,
UUID invoiceId,
UUID invoiceItemId,
CallContext context)
Delete a CBA item.
|
InvoiceItem |
InvoiceUserApi.insertCredit(UUID accountId,
BigDecimal amount,
org.joda.time.LocalDate effectiveDate,
Currency currency,
CallContext context)
Add a credit to an account.
|
InvoiceItem |
InvoiceUserApi.insertCreditForInvoice(UUID accountId,
UUID invoiceId,
BigDecimal amount,
org.joda.time.LocalDate effectiveDate,
Currency currency,
CallContext context)
Add a credit to an invoice.
|
List<InvoiceItem> |
InvoiceUserApi.insertExternalCharges(UUID accountId,
org.joda.time.LocalDate effectiveDate,
Iterable<InvoiceItem> charges,
CallContext context)
Add one or multiple external charges to an account.
|
InvoiceItem |
InvoiceUserApi.insertInvoiceItemAdjustment(UUID accountId,
UUID invoiceId,
UUID invoiceItemId,
org.joda.time.LocalDate effectiveDate,
BigDecimal amount,
Currency currency,
CallContext context)
Adjust partially a given invoice item.
|
InvoiceItem |
InvoiceUserApi.insertInvoiceItemAdjustment(UUID accountId,
UUID invoiceId,
UUID invoiceItemId,
org.joda.time.LocalDate effectiveDate,
CallContext context)
Adjust fully a given invoice item.
|
void |
InvoiceUserApi.tagInvoiceAsNotWrittenOff(UUID invoiceId,
CallContext context)
Unmark an invoice as written off.
|
void |
InvoiceUserApi.tagInvoiceAsWrittenOff(UUID invoiceId,
CallContext context)
Mark an invoice as written off.
|
Invoice |
InvoiceUserApi.triggerInvoiceGeneration(UUID accountId,
org.joda.time.LocalDate targetDate,
boolean dryRun,
CallContext context)
Trigger an invoice for a given account and a given day.
|
| Modifier and Type | Method and Description |
|---|---|
UUID |
PaymentApi.addPaymentMethod(Account account,
String paymentMethodExternalKey,
String pluginName,
boolean setDefault,
PaymentMethodPlugin paymentMethodInfo,
Iterable<PluginProperty> properties,
CallContext context) |
HostedPaymentPageFormDescriptor |
PaymentGatewayApi.buildFormDescriptor(Account account,
Iterable<PluginProperty> customFields,
Iterable<PluginProperty> properties,
CallContext context)
Build metadata for the client to create a redirect form
|
Payment |
PaymentApi.createAuthorization(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Authorize a payment.
|
Payment |
PaymentApi.createCapture(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Capture a previously authorized payment.
|
Payment |
PaymentApi.createChargeback(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
CallContext context)
Record a chargeback
|
Payment |
PaymentApi.createChargebackWithPaymentControl(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
PaymentOptions paymentOptions,
CallContext context)
Record a chargeback
|
Payment |
PaymentApi.createCredit(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Credit a payment method.
|
Payment |
PaymentApi.createPurchase(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Combine an authorize and capture payment.
|
Payment |
PaymentApi.createPurchaseWithPaymentControl(Account account,
UUID paymentMethodId,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentExternalKey,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Combine an authorize and capture payment.
|
Payment |
PaymentApi.createRefund(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Refund a previously captured payment.
|
Payment |
PaymentApi.createRefundWithPaymentControl(Account account,
UUID paymentId,
BigDecimal amount,
Currency currency,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
PaymentOptions paymentOptions,
CallContext context)
Refund a previously captured payment.
|
Payment |
PaymentApi.createVoid(Account account,
UUID paymentId,
String paymentTransactionExternalKey,
Iterable<PluginProperty> properties,
CallContext context)
Void a previously authorized payment.
|
void |
PaymentApi.deletePaymentMethod(Account account,
UUID paymentMethodId,
boolean deleteDefaultPaymentMethodWithAutoPayOff,
Iterable<PluginProperty> properties,
CallContext context) |
Payment |
PaymentApi.notifyPendingTransactionOfStateChanged(Account account,
UUID paymentTransactionId,
boolean isSuccess,
CallContext context)
Transition a currently PENDING transaction into either a SUCCESS or a FAILURE
|
Payment |
PaymentApi.notifyPendingTransactionOfStateChangedWithPaymentControl(Account account,
UUID paymentTransactionId,
boolean isSuccess,
PaymentOptions paymentOptions,
CallContext context)
Transition a currently PENDING transaction into either a SUCCESS or a FAILURE
|
GatewayNotification |
PaymentGatewayApi.processNotification(String notification,
String pluginName,
Iterable<PluginProperty> properties,
CallContext context)
Process a notification from the gateway
This potentially does more than just deserialize the payload.
|
List<PaymentMethod> |
PaymentApi.refreshPaymentMethods(Account account,
Iterable<PluginProperty> properties,
CallContext context)
Refresh all payment methods across all plugins
This call is not atomic.
|
List<PaymentMethod> |
PaymentApi.refreshPaymentMethods(Account account,
String pluginName,
Iterable<PluginProperty> properties,
CallContext context) |
void |
PaymentApi.setDefaultPaymentMethod(Account account,
UUID paymentMethodId,
Iterable<PluginProperty> properties,
CallContext context) |
| Modifier and Type | Method and Description |
|---|---|
void |
TenantUserApi.addTenantKeyValue(String key,
String value,
CallContext context) |
Tenant |
TenantUserApi.createTenant(TenantData data,
CallContext context) |
void |
TenantUserApi.deleteTenantKey(String key,
CallContext context) |
| Modifier and Type | Method and Description |
|---|---|
void |
UsageUserApi.recordRolledUpUsage(SubscriptionUsageRecord usage,
CallContext context)
Bulk usage API when the external system (or the meter module) rolls-up usage data.
|
| Modifier and Type | Method and Description |
|---|---|
void |
CustomFieldUserApi.addCustomFields(List<CustomField> fields,
CallContext context) |
void |
TagUserApi.addTag(UUID objectId,
ObjectType objectType,
UUID tagDefinitionId,
CallContext context) |
void |
TagUserApi.addTags(UUID objectId,
ObjectType objectType,
Collection<UUID> tagDefinitionIds,
CallContext context) |
TagDefinition |
TagUserApi.createTagDefinition(String definitionName,
String description,
CallContext context) |
void |
TagUserApi.deleteTagDefinition(UUID tagDefinitionId,
CallContext context) |
void |
ExportUserApi.exportDataAsCSVForAccount(UUID accountId,
OutputStream out,
CallContext context) |
void |
ExportUserApi.exportDataForAccount(UUID accountId,
DatabaseExportOutputStream out,
CallContext context) |
void |
CustomFieldUserApi.removeCustomFields(List<CustomField> fields,
CallContext context) |
void |
TagUserApi.removeTag(UUID objectId,
ObjectType objectType,
UUID tagDefinitionId,
CallContext context) |
void |
TagUserApi.removeTags(UUID objectId,
ObjectType objectType,
Collection<UUID> tagDefinitions,
CallContext context) |
Copyright © 2010-2014. All Rights Reserved.