Get Balance Groups for a Bill Unit
get
/bcws/webresources/v1.0/billunits/balancegroups/{id}
Gets the list of balance groups with balances and services for the bill unit that matches the specified ID. Balances will include both currency and noncurrency balances.
Request
Path Parameters
-
id(required): string
The ID of the bill unit.
Query Parameters
-
includeBalanceMonitor(required): boolean
whether it needs to fetch balance group monitor or not
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The balance groups were returned successfully.
Root Schema : billUnit
Type:
object
A bill unit.
Show Source
-
accountingCycleDom: integer
(int32)
The bill unit's accounting cycle day of month (DOM).
-
accountingCycleEnd: string
(date-time)
The date and time the accounting cycle ends.
-
accountingCycleStart: string
(date-time)
The date and time the accounting cycle starts.
-
accountingCyclesUntilBillCycleEnds: integer
(int32)
The number of monthly accounting cycles remaining until the current billing cycle ends.
-
accountingType: integer
(int32)
The bill unit's accounting type: open item (1) or balance forward (2).
-
accountRef: object
ResourceRef
-
arBillUnitRef: object
ResourceRef
-
balanceGroups(required): array
balanceGroups
-
billForCurrentCycleRef: object
ResourceRef
-
billingCycleEnd: string
(date-time)
The date and time the billing cycle ends.
-
billingCycleStart: string
(date-time)
The date and time the billing cycle starts
-
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.
-
collectionDate: string
(date-time)
The date collections is due.
-
collectionDetailsRef: object
ResourceRef
-
correctiveInvoiceType: integer
(int32)
The type of invoice to create for corrective bills, such as an invoice correction letter or a replacement invoice.
-
creationDate(required): string
(date-time)
The date and time the bill unit was created.
-
currency: integer
(int32)
The bill unit's primary currency.
-
currencySecondary: integer
(int32)
The bill unit's secondary currency.
-
daysInBillCycle: integer
(int32)
The number of days in a billing cycle.
-
daysRemainingInBillCycle: integer
(int32)
The number of days that remain in the current billing cycle.
-
defaultBillUnit: boolean
Whether this is the default bill unit (true) or not (false).
-
exemptFromCollections: integer
(int32)
Whether the bill unit is exempt from collections or not.
-
extension: object
extension
The extended attributes.
-
id(required): string
The ID.
-
inCollections: boolean
Whether the bill unit is in collections (true) or not (false).
-
invoiceTemplate(required): string
The name of the invoice template associated with the bill unit.
-
lastActualBillDate: string
(date-time)
The date and time the last bill was created.
-
lastActualBillRef: object
ResourceRef
-
lastBillFromBillingRef: object
ResourceRef
-
lastModified: string
(date-time)
The date and time the bill unit was last modified.
-
name(required): string
The bill unit's name.
-
numSuppressedCycles: integer
(int32)
The number of consecutive billing cycles that the bill unit has been suppressed.
-
parentAccountId(required): string
The ID of this bill unit's parent account.
-
parentAccountNumber(required): string
The account number associated with the parent's bill unit.
-
parentBillUnit: boolean
Whether this is a parent bill unit (true) or not (false).
-
parentBillUnitName(required): string
The name of this bill unit's parent bill unit.
-
parentCompanyName(required): string
The parent bill unit's company name.
-
parentFirstName(required): string
The first name associated with the parent bill unit.
-
parentLastName(required): string
The last name associated with the parent bill unit.
-
parentSalutation(required): string
The parent bill unit's salutation, such as Mr. or Mx.
-
paymentInstrumentName(required): string
The name of the payment instrument.
-
paymentInstrumentRef: object
ResourceRef
-
paymentMethod: object
PaymentMethod
-
paymentType: integer
(int32)
The payment type. Can be one of the following:
- 10001:Invoice
- 10003: Credit card
- 10005: Direct debit
- 10007: Subordinate
-
rollUp: boolean
-
scenarioRef: object
ResourceRef
-
segment: string
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: defunct (0), active (10100), inactive (10102), or closed (10103)
-
suppressed: integer
(int32)
Whether the bill unit is suppressed or not.
-
suppressionCyclesLeft: integer
(int32)
The number of consecutive billing cycles for which the bill is to be suppressed.
-
totalChildAccounts: integer
(int32)
The total number of child accounts.
-
wholesaleBilling(required): string
The wholesale billing key.
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 : extension
Type:
object
The extended attributes.
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 : 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 : 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 : 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.
500 Response
An internal server error occurred.
Examples
This example shows how to get the balance groups for a specified bill unit by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X GET 'http://hostname:port/bcws/webresources/version/billunits/balancegroups/0.0.0.1+-billinfo+60687'
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.
Example of Response Body
This example shows the contents of the response body in JSON format.
{
"extension": null,
"id": null,
"name": null,
"accountRef": null,
"accountingCycleDom": null,
"accountingType": null,
"balanceGroups": [
{
"extension": null,
"id": "0.0.0.1+-balance_group+61199",
"name": "Balance Group<Account>",
"services": [
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+156801",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1600943653000,
"effectiveDate": 1601383372000,
"lastStatusComment": null,
"lastStatusChange": 1601383372000,
"login": "ip0",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+166570",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601448244000,
"effectiveDate": 1598954633000,
"lastStatusComment": null,
"lastStatusChange": 1596523436000,
"login": "IP_Service",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+161387",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601388328000,
"effectiveDate": 1600265109000,
"lastStatusComment": null,
"lastStatusChange": 1600265109000,
"login": "service_ip",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+165544",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601443489000,
"effectiveDate": 1601443489000,
"lastStatusComment": null,
"lastStatusChange": 1601443489000,
"login": "service-ip",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-email+166825",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601536347000,
"effectiveDate": 1607347026000,
"lastStatusComment": null,
"lastStatusChange": 1601536345000,
"login": "emailservice2@portal.com",
"lifeCycleState": 0,
"lastModified": null,
"name": "email",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-email+165033",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1601536346000,
"effectiveDate": 1601536345000,
"lastStatusComment": null,
"lastStatusChange": 1601536345000,
"login": "emailservice1@portal.com",
"lifeCycleState": 0,
"lastModified": null,
"name": "email",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-ip+60815",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1589182094000,
"effectiveDate": 1601461071000,
"lastStatusComment": null,
"lastStatusChange": 1601461071000,
"login": "ip",
"lifeCycleState": 0,
"lastModified": null,
"name": "ip",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
},
{
"extension": null,
"id": {
"id": "0.0.0.1+-service-email+57999",
"uri": null
},
"pendingDeferredActionsCount": null,
"accountRef": null,
"aliasList": [],
"balanceGroupRef": {
"id": "0.0.0.1+-balance_group+61199",
"uri": null
},
"creationDate": 1589182094000,
"effectiveDate": 1600956338000,
"lastStatusComment": null,
"lastStatusChange": 1589182094000,
"login": "email@portal.com",
"lifeCycleState": 0,
"lastModified": null,
"name": "email",
"password": null,
"passwordExpiration": null,
"passwordStatus": null,
"status": 10100,
"statusFlags": null,
"subscriptionServiceRef": null,
"serviceAccessLevel": null,
"balGrpIndex": null
}
],
"balances": [
{
"modifyLimit": null,
"currentBalance": 3,
"creditFloor": 1,
"creditLimit": 12,
"creditThresholds": 0,
"formattedCreditThresholds": "",
"creditThresholdsFixed": "|1.00",
"expiredBeforeUsing": 0,
"subBalances": [
{
"extension": null,
"currentBalance": 3,
"validFrom": 1514793600000,
"validTo": 0,
"rolloverData": 0,
"expiredBeforeUsing": 0,
"elementId": 0
}
],
"outstandingAmount": 0,
"loanThresholds": null,
"loanThresholdsFixed": null,
"tempCreditLimit": [
{
"limit": 20,
"resourceId": 840,
"validToUnit": 4,
"validToOffset": 10,
"validFromUnit": 4,
"validFromOffset": 30
}
],
"resourceId": 840
}
],
"elem": null
}
],
"paymentInstrumentRef": null,
"currency": 840,
"currencySecondary": null,
"status": null,
"arBillUnitRef": null,
"parentBillUnitName": null,
"parentAccountId": null,
"parentFirstName": "Nancy",
"parentLastName": "Miller",
"parentCompanyName": Vision Corporation,
"parentSalutation": "Miss",
"parentAccountNumber": null,
"invoiceTemplate": null,
"businessProfile": null,
"wholesaleBilling": null,
"correctiveInvoiceType": null,
"lastModified": null,
"creationDate": null,
"accountingCyclesUntilBillCycleEnds": null,
"billForCurrentCycleRef": null,
"defaultBillUnit": null,
"parentBillUnit": null,
"billingFrequencyInMonths": null,
"accountingCycleStart": null,
"accountingCycleEnd": null,
"lastActualBillRef": null,
"lastActualBillDate": null,
"lastBillFromBillingRef": null,
"billingCycleStart": null,
"billingCycleEnd": null,
"segment": null,
"daysInBillCycle": null,
"daysRemainingInBillCycle": null,
"exemptFromCollections": null,
"scenarioRef": null,
"numSuppressedCycles": null,
"suppressed": null,
"suppressionCyclesLeft": null,
"collectionDate": null,
"paymentInstrumentName": null,
"collectionDetailsRef": null,
"inCollections": null,
"paymentMethod": null,
"paymentType": null,
"totalChildAccounts": null
}