Add Services to an Account
post
/bcws/webresources/v1.0/accounts/{id}/package
Adds new services to the specified account.
Request
Path Parameters
-
id(required): string
The ID of the account to add the services to.
Supported Media Types
- application/xml
- application/json
Information about the services to add. The minimum required parameters are:
- purchasingPackageRef
- services
- serviceKey
- @class
- serviceType
- login
Root Schema : schema
Type:
Show Source
object
-
effective: string
(date-time)
The date and time the package purchase takes effect.
-
existingBillunitsForBalanceGroups: array
existingBillunitsForBalanceGroups
-
extension: object
extension
The extended attributes.
-
genericBundle: object
CustomizedBundleForPurchase
-
newBillunitsForBalanceGroups: array
newBillunitsForBalanceGroups
-
notes: object
Notes
-
purchasingPackageRef(required): string
The resource associated with the package purchase.
-
services(required): array
services
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : CustomizedBundleForPurchase
Type:
Show Source
object
-
creditLimitFlags: integer
(int32)
Flag to set credit limit options. Allowed Values: 1 (Override credit limit), 2 (Prorate based on credit limit), 64 (Enforce credit limit).
-
customizedChargeOffers: array
customizedChargeOffers
The list of customized charge offers in the bundle.
-
customizedDiscountOffers: array
customizedDiscountOffers
The list of customized discount offers.
-
effective: string
(date-time)
The date and time the bundle takes effect.
-
extension: object
extension
The extended attributes.
-
id(required): string
The ID.
-
name(required): string
The bundle's name.
-
notes: object
Notes
Nested Schema : Notes
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
Nested Schema : ExistingBillUnits
Type:
Show Source
object
-
balanceGroups: array
balanceGroups
-
billUnitId(required): string
The ID of the bill unit.
-
forServiceGroup(required): array
forServiceGroup
Nested Schema : BalanceGroup
Type:
Show Source
object
-
balances: array
balances
The list of balances associated with the balance group.
-
elem: integer
(int32)
The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
-
extension: object
extension
The extended attributes.
-
id(required): string
The ID.
-
monitorType: string
The monitoring group type. Allowed Values:
- H_CE (Hierarchy Credit Exposure)
- PR_CE (Payment Responsible Credit Exposure)
- SUB_CE (Subscription Credit Exposure)
- PR_RTCE (Payment Responsible Real-Time Credit Enforcement)
-
name: string
The name of the balance group.
-
services: array
services
Nested Schema : balances
Type:
array
The list of balances associated with the balance group.
Show Source
-
Array of:
object Balances
The list of balances associated with the balance group.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Balances
Type:
object
The list of balances associated with the balance group.
Show Source
-
creditFloor: number
The credit floor associated with the balance.
-
creditLimit: number
The credit limit associated with the balance.
-
creditThresholds: integer
(int32)
The credit thresholds associated with the balance.
-
creditThresholdsFixed: string
The value at which to send a notification, such as 30 US dollars or 30 minutes.
-
currentBalance(required): number
The current balance.
-
dynamicCreditFloor: boolean
Whether to use a dynamic credit floor (true) or not (false). The default is false.
-
expiredBeforeUsing: number
The number of days until the balance expires.
-
formattedCreditThresholds: string
The balance percentage usage at which to notify the customer.
-
loanThresholds: integer
(int32)
The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.
-
loanThresholdsFixed: string
The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan.
-
modifyLimit: boolean
Whether a credit limit is being modified by the request (true) or not (false).
-
outstandingAmount(required): number
An amount that the customer still owes, for loans or when they exceed their credit limit.
-
overrideCreditLimit: integer
(int32)
Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).
-
resourceId: integer
(int32)
The resource ID associated with the balance.
-
subBalances: array
subBalances
-
tempCreditLimit: array
tempCreditLimit
Nested Schema : SubBalances
Type:
Show Source
object
-
currentBalance: number
The current amount of the sub-balance.
-
elementId: integer
(int32)
The ID of the element.
-
expiredBeforeUsing: number
The number of days until the sub-balance expires.
-
extension: object
extension
The extended attributes.
-
rolloverData: integer
(int32)
Details about a rollover subbalance.
-
validFrom: string
(date-time)
The date and time the validity period starts.
-
validTo: string
(date-time)
The date and time the validity period ends.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : TempCreditLimit
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
limit: number
The temporary credit limit amount.
-
resourceId: integer
(int32)
The resource ID associated with the temporary credit limit.
-
validFrom(required): string
(date-time)
The date and time temporary credit limit's validity starts.
-
validFromOffset: integer
(int32)
The offset for the temporary credit limit's validity period start.
-
validFromUnit: integer
(int32)
The unit for the temporary credit limit's validity period start.
-
validTo(required): string
(date-time)
The date and time temporary credit limit's validity ends.
-
validToOffset: integer
(int32)
The offset for the temporary credit limit's validity period end.
-
validToUnit: integer
(int32)
The unit for the temporary credit limit's validity period end.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ServiceType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
aliasList: array
aliasList
The list of aliases associated with the service.
-
balanceGroupRef: object
ResourceRef
-
balGrpIndex: integer
(int32)
The balance group index.
-
creationDate: string
(date-time)
The date and time the service type was created.
-
effectiveDate: string
(date-time)
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
lastModified: string
(date-time)
The date and time the service was last modified.
-
lastStatusChange: string
(date-time)
The date and time of the last status change.
-
lastStatusComment: string
The comment associated with the last status change.
-
lifeCycleState: integer
(int32)
The current life cycle state.
-
login(required): string
The login associated with the service.
-
name: string
The name of the service.
-
password(required): string
The password associated with the service.
-
passwordExpiration: string
(date-time)
The date and time the password expires.
-
passwordStatus: integer
(int32)
The current status of the password.
-
pendingDeferredActionsCount: integer
(int32)
The number of deferred actions that are pending for the service.
-
serviceAccessLevel: string
The service access level.
-
status: integer
(int32)
The status.
-
statusFlags: integer
(int32)
The status flags.
-
subscriptionServiceRef: object
ResourceRef
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : aliasList
Type:
array
The list of aliases associated with the service.
Show Source
-
Array of:
object AliasList
The list of aliases associated with the service.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ServiceGroupIndex
Type:
Show Source
object
-
serviceGroupElem: integer
(int32)
The service group element.
Nested Schema : customizedChargeOffers
Type:
array
The list of customized charge offers in the bundle.
Show Source
-
Array of:
object CustomizedChargeOffers
The list of customized charge offers in the bundle.
Nested Schema : customizedDiscountOffers
Type:
array
The list of customized discount offers.
Show Source
-
Array of:
object CustomizedDiscountOffers
The list of customized discount offers.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : CustomizedChargeOffers
Type:
object
The list of customized charge offers in the bundle.
Show Source
-
baseChargeOfferRef: object
ResourceRef
-
baseProductRef: object
ResourceRef
-
cycleDiscountOverride: number
The fixed amount of the cycle discount override.
-
cycleDiscountPercentOverride: number
The percentage amount of the cycle discount override.
-
cycleEnd: object
EndingType
-
cycleFeeOverride: number
The amount of the cycle fee override.
-
cycleStart: object
StartingType
-
description: string
The charge offer's description.
-
gracePeriodOffset: integer
(int32)
The number to offset the grace period by.
-
gracePeriodUnit: integer
(int32)
The unit for the grace period.
-
name: string
The charge offer's name.
-
overriddenCharges: array
overriddenCharges
The overridden charges.
-
purchaseDiscountOverride: number
The fixed amount of the purchase discount override.
-
purchaseDiscountPercentOverride: number
The percentage amount of the purchase discount override.
-
purchaseEnd: object
EndingType
-
purchaseFeeOverride: number
The fixed amount of the purchase fee override.
-
purchaseStart: object
StartingType
-
quantity: integer
(int32)
The quantity purchased.
-
renewalMode: integer
(int32)
How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are:
- 0: Cycle aligns with the original billing date or configured specific day of the month.
- 1: Cycle aligns with the reactivation date.
-
status: integer
(int32)
The charge offer's status. Can be one of the following:
- 0: Not set
- 1: Active
- 2: Inactive
- 3: Canceled
-
statusFlag: integer
(int32)
The status flag.
-
usageEnd: object
EndingType
-
usagePercentOverride: number
The percentage amount of the usage override.
-
usageStart: object
StartingType
-
validityAlignMode: string
The validity align mode for a product. Can be one of the following:
- base: Align the validity with baseProductRef passed in request
- any_base_earliest: Aligns the validity dates with the active base charge offer that expires first.
- any_base_latest: Aligns the validity dates with the active base charge offer that expires last.
- any_earliest: Aligns the validity dates with the active charge offer that expires first.
- any_latest: Aligns the validity dates with the active charge offer that expires last.
Nested Schema : EndingType
Type:
Show Source
object
-
endDate: string
(date-time)
The date and time the cycle ends.
-
mode(required): string
The ending type mode for a product. Can be one of the following:
- absolute: The end date is a calendar day.
- relativeToStart: The end date is relative to the start date, such as a specified number of billing cycles, months, days, hours, minutes, or seconds after the start date.
- never: There is no set end date.
-
unitSettings: object
RelativeSettings
Nested Schema : StartingType
Type:
Show Source
object
-
mode(required): string
The starting type mode for a product. Can be one of the following:
- immediately: The start date is set to today. This mode can be used with the purchaseStart, cycleStart, and usageStart parameters.
- absolute: The start date is a calendar date. This mode can be used with the purchaseStart, cycleStart, and usageStart parameters.
- relativeToPurchase: The start date is relative to the purchase date, such as a specified number of billing cycles, months, days, hours, minutes, or seconds after activation. This mode can be used with the cycleStart and usageStart parameters.
- firstUsage: The start day is the day of the first recorded usage.
-
startDate: string
(date-time)
The date and time the cycle starts.
-
unitSettings: object
RelativeSettings
Nested Schema : RelativeSettings
Type:
Show Source
object
-
offset: integer
(int32)
The number of days, hours, minutes or so on after the cycle starts or ends.
-
units(required): string
The offset unit. Can be one of the following:
- seconds
- minutes
- hours
- days
- months
- cycles
Nested Schema : overriddenCharges
Type:
Show Source
object
-
charges(required): array
charges
The charge details.
-
event(required): string
The event associated with the overridden charges.
Nested Schema : charges
Type:
array
The charge details.
Show Source
-
Array of:
object Charges
The charge details.
Nested Schema : Charges
Type:
object
The charge details.
Show Source
-
charge(required): array
charge
The charges.
-
endDate: string
(date-time)
The date and time the charge's validity ends.
-
startDate(required): string
(date-time)
The date and time the charge's validity starts.
Nested Schema : Charge
Type:
object
The charges.
Show Source
-
amount(required): number
The charge amount.
-
priceTag(required): string
The charge's price tag.
-
type(required): string
The charge type.
Nested Schema : CustomizedDiscountOffers
Type:
object
The list of customized discount offers.
Show Source
-
baseDiscountOfferRef: object
ResourceRef
-
cycleEnd: object
EndingType
-
cycleStart: object
StartingType
-
description: string
The discount offer's description.
-
name: string
The discount offer's name.
-
overriddenCharges: array
overriddenCharges
The overridden charges.
-
purchaseEnd: object
EndingType
-
purchaseStart: object
StartingType
-
quantity: integer
(int32)
The discount's quantity.
-
status: integer
(int32)
The discount offer's status. Can be one of the following:
- 0: Not set
- 1: Active
- 2: Inactive
- 3: Canceled
-
statusFlag: integer
(int32)
The status flag.
-
usageEnd: object
EndingType
-
usageStart: object
StartingType
Nested Schema : NewBillUnits
Type:
Show Source
object
-
accountingCycleDom: integer
(int32)
The accounting cycle day of month (DOM).
-
accountingType: integer
(int32)
The accounting type. Can be one of the following:
- 1: Open item
- 2: Balance forward
-
arBillUnitRef: object
ResourceRef
-
balanceGroups: array
balanceGroups
-
billingFrequencyInMonths: integer
(int32)
The billing frequency in number of months. Can be one of the following:
- 1: Monthly
- 2: Bi-monthly
- 3: Quarterly
- 12: Yearly
-
businessProfile(required): string
The business profile associated with bill unit.
-
currency: integer
(int32)
The primary currency of the bill unit.
-
effectiveDate: string
(date-time)
The date and time the bill unit takes effect.
-
forServiceGroup(required): array
forServiceGroup
-
name: string
The name of the bill unit.
-
parentBillUnitRef: object
ResourceRef
-
parentRef: string
A reference to the parent.
-
paymentMethod: object
PaymentMethod
-
paymentMethodId: string
The ID of the payment method.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
-
rollUp: boolean
-
segment: integer
(int32)
The customer segment associated with the bill unit. A customer segment is a user-defined customer description that can be used to group accounts according to customer billing and payment practices.
-
status: string
The status of the bill unit, such as active, inactive, or closed.
-
walletPaymentInstrumentIndex: integer
(int32)
The wallet index number for the payment instrument associated with the bill unit.
Nested Schema : PaymentMethod
Type:
Show Source
object
-
creditCard: object
CreditCardType
-
directDebit: object
DirectDebitType
-
extension: object
extension
The extended attributes.
-
invoice: object
InvoiceType
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
-
sepa: object
SepaType
Nested Schema : CreditCardType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : DirectDebitType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : InvoiceType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : SepaType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : Details
Type:
object
The offer details.
Show Source
-
balanceImpactResource(required): string
The resource that represents the balance impact of the offer.
-
fixedAmount: number
(float)
The fixed amount of the offer.
-
fixedPriceTag(required): string
The fixed price tag of the offer.
-
scaledAmount: number
(float)
The scaled amount of the offer.
-
scaledPriceTag(required): string
The scaled price tag of the offer.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : comments
Type:
array
The list of comments associated with the note.
Show Source
-
Array of:
object Comments
The list of comments associated with the note.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Comments
Type:
object
The list of comments associated with the note.
Show Source
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Nested Schema : PurchasingService
Type:
Show Source
object
-
balanceGroupRef: object
ResourceRef
-
balGrpIndex: integer
(int32)
The balance group index.
-
customizedBundles: array
customizedBundles
-
devices: array
devices
The list of devices associated with the service.
-
groupParent: boolean
Whether this is a parent in a service group (true) or not (false).
-
profiles: array
profiles
-
service: object
Discriminator: @class
Discriminator:
{ "propertyName":"@class" }
-
serviceKey(required): string
The service key.
-
serviceType: string
The service type.
-
subscriptionIndex: integer
(int32)
The subscription index.
Nested Schema : devices
Type:
array
The list of devices associated with the service.
Show Source
-
Array of:
object Devices
The list of devices associated with the service.
Nested Schema : profiles
Type:
Show Source
array
-
Array of:
object Discriminator: @class
Discriminator:
{ "propertyName":"@class" }
Nested Schema : Discriminator: @class
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
aliasList: array
aliasList
The list of aliases associated with the service.
-
balanceGroupRef: object
ResourceRef
-
balGrpIndex: integer
(int32)
The balance group index.
-
creationDate: string
(date-time)
The date and time the service type was created.
-
effectiveDate: string
(date-time)
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
lastModified: string
(date-time)
The date and time the service was last modified.
-
lastStatusChange: string
(date-time)
The date and time of the last status change.
-
lastStatusComment: string
The comment associated with the last status change.
-
lifeCycleState: integer
(int32)
The current life cycle state.
-
login(required): string
The login associated with the service.
-
name: string
The name of the service.
-
password(required): string
The password associated with the service.
-
passwordExpiration: string
(date-time)
The date and time the password expires.
-
passwordStatus: integer
(int32)
The current status of the password.
-
pendingDeferredActionsCount: integer
(int32)
The number of deferred actions that are pending for the service.
-
serviceAccessLevel: string
The service access level.
-
status: integer
(int32)
The status.
-
statusFlags: integer
(int32)
The status flags.
-
subscriptionServiceRef: object
ResourceRef
Nested Schema : Devices
Type:
object
The list of devices associated with the service.
Show Source
-
description: string
A device's description.
-
id(required): string
The device ID.
Nested Schema : Discriminator: @class
Type:
Show Source
object
-
accountObj: object
ResourceRef
-
creationDate: string
(date-time)
The date and time the profile was created.
-
effectiveDate: string
(date-time)
The date and time the profile is effective from.
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
multiValued: boolean
Whether the profile has multiple values (true) or not (false).
-
name: string
The name of the profile.
-
parentName: string
The name of the parent profile.
-
selected: boolean
Whether the profile is selected (true) or not (false).
-
serviceObj: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : aliasList
Type:
array
The list of aliases associated with the service.
Show Source
-
Array of:
object AliasList
The list of aliases associated with the service.
Nested Schema : extension
Type:
object
The extended attributes.
Information about the services to add. The minimum required parameters are:
- purchasingPackageRef
- services
- serviceKey
- @class
- serviceType
- login
Root Schema : schema
Type:
Show Source
object
-
effective: string
(date-time)
The date and time the package purchase takes effect.
-
existingBillunitsForBalanceGroups: array
existingBillunitsForBalanceGroups
-
extension: object
extension
The extended attributes.
-
genericBundle: object
CustomizedBundleForPurchase
-
newBillunitsForBalanceGroups: array
newBillunitsForBalanceGroups
-
notes: object
Notes
-
purchasingPackageRef(required): string
The resource associated with the package purchase.
-
services(required): array
services
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : CustomizedBundleForPurchase
Type:
Show Source
object
-
creditLimitFlags: integer
(int32)
Flag to set credit limit options. Allowed Values: 1 (Override credit limit), 2 (Prorate based on credit limit), 64 (Enforce credit limit).
-
customizedChargeOffers: array
customizedChargeOffers
The list of customized charge offers in the bundle.
-
customizedDiscountOffers: array
customizedDiscountOffers
The list of customized discount offers.
-
effective: string
(date-time)
The date and time the bundle takes effect.
-
extension: object
extension
The extended attributes.
-
id(required): string
The ID.
-
name(required): string
The bundle's name.
-
notes: object
Notes
Nested Schema : Notes
Type:
Show Source
object
-
accountId(required): string
The ID of the account associated with the note.
-
amount: number
The amount associated with the note. It can be a payment amount, adjustment amount, or so on.
-
billId: string
The ID of the bill associated with the note.
-
billUnitId: string
The ID of the bill unit associated with the note.
-
closedDate: string
(date-time)
The date and time the note was resolved.
-
comments: array
comments
The list of comments associated with the note.
-
count: integer
(int32)
The number of comments associated with the note.
-
domainId: integer
(int32)
The domain ID associated with the note.
-
effectiveDate: string
(date-time)
The date and time the comment was posted.
-
eventId: string
The ID of the event associated with the note.
-
extension: object
extension
The extended attributes.
-
header: string
The header associated with the note.
-
id: string
The ID.
-
itemId: string
The ID of the item associated with the note.
-
reasonId: integer
(int32)
The reason ID associated with the note. Possible values are stored in /config/reason_code_scope objects. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the reasons.locale file.
-
serviceId: string
The service ID associated with the note.
-
status: number
The note's status: not set (100), resolved (101), or unresolved (102). The default value is 102.
-
subType: integer
(int32)
The note's subtype. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
-
type: integer
(int32)
The note's type. Possible values are stored in the /config/note_type object. See Localizing and Customizing Strings in BRM Developer's Guide for information about how to customize these values using the note.locale file.
Nested Schema : ExistingBillUnits
Type:
Show Source
object
-
balanceGroups: array
balanceGroups
-
billUnitId(required): string
The ID of the bill unit.
-
forServiceGroup(required): array
forServiceGroup
Nested Schema : BalanceGroup
Type:
Show Source
object
-
balances: array
balances
The list of balances associated with the balance group.
-
elem: integer
(int32)
The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
-
extension: object
extension
The extended attributes.
-
id(required): string
The ID.
-
monitorType: string
The monitoring group type. Allowed Values:
- H_CE (Hierarchy Credit Exposure)
- PR_CE (Payment Responsible Credit Exposure)
- SUB_CE (Subscription Credit Exposure)
- PR_RTCE (Payment Responsible Real-Time Credit Enforcement)
-
name: string
The name of the balance group.
-
services: array
services
Nested Schema : balances
Type:
array
The list of balances associated with the balance group.
Show Source
-
Array of:
object Balances
The list of balances associated with the balance group.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Balances
Type:
object
The list of balances associated with the balance group.
Show Source
-
creditFloor: number
The credit floor associated with the balance.
-
creditLimit: number
The credit limit associated with the balance.
-
creditThresholds: integer
(int32)
The credit thresholds associated with the balance.
-
creditThresholdsFixed: string
The value at which to send a notification, such as 30 US dollars or 30 minutes.
-
currentBalance(required): number
The current balance.
-
dynamicCreditFloor: boolean
Whether to use a dynamic credit floor (true) or not (false). The default is false.
-
expiredBeforeUsing: number
The number of days until the balance expires.
-
formattedCreditThresholds: string
The balance percentage usage at which to notify the customer.
-
loanThresholds: integer
(int32)
The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.
-
loanThresholdsFixed: string
The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan.
-
modifyLimit: boolean
Whether a credit limit is being modified by the request (true) or not (false).
-
outstandingAmount(required): number
An amount that the customer still owes, for loans or when they exceed their credit limit.
-
overrideCreditLimit: integer
(int32)
Whether to override the credit limit. Allowed Values: 0 (Enforce Credit Limit) or 1 (Override credit limit).
-
resourceId: integer
(int32)
The resource ID associated with the balance.
-
subBalances: array
subBalances
-
tempCreditLimit: array
tempCreditLimit
Nested Schema : SubBalances
Type:
Show Source
object
-
currentBalance: number
The current amount of the sub-balance.
-
elementId: integer
(int32)
The ID of the element.
-
expiredBeforeUsing: number
The number of days until the sub-balance expires.
-
extension: object
extension
The extended attributes.
-
rolloverData: integer
(int32)
Details about a rollover subbalance.
-
validFrom: string
(date-time)
The date and time the validity period starts.
-
validTo: string
(date-time)
The date and time the validity period ends.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : TempCreditLimit
Type:
Show Source
object
-
extension: object
extension
The extended attributes.
-
limit: number
The temporary credit limit amount.
-
resourceId: integer
(int32)
The resource ID associated with the temporary credit limit.
-
validFrom(required): string
(date-time)
The date and time temporary credit limit's validity starts.
-
validFromOffset: integer
(int32)
The offset for the temporary credit limit's validity period start.
-
validFromUnit: integer
(int32)
The unit for the temporary credit limit's validity period start.
-
validTo(required): string
(date-time)
The date and time temporary credit limit's validity ends.
-
validToOffset: integer
(int32)
The offset for the temporary credit limit's validity period end.
-
validToUnit: integer
(int32)
The unit for the temporary credit limit's validity period end.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ServiceType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
aliasList: array
aliasList
The list of aliases associated with the service.
-
balanceGroupRef: object
ResourceRef
-
balGrpIndex: integer
(int32)
The balance group index.
-
creationDate: string
(date-time)
The date and time the service type was created.
-
effectiveDate: string
(date-time)
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
lastModified: string
(date-time)
The date and time the service was last modified.
-
lastStatusChange: string
(date-time)
The date and time of the last status change.
-
lastStatusComment: string
The comment associated with the last status change.
-
lifeCycleState: integer
(int32)
The current life cycle state.
-
login(required): string
The login associated with the service.
-
name: string
The name of the service.
-
password(required): string
The password associated with the service.
-
passwordExpiration: string
(date-time)
The date and time the password expires.
-
passwordStatus: integer
(int32)
The current status of the password.
-
pendingDeferredActionsCount: integer
(int32)
The number of deferred actions that are pending for the service.
-
serviceAccessLevel: string
The service access level.
-
status: integer
(int32)
The status.
-
statusFlags: integer
(int32)
The status flags.
-
subscriptionServiceRef: object
ResourceRef
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
Nested Schema : aliasList
Type:
array
The list of aliases associated with the service.
Show Source
-
Array of:
object AliasList
The list of aliases associated with the service.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ServiceGroupIndex
Type:
Show Source
object
-
serviceGroupElem: integer
(int32)
The service group element.
Nested Schema : customizedChargeOffers
Type:
array
The list of customized charge offers in the bundle.
Show Source
-
Array of:
object CustomizedChargeOffers
The list of customized charge offers in the bundle.
Nested Schema : customizedDiscountOffers
Type:
array
The list of customized discount offers.
Show Source
-
Array of:
object CustomizedDiscountOffers
The list of customized discount offers.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : CustomizedChargeOffers
Type:
object
The list of customized charge offers in the bundle.
Show Source
-
baseChargeOfferRef: object
ResourceRef
-
baseProductRef: object
ResourceRef
-
cycleDiscountOverride: number
The fixed amount of the cycle discount override.
-
cycleDiscountPercentOverride: number
The percentage amount of the cycle discount override.
-
cycleEnd: object
EndingType
-
cycleFeeOverride: number
The amount of the cycle fee override.
-
cycleStart: object
StartingType
-
description: string
The charge offer's description.
-
gracePeriodOffset: integer
(int32)
The number to offset the grace period by.
-
gracePeriodUnit: integer
(int32)
The unit for the grace period.
-
name: string
The charge offer's name.
-
overriddenCharges: array
overriddenCharges
The overridden charges.
-
purchaseDiscountOverride: number
The fixed amount of the purchase discount override.
-
purchaseDiscountPercentOverride: number
The percentage amount of the purchase discount override.
-
purchaseEnd: object
EndingType
-
purchaseFeeOverride: number
The fixed amount of the purchase fee override.
-
purchaseStart: object
StartingType
-
quantity: integer
(int32)
The quantity purchased.
-
renewalMode: integer
(int32)
How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are:
- 0: Cycle aligns with the original billing date or configured specific day of the month.
- 1: Cycle aligns with the reactivation date.
-
status: integer
(int32)
The charge offer's status. Can be one of the following:
- 0: Not set
- 1: Active
- 2: Inactive
- 3: Canceled
-
statusFlag: integer
(int32)
The status flag.
-
usageEnd: object
EndingType
-
usagePercentOverride: number
The percentage amount of the usage override.
-
usageStart: object
StartingType
-
validityAlignMode: string
The validity align mode for a product. Can be one of the following:
- base: Align the validity with baseProductRef passed in request
- any_base_earliest: Aligns the validity dates with the active base charge offer that expires first.
- any_base_latest: Aligns the validity dates with the active base charge offer that expires last.
- any_earliest: Aligns the validity dates with the active charge offer that expires first.
- any_latest: Aligns the validity dates with the active charge offer that expires last.
Nested Schema : EndingType
Type:
Show Source
object
-
endDate: string
(date-time)
The date and time the cycle ends.
-
mode(required): string
The ending type mode for a product. Can be one of the following:
- absolute: The end date is a calendar day.
- relativeToStart: The end date is relative to the start date, such as a specified number of billing cycles, months, days, hours, minutes, or seconds after the start date.
- never: There is no set end date.
-
unitSettings: object
RelativeSettings
Nested Schema : StartingType
Type:
Show Source
object
-
mode(required): string
The starting type mode for a product. Can be one of the following:
- immediately: The start date is set to today. This mode can be used with the purchaseStart, cycleStart, and usageStart parameters.
- absolute: The start date is a calendar date. This mode can be used with the purchaseStart, cycleStart, and usageStart parameters.
- relativeToPurchase: The start date is relative to the purchase date, such as a specified number of billing cycles, months, days, hours, minutes, or seconds after activation. This mode can be used with the cycleStart and usageStart parameters.
- firstUsage: The start day is the day of the first recorded usage.
-
startDate: string
(date-time)
The date and time the cycle starts.
-
unitSettings: object
RelativeSettings
Nested Schema : RelativeSettings
Type:
Show Source
object
-
offset: integer
(int32)
The number of days, hours, minutes or so on after the cycle starts or ends.
-
units(required): string
The offset unit. Can be one of the following:
- seconds
- minutes
- hours
- days
- months
- cycles
Nested Schema : overriddenCharges
Type:
Show Source
object
-
charges(required): array
charges
The charge details.
-
event(required): string
The event associated with the overridden charges.
Nested Schema : charges
Type:
array
The charge details.
Show Source
-
Array of:
object Charges
The charge details.
Nested Schema : Charges
Type:
object
The charge details.
Show Source
-
charge(required): array
charge
The charges.
-
endDate: string
(date-time)
The date and time the charge's validity ends.
-
startDate(required): string
(date-time)
The date and time the charge's validity starts.
Nested Schema : Charge
Type:
object
The charges.
Show Source
-
amount(required): number
The charge amount.
-
priceTag(required): string
The charge's price tag.
-
type(required): string
The charge type.
Nested Schema : CustomizedDiscountOffers
Type:
object
The list of customized discount offers.
Show Source
-
baseDiscountOfferRef: object
ResourceRef
-
cycleEnd: object
EndingType
-
cycleStart: object
StartingType
-
description: string
The discount offer's description.
-
name: string
The discount offer's name.
-
overriddenCharges: array
overriddenCharges
The overridden charges.
-
purchaseEnd: object
EndingType
-
purchaseStart: object
StartingType
-
quantity: integer
(int32)
The discount's quantity.
-
status: integer
(int32)
The discount offer's status. Can be one of the following:
- 0: Not set
- 1: Active
- 2: Inactive
- 3: Canceled
-
statusFlag: integer
(int32)
The status flag.
-
usageEnd: object
EndingType
-
usageStart: object
StartingType
Nested Schema : NewBillUnits
Type:
Show Source
object
-
accountingCycleDom: integer
(int32)
The accounting cycle day of month (DOM).
-
accountingType: integer
(int32)
The accounting type. Can be one of the following:
- 1: Open item
- 2: Balance forward
-
arBillUnitRef: object
ResourceRef
-
balanceGroups: array
balanceGroups
-
billingFrequencyInMonths: integer
(int32)
The billing frequency in number of months. Can be one of the following:
- 1: Monthly
- 2: Bi-monthly
- 3: Quarterly
- 12: Yearly
-
businessProfile(required): string
The business profile associated with bill unit.
-
currency: integer
(int32)
The primary currency of the bill unit.
-
effectiveDate: string
(date-time)
The date and time the bill unit takes effect.
-
forServiceGroup(required): array
forServiceGroup
-
name: string
The name of the bill unit.
-
parentBillUnitRef: object
ResourceRef
-
parentRef: string
A reference to the parent.
-
paymentMethod: object
PaymentMethod
-
paymentMethodId: string
The ID of the payment method.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
-
rollUp: boolean
-
segment: integer
(int32)
The customer segment associated with the bill unit. A customer segment is a user-defined customer description that can be used to group accounts according to customer billing and payment practices.
-
status: string
The status of the bill unit, such as active, inactive, or closed.
-
walletPaymentInstrumentIndex: integer
(int32)
The wallet index number for the payment instrument associated with the bill unit.
Nested Schema : PaymentMethod
Type:
Show Source
object
-
creditCard: object
CreditCardType
-
directDebit: object
DirectDebitType
-
extension: object
extension
The extended attributes.
-
invoice: object
InvoiceType
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
-
sepa: object
SepaType
Nested Schema : CreditCardType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : DirectDebitType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : InvoiceType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : SepaType
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create, such as an invoice correction letter or a replacement invoice.
-
details: object
Details
The offer details.
-
extension: object
extension
The extended attributes.
-
id: string
The ID.
-
name: string
The payment instrument's name.
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
Nested Schema : Details
Type:
object
The offer details.
Show Source
-
balanceImpactResource(required): string
The resource that represents the balance impact of the offer.
-
fixedAmount: number
(float)
The fixed amount of the offer.
-
fixedPriceTag(required): string
The fixed price tag of the offer.
-
scaledAmount: number
(float)
The scaled amount of the offer.
-
scaledPriceTag(required): string
The scaled price tag of the offer.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : comments
Type:
array
The list of comments associated with the note.
Show Source
-
Array of:
object Comments
The list of comments associated with the note.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : Comments
Type:
object
The list of comments associated with the note.
Show Source
-
comment(required): string
The comment.
-
csrAccountId: string
The CSR's account ID.
-
csrFirstName: string
The CSR's first name.
-
csrLastName: string
The CSR's last name.
-
csrLoginId: string
The login ID associated with the CSR.
-
entryDate: string
(date-time)
The date and time the comment was entered by the CSR.
-
externalUser: string
The external user.
-
trackingId: string
The tracking ID.
Nested Schema : PurchasingService
Type:
Show Source
object
-
balanceGroupRef: object
ResourceRef
-
balGrpIndex: integer
(int32)
The balance group index.
-
customizedBundles: array
customizedBundles
-
devices: array
devices
The list of devices associated with the service.
-
groupParent: boolean
Whether this is a parent in a service group (true) or not (false).
-
profiles: array
profiles
-
service: object
Discriminator: @class
Discriminator:
{ "propertyName":"@class" }
-
serviceKey(required): string
The service key.
-
serviceType: string
The service type.
-
subscriptionIndex: integer
(int32)
The subscription index.
Nested Schema : devices
Type:
array
The list of devices associated with the service.
Show Source
-
Array of:
object Devices
The list of devices associated with the service.
Nested Schema : profiles
Type:
Show Source
array
-
Array of:
object Discriminator: @class
Discriminator:
{ "propertyName":"@class" }
Nested Schema : Discriminator: @class
Type:
Show Source
object
-
accountRef: object
ResourceRef
-
aliasList: array
aliasList
The list of aliases associated with the service.
-
balanceGroupRef: object
ResourceRef
-
balGrpIndex: integer
(int32)
The balance group index.
-
creationDate: string
(date-time)
The date and time the service type was created.
-
effectiveDate: string
(date-time)
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
lastModified: string
(date-time)
The date and time the service was last modified.
-
lastStatusChange: string
(date-time)
The date and time of the last status change.
-
lastStatusComment: string
The comment associated with the last status change.
-
lifeCycleState: integer
(int32)
The current life cycle state.
-
login(required): string
The login associated with the service.
-
name: string
The name of the service.
-
password(required): string
The password associated with the service.
-
passwordExpiration: string
(date-time)
The date and time the password expires.
-
passwordStatus: integer
(int32)
The current status of the password.
-
pendingDeferredActionsCount: integer
(int32)
The number of deferred actions that are pending for the service.
-
serviceAccessLevel: string
The service access level.
-
status: integer
(int32)
The status.
-
statusFlags: integer
(int32)
The status flags.
-
subscriptionServiceRef: object
ResourceRef
Nested Schema : Devices
Type:
object
The list of devices associated with the service.
Show Source
-
description: string
A device's description.
-
id(required): string
The device ID.
Nested Schema : Discriminator: @class
Type:
Show Source
object
-
accountObj: object
ResourceRef
-
creationDate: string
(date-time)
The date and time the profile was created.
-
effectiveDate: string
(date-time)
The date and time the profile is effective from.
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
multiValued: boolean
Whether the profile has multiple values (true) or not (false).
-
name: string
The name of the profile.
-
parentName: string
The name of the parent profile.
-
selected: boolean
Whether the profile is selected (true) or not (false).
-
serviceObj: object
ResourceRef
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : aliasList
Type:
array
The list of aliases associated with the service.
Show Source
-
Array of:
object AliasList
The list of aliases associated with the service.
Nested Schema : extension
Type:
object
The extended attributes.
Response
200 Response
The services were successfully added to the account.
500 Response
An internal server error occurred.
Examples
This example shows how to add a service to a specified account by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X POST 'http://hostname:port/bcws/webresources/v1.0/accounts/0.0.0.1+-account+174832/package' -H 'content-type: application/json' -d @addService.json
where:
- hostname is the URL for the Billing Care REST server.
- port is the port for the Billing Care REST server.
- version is the version of the API you're using, such as v1.0.
- addService.json is the JSON file that specifies the service to add.
Example of Request Body
This example shows the contents of the addService.json file sent as the request body.
{
"purchasingPackageRef": "0.0.0.1+-plan+148796",
"services": [
{
"service": {
"login": "ip_832",
"@class": "com.oracle.communications.brm.cc.model.ServiceBase"
},
"serviceType": "/service/ip",
"serviceKey": "/service/ip-cfbc3db9-d7f5-4297-892a-e3dd4c0f447f",
"balGrpIndex": 0,
"customizedBundles": [
{
"name": "Deal_1",
"id": "0.0.0.1+-deal+151454",
"customizedChargeOffers": [
{
"name": "IP",
"description": "",
"baseChargeOfferRef": {
"id": "0.0.0.1+-product+143633",
"uri": null
}
}
],
"customizedDiscountOffers": []
}
],
"subscriptionIndex": 0,
"groupParent": false
}
],
"genericBundle": {},
"existingBillunitsForBalanceGroups": [
{
"billUnitId": "0.0.0.1+-billinfo+254889",
"forServiceGroup": []
},
{
"billUnitId": "0.0.0.1+-billinfo+172528",
"forServiceGroup": [
{
"serviceGroupElem": -1
}
]
}
],
"newBillunitsForBalanceGroups": []
}
Example of Response Body
If successful, the response code 200 is returned with no response body.