REST Services Manager API for Billing and Revenue Management

Create an Adjusted Balance

post

/adjustBalance

Creates an adjusted balance.

Request

There are no request parameters for this operation.

Supported Media Types

application/json;charset=utf-8

Root Schema : Adjust Balance Create

Type: object

Title: Adjust Balance Create

An adjustment to a balance, used in AdjustBalance create requests. The id, href, status, requestedDate, confirmationDate, relatedParty, and partyAccount properties are not used in create requests.

The value for amount can be a positive or negative integer. For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due. For event adjustments, the opposite is true: a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.

For noncurrency adjustments, the bucket property is required..

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property).
@type: string

Title: Type

The object's subclass.
adjustType: string

The type of adjustment. (BRM does not use this property).
amount(required): object Quantity

Represents an amount in a specified unit.
bieId: array bieId

The bills, items, or events associated with the adjustment.
bucket: object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
channel: object ChannelRef

A reference to a channel.
confirmationDate: string (date-time)

The date that the adjustment was confirmed. (BRM does not use this property).
description: string

Title: Description

The adjusted balance's description.
impactedBucket: array impactedBucket

A bucket impacted by the adjustment request.
logicalResource: object Logical Resource Ref

Title: Logical Resource Ref

A reference to a logical resource.
partyAccount: object Party Account Ref

Title: Party Account Ref

A reference to a party account.
product: object ProductRef

A product reference.
reason: string

Title: Reason

The reason for the adjustment.
relatedParty: array relatedParty

The parties are related to the adjusted balance. (BRM does not use this property).
requestedDate: string (date-time)

The date and time that the request was received.
requestor: object Related Party

Title: Related Party

A party related to another object.
status: string

The adjustment's status.
taxTreatment: string

The tax treatment for the adjustment.
usageType: string

The usage type for the adjustment. (BRM does not use this property).

{
    "required":[
        "amount"
    ],
    "type":"object",
    "title":"Adjust Balance Create",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property).",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The adjusted balance's description."
        },
        "adjustType":{
            "type":"string",
            "description":"The type of adjustment. (BRM does not use this property)."
        },
        "amount":{
            "description":"The amount to adjust. The amount can be a positive or negative integer. <p>For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due. <p>For event adjustments, the opposite is true&colon; a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bieId":{
            "type":"array",
            "x-cardinality":"1",
            "description":"The bills, items, or events associated with the adjustment.",
            "items":{
                "$ref":"#/components/schemas/BieFieldOracle"
            }
        },
        "bucket":{
            "description":"The bucket to track the adjustment in. For noncurrency adjustments, this is required.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "channel":{
            "description":"The channel for the adjustment. (BRM does not use this property).",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date that the adjustment was confirmed. (BRM does not use this property).",
            "format":"date-time"
        },
        "impactedBucket":{
            "type":"array",
            "description":"A bucket impacted by the adjustment request.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucket"
            }
        },
        "logicalResource":{
            "description":"The logical resource associated with the adjusted balance. (BRM does not use this property).",
            "$ref":"#/components/schemas/LogicalResourceRef"
        },
        "partyAccount":{
            "description":"The party account associated with the adjusted balance.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "product":{
            "description":"The product associated with the adjusted balance.",
            "$ref":"#/components/schemas/ProductRef",
            "examples":{
                "createAdjustmentProductIdExample":{
                    "value":"0.0.0.1+-service-telco-gsm-telephony+247218",
                    "summary":"product.id=0.0.0.1+-service-telco-gsm-telephony+247218"
                },
                "createAdjustmentProductIdExample2":{
                    "value":"aliasMsisdnBase_0010",
                    "summary":"product.id=aliasMsisdnBase_0010"
                },
                "createAdjustmentProductIdExample3":{
                    "value":"vemoort_gsm1",
                    "summary":"product.id=vemoort_gsm1"
                }
            }
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the adjustment."
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties are related to the adjusted balance. (BRM does not use this property).",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "requestedDate":{
            "type":"string",
            "description":"The date and time that the request was received.",
            "format":"date-time"
        },
        "requestor":{
            "description":"The party that requested the adjustment.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "status":{
            "type":"string",
            "description":"The adjustment's status."
        },
        "taxTreatment":{
            "type":"string",
            "description":"The tax treatment for the adjustment."
        },
        "usageType":{
            "type":"string",
            "description":"The usage type for the adjustment. (BRM does not use this property)."
        }
    },
    "description":"An adjustment to a balance, used in <b>AdjustBalance</b> create requests. The <b>id</b>, <b>href</b>, <b>status</b>, <b>requestedDate</b>, <b>confirmationDate</b>, <b>relatedParty</b>, and <b>partyAccount</b> properties are not used in create requests.<p>The value for <b>amount</b> can be a positive or negative integer. For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due. For event adjustments, the opposite is true&colon; a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.</p><p>For noncurrency adjustments, the <b>bucket</b> property is required.</b>."
}

Nested Schema : Quantity

Type: object

Represents an amount in a specified unit.

Show Source

amount: number (double)

Default Value: 1

The numeric value in the specified unit.
units: string

The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The unit."
        }
    }
}

Nested Schema : bieId

Type: array

The bills, items, or events associated with the adjustment.

Show Source

Array of: object BIEField Oracle

Title: BIEField Oracle

A bill, item, or event, extended for BRM REST Services Manager.

{
    "type":"array",
    "x-cardinality":"1",
    "description":"The bills, items, or events associated with the adjustment.",
    "items":{
        "$ref":"#/components/schemas/BieFieldOracle"
    }
}

Nested Schema : Bucket Ref

Type: object

Title: Bucket Ref

A reference to a bucket.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string (uri)

The bucket's href.
id(required): string

Title: Bucket ID

The bucket's ID.
name: string

Title: Bucket Name

The bucket's name.
usageType: string

The bucket's usage type.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The bucket's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "usageType":{
            "type":"string",
            "description":"The bucket's usage type."
        }
    },
    "description":"A reference to a bucket."
}

Nested Schema : ChannelRef

Type: object

A reference to a channel.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string

Title: Channel Href

The channel's href.
id(required): string

Title: Channel ID

The channel's ID.
name: string

Title: Channel Name

The channel's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "title":"Channel ID",
            "description":"The channel's ID."
        },
        "href":{
            "type":"string",
            "title":"Channel Href",
            "description":"The channel's href."
        },
        "name":{
            "type":"string",
            "title":"Channel Name",
            "description":"The channel's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a channel."
}

Nested Schema : impactedBucket

Type: array

A bucket impacted by the adjustment request.

Show Source

Array of: object ImpactedBucket

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

{
    "type":"array",
    "description":"A bucket impacted by the adjustment request.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucket"
    }
}

Nested Schema : Logical Resource Ref

Type: object

Title: Logical Resource Ref

A reference to a logical resource.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string

Title: Href

The resource's href.
id(required): string

Title: ID

The resource's ID.
name: string

Title: Name

The resource's name.
value: string

The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN).

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Logical Resource Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The resource's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The resource's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The resource's name."
        },
        "value":{
            "type":"string",
            "description":"The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN)."
        }
    },
    "description":"A reference to a logical resource."
}

Nested Schema : Party Account Ref

Type: object

Title: Party Account Ref

A reference to a party account.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
description: string

Title: Description

The party account's description.
href: string

Title: Href

The party account's href.
id(required): string

Title: Account ID

The party account's ID.
name: string

Title: Name

The party account's name.
status: string

Title: Status

The overall status of the account. For example: due, paid, or in arrears.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Party Account Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The party account's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The overall status of the account. For example&colon; <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : ProductRef

Type: object

A product reference.

Match All

A product reference.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
allOf EntityRef

{
    "type":"object",
    "description":"A product reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : relatedParty

Type: array

The parties are related to the adjusted balance. (BRM does not use this property).

Show Source

Array of: object Related Party

Title: Related Party

A party related to another object.

{
    "type":"array",
    "description":"The parties are related to the adjusted balance. (BRM does not use this property).",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

Nested Schema : Related Party

Type: object

Title: Related Party

A party related to another object.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType(required): string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string (uri)

Title: Href

The party's href.
id(required): string

Title: Party ID

The party's ID.
name: string

Title: Party Name

The party's name.
role: string

Title: Party Role

The party's role.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Party",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        }
    },
    "description":"A party related to another object."
}

Nested Schema : BIEField Oracle

Type: object

Title: BIEField Oracle

A bill, item, or event, extended for BRM REST Services Manager.

Show Source

href: string

Title: Href

The bill, item, or event href.
id(required): string

Title: ID

The bill, item, or event ID.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"BIEField Oracle",
    "description":"A bill, item, or event, extended for BRM REST Services Manager.",
    "properties":{
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The bill, item, or event ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The bill, item, or event href."
        }
    }
}

Nested Schema : ImpactedBucket

Type: object

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

Show Source

@baseType: string

The object's superclass.
@schemaLocation: string (uri)

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

The object's subclass.
amountAfter: object Quantity

Represents an amount in a specified unit.
amountBefore: object Quantity

Represents an amount in a specified unit.
bucket: object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
confirmationDate: string (date-time)

The date and time the impact was confirmed.
description: string

The impacted bucket's description.
item(required): array item

Minimum Number of Items: 1

The impacted bucket items.
name: string

The impacted bucket's name.
requestedDate: string (date-time)

The date and time the request was received.

{
    "required":[
        "item"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amountAfter":{
            "description":"The amount in the bucket after the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "amountBefore":{
            "description":"The amount in the bucket before the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"A reference to the impacted bucket.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date and time the impact was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"The impacted bucket's description."
        },
        "item":{
            "minItems":1,
            "type":"array",
            "description":"The impacted bucket items.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucketItem"
            }
        },
        "name":{
            "type":"string",
            "description":"The impacted bucket's name."
        },
        "requestedDate":{
            "type":"string",
            "description":"The date and time the request was received.",
            "format":"date-time"
        }
    },
    "description":"A bucket impacted by a balance top-up, adjustment, transfer, or reservation."
}

Nested Schema : item

Type: array

Minimum Number of Items: 1

The impacted bucket items.

Show Source

Array of: object ImpactedBucketItem

An impact item that affects an ImpactedBucket object.

{
    "minItems":1,
    "type":"array",
    "description":"The impacted bucket items.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucketItem"
    }
}

Nested Schema : ImpactedBucketItem

Type: object

An impact item that affects an ImpactedBucket object.

Show Source

@baseType: string

The object's superclass.
@schemaLocation: string (uri)

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

The object's subclass.
amount: object Quantity

Represents an amount in a specified unit.
description: string

The impact item's description.
itemType: string

The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit).
name: string

The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees.
reason: string

The reason for the impact item.

{
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The impact item's amount.",
            "$ref":"#/components/schemas/Quantity"
        },
        "description":{
            "type":"string",
            "description":"The impact item's description."
        },
        "itemType":{
            "type":"string",
            "description":"The impact item's type, indicating if the bucket is incremented (<b>credit</b>) or decremented (<b>debit</b>)."
        },
        "name":{
            "type":"string",
            "description":"The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the impact item."
        }
    },
    "description":"An impact item that affects an ImpactedBucket object."
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Addressable

Defines a base schema for addressable entities.
object EntityRef-allOf[2]

Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

href: string

The hyperlink reference.
id: string

The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

@referredType: string

The actual type of the target instance when needed for disambiguation.
href: string

The URI of the referred entity.
id(required): string

The identifier of the referred entity.
name: string

The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

Response

Supported Media Types

application/json;charset=utf-8

201 Response

The adjusted balance was created successfully.

Root Schema : Adjust Balance

Type: object

Title: Adjust Balance

An adjustment to a balance.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property).
@type: string

Title: Type

The object's subclass.
actionType: string

Title: Action Type

The type of adjustment action.
adjustmentNo: string

Title: Adjustment Number

The adjustment number associated with this adjustment.
adjustType: string

The adjustment type. (BRM does not use this property).
amount: object Quantity

Represents an amount in a specified unit.
bieId: array bieId

The bills, items, or events are associated with the adjustment.
billingCycleSpecification: object Billing Cycle Specification Ref Oracle

Title: Billing Cycle Specification Ref Oracle

A reference to a billing cycle specification, extended for BRM REST Services Manager.
billStructure: object Bill Structure Ref

Title: Bill Structure Ref

A reference to a bill structure, extended for BRM REST Services Manager.
bucket: object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
channel: object ChannelRef

A reference to a channel.
confirmationDate: string (date-time)

Title: Confirmation Date

The date that the adjustment was confirmed.
description: string

Title: Adjust Balance Description

The adjusted balance's description.
href: string (uri)

Title: Adjust Balance Href

The adjusted balance's href. (BRM does not use this property).
id: string

Title: Adjust Balance ID

The adjusted balance's ID.
impactedBucket: array impactedBucket

The buckets are impacted by the adjustment. itself.
logicalResource: object Logical Resource Ref

Title: Logical Resource Ref

A reference to a logical resource.
partyAccount: object Party Account Ref

Title: Party Account Ref

A reference to a party account.
product: object ProductRef

A product reference.
reason:

Title: Reason

The reason for the adjustment.
relatedParty: array relatedParty

The parties related to the adjusted balance. (BRM does not use this property).
requestedDate: string (date-time)

Title: Requested Date

The date and time that the request was received.
requestor: object Related Party

Title: Related Party

A party related to another object.
status: string

The adjustment's status.
taxTreatment: string

The tax treatment for the adjustment.
usageType: string

The usage type associated with the adjusted balance.

{
    "type":"object",
    "title":"Adjust Balance",
    "properties":{
        "id":{
            "type":"string",
            "title":"Adjust Balance ID",
            "description":"The adjusted balance's ID."
        },
        "href":{
            "type":"string",
            "title":"Adjust Balance Href",
            "description":"The adjusted balance's href. (BRM does not use this property).",
            "format":"uri"
        },
        "description":{
            "type":"string",
            "title":"Adjust Balance Description",
            "description":"The adjusted balance's description."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships. (BRM does not use this property).",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "actionType":{
            "type":"string",
            "title":"Action Type",
            "description":"The type of adjustment action."
        },
        "adjustType":{
            "type":"string",
            "description":"The adjustment type. (BRM does not use this property)."
        },
        "amount":{
            "description":"The amount to adjust.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bieId":{
            "type":"array",
            "x-cardinality":"1",
            "description":"The bills, items, or events are associated with the adjustment.",
            "items":{
                "$ref":"#/components/schemas/BieFieldOracle"
            }
        },
        "bucket":{
            "description":"The bucket to track the adjustment in.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "adjustmentNo":{
            "type":"string",
            "title":"Adjustment Number",
            "description":"The adjustment number associated with this adjustment."
        },
        "billingCycleSpecification":{
            "description":"The billing cycle specification is associated with this adjustment.",
            "$ref":"#/components/schemas/BillingCycleSpecificationRefOracle"
        },
        "billStructure":{
            "description":"The bill structure associated with the adjustment.",
            "$ref":"#/components/schemas/BillStructureRef"
        },
        "channel":{
            "description":"The channel for the adjustment. (BRM does not use this property).",
            "$ref":"#/components/schemas/ChannelRef"
        },
        "confirmationDate":{
            "type":"string",
            "title":"Confirmation Date",
            "description":"The date that the adjustment was confirmed.",
            "format":"date-time"
        },
        "impactedBucket":{
            "type":"array",
            "description":"The buckets are impacted by the adjustment. itself.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucket"
            }
        },
        "logicalResource":{
            "description":"The logical resource associated with the adjusted balance. (BRM does not use this property).",
            "$ref":"#/components/schemas/LogicalResourceRef"
        },
        "partyAccount":{
            "description":"The party account associated with the adjusted balance.",
            "$ref":"#/components/schemas/PartyAccountRef"
        },
        "product":{
            "description":"The products associated with the adjusted balance.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "reason":{
            "title":"Reason",
            "description":"The reason for the adjustment."
        },
        "relatedParty":{
            "type":"array",
            "description":"The parties related to the adjusted balance. (BRM does not use this property).",
            "items":{
                "$ref":"#/components/schemas/RelatedParty"
            }
        },
        "requestedDate":{
            "type":"string",
            "title":"Requested Date",
            "description":"The date and time that the request was received.",
            "format":"date-time"
        },
        "requestor":{
            "description":"The party that requested the adjustment.",
            "$ref":"#/components/schemas/RelatedParty"
        },
        "status":{
            "type":"string",
            "description":"The adjustment's status."
        },
        "usageType":{
            "type":"string",
            "description":"The usage type associated with the adjusted balance."
        },
        "taxTreatment":{
            "type":"string",
            "description":"The tax treatment for the adjustment."
        }
    },
    "description":"An adjustment to a balance."
}

Nested Schema : Quantity

Type: object

Represents an amount in a specified unit.

Show Source

amount: number (double)

Default Value: 1

The numeric value in the specified unit.
units: string

The unit.

{
    "type":"object",
    "description":"Represents an amount in a specified unit.",
    "properties":{
        "amount":{
            "type":"number",
            "nullable":true,
            "format":"double",
            "default":1,
            "description":"The numeric value in the specified unit."
        },
        "units":{
            "type":"string",
            "nullable":true,
            "description":"The unit."
        }
    }
}

Nested Schema : bieId

Type: array

The bills, items, or events are associated with the adjustment.

Show Source

Array of: object BIEField Oracle

Title: BIEField Oracle

A bill, item, or event, extended for BRM REST Services Manager.

{
    "type":"array",
    "x-cardinality":"1",
    "description":"The bills, items, or events are associated with the adjustment.",
    "items":{
        "$ref":"#/components/schemas/BieFieldOracle"
    }
}

Nested Schema : Billing Cycle Specification Ref Oracle

Type: object

Title: Billing Cycle Specification Ref Oracle

A reference to a billing cycle specification, extended for BRM REST Services Manager.

Show Source

href: string

Title: Href

The billing cycle specification's href.
id: string

Title: ID

The billing cycle specification's ID.
name: string

Title: Name

The billing cycle specification's name.

{
    "title":"Billing Cycle Specification Ref Oracle",
    "description":"A reference to a billing cycle specification, extended for BRM REST Services Manager.",
    "type":"object",
    "properties":{
        "id":{
            "title":"ID",
            "type":"string",
            "description":"The billing cycle specification's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The billing cycle specification's href."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The billing cycle specification's name."
        }
    }
}

Nested Schema : Bill Structure Ref

Type: object

Title: Bill Structure Ref

A reference to a bill structure, extended for BRM REST Services Manager.

Show Source

href: string

Title: Href

The bill structure's href.
id: string

Title: ID

The bill structure's ID.
name: string

Title: Name

The bill structure's name.

{
    "title":"Bill Structure Ref",
    "description":"A reference to a bill structure, extended for BRM REST Services Manager.",
    "type":"object",
    "properties":{
        "id":{
            "title":"ID",
            "type":"string",
            "description":"The bill structure's ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The bill structure's href."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The bill structure's name."
        }
    }
}

Nested Schema : Bucket Ref

Type: object

Title: Bucket Ref

A reference to a bucket.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string (uri)

The bucket's href.
id(required): string

Title: Bucket ID

The bucket's ID.
name: string

Title: Bucket Name

The bucket's name.
usageType: string

The bucket's usage type.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Bucket Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "description":"The bucket's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Bucket ID",
            "description":"The bucket's ID."
        },
        "name":{
            "type":"string",
            "title":"Bucket Name",
            "description":"The bucket's name."
        },
        "usageType":{
            "type":"string",
            "description":"The bucket's usage type."
        }
    },
    "description":"A reference to a bucket."
}

Nested Schema : ChannelRef

Type: object

A reference to a channel.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string

Title: Channel Href

The channel's href.
id(required): string

Title: Channel ID

The channel's ID.
name: string

Title: Channel Name

The channel's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "title":"Channel ID",
            "description":"The channel's ID."
        },
        "href":{
            "type":"string",
            "title":"Channel Href",
            "description":"The channel's href."
        },
        "name":{
            "type":"string",
            "title":"Channel Name",
            "description":"The channel's name."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to a channel."
}

Nested Schema : impactedBucket

Type: array

The buckets are impacted by the adjustment. itself.

Show Source

Array of: object ImpactedBucket

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

{
    "type":"array",
    "description":"The buckets are impacted by the adjustment. itself.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucket"
    }
}

Nested Schema : Logical Resource Ref

Type: object

Title: Logical Resource Ref

A reference to a logical resource.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string

Title: Href

The resource's href.
id(required): string

Title: ID

The resource's ID.
name: string

Title: Name

The resource's name.
value: string

The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN).

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Logical Resource Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The resource's href."
        },
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The resource's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The resource's name."
        },
        "value":{
            "type":"string",
            "description":"The device number(PIN_FLD_ALIAS_LIST) or the login (PIN_FLD_LOGIN)."
        }
    },
    "description":"A reference to a logical resource."
}

Nested Schema : Party Account Ref

Type: object

Title: Party Account Ref

A reference to a party account.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType: string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
description: string

Title: Description

The party account's description.
href: string

Title: Href

The party account's href.
id(required): string

Title: Account ID

The party account's ID.
name: string

Title: Name

The party account's name.
status: string

Title: Status

The overall status of the account. For example: due, paid, or in arrears.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Party Account Ref",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The party account's description."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party account's href."
        },
        "id":{
            "type":"string",
            "title":"Account ID",
            "description":"The party account's ID."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The party account's name."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The overall status of the account. For example&colon; <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : ProductRef

Type: object

A product reference.

Match All

A product reference.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
allOf EntityRef

{
    "type":"object",
    "description":"A product reference.",
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/EntityRef"
        }
    ]
}

Nested Schema : relatedParty

Type: array

The parties related to the adjusted balance. (BRM does not use this property).

Show Source

Array of: object Related Party

Title: Related Party

A party related to another object.

{
    "type":"array",
    "description":"The parties related to the adjusted balance. (BRM does not use this property).",
    "items":{
        "$ref":"#/components/schemas/RelatedParty"
    }
}

Nested Schema : Related Party

Type: object

Title: Related Party

A party related to another object.

Show Source

@baseType: string

Title: Base Type

The object's superclass.
@referredType(required): string

Title: Referred Type

The object's type in the target system, if baseType and type need further disambiguation.
@schemaLocation: string (uri)

Title: Schema Location

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

Title: Type

The object's subclass.
href: string (uri)

Title: Href

The party's href.
id(required): string

Title: Party ID

The party's ID.
name: string

Title: Party Name

The party's name.
role: string

Title: Party Role

The party's role.

{
    "required":[
        "@referredType",
        "id"
    ],
    "type":"object",
    "title":"Related Party",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The party's href.",
            "format":"uri"
        },
        "id":{
            "type":"string",
            "title":"Party ID",
            "description":"The party's ID."
        },
        "name":{
            "type":"string",
            "title":"Party Name",
            "description":"The party's name."
        },
        "role":{
            "type":"string",
            "title":"Party Role",
            "description":"The party's role."
        }
    },
    "description":"A party related to another object."
}

Nested Schema : BIEField Oracle

Type: object

Title: BIEField Oracle

A bill, item, or event, extended for BRM REST Services Manager.

Show Source

href: string

Title: Href

The bill, item, or event href.
id(required): string

Title: ID

The bill, item, or event ID.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"BIEField Oracle",
    "description":"A bill, item, or event, extended for BRM REST Services Manager.",
    "properties":{
        "id":{
            "type":"string",
            "title":"ID",
            "description":"The bill, item, or event ID."
        },
        "href":{
            "type":"string",
            "title":"Href",
            "description":"The bill, item, or event href."
        }
    }
}

Nested Schema : ImpactedBucket

Type: object

A bucket impacted by a balance top-up, adjustment, transfer, or reservation.

Show Source

@baseType: string

The object's superclass.
@schemaLocation: string (uri)

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

The object's subclass.
amountAfter: object Quantity

Represents an amount in a specified unit.
amountBefore: object Quantity

Represents an amount in a specified unit.
bucket: object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
confirmationDate: string (date-time)

The date and time the impact was confirmed.
description: string

The impacted bucket's description.
item(required): array item

Minimum Number of Items: 1

The impacted bucket items.
name: string

The impacted bucket's name.
requestedDate: string (date-time)

The date and time the request was received.

{
    "required":[
        "item"
    ],
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amountAfter":{
            "description":"The amount in the bucket after the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "amountBefore":{
            "description":"The amount in the bucket before the impact.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"A reference to the impacted bucket.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "confirmationDate":{
            "type":"string",
            "description":"The date and time the impact was confirmed.",
            "format":"date-time"
        },
        "description":{
            "type":"string",
            "description":"The impacted bucket's description."
        },
        "item":{
            "minItems":1,
            "type":"array",
            "description":"The impacted bucket items.",
            "items":{
                "$ref":"#/components/schemas/ImpactedBucketItem"
            }
        },
        "name":{
            "type":"string",
            "description":"The impacted bucket's name."
        },
        "requestedDate":{
            "type":"string",
            "description":"The date and time the request was received.",
            "format":"date-time"
        }
    },
    "description":"A bucket impacted by a balance top-up, adjustment, transfer, or reservation."
}

Nested Schema : item

Type: array

Minimum Number of Items: 1

The impacted bucket items.

Show Source

Array of: object ImpactedBucketItem

An impact item that affects an ImpactedBucket object.

{
    "minItems":1,
    "type":"array",
    "description":"The impacted bucket items.",
    "items":{
        "$ref":"#/components/schemas/ImpactedBucketItem"
    }
}

Nested Schema : ImpactedBucketItem

Type: object

An impact item that affects an ImpactedBucket object.

Show Source

@baseType: string

The object's superclass.
@schemaLocation: string (uri)

A URI to a JSON schema file that defines additional attributes and relationships.
@type: string

The object's subclass.
amount: object Quantity

Represents an amount in a specified unit.
description: string

The impact item's description.
itemType: string

The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit).
name: string

The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees.
reason: string

The reason for the impact item.

{
    "type":"object",
    "properties":{
        "@baseType":{
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "description":"The object's subclass."
        },
        "amount":{
            "description":"The impact item's amount.",
            "$ref":"#/components/schemas/Quantity"
        },
        "description":{
            "type":"string",
            "description":"The impact item's description."
        },
        "itemType":{
            "type":"string",
            "description":"The impact item's type, indicating if the bucket is incremented (<b>credit</b>) or decremented (<b>debit</b>)."
        },
        "name":{
            "type":"string",
            "description":"The impact item's name indicates the transaction activity, such as a top-up or bonus. additional bonus, tax, or fees."
        },
        "reason":{
            "type":"string",
            "description":"The reason for the impact item."
        }
    },
    "description":"An impact item that affects an ImpactedBucket object."
}

Nested Schema : EntityRef

Match All

Represents an entity reference schema for EntityRef classes.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Addressable

Defines a base schema for addressable entities.
object EntityRef-allOf[2]

Represents an entity reference schema for EntityRef classes.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "$ref":"#/components/schemas/Addressable"
        },
        {
            "type":"object",
            "description":"Represents an entity reference schema for EntityRef classes.",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The identifier of the referred entity."
                },
                "href":{
                    "type":"string",
                    "nullable":true,
                    "description":"The URI of the referred entity."
                },
                "name":{
                    "type":"string",
                    "nullable":true,
                    "description":"The referred entity's name."
                },
                "@referredType":{
                    "type":"string",
                    "nullable":true,
                    "description":"The actual type of the target instance when needed for disambiguation."
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Addressable

Type: object

Defines a base schema for addressable entities.

Show Source

href: string

The hyperlink reference.
id: string

The ID.

{
    "type":"object",
    "description":"Defines a base schema for addressable entities.",
    "properties":{
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The hyperlink reference."
        },
        "id":{
            "type":"string",
            "description":"The ID."
        }
    }
}

Nested Schema : EntityRef-allOf[2]

Type: object

Represents an entity reference schema for EntityRef classes.

Show Source

@referredType: string

The actual type of the target instance when needed for disambiguation.
href: string

The URI of the referred entity.
id(required): string

The identifier of the referred entity.
name: string

The referred entity's name.

{
    "type":"object",
    "description":"Represents an entity reference schema for EntityRef classes.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The identifier of the referred entity."
        },
        "href":{
            "type":"string",
            "nullable":true,
            "description":"The URI of the referred entity."
        },
        "name":{
            "type":"string",
            "nullable":true,
            "description":"The referred entity's name."
        },
        "@referredType":{
            "type":"string",
            "nullable":true,
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

400 Response

The request isn't valid.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

401 Response

The client doesn't have the correct privileges.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

403 Response

The request wasn't authorized.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

405 Response

This method is not allowed.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

409 Response

The request could not be processed due to the conflict with the existing state of the resource.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

500 Response

The system encountered an internal error.

Root Schema : Error

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Match All

Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code.

Show Source

object Extensible

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.
object Error-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Extensible"
        },
        {
            "type":"object",
            "required":[
                "code",
                "reason"
            ],
            "properties":{
                "code":{
                    "type":"string",
                    "description":"The application-specific error detail defined by the API or a common list."
                },
                "reason":{
                    "type":"string",
                    "description":"Explains the error to a client user."
                },
                "message":{
                    "type":"string",
                    "description":"Provides error details and corrective actions for a client user."
                },
                "status":{
                    "type":"string",
                    "description":"The HTTP error code extension."
                },
                "referenceError":{
                    "type":"string",
                    "description":"The URI of documentation that describes the error."
                }
            }
        }
    ],
    "description":"Represents an error returned by an API, typically with an HTTP 3xx, 4xx, or 5xx response code."
}

Nested Schema : Extensible

Type: object

Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.

Show Source

@baseType: string

The superclass.
@schemaLocation: string

The URI of a JSON Schema file that defines additional attributes and relationships.
@type(required): string

The subclass Extensible name.

{
    "type":"object",
    "description":"Represents a base extensible schema for TM Forum Open APIs. The entity must include @type.",
    "properties":{
        "@type":{
            "type":"string",
            "nullable":true,
            "description":"The subclass Extensible name."
        },
        "@baseType":{
            "type":"string",
            "nullable":true,
            "description":"The superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "nullable":true,
            "description":"The URI of a JSON Schema file that defines additional attributes and relationships."
        }
    },
    "required":[
        "@type"
    ]
}

Nested Schema : Error-allOf[1]

Type: object

Show Source

code(required): string

The application-specific error detail defined by the API or a common list.
message: string

Provides error details and corrective actions for a client user.
reason(required): string

Explains the error to a client user.
referenceError: string

The URI of documentation that describes the error.
status: string

The HTTP error code extension.

{
    "type":"object",
    "required":[
        "code",
        "reason"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"The application-specific error detail defined by the API or a common list."
        },
        "reason":{
            "type":"string",
            "description":"Explains the error to a client user."
        },
        "message":{
            "type":"string",
            "description":"Provides error details and corrective actions for a client user."
        },
        "status":{
            "type":"string",
            "description":"The HTTP error code extension."
        },
        "referenceError":{
            "type":"string",
            "description":"The URI of documentation that describes the error."
        }
    }
}

Examples

The following example shows how to create a noncurrency balance adjustment by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.

The -d option specifies the file to attach as the request body.

curl -X POST 'http://host:port/brm/prepayBalanceManagement/version/adjustBalance' -d @adjustBalanceCreate.json

Example Request Body for a Noncurrency Adjustment

The following is an example of the contents of the adjustBalanceCreate.json file sent as the request body.

{
   "description": "Non-currency Adjustment",
   "reason": "1",
   "bucket": {
      "id": "0.0.0.1+-balance_group+71659"
   },
   "amount": {
      "amount": "5",
      "units": "Free Minutes"
   },
   "validFor": {
      "startDateTime": "2025-05-21T13:14:53+05:30",
      "endDateTime":"2025-05-21T13:14:53+05:30"
   }
}

Example Response Body for a Noncurrency Adjustment

The following is an example of the response body in JSON format.

{
    "id": "0.0.0.1+-adjustment+227008",
    "href": "http://host:port/brm/prepayBalanceManagement/version/adjustBalance/0.0.0.1+-adjustment+227008",
    "confirmationDate": "2025-01-08T07:40:45-08:00",
    "description": "Non-currency Adjustment",
    "reason": "1",
    "requestedDate": "2025-01-08T07:40:45-08:00",
    "adjustType": null,
    "amount": {
        "amount": -5.0,
        "units": "Free Minutes",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null
    },
    "bucket": {
	"id": "0.0.0.1+-balance_group+71659"
	"href": "http://host:port/brm/prepayBalanceManagement/version/bucket/0.0.0.1+-balance_group+71659"
	},
    "channel": null,
    "logicalResource": null,
    "partyAccount": {
        "id": "0.0.0.1+-account+228862",
        "href": null,
        "description": null,
        "name": "Danielle Rao",
        "status": null,
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null,
        "@referredType": null
    },
    "product": null,
    "relatedParty": null,
    "requestor": {
        "id": null,
        "href": null,
        "name": "Billing Care",
        "role": null,
        "@baseType": null,
        "@schemaLocation": null,
        "@type": null,
        "@referredType": null
    },
    "status": "COMPLETED",
    "usageType": "OTHER",
    "validFor": {
	"startDateTime": "2025-05-21T13:14:53+05:30",
     "endDateTime":"2025-05-21T13:14:53+05:30"
	 },
    "@baseType": "AdjustBalance",
    "@schemaLocation": null,
    "@type": "AdjustBalance"
}