REST Services Manager API for Billing and Revenue Management

Get Adjusted Balances

get

/adjustBalance

Gets the adjusted balances that match the query criteria.

Request

Query Parameters

@type: string
The type of object to return. Use @type=AdjustBalance for a base object or @type=AdjustBalanceOracle for an extended object.
Example:
```
AdjustBalance
```
fields: string
The list of comma-separated fields to return in the response.
Example:
```
description,amount
```
id: string
Retrieves the adjustment with the specified ID or adjustment number.
Example:
```
0.0.0.1+-item-adjustment+216265
```
limit: integer
The maximum number of results to return. For example, use limit=10 to return the first 10 results only.
Example:
```
10
```
offset: integer
The number of results to offset the response by. For example, use offset=10 to return results 10 and higher. For example, use offset=10 to return results 10 and higher.
Example:
```
10
```
partyAccount.id: string
Retrieves the adjustments for the account with the specified ID or account number.
Example:
```
0.0.0.1+-account+70489
```
requestedDate: string
Retrieves the adjustments with a requestedDate that matches the specified date and time.
Example:
```
2020-01-01T12:00:27.000Z
```
requestedDate.gt: string
Retrieves the adjustments with a requestedDate that is greater than the specified date and time.
Example:
```
2020-01-01T12:00:27.000Z
```
requestedDate.gte: string
Retrieves the adjustments with a requestedDate that is greater than or equal to the specified date and time.
Example:
```
2020-01-01T12:00:27.000Z
```
requestedDate.lt: string
Retrieves the adjustments with a requestedDate that is less than the specified date and time.
Example:
```
2020-01-01T12:00:27.000Z
```
requestedDate.lte: string
Retrieves the adjustments with a requestedDate that is less than or equal to the specified date and time.
Example:
```
2020-01-01T12:00:27.000Z
```
status: string
Retrieves the adjustment with the specified item status. Use status=completed to retrieve closed currency balance adjustments or status=created to retrieve open currency balance adjustments.
Example:
```
completed
```
usageType: string
Retrieves adjustments that match the specified usage type. If usageType is not specified, only currency balance adjustments are retrieved. Use usageType=monetary to retrieve currency balance adjustments or usageType=other to retrieve non-currency balance adjustments.
Example:
```
monetary
```

There's no request body for this operation.

Response

Supported Media Types

application/json;charset=utf-8

200 Response

Success

Headers

X-Result-Count(required):

The number of items returned in the response body.
X-Total-Count(required):

The total number of items that matched the criteria.

Root Schema : schema

Type: array

Show Source

Array of: object Adjust Balance

Title: Adjust Balance

An adjustment to a balance.

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

Nested 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.
adjustType: string

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

Title: Quantity

The quantity of an object.
bucket: object object Bucket Ref

Title: Bucket Ref

A reference to a bucket.
channel: object 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 array impactedBucket

Buckets impacted by the adjustment. itself.
logicalResource: object object Logical Resource Ref

Title: Logical Resource Ref

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

Title: Party Account Ref

A reference to a party account.
product: object object Product Ref

Title: Product Ref

A reference to a product.
reason:

Title: Reason

The reason for the adjustment.
relatedParty: array array relatedParty

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

Title: Requested Date

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

Title: Related Party

A party related to another object.
status: string

The adjustment's status.
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."
        },
        "adjustType":{
            "type":"string",
            "description":"The adjustment type. (BRM does not use this property.)"
        },
        "amount":{
            "description":"The amount to adjust.",
            "$ref":"#/components/schemas/Quantity"
        },
        "bucket":{
            "description":"The bucket to track the adjustment in.",
            "$ref":"#/components/schemas/BucketRef"
        },
        "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":"Buckets 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":"Products associated with the adjusted balance.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "reason":{
            "title":"Reason",
            "description":"The reason for the adjustment."
        },
        "relatedParty":{
            "type":"array",
            "description":"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 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."
        }
    },
    "description":"An adjustment to a balance."
}

Nested Schema : Quantity

Type: object

Title: Quantity

The quantity of an object.

Show Source

amount: number (float)

Title: Amount

Default Value: 1

A numeric value.
units: string

Title: Units

A unit. For example, MB or minutes.

{
    "type":"object",
    "title":"Quantity",
    "properties":{
        "amount":{
            "type":"number",
            "title":"Amount",
            "description":"A numeric value.",
            "format":"float",
            "default":1
        },
        "units":{
            "type":"string",
            "title":"Units",
            "description":"A unit. For example, <b>MB</b> or <b>minutes</b>."
        }
    },
    "description":"The quantity of an object."
}

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

Buckets 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":"Buckets 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 resource's value.

{
    "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 resource's value."
        }
    },
    "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, <b>due</b>, <b>paid</b>, or <b>in arrears</b>."
        }
    },
    "description":"A reference to a party account."
}

Nested Schema : Product Ref

Type: object

Title: Product Ref

A reference to a product.

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: Product Href

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

Title: Product ID

The product's ID.
name: string

Title: Product Name

The product's name.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Product Ref",
    "description":"A reference to a product.",
    "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":"Product Href",
            "description":"The product's href."
        },
        "id":{
            "type":"string",
            "title":"Product ID",
            "description":"The product's ID."
        },
        "name":{
            "type":"string",
            "title":"Product Name",
            "description":"The product's name."
        }
    }
}

Nested Schema : relatedParty

Type: array

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":"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 : 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 object Quantity

Title: Quantity

The quantity of an object.
amountBefore: object object Quantity

Title: Quantity

The quantity of an object.
bucket: object object Bucket Ref

Title: Bucket Ref

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

The date the impact was confirmed.
description: string

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

Minimum Number of Items: 1

The impacted bucket items.
name: string

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

The date 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 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 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 object Quantity

Title: Quantity

The quantity of an object.
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, indicating the transaction activity. For example, top-up, 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 (credit) or decremented (debit)."
        },
        "name":{
            "type":"string",
            "description":"The impact item's name, indicating the transaction activity. For example, top-up, 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."
}

400 Response

Bad Request

Root Schema : Error

Type: object

Title: Error

Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).

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.
@type: string

Title: Type

The object's subclass.
code(required): string

Title: Error Code

An error code.
message: string

Title: Error Message

Details and corrective actions related to the error.
reason(required): string

Title: Reason

The reason for the error.
referenceError: string (uri)

Title: Reference Error

A URI to documentation describing the error.
status: string

Title: Error Status

The HTTP Error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

401 Response

Unauthorized

Root Schema : Error

Type: object

Title: Error

Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).

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.
@type: string

Title: Type

The object's subclass.
code(required): string

Title: Error Code

An error code.
message: string

Title: Error Message

Details and corrective actions related to the error.
reason(required): string

Title: Reason

The reason for the error.
referenceError: string (uri)

Title: Reference Error

A URI to documentation describing the error.
status: string

Title: Error Status

The HTTP Error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

403 Response

Forbidden

Root Schema : Error

Type: object

Title: Error

Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).

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.
@type: string

Title: Type

The object's subclass.
code(required): string

Title: Error Code

An error code.
message: string

Title: Error Message

Details and corrective actions related to the error.
reason(required): string

Title: Reason

The reason for the error.
referenceError: string (uri)

Title: Reference Error

A URI to documentation describing the error.
status: string

Title: Error Status

The HTTP Error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

404 Response

Not Found

Root Schema : Error

Type: object

Title: Error

Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).

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.
@type: string

Title: Type

The object's subclass.
code(required): string

Title: Error Code

An error code.
message: string

Title: Error Message

Details and corrective actions related to the error.
reason(required): string

Title: Reason

The reason for the error.
referenceError: string (uri)

Title: Reference Error

A URI to documentation describing the error.
status: string

Title: Error Status

The HTTP Error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

405 Response

Method Not Allowed

Root Schema : Error

Type: object

Title: Error

Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).

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.
@type: string

Title: Type

The object's subclass.
code(required): string

Title: Error Code

An error code.
message: string

Title: Error Message

Details and corrective actions related to the error.
reason(required): string

Title: Reason

The reason for the error.
referenceError: string (uri)

Title: Reference Error

A URI to documentation describing the error.
status: string

Title: Error Status

The HTTP Error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

409 Response

Conflict

Root Schema : Error

Type: object

Title: Error

Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).

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.
@type: string

Title: Type

The object's subclass.
code(required): string

Title: Error Code

An error code.
message: string

Title: Error Message

Details and corrective actions related to the error.
reason(required): string

Title: Reason

The reason for the error.
referenceError: string (uri)

Title: Reference Error

A URI to documentation describing the error.
status: string

Title: Error Status

The HTTP Error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

500 Response

Internal Server Error

Root Schema : Error

Type: object

Title: Error

Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).

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.
@type: string

Title: Type

The object's subclass.
code(required): string

Title: Error Code

An error code.
message: string

Title: Error Message

Details and corrective actions related to the error.
reason(required): string

Title: Reason

The reason for the error.
referenceError: string (uri)

Title: Reference Error

A URI to documentation describing the error.
status: string

Title: Error Status

The HTTP Error code extension.

{
    "required":[
        "code",
        "reason"
    ],
    "type":"object",
    "title":"Error",
    "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.",
            "format":"uri"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)."
}

Examples

The following examples shows how to get balance adjustments by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

Examples of the Request Body

This request uses the usageType=monetary query parameter to return only currency adjustments:

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/adjustBalance?limit=2&usageType=monetary'

This request uses the usageType=other query parameter to return only noncurrency adjustments:

curl -X GET 'http://host:port/brm/prepayBalanceManagement/version/adjustBalance?limit=1&usageType=other'

Example of the Response Body for Currency Adjustments

The following example shows the contents of the response body for currency adjustments in JSON format.

[
    {
        "id": "0.0.0.1+-item-adjustment+221139",
        "href": "http://host:port/brm/prepayBalanceManagement/version/adjustBalance/0.0.0.1+-item-adjustment+221139",
        "confirmationDate": "2020-01-08T07:35:58-08:00",
        "description": "",
        "reason": "1",
        "requestedDate": "2020-01-08T07:35:58-08:00",
        "adjustType": null,
        "amount": {
            "amount": -1.0,
            "units": "USD",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null
        },
        "bucket": null,
        "channel": null,
        "logicalResource": null,
        "partyAccount": {
            "id": "0.0.0.1+-account+228862",
            "href": null,
            "description": null,
            "name": "Daniel R",
            "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": "MONETARY",
        "validFor": null,
        "@baseType": "AdjustBalance",
        "@schemaLocation": null,
        "@type": "AdjustBalance"
    },
    {
        "id": "0.0.0.1+-item-adjustment+220881",
        "href": "http://host:port/brm/prepayBalanceManagement/version/adjustBalance/0.0.0.1+-item-adjustment+220881",
        "confirmationDate": "2020-01-08T07:34:40-08:00",
        "description": "",
        "reason": "1",
        "requestedDate": "2020-01-08T07:34:40-08:00",
        "adjustType": null,
        "amount": {
            "amount": -3.0,
            "units": "USD",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null
        },
        "bucket": null,
        "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": "MONETARY",
        "validFor": null,
        "@baseType": "AdjustBalance",
        "@schemaLocation": null,
        "@type": "AdjustBalance"
    }
]

Example of the Response Body for Noncurrency Adjustments

The following example shows the contents of the response body for noncurrency adjustments in JSON format.

[
    {
        "id": "0.0.0.1+-event-billing-debit+32593",
        "href": "http://host:port/brm/prepayBalanceManagement/v4/adjustBalance/0.0.0.1+-event-billing-debit+32593",
        "confirmationDate": "2020-09-22T23:20:56+05:30",
        "description": "My Noncurrency Adjustment",
        "reason": "1",
        "requestedDate": "2020-09-22T23:20:56+05:30",
        "adjustType": null,
        "amount": {
            "amount": 1.0,
            "units": "Free Game",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null
        },
        "bucket": {
            "id": "0.0.0.1+-balance_group+57356",
            "href": "http://host:port/brm/prepayBalanceManagement/v4/bucket/0.0.0.1+-balance_group+57356",
            "name": null,
            "@baseType": "Bucket",
            "@schemaLocation": null,
            "@type": "Bucket",
            "@referredType": null
        },
        "channel": null,
        "logicalResource": null,
        "partyAccount": {
            "id": "0.0.0.1+-account+59892",
            "href": null,
            "description": null,
            "name": "acc01 acc01",
            "status": "active",
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null,
            "@referredType": null
        },
        "product": null,
        "relatedParty": null,
        "requestor": {
            "id": null,
            "href": null,
            "name": "brm-rest-services-manager",
            "role": null,
            "@baseType": null,
            "@schemaLocation": null,
            "@type": null,
            "@referredType": null
        },
        "status": null,
        "usageType": "OTHER",
        "validFor": {
            "endDateTime": "2022-10-21T13:14:53+05:30",
            "startDateTime": "2020-10-21T13:14:53+05:30"
        },
        "@baseType": "AdjustBalance",
        "@schemaLocation": null,
        "@type": "AdjustBalance"
    }
]