Jump to

• Request
• Response
• Examples

Validate an Account

post

/bcws/webresources/v1.0/accounts/validate

Validates the registration data for the specified account.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• billUnits: array billUnits
• businessType: integer (int32)
  The business type: consumer (1) or business (2).
• contacts(required): array contacts
  An account's contact information.
• currency: integer (int32)
  The account's primary currency.
• customerTypeCode: integer (int32)
  The customer type: standard (1), brand (2), or subscription (3).
• effective: string (date-time)
  The date and time the account takes effect.
• extension: object extension
  The extended attributes.
• genericBundle: object CustomizedBundleForPurchase
• locale: string
  The customer's locale, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.
• notes: object Notes
• organizationHierarchyTypeCode: integer (int32)
  The code for the account organization hierarchy type, such as site or legal entity.
• parentRef: object ResourceRef
• paymentMethod: array paymentMethod
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10000:Prepaid
  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate
• profiles: array profiles
• purchasingPlanRef: string
  The resource for the purchased package, such as 0.0.0.1+-plan+45678.
• securityCode1: string
  A security code used to verify account access. This provides an authentication test for customer service requests.
• securityCode2: string
  A security code used to verify account access. This provides an authentication test for customer service requests.
• services(required): array services
• status: string
  The account's status: active (10100), inactive (10102), or closed (10103).
• timezoneId: string
  The ID for the customer's timezone.
• wallet: object Wallet

{
    "required":[
        "contacts",
        "services"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "contacts":{
            "type":"array",
            "description":"An account's contact information.",
            "items":{
                "$ref":"#/components/schemas/Contacts"
            }
        },
        "securityCode1":{
            "type":"string",
            "description":"A security code used to verify account access. This provides an authentication test for customer service requests."
        },
        "securityCode2":{
            "type":"string",
            "description":"A security code used to verify account access. This provides an authentication test for customer service requests."
        },
        "parentRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "locale":{
            "type":"string",
            "description":"The customer's locale, such as <b>en_US</b> or <b>fr_FR</b>. For a list of valid values, see \"Locale Names\" in <i>BRM Developer's Guide</i>."
        },
        "timezoneId":{
            "type":"string",
            "description":"The ID for the customer's timezone."
        },
        "purchasingPlanRef":{
            "type":"string",
            "description":"The resource for the purchased package, such as 0.0.0.1+-plan+45678."
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PurchasingService"
            }
        },
        "genericBundle":{
            "$ref":"#/components/schemas/CustomizedBundleForPurchase"
        },
        "customerTypeCode":{
            "type":"integer",
            "description":"The customer type: standard (<b>1</b>), brand (<b>2</b>), or subscription (<b>3</b>).",
            "format":"int32"
        },
        "organizationHierarchyTypeCode":{
            "type":"integer",
            "description":"The code for the account organization hierarchy type, such as site or legal entity.",
            "format":"int32"
        },
        "effective":{
            "type":"string",
            "description":"The date and time the account takes effect.",
            "format":"date-time"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "businessType":{
            "type":"integer",
            "description":"The business type: consumer (<b>1</b>) or business (<b>2</b>).",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"The account's status: active (<b>10100</b>), inactive (<b>10102</b>), or closed (<b>10103</b>)."
        },
        "currency":{
            "type":"integer",
            "description":"The account's primary currency.",
            "format":"int32"
        },
        "wallet":{
            "$ref":"#/components/schemas/Wallet"
        },
        "billUnits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NewBillUnits"
            }
        },
        "profiles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProfileBase"
            }
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10000</b>:Prepaid</li><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "paymentMethod":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PaymentMethod"
            }
        }
    },
    "xml":{
        "name":"registrationAccount"
    }
}

Nested Schema : billUnits

Type: array

Show Source

• Array of: object NewBillUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NewBillUnits"
    }
}

Nested Schema : contacts

Type: array

An account's contact information.

Show Source

• Array of: object contacts
  An account's contact information.

{
    "type":"array",
    "description":"An account's contact information.",
    "items":{
        "$ref":"#/components/schemas/Contacts"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : CustomizedBundleForPurchase

Type: object

Show Source

• 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

{
    "required":[
        "id",
        "name"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The bundle's name."
        },
        "effective":{
            "type":"string",
            "description":"The date and time the bundle takes effect.",
            "format":"date-time"
        },
        "creditLimitFlags":{
            "type":"integer",
            "description":"Flag to set credit limit options. Allowed Values: <b>1</b> (Override credit limit), <b>2</b> (Prorate based on credit limit), <b>64</b> (Enforce credit limit).",
            "format":"int32"
        },
        "customizedChargeOffers":{
            "type":"array",
            "description":"The list of customized charge offers in the bundle.",
            "items":{
                "$ref":"#/components/schemas/CustomizedChargeOffers"
            }
        },
        "customizedDiscountOffers":{
            "type":"array",
            "description":"The list of customized discount offers.",
            "items":{
                "$ref":"#/components/schemas/CustomizedDiscountOffers"
            }
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        }
    }
}

Nested Schema : Notes

Type: object

Show Source

• 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.

{
    "required":[
        "accountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the note."
        },
        "amount":{
            "type":"number",
            "description":"The amount associated with the note. It can be a payment amount, adjustment amount, or so on."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit associated with the note."
        },
        "billId":{
            "type":"string",
            "description":"The ID of the bill associated with the note."
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the note was resolved.",
            "format":"date-time"
        },
        "count":{
            "type":"integer",
            "description":"The number of comments associated with the note.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the comment was posted.",
            "format":"date-time"
        },
        "eventId":{
            "type":"string",
            "description":"The ID of the event associated with the note."
        },
        "header":{
            "type":"string",
            "description":"The header associated with the note."
        },
        "itemId":{
            "type":"string",
            "description":"The ID of the item associated with the note."
        },
        "subType":{
            "type":"integer",
            "description":"The note's subtype. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "type":{
            "type":"integer",
            "description":"The note's type. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "domainId":{
            "type":"integer",
            "description":"The domain ID associated with the note.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID associated with the note. Possible values are stored in <b>/config/reason_code_scope</b> objects. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>reasons.</b><i>locale</i> file.",
            "format":"int32"
        },
        "serviceId":{
            "type":"string",
            "description":"The service ID associated with the note."
        },
        "status":{
            "type":"number",
            "description":"The note's status: not set (<b>100</b>), resolved (<b>101</b>), or unresolved (<b>102</b>). The default value is <b>102</b>."
        },
        "comments":{
            "type":"array",
            "description":"The list of comments associated with the note.",
            "items":{
                "$ref":"#/components/schemas/Comments"
            }
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : paymentMethod

Type: array

Show Source

• Array of: object PaymentMethod

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PaymentMethod"
    }
}

Nested Schema : profiles

Type: array

Show Source

• Array of: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProfileBase"
    }
}

Nested Schema : services

Type: array

Show Source

• Array of: object PurchasingService

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PurchasingService"
    }
}

Nested Schema : Wallet

Type: object

Show Source

• extension: object extension
  The extended attributes.
• paymentInstrument: array paymentInstrument

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "paymentInstrument":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"object",
                        "properties":{
                            "namespaceURI":{
                                "type":"string"
                            },
                            "localPart":{
                                "type":"string"
                            },
                            "prefix":{
                                "type":"string"
                            }
                        }
                    },
                    "value":{
                        "$ref":"#/components/schemas/PaymentInstrumentType"
                    },
                    "nil":{
                        "type":"boolean"
                    },
                    "globalScope":{
                        "type":"boolean"
                    },
                    "typeSubstituted":{
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : NewBillUnits

Type: object

Show Source

• 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.

{
    "required":[
        "businessProfile",
        "forServiceGroup"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the bill unit."
        },
        "forServiceGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceGroupIndex"
            }
        },
        "walletPaymentInstrumentIndex":{
            "type":"integer",
            "description":"The wallet index number for the payment instrument associated with the bill unit.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the bill unit takes effect.",
            "format":"date-time"
        },
        "currency":{
            "type":"integer",
            "description":"The primary currency of the bill unit.",
            "format":"int32"
        },
        "accountingCycleDom":{
            "type":"integer",
            "description":"The accounting cycle day of month (DOM).",
            "format":"int32"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "paymentMethod":{
            "$ref":"#/components/schemas/PaymentMethod"
        },
        "paymentMethodId":{
            "type":"string",
            "description":"The ID of the payment method."
        },
        "rollUp":{
            "type":"boolean"
        },
        "accountingType":{
            "type":"integer",
            "description":"The accounting type. Can be one of the following: <ul><li><b>1</b>: Open item</li><li><b>2</b>: Balance forward</li></ul>",
            "format":"int32"
        },
        "billingFrequencyInMonths":{
            "type":"integer",
            "description":"The billing frequency in number of months. Can be one of the following: <ul><li><b>1</b>: Monthly</li><li><b>2</b>: Bi-monthly</li><li><b>3</b>: Quarterly</li><li><b>12</b>: Yearly</li></ul>",
            "format":"int32"
        },
        "segment":{
            "type":"integer",
            "description":"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.",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"The status of the bill unit, such as active, inactive, or closed."
        },
        "arBillUnitRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentBillUnitRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentRef":{
            "type":"string",
            "description":"A reference to the parent."
        },
        "businessProfile":{
            "type":"string",
            "description":"The business profile associated with bill unit."
        },
        "balanceGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BalanceGroup"
            }
        }
    }
}

Nested Schema : balanceGroups

Type: array

Show Source

• Array of: object BalanceGroup

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BalanceGroup"
    }
}

Nested Schema : forServiceGroup

Type: array

Show Source

• Array of: object ServiceGroupIndex

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceGroupIndex"
    }
}

Nested Schema : PaymentMethod

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "creditCard":{
            "$ref":"#/components/schemas/CreditCardType"
        },
        "directDebit":{
            "$ref":"#/components/schemas/DirectDebitType"
        },
        "invoice":{
            "$ref":"#/components/schemas/InvoiceType"
        },
        "sepa":{
            "$ref":"#/components/schemas/SepaType"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        }
    }
}

Nested Schema : BalanceGroup

Type: object

Show Source

• 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

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance group."
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceType"
            }
        },
        "monitorType":{
            "type":"string",
            "description":"The monitoring group type. Allowed Values: <ul><li><b>H_CE</b> (Hierarchy Credit Exposure)</li><li><b>PR_CE</b> (Payment Responsible Credit Exposure)</li><li><b>SUB_CE</b> (Subscription Credit Exposure)</li><li><b>PR_RTCE</b> (Payment Responsible Real-Time Credit Enforcement)</li></ul>"
        },
        "balances":{
            "type":"array",
            "description":"The list of balances associated with the balance group.",
            "items":{
                "$ref":"#/components/schemas/Balances"
            }
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    }
}

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.

{
    "type":"array",
    "description":"The list of balances associated with the balance group.",
    "items":{
        "$ref":"#/components/schemas/Balances"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : services

Type: array

Show Source

• Array of: object ServiceType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceType"
    }
}

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

{
    "required":[
        "currentBalance",
        "outstandingAmount"
    ],
    "type":"object",
    "properties":{
        "modifyLimit":{
            "type":"boolean",
            "description":"Whether a credit limit is being modified by the request (<b>true</b>) or not (<b>false</b>)."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current balance."
        },
        "dynamicCreditFloor":{
            "type":"boolean",
            "description":"Whether to use a dynamic credit floor (<b>true</b>) or not (<b>false</b>). The default is <b>false</b>."
        },
        "creditFloor":{
            "type":"number",
            "description":"The credit floor associated with the balance."
        },
        "creditLimit":{
            "type":"number",
            "description":"The credit limit associated with the balance."
        },
        "overrideCreditLimit":{
            "type":"integer",
            "description":"Whether to override the credit limit. Allowed Values: <b>0</b> (Enforce Credit Limit) or <b>1</b> (Override credit limit).",
            "format":"int32"
        },
        "creditThresholds":{
            "type":"integer",
            "description":"The credit thresholds associated with the balance.",
            "format":"int32"
        },
        "formattedCreditThresholds":{
            "type":"string",
            "description":"The balance percentage usage at which to notify the customer."
        },
        "creditThresholdsFixed":{
            "type":"string",
            "description":"The value at which to send a notification, such as 30 US dollars or 30 minutes."
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the balance expires."
        },
        "subBalances":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubBalances"
            }
        },
        "outstandingAmount":{
            "type":"number",
            "description":"An amount that the customer still owes, for loans or when they exceed their credit limit."
        },
        "loanThresholds":{
            "type":"integer",
            "description":"The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.",
            "format":"int32"
        },
        "loanThresholdsFixed":{
            "type":"string",
            "description":"The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan."
        },
        "tempCreditLimit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TempCreditLimit"
            }
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the balance.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of balances associated with the balance group."
}

Nested Schema : subBalances

Type: array

Show Source

• Array of: object SubBalances

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubBalances"
    }
}

Nested Schema : tempCreditLimit

Type: array

Show Source

• Array of: object TempCreditLimit

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TempCreditLimit"
    }
}

Nested Schema : SubBalances

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current amount of the sub-balance."
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time the validity period starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the validity period ends.",
            "format":"date-time"
        },
        "rolloverData":{
            "type":"integer",
            "description":"Details about a rollover subbalance.",
            "format":"int32"
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the sub-balance expires."
        },
        "elementId":{
            "type":"integer",
            "description":"The ID of the element.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : TempCreditLimit

Type: object

Show Source

• 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.

{
    "required":[
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The temporary credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the temporary credit limit.",
            "format":"int32"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity ends.",
            "format":"date-time"
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity starts.",
            "format":"date-time"
        },
        "validToUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validToOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validFromUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period start.",
            "format":"int32"
        },
        "validFromOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period start.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : ServiceType

Type: object

Show Source

• 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.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-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.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

Nested Schema : ServiceGroupIndex

Type: object

Show Source

• serviceGroupElem: integer (int32)
  The service group element.

{
    "type":"object",
    "properties":{
        "serviceGroupElem":{
            "type":"integer",
            "description":"The service group element.",
            "format":"int32"
        }
    }
}

Nested Schema : CreditCardType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

Nested Schema : DirectDebitType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : InvoiceType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

Nested Schema : SepaType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

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.

{
    "required":[
        "balanceImpactResource",
        "fixedPriceTag",
        "scaledPriceTag"
    ],
    "type":"object",
    "properties":{
        "balanceImpactResource":{
            "type":"string",
            "description":"The resource that represents the balance impact of the offer."
        },
        "fixedAmount":{
            "type":"number",
            "description":"The fixed amount of the offer.",
            "format":"float"
        },
        "scaledAmount":{
            "type":"number",
            "description":"The scaled amount of the offer.",
            "format":"float"
        },
        "fixedPriceTag":{
            "type":"string",
            "description":"The fixed price tag of the offer."
        },
        "scaledPriceTag":{
            "type":"string",
            "description":"The scaled price tag of the offer."
        }
    },
    "description":"The offer details."
}

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 : contacts

Type: object

An account's contact information.

Show Source

• address(required): string
  The customer's address.
• city(required): string
  The customer's city.
• company: string
  The company name.
• contactType: string
  The contact type.
• country(required): string
  The customer's country.
• deleted: boolean
  Default Value: false

  Whether to delete the contact (true) or not (false). This must be set to false if you adding a contact.
• 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.
• emailAddress: string
  The customer's email address.
• firstName(required): string
  The customer's first name.
• lastName(required): string
  The customer's last name.
• middleName: string
  The customer's middle name.
• newlyCreated: boolean
  Default Value: false

  Whether the contact information was newly created (true) or not (false).
• phonenumbers: array phonenumbers
  The list of associated phone numbers.
• salutation: string
  The salutation to use use with the customer, such as Mr. or Miss.
• state: string
  The customer's state.
• title: string
  The customer's job title.
• zip: string
  The ZIP code.

{
    "required":[
        "address",
        "city",
        "country",
        "firstName",
        "lastName"
    ],
    "type":"object",
    "properties":{
        "address":{
            "type":"string",
            "description":"The customer's address."
        },
        "city":{
            "type":"string",
            "description":"The customer's city."
        },
        "company":{
            "type":"string",
            "description":"The company name."
        },
        "contactType":{
            "type":"string",
            "description":"The contact type."
        },
        "country":{
            "type":"string",
            "description":"The customer's country."
        },
        "emailAddress":{
            "type":"string",
            "description":"The customer's email address."
        },
        "firstName":{
            "type":"string",
            "description":"The customer's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The customer's last name."
        },
        "middleName":{
            "type":"string",
            "description":"The customer's middle name."
        },
        "salutation":{
            "type":"string",
            "description":"The salutation to use use with the customer, such as Mr. or Miss."
        },
        "state":{
            "type":"string",
            "description":"The customer's state."
        },
        "title":{
            "type":"string",
            "description":"The customer's job title."
        },
        "zip":{
            "type":"string",
            "description":"The ZIP code."
        },
        "deleted":{
            "type":"boolean",
            "description":"Whether to delete the contact (<b>true</b>) or not (<b>false</b>). This must be set to <b>false</b> if you adding a contact.",
            "default":false
        },
        "newlyCreated":{
            "type":"boolean",
            "description":"Whether the contact information was newly created (<b>true</b>) or not (<b>false</b>).",
            "default":false
        },
        "phonenumbers":{
            "type":"array",
            "description":"The list of associated phone numbers.",
            "items":{
                "$ref":"#/components/schemas/Phonenumbers"
            }
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"An account's contact information.",
    "xml":{
        "name":"contacts"
    }
}

Nested Schema : phonenumbers

Type: array

The list of associated phone numbers.

Show Source

• Array of: object Phonenumbers
  The list of the account's phone numbers.

{
    "type":"array",
    "description":"The list of associated phone numbers.",
    "items":{
        "$ref":"#/components/schemas/Phonenumbers"
    }
}

Nested Schema : Phonenumbers

Type: object

The list of the account's phone numbers.

Show Source

• number(required): string
  The phone number.
• phonetype: integer (int32)
  The phone number's type.

{
    "required":[
        "number"
    ],
    "type":"object",
    "properties":{
        "number":{
            "type":"string",
            "description":"The phone number."
        },
        "phonetype":{
            "type":"integer",
            "description":"The phone number's type.",
            "format":"int32"
        }
    },
    "description":"The list of the account's phone numbers."
}

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.

{
    "type":"array",
    "description":"The list of customized charge offers in the bundle.",
    "items":{
        "$ref":"#/components/schemas/CustomizedChargeOffers"
    }
}

Nested Schema : customizedDiscountOffers

Type: array

The list of customized discount offers.

Show Source

• Array of: object CustomizedDiscountOffers
  The list of customized discount offers.

{
    "type":"array",
    "description":"The list of customized discount offers.",
    "items":{
        "$ref":"#/components/schemas/CustomizedDiscountOffers"
    }
}

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.

{
    "type":"object",
    "properties":{
        "baseChargeOfferRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "baseProductRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "validityAlignMode":{
            "type":"string",
            "description":"The validity align mode for a product. Can be one of the following: <ul><li><b>base</b>: Align the validity with baseProductRef passed in request </li><li><b>any_base_earliest</b>: Aligns the validity dates with the active base charge offer that expires first.</li><li><b>any_base_latest</b>: Aligns the validity dates with the active base charge offer that expires last.</li><li><b>any_earliest</b>: Aligns the validity dates with the active charge offer that expires first.</li><li><b>any_latest</b>: Aligns the validity dates with the active charge offer that expires last.</li></ul>"
        },
        "quantity":{
            "type":"integer",
            "description":"The quantity purchased.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The charge offer's name."
        },
        "description":{
            "type":"string",
            "description":"The charge offer's description."
        },
        "cycleStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "cycleEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "cycleFeeOverride":{
            "type":"number",
            "description":"The amount of the cycle fee override."
        },
        "cycleDiscountOverride":{
            "type":"number",
            "description":"The fixed amount of the cycle discount override."
        },
        "cycleDiscountPercentOverride":{
            "type":"number",
            "description":"The percentage amount of the cycle discount override."
        },
        "purchaseStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "purchaseEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "purchaseFeeOverride":{
            "type":"number",
            "description":"The fixed amount of the purchase fee override."
        },
        "purchaseDiscountOverride":{
            "type":"number",
            "description":"The fixed amount of the purchase discount override."
        },
        "purchaseDiscountPercentOverride":{
            "type":"number",
            "description":"The percentage amount of the purchase discount override."
        },
        "usageStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "usageEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "usagePercentOverride":{
            "type":"number",
            "description":"The percentage amount of the usage override."
        },
        "gracePeriodUnit":{
            "type":"integer",
            "description":"The unit for the grace period.",
            "format":"int32"
        },
        "gracePeriodOffset":{
            "type":"integer",
            "description":"The number to offset the grace period by.",
            "format":"int32"
        },
        "renewalMode":{
            "type":"integer",
            "description":"How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are: <ul><li><b>0</b>: Cycle aligns with the original billing date or configured specific day of the month.</li><li><b>1</b>: Cycle aligns with the reactivation date.</li></ul>",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The charge offer's status. Can be one of the following: <ul><li><b>0</b>: Not set</li><li><b>1</b>: Active</li><li><b>2</b>: Inactive</li><li><b>3</b>: Canceled</li></ul>",
            "format":"int32"
        },
        "statusFlag":{
            "type":"integer",
            "description":"The status flag.",
            "format":"int32"
        },
        "overriddenCharges":{
            "type":"array",
            "description":"The overridden charges.",
            "items":{
                "$ref":"#/components/schemas/OverriddenCharges"
            }
        }
    },
    "description":"The list of customized charge offers in the bundle."
}

Nested Schema : EndingType

Type: object

Show Source

• 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

{
    "required":[
        "mode"
    ],
    "type":"object",
    "properties":{
        "mode":{
            "type":"string",
            "description":"The ending type mode for a product. Can be one of the following: <ul><li><b>absolute</b>: The end date is a calendar day.</li><li><b>relativeToStart</b>: 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.</li><li><b>never</b>: There is no set end date.</li></ul>"
        },
        "unitSettings":{
            "$ref":"#/components/schemas/RelativeSettings"
        },
        "endDate":{
            "type":"string",
            "description":"The date and time the cycle ends.",
            "format":"date-time"
        }
    }
}

Nested Schema : StartingType

Type: object

Show Source

• 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

{
    "required":[
        "mode"
    ],
    "type":"object",
    "properties":{
        "mode":{
            "type":"string",
            "description":"The starting type mode for a product. Can be one of the following:<ul><li><b>immediately</b>: The start date is set to today. This mode can be used with the <b>purchaseStart</b>, <b>cycleStart</b>, and <b>usageStart</b> parameters.</li><li><b>absolute</b>: The start date is a calendar date. This mode can be used with the <b>purchaseStart</b>, <b>cycleStart</b>, and <b>usageStart</b> parameters.</li><li><b>relativeToPurchase</b>: 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 <b>cycleStart</b> and <b>usageStart</b> parameters.</li><li><b>firstUsage</b>: The start day is the day of the first recorded usage.</li></ul>"
        },
        "startDate":{
            "type":"string",
            "description":"The date and time the cycle starts.",
            "format":"date-time"
        },
        "unitSettings":{
            "$ref":"#/components/schemas/RelativeSettings"
        }
    }
}

Nested Schema : overriddenCharges

Type: array

The overridden charges.

Show Source

• Array of: object overriddenCharges

{
    "type":"array",
    "description":"The overridden charges.",
    "items":{
        "$ref":"#/components/schemas/OverriddenCharges"
    }
}

Nested Schema : RelativeSettings

Type: object

Show Source

• 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

{
    "required":[
        "units"
    ],
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The number of days, hours, minutes or so on after the cycle starts or ends.",
            "format":"int32"
        },
        "units":{
            "type":"string",
            "description":"The offset unit. Can be one of the following: <ul><li>seconds</li><li>minutes</li><li>hours</li><li>days</li><li>months</li><li>cycles</li></ul>"
        }
    }
}

Nested Schema : overriddenCharges

Type: object

Show Source

• charges(required): array charges
  The charge details.
• event(required): string
  The event associated with the overridden charges.

{
    "required":[
        "charges",
        "event"
    ],
    "type":"object",
    "properties":{
        "event":{
            "type":"string",
            "description":"The event associated with the overridden charges."
        },
        "charges":{
            "type":"array",
            "description":"The charge details.",
            "items":{
                "$ref":"#/components/schemas/Charges"
            }
        }
    },
    "xml":{
        "name":"overriddenCharges"
    }
}

Nested Schema : charges

Type: array

The charge details.

Show Source

• Array of: object Charges
  The charge details.

{
    "type":"array",
    "description":"The charge details.",
    "items":{
        "$ref":"#/components/schemas/Charges"
    }
}

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.

{
    "required":[
        "charge",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "description":"The date and time the charge's validity starts.",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "description":"The date and time the charge's validity ends.",
            "format":"date-time"
        },
        "charge":{
            "type":"array",
            "description":"The charges.",
            "items":{
                "$ref":"#/components/schemas/Charge"
            }
        }
    },
    "description":"The charge details."
}

Nested Schema : charge

Type: array

The charges.

Show Source

• Array of: object Charge
  The charges.

{
    "type":"array",
    "description":"The charges.",
    "items":{
        "$ref":"#/components/schemas/Charge"
    }
}

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.

{
    "required":[
        "amount",
        "priceTag",
        "type"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The charge amount."
        },
        "priceTag":{
            "type":"string",
            "description":"The charge's price tag."
        },
        "type":{
            "type":"string",
            "description":"The charge type."
        }
    },
    "description":"The charges."
}

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(required): number
  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

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "baseDiscountOfferRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The discount offer's name."
        },
        "description":{
            "type":"string",
            "description":"The discount offer's description."
        },
        "quantity":{
            "type":"number",
            "description":"The discount's quantity."
        },
        "purchaseStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "purchaseEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "cycleStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "cycleEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "usageStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "usageEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "status":{
            "type":"integer",
            "description":"The discount offer's status. Can be one of the following: <ul><li><b>0</b>: Not set</li><li><b>1</b>: Active</li><li><b>2</b>: Inactive</li><li><b>3</b>: Canceled</li></ul>",
            "format":"int32"
        },
        "statusFlag":{
            "type":"integer",
            "description":"The status flag.",
            "format":"int32"
        },
        "overriddenCharges":{
            "type":"array",
            "description":"The overridden charges.",
            "items":{
                "$ref":"#/components/schemas/OverriddenCharges"
            }
        }
    },
    "description":"The list of customized discount offers."
}

Nested Schema : overriddenCharges

Type: array

The overridden charges.

Show Source

• Array of: object overriddenCharges

{
    "type":"array",
    "description":"The overridden charges.",
    "items":{
        "$ref":"#/components/schemas/OverriddenCharges"
    }
}

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.

{
    "type":"array",
    "description":"The list of comments associated with the note.",
    "items":{
        "$ref":"#/components/schemas/Comments"
    }
}

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.

{
    "required":[
        "comment"
    ],
    "type":"object",
    "properties":{
        "csrLoginId":{
            "type":"string",
            "description":"The login ID associated with the CSR."
        },
        "csrFirstName":{
            "type":"string",
            "description":"The CSR's first name."
        },
        "csrLastName":{
            "type":"string",
            "description":"The CSR's last name."
        },
        "csrAccountId":{
            "type":"string",
            "description":"The CSR's account ID."
        },
        "externalUser":{
            "type":"string",
            "description":"The external user."
        },
        "comment":{
            "type":"string",
            "description":"The comment."
        },
        "trackingId":{
            "type":"string",
            "description":"The tracking ID."
        },
        "entryDate":{
            "type":"string",
            "description":"The date and time the comment was entered by the CSR.",
            "format":"date-time"
        }
    },
    "description":"The list of comments associated with the note."
}

Nested Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : PurchasingService

Type: object

Show Source

• 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.

{
    "required":[
        "serviceKey"
    ],
    "type":"object",
    "properties":{
        "service":{
            "$ref":"#/components/schemas/ServiceBase"
        },
        "serviceKey":{
            "type":"string",
            "description":"The service key."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type."
        },
        "customizedBundles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomizedBundleForPurchase"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "groupParent":{
            "type":"boolean",
            "description":"Whether this is a parent in a service group (<b>true</b>) or not (<b>false</b>)."
        },
        "subscriptionIndex":{
            "type":"integer",
            "description":"The subscription index.",
            "format":"int32"
        },
        "devices":{
            "type":"array",
            "description":"The list of devices associated with the service.",
            "items":{
                "$ref":"#/components/schemas/Devices"
            }
        },
        "profiles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProfileBase"
            }
        }
    }
}

Nested Schema : customizedBundles

Type: array

Show Source

• Array of: object CustomizedBundleForPurchase

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomizedBundleForPurchase"
    }
}

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.

{
    "type":"array",
    "description":"The list of devices associated with the service.",
    "items":{
        "$ref":"#/components/schemas/Devices"
    }
}

Nested Schema : profiles

Type: array

Show Source

• Array of: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProfileBase"
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• 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.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The device ID."
        },
        "description":{
            "type":"string",
            "description":"A device's description."
        }
    },
    "description":"The list of devices associated with the service."
}

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.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : paymentInstrument

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"object",
                "properties":{
                    "namespaceURI":{
                        "type":"string"
                    },
                    "localPart":{
                        "type":"string"
                    },
                    "prefix":{
                        "type":"string"
                    }
                }
            },
            "value":{
                "$ref":"#/components/schemas/PaymentInstrumentType"
            },
            "nil":{
                "type":"boolean"
            },
            "globalScope":{
                "type":"boolean"
            },
            "typeSubstituted":{
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• globalScope: boolean
• name: object name
• nil: boolean
• typeSubstituted: boolean
• value: object PaymentInstrumentType

{
    "type":"object",
    "properties":{
        "name":{
            "type":"object",
            "properties":{
                "namespaceURI":{
                    "type":"string"
                },
                "localPart":{
                    "type":"string"
                },
                "prefix":{
                    "type":"string"
                }
            }
        },
        "value":{
            "$ref":"#/components/schemas/PaymentInstrumentType"
        },
        "nil":{
            "type":"boolean"
        },
        "globalScope":{
            "type":"boolean"
        },
        "typeSubstituted":{
            "type":"boolean"
        }
    }
}

Nested Schema : name

Type: object

Show Source

• localPart: string
• namespaceURI: string
• prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

Nested Schema : PaymentInstrumentType

Type: object

Show Source

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• billUnits: array billUnits
• businessType: integer (int32)
  The business type: consumer (1) or business (2).
• contacts(required): array contacts
  An account's contact information.
• currency: integer (int32)
  The account's primary currency.
• customerTypeCode: integer (int32)
  The customer type: standard (1), brand (2), or subscription (3).
• effective: string (date-time)
  The date and time the account takes effect.
• extension: object extension
  The extended attributes.
• genericBundle: object CustomizedBundleForPurchase
• locale: string
  The customer's locale, such as en_US or fr_FR. For a list of valid values, see "Locale Names" in BRM Developer's Guide.
• notes: object Notes
• organizationHierarchyTypeCode: integer (int32)
  The code for the account organization hierarchy type, such as site or legal entity.
• parentRef: object ResourceRef
• paymentMethod: array paymentMethod
• paymentType: integer (int32)
  The payment type. Can be one of the following:

  • 10000:Prepaid
  • 10001:Invoice
  • 10003: Credit card
  • 10005: Direct debit
  • 10007: Subordinate
• profiles: array profiles
• purchasingPlanRef: string
  The resource for the purchased package, such as 0.0.0.1+-plan+45678.
• securityCode1: string
  A security code used to verify account access. This provides an authentication test for customer service requests.
• securityCode2: string
  A security code used to verify account access. This provides an authentication test for customer service requests.
• services(required): array services
• status: string
  The account's status: active (10100), inactive (10102), or closed (10103).
• timezoneId: string
  The ID for the customer's timezone.
• wallet: object Wallet

{
    "required":[
        "contacts",
        "services"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "contacts":{
            "type":"array",
            "description":"An account's contact information.",
            "items":{
                "$ref":"#/components/schemas/Contacts"
            }
        },
        "securityCode1":{
            "type":"string",
            "description":"A security code used to verify account access. This provides an authentication test for customer service requests."
        },
        "securityCode2":{
            "type":"string",
            "description":"A security code used to verify account access. This provides an authentication test for customer service requests."
        },
        "parentRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "locale":{
            "type":"string",
            "description":"The customer's locale, such as <b>en_US</b> or <b>fr_FR</b>. For a list of valid values, see \"Locale Names\" in <i>BRM Developer's Guide</i>."
        },
        "timezoneId":{
            "type":"string",
            "description":"The ID for the customer's timezone."
        },
        "purchasingPlanRef":{
            "type":"string",
            "description":"The resource for the purchased package, such as 0.0.0.1+-plan+45678."
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PurchasingService"
            }
        },
        "genericBundle":{
            "$ref":"#/components/schemas/CustomizedBundleForPurchase"
        },
        "customerTypeCode":{
            "type":"integer",
            "description":"The customer type: standard (<b>1</b>), brand (<b>2</b>), or subscription (<b>3</b>).",
            "format":"int32"
        },
        "organizationHierarchyTypeCode":{
            "type":"integer",
            "description":"The code for the account organization hierarchy type, such as site or legal entity.",
            "format":"int32"
        },
        "effective":{
            "type":"string",
            "description":"The date and time the account takes effect.",
            "format":"date-time"
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        },
        "businessType":{
            "type":"integer",
            "description":"The business type: consumer (<b>1</b>) or business (<b>2</b>).",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"The account's status: active (<b>10100</b>), inactive (<b>10102</b>), or closed (<b>10103</b>)."
        },
        "currency":{
            "type":"integer",
            "description":"The account's primary currency.",
            "format":"int32"
        },
        "wallet":{
            "$ref":"#/components/schemas/Wallet"
        },
        "billUnits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/NewBillUnits"
            }
        },
        "profiles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProfileBase"
            }
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10000</b>:Prepaid</li><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "paymentMethod":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PaymentMethod"
            }
        }
    },
    "xml":{
        "name":"registrationAccount"
    }
}

Nested Schema : billUnits

Type: array

Show Source

• Array of: object NewBillUnits

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NewBillUnits"
    }
}

Nested Schema : contacts

Type: array

An account's contact information.

Show Source

• Array of: object contacts
  An account's contact information.

{
    "type":"array",
    "description":"An account's contact information.",
    "items":{
        "$ref":"#/components/schemas/Contacts"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : CustomizedBundleForPurchase

Type: object

Show Source

• 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

{
    "required":[
        "id",
        "name"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The bundle's name."
        },
        "effective":{
            "type":"string",
            "description":"The date and time the bundle takes effect.",
            "format":"date-time"
        },
        "creditLimitFlags":{
            "type":"integer",
            "description":"Flag to set credit limit options. Allowed Values: <b>1</b> (Override credit limit), <b>2</b> (Prorate based on credit limit), <b>64</b> (Enforce credit limit).",
            "format":"int32"
        },
        "customizedChargeOffers":{
            "type":"array",
            "description":"The list of customized charge offers in the bundle.",
            "items":{
                "$ref":"#/components/schemas/CustomizedChargeOffers"
            }
        },
        "customizedDiscountOffers":{
            "type":"array",
            "description":"The list of customized discount offers.",
            "items":{
                "$ref":"#/components/schemas/CustomizedDiscountOffers"
            }
        },
        "notes":{
            "$ref":"#/components/schemas/Notes"
        }
    }
}

Nested Schema : Notes

Type: object

Show Source

• 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.

{
    "required":[
        "accountId"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "accountId":{
            "type":"string",
            "description":"The ID of the account associated with the note."
        },
        "amount":{
            "type":"number",
            "description":"The amount associated with the note. It can be a payment amount, adjustment amount, or so on."
        },
        "billUnitId":{
            "type":"string",
            "description":"The ID of the bill unit associated with the note."
        },
        "billId":{
            "type":"string",
            "description":"The ID of the bill associated with the note."
        },
        "closedDate":{
            "type":"string",
            "description":"The date and time the note was resolved.",
            "format":"date-time"
        },
        "count":{
            "type":"integer",
            "description":"The number of comments associated with the note.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the comment was posted.",
            "format":"date-time"
        },
        "eventId":{
            "type":"string",
            "description":"The ID of the event associated with the note."
        },
        "header":{
            "type":"string",
            "description":"The header associated with the note."
        },
        "itemId":{
            "type":"string",
            "description":"The ID of the item associated with the note."
        },
        "subType":{
            "type":"integer",
            "description":"The note's subtype. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "type":{
            "type":"integer",
            "description":"The note's type. Possible values are stored in the <b>/config/note_type</b> object. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>note.</b><i>locale</i> file.",
            "format":"int32"
        },
        "domainId":{
            "type":"integer",
            "description":"The domain ID associated with the note.",
            "format":"int32"
        },
        "reasonId":{
            "type":"integer",
            "description":"The reason ID associated with the note. Possible values are stored in <b>/config/reason_code_scope</b> objects. See <a href=\"http://docs.oracle.com/pls/topic/lookup?ctx=brm120&id=GUID-D733989B-5B0E-4643-B70A-77B62A73314D\">Localizing and Customizing Strings</a> in <i>BRM Developer's Guide</i> for information about how to customize these values using the <b>reasons.</b><i>locale</i> file.",
            "format":"int32"
        },
        "serviceId":{
            "type":"string",
            "description":"The service ID associated with the note."
        },
        "status":{
            "type":"number",
            "description":"The note's status: not set (<b>100</b>), resolved (<b>101</b>), or unresolved (<b>102</b>). The default value is <b>102</b>."
        },
        "comments":{
            "type":"array",
            "description":"The list of comments associated with the note.",
            "items":{
                "$ref":"#/components/schemas/Comments"
            }
        }
    }
}

Nested Schema : ResourceRef

Type: object

Show Source

• id(required): string
  The ID.
• uri: string
  The Uniform Resource Identifier (URI) associated with the resource.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "uri":{
            "type":"string",
            "description":"The Uniform Resource Identifier (URI) associated with the resource."
        }
    }
}

Nested Schema : paymentMethod

Type: array

Show Source

• Array of: object PaymentMethod

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PaymentMethod"
    }
}

Nested Schema : profiles

Type: array

Show Source

• Array of: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProfileBase"
    }
}

Nested Schema : services

Type: array

Show Source

• Array of: object PurchasingService

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PurchasingService"
    }
}

Nested Schema : Wallet

Type: object

Show Source

• extension: object extension
  The extended attributes.
• paymentInstrument: array paymentInstrument

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "paymentInstrument":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "type":"object",
                        "properties":{
                            "namespaceURI":{
                                "type":"string"
                            },
                            "localPart":{
                                "type":"string"
                            },
                            "prefix":{
                                "type":"string"
                            }
                        }
                    },
                    "value":{
                        "$ref":"#/components/schemas/PaymentInstrumentType"
                    },
                    "nil":{
                        "type":"boolean"
                    },
                    "globalScope":{
                        "type":"boolean"
                    },
                    "typeSubstituted":{
                        "type":"boolean"
                    }
                }
            }
        }
    }
}

Nested Schema : NewBillUnits

Type: object

Show Source

• 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.

{
    "required":[
        "businessProfile",
        "forServiceGroup"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the bill unit."
        },
        "forServiceGroup":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceGroupIndex"
            }
        },
        "walletPaymentInstrumentIndex":{
            "type":"integer",
            "description":"The wallet index number for the payment instrument associated with the bill unit.",
            "format":"int32"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the bill unit takes effect.",
            "format":"date-time"
        },
        "currency":{
            "type":"integer",
            "description":"The primary currency of the bill unit.",
            "format":"int32"
        },
        "accountingCycleDom":{
            "type":"integer",
            "description":"The accounting cycle day of month (DOM).",
            "format":"int32"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "paymentMethod":{
            "$ref":"#/components/schemas/PaymentMethod"
        },
        "paymentMethodId":{
            "type":"string",
            "description":"The ID of the payment method."
        },
        "rollUp":{
            "type":"boolean"
        },
        "accountingType":{
            "type":"integer",
            "description":"The accounting type. Can be one of the following: <ul><li><b>1</b>: Open item</li><li><b>2</b>: Balance forward</li></ul>",
            "format":"int32"
        },
        "billingFrequencyInMonths":{
            "type":"integer",
            "description":"The billing frequency in number of months. Can be one of the following: <ul><li><b>1</b>: Monthly</li><li><b>2</b>: Bi-monthly</li><li><b>3</b>: Quarterly</li><li><b>12</b>: Yearly</li></ul>",
            "format":"int32"
        },
        "segment":{
            "type":"integer",
            "description":"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.",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"The status of the bill unit, such as active, inactive, or closed."
        },
        "arBillUnitRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentBillUnitRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "parentRef":{
            "type":"string",
            "description":"A reference to the parent."
        },
        "businessProfile":{
            "type":"string",
            "description":"The business profile associated with bill unit."
        },
        "balanceGroups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BalanceGroup"
            }
        }
    }
}

Nested Schema : balanceGroups

Type: array

Show Source

• Array of: object BalanceGroup

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BalanceGroup"
    }
}

Nested Schema : forServiceGroup

Type: array

Show Source

• Array of: object ServiceGroupIndex

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceGroupIndex"
    }
}

Nested Schema : PaymentMethod

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "creditCard":{
            "$ref":"#/components/schemas/CreditCardType"
        },
        "directDebit":{
            "$ref":"#/components/schemas/DirectDebitType"
        },
        "invoice":{
            "$ref":"#/components/schemas/InvoiceType"
        },
        "sepa":{
            "$ref":"#/components/schemas/SepaType"
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        }
    }
}

Nested Schema : BalanceGroup

Type: object

Show Source

• 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

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The name of the balance group."
        },
        "services":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceType"
            }
        },
        "monitorType":{
            "type":"string",
            "description":"The monitoring group type. Allowed Values: <ul><li><b>H_CE</b> (Hierarchy Credit Exposure)</li><li><b>PR_CE</b> (Payment Responsible Credit Exposure)</li><li><b>SUB_CE</b> (Subscription Credit Exposure)</li><li><b>PR_RTCE</b> (Payment Responsible Real-Time Credit Enforcement)</li></ul>"
        },
        "balances":{
            "type":"array",
            "description":"The list of balances associated with the balance group.",
            "items":{
                "$ref":"#/components/schemas/Balances"
            }
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    }
}

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.

{
    "type":"array",
    "description":"The list of balances associated with the balance group.",
    "items":{
        "$ref":"#/components/schemas/Balances"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : services

Type: array

Show Source

• Array of: object ServiceType

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ServiceType"
    }
}

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

{
    "required":[
        "currentBalance",
        "outstandingAmount"
    ],
    "type":"object",
    "properties":{
        "modifyLimit":{
            "type":"boolean",
            "description":"Whether a credit limit is being modified by the request (<b>true</b>) or not (<b>false</b>)."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current balance."
        },
        "dynamicCreditFloor":{
            "type":"boolean",
            "description":"Whether to use a dynamic credit floor (<b>true</b>) or not (<b>false</b>). The default is <b>false</b>."
        },
        "creditFloor":{
            "type":"number",
            "description":"The credit floor associated with the balance."
        },
        "creditLimit":{
            "type":"number",
            "description":"The credit limit associated with the balance."
        },
        "overrideCreditLimit":{
            "type":"integer",
            "description":"Whether to override the credit limit. Allowed Values: <b>0</b> (Enforce Credit Limit) or <b>1</b> (Override credit limit).",
            "format":"int32"
        },
        "creditThresholds":{
            "type":"integer",
            "description":"The credit thresholds associated with the balance.",
            "format":"int32"
        },
        "formattedCreditThresholds":{
            "type":"string",
            "description":"The balance percentage usage at which to notify the customer."
        },
        "creditThresholdsFixed":{
            "type":"string",
            "description":"The value at which to send a notification, such as 30 US dollars or 30 minutes."
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the balance expires."
        },
        "subBalances":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubBalances"
            }
        },
        "outstandingAmount":{
            "type":"number",
            "description":"An amount that the customer still owes, for loans or when they exceed their credit limit."
        },
        "loanThresholds":{
            "type":"integer",
            "description":"The percent-based threshold for offering a loan. If the customer's balance falls below this percent, they are notified and offered a loan.",
            "format":"int32"
        },
        "loanThresholdsFixed":{
            "type":"string",
            "description":"The fixed amount threshold for offering a loan. If the customer's balance falls below this amount, they are notified and offered a loan."
        },
        "tempCreditLimit":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TempCreditLimit"
            }
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the balance.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of balances associated with the balance group."
}

Nested Schema : subBalances

Type: array

Show Source

• Array of: object SubBalances

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubBalances"
    }
}

Nested Schema : tempCreditLimit

Type: array

Show Source

• Array of: object TempCreditLimit

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TempCreditLimit"
    }
}

Nested Schema : SubBalances

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "currentBalance":{
            "type":"number",
            "description":"The current amount of the sub-balance."
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time the validity period starts.",
            "format":"date-time"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time the validity period ends.",
            "format":"date-time"
        },
        "rolloverData":{
            "type":"integer",
            "description":"Details about a rollover subbalance.",
            "format":"int32"
        },
        "expiredBeforeUsing":{
            "type":"number",
            "description":"The number of days until the sub-balance expires."
        },
        "elementId":{
            "type":"integer",
            "description":"The ID of the element.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : TempCreditLimit

Type: object

Show Source

• 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.

{
    "required":[
        "validFrom",
        "validTo"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "limit":{
            "type":"number",
            "description":"The temporary credit limit amount."
        },
        "resourceId":{
            "type":"integer",
            "description":"The resource ID associated with the temporary credit limit.",
            "format":"int32"
        },
        "validTo":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity ends.",
            "format":"date-time"
        },
        "validFrom":{
            "type":"string",
            "description":"The date and time temporary credit limit's validity starts.",
            "format":"date-time"
        },
        "validToUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validToOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period end.",
            "format":"int32"
        },
        "validFromUnit":{
            "type":"integer",
            "description":"The unit for the temporary credit limit's validity period start.",
            "format":"int32"
        },
        "validFromOffset":{
            "type":"integer",
            "description":"The offset for the temporary credit limit's validity period start.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : ServiceType

Type: object

Show Source

• 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.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-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.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : AliasList

Type: object

The list of aliases associated with the service.

Show Source

• elem: integer (int32)
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "elem":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"The list of aliases associated with the service."
}

Nested Schema : ServiceGroupIndex

Type: object

Show Source

• serviceGroupElem: integer (int32)
  The service group element.

{
    "type":"object",
    "properties":{
        "serviceGroupElem":{
            "type":"integer",
            "description":"The service group element.",
            "format":"int32"
        }
    }
}

Nested Schema : CreditCardType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

Nested Schema : DirectDebitType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : InvoiceType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

Nested Schema : SepaType

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        },
        "details":{
            "$ref":"#/components/schemas/Details"
        }
    }
}

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.

{
    "required":[
        "balanceImpactResource",
        "fixedPriceTag",
        "scaledPriceTag"
    ],
    "type":"object",
    "properties":{
        "balanceImpactResource":{
            "type":"string",
            "description":"The resource that represents the balance impact of the offer."
        },
        "fixedAmount":{
            "type":"number",
            "description":"The fixed amount of the offer.",
            "format":"float"
        },
        "scaledAmount":{
            "type":"number",
            "description":"The scaled amount of the offer.",
            "format":"float"
        },
        "fixedPriceTag":{
            "type":"string",
            "description":"The fixed price tag of the offer."
        },
        "scaledPriceTag":{
            "type":"string",
            "description":"The scaled price tag of the offer."
        }
    },
    "description":"The offer details."
}

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 : contacts

Type: object

An account's contact information.

Show Source

• address(required): string
  The customer's address.
• city(required): string
  The customer's city.
• company: string
  The company name.
• contactType: string
  The contact type.
• country(required): string
  The customer's country.
• deleted: boolean
  Default Value: false

  Whether to delete the contact (true) or not (false). This must be set to false if you adding a contact.
• 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.
• emailAddress: string
  The customer's email address.
• firstName(required): string
  The customer's first name.
• lastName(required): string
  The customer's last name.
• middleName: string
  The customer's middle name.
• newlyCreated: boolean
  Default Value: false

  Whether the contact information was newly created (true) or not (false).
• phonenumbers: array phonenumbers
  The list of associated phone numbers.
• salutation: string
  The salutation to use use with the customer, such as Mr. or Miss.
• state: string
  The customer's state.
• title: string
  The customer's job title.
• zip: string
  The ZIP code.

{
    "required":[
        "address",
        "city",
        "country",
        "firstName",
        "lastName"
    ],
    "type":"object",
    "properties":{
        "address":{
            "type":"string",
            "description":"The customer's address."
        },
        "city":{
            "type":"string",
            "description":"The customer's city."
        },
        "company":{
            "type":"string",
            "description":"The company name."
        },
        "contactType":{
            "type":"string",
            "description":"The contact type."
        },
        "country":{
            "type":"string",
            "description":"The customer's country."
        },
        "emailAddress":{
            "type":"string",
            "description":"The customer's email address."
        },
        "firstName":{
            "type":"string",
            "description":"The customer's first name."
        },
        "lastName":{
            "type":"string",
            "description":"The customer's last name."
        },
        "middleName":{
            "type":"string",
            "description":"The customer's middle name."
        },
        "salutation":{
            "type":"string",
            "description":"The salutation to use use with the customer, such as Mr. or Miss."
        },
        "state":{
            "type":"string",
            "description":"The customer's state."
        },
        "title":{
            "type":"string",
            "description":"The customer's job title."
        },
        "zip":{
            "type":"string",
            "description":"The ZIP code."
        },
        "deleted":{
            "type":"boolean",
            "description":"Whether to delete the contact (<b>true</b>) or not (<b>false</b>). This must be set to <b>false</b> if you adding a contact.",
            "default":false
        },
        "newlyCreated":{
            "type":"boolean",
            "description":"Whether the contact information was newly created (<b>true</b>) or not (<b>false</b>).",
            "default":false
        },
        "phonenumbers":{
            "type":"array",
            "description":"The list of associated phone numbers.",
            "items":{
                "$ref":"#/components/schemas/Phonenumbers"
            }
        },
        "elem":{
            "type":"integer",
            "description":"The position of the entry in the array. For example, the first item in a list would have an <b>elem</b> value of <b>1</b>.",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        }
    },
    "description":"An account's contact information.",
    "xml":{
        "name":"contacts"
    }
}

Nested Schema : phonenumbers

Type: array

The list of associated phone numbers.

Show Source

• Array of: object Phonenumbers
  The list of the account's phone numbers.

{
    "type":"array",
    "description":"The list of associated phone numbers.",
    "items":{
        "$ref":"#/components/schemas/Phonenumbers"
    }
}

Nested Schema : Phonenumbers

Type: object

The list of the account's phone numbers.

Show Source

• number(required): string
  The phone number.
• phonetype: integer (int32)
  The phone number's type.

{
    "required":[
        "number"
    ],
    "type":"object",
    "properties":{
        "number":{
            "type":"string",
            "description":"The phone number."
        },
        "phonetype":{
            "type":"integer",
            "description":"The phone number's type.",
            "format":"int32"
        }
    },
    "description":"The list of the account's phone numbers."
}

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.

{
    "type":"array",
    "description":"The list of customized charge offers in the bundle.",
    "items":{
        "$ref":"#/components/schemas/CustomizedChargeOffers"
    }
}

Nested Schema : customizedDiscountOffers

Type: array

The list of customized discount offers.

Show Source

• Array of: object CustomizedDiscountOffers
  The list of customized discount offers.

{
    "type":"array",
    "description":"The list of customized discount offers.",
    "items":{
        "$ref":"#/components/schemas/CustomizedDiscountOffers"
    }
}

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.

{
    "type":"object",
    "properties":{
        "baseChargeOfferRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "baseProductRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "validityAlignMode":{
            "type":"string",
            "description":"The validity align mode for a product. Can be one of the following: <ul><li><b>base</b>: Align the validity with baseProductRef passed in request </li><li><b>any_base_earliest</b>: Aligns the validity dates with the active base charge offer that expires first.</li><li><b>any_base_latest</b>: Aligns the validity dates with the active base charge offer that expires last.</li><li><b>any_earliest</b>: Aligns the validity dates with the active charge offer that expires first.</li><li><b>any_latest</b>: Aligns the validity dates with the active charge offer that expires last.</li></ul>"
        },
        "quantity":{
            "type":"integer",
            "description":"The quantity purchased.",
            "format":"int32"
        },
        "name":{
            "type":"string",
            "description":"The charge offer's name."
        },
        "description":{
            "type":"string",
            "description":"The charge offer's description."
        },
        "cycleStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "cycleEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "cycleFeeOverride":{
            "type":"number",
            "description":"The amount of the cycle fee override."
        },
        "cycleDiscountOverride":{
            "type":"number",
            "description":"The fixed amount of the cycle discount override."
        },
        "cycleDiscountPercentOverride":{
            "type":"number",
            "description":"The percentage amount of the cycle discount override."
        },
        "purchaseStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "purchaseEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "purchaseFeeOverride":{
            "type":"number",
            "description":"The fixed amount of the purchase fee override."
        },
        "purchaseDiscountOverride":{
            "type":"number",
            "description":"The fixed amount of the purchase discount override."
        },
        "purchaseDiscountPercentOverride":{
            "type":"number",
            "description":"The percentage amount of the purchase discount override."
        },
        "usageStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "usageEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "usagePercentOverride":{
            "type":"number",
            "description":"The percentage amount of the usage override."
        },
        "gracePeriodUnit":{
            "type":"integer",
            "description":"The unit for the grace period.",
            "format":"int32"
        },
        "gracePeriodOffset":{
            "type":"integer",
            "description":"The number to offset the grace period by.",
            "format":"int32"
        },
        "renewalMode":{
            "type":"integer",
            "description":"How to handle the charge offer's cycle alignment when its bundle is reactivated. Possible values are: <ul><li><b>0</b>: Cycle aligns with the original billing date or configured specific day of the month.</li><li><b>1</b>: Cycle aligns with the reactivation date.</li></ul>",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The charge offer's status. Can be one of the following: <ul><li><b>0</b>: Not set</li><li><b>1</b>: Active</li><li><b>2</b>: Inactive</li><li><b>3</b>: Canceled</li></ul>",
            "format":"int32"
        },
        "statusFlag":{
            "type":"integer",
            "description":"The status flag.",
            "format":"int32"
        },
        "overriddenCharges":{
            "type":"array",
            "description":"The overridden charges.",
            "items":{
                "$ref":"#/components/schemas/OverriddenCharges"
            }
        }
    },
    "description":"The list of customized charge offers in the bundle."
}

Nested Schema : EndingType

Type: object

Show Source

• 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

{
    "required":[
        "mode"
    ],
    "type":"object",
    "properties":{
        "mode":{
            "type":"string",
            "description":"The ending type mode for a product. Can be one of the following: <ul><li><b>absolute</b>: The end date is a calendar day.</li><li><b>relativeToStart</b>: 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.</li><li><b>never</b>: There is no set end date.</li></ul>"
        },
        "unitSettings":{
            "$ref":"#/components/schemas/RelativeSettings"
        },
        "endDate":{
            "type":"string",
            "description":"The date and time the cycle ends.",
            "format":"date-time"
        }
    }
}

Nested Schema : StartingType

Type: object

Show Source

• 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

{
    "required":[
        "mode"
    ],
    "type":"object",
    "properties":{
        "mode":{
            "type":"string",
            "description":"The starting type mode for a product. Can be one of the following:<ul><li><b>immediately</b>: The start date is set to today. This mode can be used with the <b>purchaseStart</b>, <b>cycleStart</b>, and <b>usageStart</b> parameters.</li><li><b>absolute</b>: The start date is a calendar date. This mode can be used with the <b>purchaseStart</b>, <b>cycleStart</b>, and <b>usageStart</b> parameters.</li><li><b>relativeToPurchase</b>: 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 <b>cycleStart</b> and <b>usageStart</b> parameters.</li><li><b>firstUsage</b>: The start day is the day of the first recorded usage.</li></ul>"
        },
        "startDate":{
            "type":"string",
            "description":"The date and time the cycle starts.",
            "format":"date-time"
        },
        "unitSettings":{
            "$ref":"#/components/schemas/RelativeSettings"
        }
    }
}

Nested Schema : overriddenCharges

Type: array

The overridden charges.

Show Source

• Array of: object overriddenCharges

{
    "type":"array",
    "description":"The overridden charges.",
    "items":{
        "$ref":"#/components/schemas/OverriddenCharges"
    }
}

Nested Schema : RelativeSettings

Type: object

Show Source

• 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

{
    "required":[
        "units"
    ],
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The number of days, hours, minutes or so on after the cycle starts or ends.",
            "format":"int32"
        },
        "units":{
            "type":"string",
            "description":"The offset unit. Can be one of the following: <ul><li>seconds</li><li>minutes</li><li>hours</li><li>days</li><li>months</li><li>cycles</li></ul>"
        }
    }
}

Nested Schema : overriddenCharges

Type: object

Show Source

• charges(required): array charges
  The charge details.
• event(required): string
  The event associated with the overridden charges.

{
    "required":[
        "charges",
        "event"
    ],
    "type":"object",
    "properties":{
        "event":{
            "type":"string",
            "description":"The event associated with the overridden charges."
        },
        "charges":{
            "type":"array",
            "description":"The charge details.",
            "items":{
                "$ref":"#/components/schemas/Charges"
            }
        }
    },
    "xml":{
        "name":"overriddenCharges"
    }
}

Nested Schema : charges

Type: array

The charge details.

Show Source

• Array of: object Charges
  The charge details.

{
    "type":"array",
    "description":"The charge details.",
    "items":{
        "$ref":"#/components/schemas/Charges"
    }
}

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.

{
    "required":[
        "charge",
        "startDate"
    ],
    "type":"object",
    "properties":{
        "startDate":{
            "type":"string",
            "description":"The date and time the charge's validity starts.",
            "format":"date-time"
        },
        "endDate":{
            "type":"string",
            "description":"The date and time the charge's validity ends.",
            "format":"date-time"
        },
        "charge":{
            "type":"array",
            "description":"The charges.",
            "items":{
                "$ref":"#/components/schemas/Charge"
            }
        }
    },
    "description":"The charge details."
}

Nested Schema : charge

Type: array

The charges.

Show Source

• Array of: object Charge
  The charges.

{
    "type":"array",
    "description":"The charges.",
    "items":{
        "$ref":"#/components/schemas/Charge"
    }
}

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.

{
    "required":[
        "amount",
        "priceTag",
        "type"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The charge amount."
        },
        "priceTag":{
            "type":"string",
            "description":"The charge's price tag."
        },
        "type":{
            "type":"string",
            "description":"The charge type."
        }
    },
    "description":"The charges."
}

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(required): number
  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

{
    "required":[
        "quantity"
    ],
    "type":"object",
    "properties":{
        "baseDiscountOfferRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The discount offer's name."
        },
        "description":{
            "type":"string",
            "description":"The discount offer's description."
        },
        "quantity":{
            "type":"number",
            "description":"The discount's quantity."
        },
        "purchaseStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "purchaseEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "cycleStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "cycleEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "usageStart":{
            "$ref":"#/components/schemas/StartingType"
        },
        "usageEnd":{
            "$ref":"#/components/schemas/EndingType"
        },
        "status":{
            "type":"integer",
            "description":"The discount offer's status. Can be one of the following: <ul><li><b>0</b>: Not set</li><li><b>1</b>: Active</li><li><b>2</b>: Inactive</li><li><b>3</b>: Canceled</li></ul>",
            "format":"int32"
        },
        "statusFlag":{
            "type":"integer",
            "description":"The status flag.",
            "format":"int32"
        },
        "overriddenCharges":{
            "type":"array",
            "description":"The overridden charges.",
            "items":{
                "$ref":"#/components/schemas/OverriddenCharges"
            }
        }
    },
    "description":"The list of customized discount offers."
}

Nested Schema : overriddenCharges

Type: array

The overridden charges.

Show Source

• Array of: object overriddenCharges

{
    "type":"array",
    "description":"The overridden charges.",
    "items":{
        "$ref":"#/components/schemas/OverriddenCharges"
    }
}

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.

{
    "type":"array",
    "description":"The list of comments associated with the note.",
    "items":{
        "$ref":"#/components/schemas/Comments"
    }
}

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.

{
    "required":[
        "comment"
    ],
    "type":"object",
    "properties":{
        "csrLoginId":{
            "type":"string",
            "description":"The login ID associated with the CSR."
        },
        "csrFirstName":{
            "type":"string",
            "description":"The CSR's first name."
        },
        "csrLastName":{
            "type":"string",
            "description":"The CSR's last name."
        },
        "csrAccountId":{
            "type":"string",
            "description":"The CSR's account ID."
        },
        "externalUser":{
            "type":"string",
            "description":"The external user."
        },
        "comment":{
            "type":"string",
            "description":"The comment."
        },
        "trackingId":{
            "type":"string",
            "description":"The tracking ID."
        },
        "entryDate":{
            "type":"string",
            "description":"The date and time the comment was entered by the CSR.",
            "format":"date-time"
        }
    },
    "description":"The list of comments associated with the note."
}

Nested Schema : Discriminator: @class

Type: object

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the profile was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date and time the profile is effective from.",
            "format":"date-time"
        },
        "accountObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "name":{
            "type":"string",
            "description":"The name of the profile."
        },
        "selected":{
            "type":"boolean",
            "description":"Whether the profile is selected (<b>true</b>) or not (<b>false</b>)."
        },
        "parentName":{
            "type":"string",
            "description":"The name of the parent profile."
        },
        "multiValued":{
            "type":"boolean",
            "description":"Whether the profile has multiple values (<b>true</b>) or not (<b>false</b>)."
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : PurchasingService

Type: object

Show Source

• 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.

{
    "required":[
        "serviceKey"
    ],
    "type":"object",
    "properties":{
        "service":{
            "$ref":"#/components/schemas/ServiceBase"
        },
        "serviceKey":{
            "type":"string",
            "description":"The service key."
        },
        "serviceType":{
            "type":"string",
            "description":"The service type."
        },
        "customizedBundles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomizedBundleForPurchase"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "groupParent":{
            "type":"boolean",
            "description":"Whether this is a parent in a service group (<b>true</b>) or not (<b>false</b>)."
        },
        "subscriptionIndex":{
            "type":"integer",
            "description":"The subscription index.",
            "format":"int32"
        },
        "devices":{
            "type":"array",
            "description":"The list of devices associated with the service.",
            "items":{
                "$ref":"#/components/schemas/Devices"
            }
        },
        "profiles":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ProfileBase"
            }
        }
    }
}

Nested Schema : customizedBundles

Type: array

Show Source

• Array of: object CustomizedBundleForPurchase

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomizedBundleForPurchase"
    }
}

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.

{
    "type":"array",
    "description":"The list of devices associated with the service.",
    "items":{
        "$ref":"#/components/schemas/Devices"
    }
}

Nested Schema : profiles

Type: array

Show Source

• Array of: object Discriminator: @class
  Discriminator: { "propertyName":"@class" }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ProfileBase"
    }
}

Nested Schema : Discriminator: @class

Type: object

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

Show Source

• 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.

{
    "required":[
        "login",
        "password"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "pendingDeferredActionsCount":{
            "type":"integer",
            "description":"The number of deferred actions that are pending for the service.",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "aliasList":{
            "type":"array",
            "description":"The list of aliases associated with the service.",
            "items":{
                "$ref":"#/components/schemas/AliasList"
            }
        },
        "balanceGroupRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "creationDate":{
            "type":"string",
            "description":"The date and time the service type was created.",
            "format":"date-time"
        },
        "effectiveDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastStatusComment":{
            "type":"string",
            "description":"The comment associated with the last status change."
        },
        "lastStatusChange":{
            "type":"string",
            "description":"The date and time of the last status change.",
            "format":"date-time"
        },
        "login":{
            "type":"string",
            "description":"The login associated with the service."
        },
        "lifeCycleState":{
            "type":"integer",
            "description":"The current life cycle state.",
            "format":"int32"
        },
        "lastModified":{
            "type":"string",
            "description":"The date and time the service was last modified.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"The name of the service."
        },
        "password":{
            "type":"string",
            "description":"The password associated with the service."
        },
        "passwordExpiration":{
            "type":"string",
            "description":"The date and time the password expires.",
            "format":"date-time"
        },
        "passwordStatus":{
            "type":"integer",
            "description":"The current status of the password.",
            "format":"int32"
        },
        "status":{
            "type":"integer",
            "description":"The status.",
            "format":"int32"
        },
        "statusFlags":{
            "type":"integer",
            "description":"The status flags.",
            "format":"int32"
        },
        "subscriptionServiceRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "serviceAccessLevel":{
            "type":"string",
            "description":"The service access level."
        },
        "balGrpIndex":{
            "type":"integer",
            "description":"The balance group index.",
            "format":"int32"
        },
        "nameinfoObj":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "svcExpLastNotiOffset":{
            "type":"string",
            "description":"The notification offset."
        },
        "svcExpLastNotiT":{
            "type":"string",
            "description":"The last notification time.",
            "format":"date-time"
        }
    },
    "discriminator":{
        "propertyName":"@class"
    }
}

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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The device ID."
        },
        "description":{
            "type":"string",
            "description":"A device's description."
        }
    },
    "description":"The list of devices associated with the service."
}

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.

{
    "type":"array",
    "description":"The list of aliases associated with the service.",
    "items":{
        "$ref":"#/components/schemas/AliasList"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : paymentInstrument

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "type":"object",
                "properties":{
                    "namespaceURI":{
                        "type":"string"
                    },
                    "localPart":{
                        "type":"string"
                    },
                    "prefix":{
                        "type":"string"
                    }
                }
            },
            "value":{
                "$ref":"#/components/schemas/PaymentInstrumentType"
            },
            "nil":{
                "type":"boolean"
            },
            "globalScope":{
                "type":"boolean"
            },
            "typeSubstituted":{
                "type":"boolean"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• globalScope: boolean
• name: object name
• nil: boolean
• typeSubstituted: boolean
• value: object PaymentInstrumentType

{
    "type":"object",
    "properties":{
        "name":{
            "type":"object",
            "properties":{
                "namespaceURI":{
                    "type":"string"
                },
                "localPart":{
                    "type":"string"
                },
                "prefix":{
                    "type":"string"
                }
            }
        },
        "value":{
            "$ref":"#/components/schemas/PaymentInstrumentType"
        },
        "nil":{
            "type":"boolean"
        },
        "globalScope":{
            "type":"boolean"
        },
        "typeSubstituted":{
            "type":"boolean"
        }
    }
}

Nested Schema : name

Type: object

Show Source

• localPart: string
• namespaceURI: string
• prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

Nested Schema : PaymentInstrumentType

Type: object

Show Source

• accountRef: object ResourceRef
• correctiveInvoiceType: integer (int32)
  The type of invoice to create, such as an invoice correction letter or a replacement invoice.
• 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

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        },
        "name":{
            "type":"string",
            "description":"The payment instrument's name."
        },
        "paymentType":{
            "type":"integer",
            "description":"The payment type. Can be one of the following: <ul><li><b>10001</b>:Invoice</li><li><b>10003</b>: Credit card</li><li><b>10005</b>: Direct debit</li><li><b>10007</b>: Subordinate</li></ul>",
            "format":"int32"
        },
        "accountRef":{
            "$ref":"#/components/schemas/ResourceRef"
        },
        "correctiveInvoiceType":{
            "type":"integer",
            "description":"The type of invoice to create, such as an invoice correction letter or a replacement invoice.",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Back to Top

Response

200 Response

The account data was validated successfully.

500 Response

An internal server error occurred.

Back to Top

Examples

This example shows how to validate the registration data for an 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/version/accounts/validate' -H 'content-type: application/json' -d @validate.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.
• validate.json is the JSON file that specifies the account content to validate.

Example of Request Body

This example shows the contents of the validate.json file sent as the request body.

{
    "locale": "en_US",
    "customerTypeCode": "",
    "organizationHierarchyTypeCode": "-1",
    "securityCode1": "question",
    "securityCode2": "answer",
    "contacts": [
        {
            "firstName": "Emelia",
            "lastName": "Jackson",
            "middleName": "Sue",
            "salutation": "Ms.",
            "address": "2300 Oracle Way",
            "city": "Austin",
            "company": "Vision Corporation",
            "emailAddress": "[e-mail]",
            "state": "TX",
            "zip": "78741",
            "deleted": false,
            "newlyCreated": true,
            "elem": 1,
            "contactType": "Work",
            "country": "US",
            "phonenumbers": []
        }
    ]
}

Example of Response Body

If the account information is valid, the response code 200 is returned with true in the response body.

Back to Top