Generate a Bill Unit Summary
post
/bcws/webresources/v1.0/billunits/bill-unit-summary
Create a summary of the bill units that match the specified IDs.
Request
Query Parameters
-
id: string
Account id
Supported Media Types
- application/xml
- application/json
Nested Schema : schema
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
-
bdomChangeStatus: integer
(int32)
The status of the billing day-of-month (DOM) change. Can be one of the following:
- -1: Does not exist
- 0: New
- 1: In progress
- 2: Failed
- 3: Completed
-
bdomJobCompletion: string
(date-time)
The time the billing day-of-month (DOM) change job was completed, if applicable.
-
bdomJobFlag: integer
(int32)
Whether the billing day of month (DOM) changes for member accounts should be executed immediately (1) or deferred (2). This flag applies only to parent accounts' bill units that have a business profile with the AsyncBDOMChange key set to yes. If a value is not sent, the job will be deferred (as with a value of 2).
-
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.
-
totalChildBillUnits: integer
(int32)
The total number of child bill units.
-
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.
-
originalBalance: number
The original balance of the sub-balance.
-
rolloverData: integer
(int32)
Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.
-
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.
-
nameinfoObj: object
ResourceRef
-
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
-
svcExpLastNotiOffset: string
The notification offset.
-
svcExpLastNotiT: string
(date-time)
The last notification time.
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
CreditCardTypeDetails
-
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
DebitCardTypeDetails
-
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
InvoiceTypeDetails
-
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
SepaTypeDetails
-
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 : CreditCardTypeDetails
Type:
Show Source
object
-
address: string
The street address associated with the credit card.
-
city: string
The city associated with the credit card.
-
country: string
The country associated with the credit card.
-
debitExp: string
The credit card expiration in mmyy format.
-
debitNumber: string
The credit card number.
-
name: string
The name as it appears on the credit card.
-
securityCode: string
The credit card's 3-digit CVV2 or 4-digit CID.
-
state: string
The state associated with the credit card.
-
zip: string
The ZIP code associated with the credit card.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : DebitCardTypeDetails
Type:
Show Source
object
-
accountType: integer
The bank account type. Possible values are:
- 1: Checking account
- 2: Savings account
- 3: Corporate account.
-
address: string
The street address associated with the bank account.
-
bankNumber: string
The RDFI or Bank ID used for routing transactions.
-
cardActivationDate: string
The date and time the card was activated.
-
city: string
The city associated with the bank account.
-
country: string
The country associated with the bank account.
-
debitNumber: string
The RDFI or Bank ID used for routing transactions.
-
fiasId: string
The FIAS ID.
-
mandateReceivedDate: string
The date and time the mandate was received.
-
mandateStatus: integer
The current mandate status.
-
name: string
The name as it appears on the bank account.
-
state: string
The state associated with the bank account.
-
zip: string
The ZIP code associated with the bank account.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : InvoiceTypeDetails
Type:
Show Source
object
-
address: string
The customer's street address.
-
city: string
The customer's city.
-
country: string
The customer's country.
-
deliveryPrefer: string
The customer's invoice delivery preference. Possible values are:
- 0&colon Email
- 1&colon Postal
- 2&colon Fax
-
elem: integer
The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
-
emailAddr: string
The customer's email address.
-
invoiceID: string
The invoice's ID.
-
name: string
The customer's name.
-
state: string
The customer's state.
-
zip: string
The customer's ZIP code.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : SepaTypeDetails
Type:
Show Source
object
-
bankIdentifierCode: string
The bank identifier code.
-
creditorId: string
The creditor's ID.
-
creditorName: string
The creditor's name.
-
debtorInfo: object
DebtorInfoDetails
-
internationalBankAccountNumber: string
The international bank account number.
-
mandateAmended: integer
The date and time the customer's SEPA mandate was last amended.
-
mandateContractDescr: string
The description of the customer's SEPA mandate contract.
-
mandateContractId: string
The ID of the customer's SEPA mandate contract.
-
mandateEndDate: string
The date and time the customer's SEPA mandate ends.
-
mandateLastPostedDate: string
The date and time the customer's SEPA mandate was last posted.
-
mandateSignedDate: integer
The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
-
mandateSignedPlace: string
The date and time the customer's SEPA mandate contract was signed.
-
mandateStatus: integer
The status of the customer's SEPA mandate. Possible values are:
- 0: Active
- 1: Expired
- 2: Canceled
-
mandateType: integer
The mandate type. Possible values are:
- 0: One-off mandate
- 1: Recurring mandate
-
mandateUniqueReference: string
The unique reference number for the mandate.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : DebtorInfoDetails
Type:
Show Source
object
-
address: string
The debtor's address.
-
city: string
The debtor's city.
-
country: string
The debtor's country.
-
identificationCode: string
The debtor's bank identifier code.
-
name: string
The debtor's name.
-
partyIdCode: string
The debtor's party ID code.
-
referencePartyName: string
The debtor's party name.
-
zip: string
The debtor's ZIP code.
Nested Schema : schema
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
-
bdomChangeStatus: integer
(int32)
The status of the billing day-of-month (DOM) change. Can be one of the following:
- -1: Does not exist
- 0: New
- 1: In progress
- 2: Failed
- 3: Completed
-
bdomJobCompletion: string
(date-time)
The time the billing day-of-month (DOM) change job was completed, if applicable.
-
bdomJobFlag: integer
(int32)
Whether the billing day of month (DOM) changes for member accounts should be executed immediately (1) or deferred (2). This flag applies only to parent accounts' bill units that have a business profile with the AsyncBDOMChange key set to yes. If a value is not sent, the job will be deferred (as with a value of 2).
-
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.
-
totalChildBillUnits: integer
(int32)
The total number of child bill units.
-
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.
-
originalBalance: number
The original balance of the sub-balance.
-
rolloverData: integer
(int32)
Indicates whether the leftover balance in this bucket will be rolled over, and if so, how.
-
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.
-
nameinfoObj: object
ResourceRef
-
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
-
svcExpLastNotiOffset: string
The notification offset.
-
svcExpLastNotiT: string
(date-time)
The last notification time.
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
CreditCardTypeDetails
-
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
DebitCardTypeDetails
-
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
InvoiceTypeDetails
-
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
SepaTypeDetails
-
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 : CreditCardTypeDetails
Type:
Show Source
object
-
address: string
The street address associated with the credit card.
-
city: string
The city associated with the credit card.
-
country: string
The country associated with the credit card.
-
debitExp: string
The credit card expiration in mmyy format.
-
debitNumber: string
The credit card number.
-
name: string
The name as it appears on the credit card.
-
securityCode: string
The credit card's 3-digit CVV2 or 4-digit CID.
-
state: string
The state associated with the credit card.
-
zip: string
The ZIP code associated with the credit card.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : DebitCardTypeDetails
Type:
Show Source
object
-
accountType: integer
The bank account type. Possible values are:
- 1: Checking account
- 2: Savings account
- 3: Corporate account.
-
address: string
The street address associated with the bank account.
-
bankNumber: string
The RDFI or Bank ID used for routing transactions.
-
cardActivationDate: string
The date and time the card was activated.
-
city: string
The city associated with the bank account.
-
country: string
The country associated with the bank account.
-
debitNumber: string
The RDFI or Bank ID used for routing transactions.
-
fiasId: string
The FIAS ID.
-
mandateReceivedDate: string
The date and time the mandate was received.
-
mandateStatus: integer
The current mandate status.
-
name: string
The name as it appears on the bank account.
-
state: string
The state associated with the bank account.
-
zip: string
The ZIP code associated with the bank account.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : InvoiceTypeDetails
Type:
Show Source
object
-
address: string
The customer's street address.
-
city: string
The customer's city.
-
country: string
The customer's country.
-
deliveryPrefer: string
The customer's invoice delivery preference. Possible values are:
- 0&colon Email
- 1&colon Postal
- 2&colon Fax
-
elem: integer
The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
-
emailAddr: string
The customer's email address.
-
invoiceID: string
The invoice's ID.
-
name: string
The customer's name.
-
state: string
The customer's state.
-
zip: string
The customer's ZIP code.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : SepaTypeDetails
Type:
Show Source
object
-
bankIdentifierCode: string
The bank identifier code.
-
creditorId: string
The creditor's ID.
-
creditorName: string
The creditor's name.
-
debtorInfo: object
DebtorInfoDetails
-
internationalBankAccountNumber: string
The international bank account number.
-
mandateAmended: integer
The date and time the customer's SEPA mandate was last amended.
-
mandateContractDescr: string
The description of the customer's SEPA mandate contract.
-
mandateContractId: string
The ID of the customer's SEPA mandate contract.
-
mandateEndDate: string
The date and time the customer's SEPA mandate ends.
-
mandateLastPostedDate: string
The date and time the customer's SEPA mandate was last posted.
-
mandateSignedDate: integer
The position of the entry in the array. For example, the first item in a list would have an elem value of 1.
-
mandateSignedPlace: string
The date and time the customer's SEPA mandate contract was signed.
-
mandateStatus: integer
The status of the customer's SEPA mandate. Possible values are:
- 0: Active
- 1: Expired
- 2: Canceled
-
mandateType: integer
The mandate type. Possible values are:
- 0: One-off mandate
- 1: Recurring mandate
-
mandateUniqueReference: string
The unique reference number for the mandate.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : DebtorInfoDetails
Type:
Show Source
object
-
address: string
The debtor's address.
-
city: string
The debtor's city.
-
country: string
The debtor's country.
-
identificationCode: string
The debtor's bank identifier code.
-
name: string
The debtor's name.
-
partyIdCode: string
The debtor's party ID code.
-
referencePartyName: string
The debtor's party name.
-
zip: string
The debtor's ZIP code.
Response
Supported Media Types
- application/xml
- application/json
200 Response
The bill unit summary information was returned successfully.
Nested Schema : accountSummary
Type:
Show Source
object
-
billInProgressDue(required): number
The in progress amount due for the bill unit.
-
disputed(required): number
The amount for the bill unit that is in dispute.
-
dueNow(required): number
The amount that is due now.
-
extension: object
extension
The extended attributes.
-
id: object
ResourceRef
-
numBills(required): integer
The number of bills associated with the bill unit.
-
paymentTypeId(required): string
The ID for the bill unit's payment type.
-
pendingDue(required): number
The amount for the bill unit that is in pending state.
-
pendingDueDate(required): string
(date-time)
The date and time the pending amount is due.
-
unallocatedAdjustments(required): number
The adjustment amount that is still unallocated.
-
unallocatedPayments(required): number
The payment amount that is still unallocated.
Nested Schema : extension
Type:
object
The extended attributes.
Nested Schema : ResourceRef
Type:
Show Source
object
-
id(required): string
The ID.
-
uri: string
The Uniform Resource Identifier (URI) associated with the resource.
500 Response
An internal server error occurred.
Examples
This example shows how to generate a bill unit summary 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/billunits/bill-unit-summary' -H 'content-type: application/json' -d @billUnitSummary.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.
- billUnitSummary.json is the JSON file that provides information about the bill units.
Example of Request Body
This example shows the contents of the billUnitSummary.json file sent as the request body.
[
{
"extension": null,
"id": "0.0.0.1+-billinfo+78769",
"name": "Bill Unit(1)",
"accountRef": {
"id": "0.0.0.1+-account+81329",
"uri": null
},
"accountingCycleDom": 11,
"accountingType": 2,
"balanceGroups": [
{
"extension": null,
"id": "0.0.0.1+-balance_group+77937",
"name": null,
"services": [],
"balances": [
{
"currentBalance": -1301.52,
"creditFloor": null,
"creditLimit": null,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 840
},
{
"currentBalance": 2000,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000095
}
],
"elem": null
}
],
"paymentInstrumentRef": {
"id": "0.0.0.1+-payinfo-invoice+84306",
"uri": null
},
"currency": 840,
"currencySecondary": 0,
"status": null,
"arBillUnitRef": {
"id": "0.0.0.1+-billinfo+78769",
"uri": null
},
"parentBillUnitName": "Bill Unit(1)",
"parentAccountId": null,
"parentFirstName": null,
"parentLastName": null,
"parentCompanyName": null,
"parentSalutation": null,
"parentAccountNumber": null,
"invoiceTemplate": null,
"businessProfile": "0.0.0.0++0",
"wholesaleBilling": null,
"correctiveInvoiceType": null,
"lastModified": 1611840097000,
"creationDate": null,
"accountingCyclesUntilBillCycleEnds": null,
"billForCurrentCycleRef": {
"id": "0.0.0.1+-bill+209369",
"uri": null
},
"defaultBillUnit": true,
"parentBillUnit": false,
"billingFrequencyInMonths": 1,
"accountingCycleStart": null,
"accountingCycleEnd": null,
"lastActualBillRef": null,
"lastActualBillDate": null,
"lastBillFromBillingRef": null,
"billingCycleStart": 1607673600000,
"billingCycleEnd": 1610352000000,
"segment": "-18",
"daysInBillCycle": 31,
"daysRemainingInBillCycle": 0,
"exemptFromCollections": null,
"scenarioRef": null,
"numSuppressedCycles": null,
"suppressed": null,
"suppressionCyclesLeft": null,
"collectionDate": null,
"paymentInstrumentName": "10001 123",
"collectionDetailsRef": null,
"inCollections": false,
"paymentMethod": null,
"paymentType": 10001,
"totalChildAccounts": null
},
{
"extension": null,
"id": "0.0.0.1+-billinfo+79498",
"name": "bu2",
"accountRef": {
"id": "0.0.0.1+-account+81329",
"uri": null
},
"accountingCycleDom": 1,
"accountingType": 1,
"balanceGroups": [
{
"extension": null,
"id": "0.0.0.1+-balance_group+79242",
"name": null,
"services": [],
"balances": [
{
"currentBalance": -20,
"creditFloor": null,
"creditLimit": null,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 840
}
],
"elem": null
},
{
"extension": null,
"id": "0.0.0.1+-balance_group+199289",
"name": null,
"services": [],
"balances": [
{
"currentBalance": 4530.5,
"creditFloor": null,
"creditLimit": null,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 840
},
{
"currentBalance": 2,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000004
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000007
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000010
},
{
"currentBalance": 2,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000012
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000018
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000020
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000023
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000024
},
{
"currentBalance": 211,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000025
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000026
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000027
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000093
},
{
"currentBalance": 1222,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000095
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000098
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000099
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000100
},
{
"currentBalance": 1,
"creditFloor": null,
"creditLimit": 0,
"creditThresholds": 0,
"formattedCreditThresholds": null,
"creditThresholdsFixed": "",
"expiredBeforeUsing": null,
"subBalances": [],
"resourceId": 1000102
}
],
"elem": null
}
],
"paymentInstrumentRef": {
"id": "0.0.0.1+-payinfo-invoice+84306",
"uri": null
},
"currency": 840,
"currencySecondary": 0,
"status": null,
"arBillUnitRef": {
"id": "0.0.0.1+-billinfo+79498",
"uri": null
},
"parentBillUnitName": "bu2",
"parentAccountId": null,
"parentFirstName": null,
"parentLastName": null,
"parentCompanyName": null,
"parentSalutation": null,
"parentAccountNumber": null,
"invoiceTemplate": null,
"businessProfile": "0.0.0.0++0",
"wholesaleBilling": null,
"correctiveInvoiceType": null,
"lastModified": 1609852907000,
"creationDate": null,
"accountingCyclesUntilBillCycleEnds": null,
"billForCurrentCycleRef": {
"id": "0.0.0.1+-bill+203289",
"uri": null
},
"defaultBillUnit": false,
"parentBillUnit": false,
"billingFrequencyInMonths": 1,
"accountingCycleStart": null,
"accountingCycleEnd": null,
"lastActualBillRef": null,
"lastActualBillDate": null,
"lastBillFromBillingRef": null,
"billingCycleStart": 1606809600000,
"billingCycleEnd": 1609488000000,
"segment": "-28",
"daysInBillCycle": 31,
"daysRemainingInBillCycle": -28,
"exemptFromCollections": null,
"scenarioRef": null,
"numSuppressedCycles": null,
"suppressed": null,
"suppressionCyclesLeft": null,
"collectionDate": null,
"paymentInstrumentName": "10001 123",
"collectionDetailsRef": null,
"inCollections": false,
"paymentMethod": null,
"paymentType": 10001,
"totalChildAccounts": null
}
]
Example of Response Body
This shows an example of the contents of the response body in JSON format.
[
{
"extension": null,
"pendingDue": -33.50,
"pendingDueDate": 1612944000000,
"unallocatedPayments": -286.95,
"unallocatedAdjustments": -1020.5,
"billInProgressDue": 0,
"dueNow": 21.95,
"numBills": 9,
"disputed": 0,
"paymentTypeId": null
},
{
"extension": null,
"pendingDue": 4530.5,
"pendingDueDate": 1614758400000,
"unallocatedPayments": -20,
"unallocatedAdjustments": null,
"billInProgressDue": 0,
"dueNow": 2287.5,
"numBills": 9,
"disputed": 0,
"paymentTypeId": null
}
]