Get On-Demand Customer Bills
get
/customerBillOnDemand
Gets the on-demand customer bills that match the query criteria.
Request
Query Parameters
-
@type: string
The type of object to return.Examples
-
billingAccount.id: string
Retrieves the on-demand customer bills for the specified account ID or account number.Examples
-
id: string
Retrieves the on-demand customer bill for the specified bill ID or bill number.Examples
-
limit: integer
The maximum number of results to return.Examples
-
offset: integer
The number of results to offset the response by.Examples
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
The on-demand customer bill was retrieved successfully.
Root Schema : schema
Type:
Show Source
array-
Array of:
object Customer Bill OnDemand
Title:
Customer Bill OnDemandA customer bill created on demand.
Nested Schema : Customer Bill OnDemand
Type:
objectTitle:
Customer Bill OnDemandA customer bill created on demand.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
billingAccount(required): object
Billing Account Ref
Title:
Billing Account RefA billing account is a detailed description of a bill structure. -
customerBill: object
Bill Ref
Title:
Bill RefA reference to a bill. -
description: string
Title:
Bill DescriptionThe on-demand bill's description. -
href(required): string
Title:
Bill HrefThe on-demand bill's href. -
id(required): string
Title:
Bill IDThe on-demand bill's ID or bill number. -
lastUpdate: string
Title:
Last Updated DateThe date that the on-demand bill was last updated. -
name: string
Title:
Bill NameThe on-demand bill's name. - relatedParty: object Related Party Ref
-
state(required): string
Title:
State ValuesAllowed Values:[ "inProgress", "rejected", "done", "terminatedWithError" ]The possible values for an on-demand bill's state: inProgress, rejected, done, and terminatedWithError.
Nested Schema : Billing Account Ref
Type:
objectTitle:
Billing Account RefA billing account is a detailed description of a bill structure.
Show Source
-
@baseType: string
The super-class when sub-classing.
-
@referredType: string
The actual type of the target instance when needed for disambiguation.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
The sub-class entity name when sub-classing.
-
accountNumber: string
The account number.
-
href: string
A reference for the billing account.
-
id: string
The billing account ID or billing account number.
-
name: string
The name of the billing account.
Nested Schema : Bill Ref
Type:
objectTitle:
Bill RefA reference to a bill.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe actual type of the target instance when needed for disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
Bill HrefThe bill's href. -
id: string
Title:
Bill IDThe bill's ID.
Nested Schema : Related Party Ref
Type:
objectTitle:
Related Party RefA reference to the party related to an object.
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@referredType: string
Title:
Referred TypeThe object's type in the target system. If baseType and type, need further disambiguation. -
@schemaLocation: string
(uri)
Title:
Schema LocationThe URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
href: string
Title:
Related Party HrefThe related party's href. -
id(required): string
Title:
Related Party IDThe related party's ID. -
name: string
Title:
Related Party NameThe related party's name. -
role: string
Title:
Related Party RoleThe related party's role.
400 Response
The request isn't valid.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
401 Response
The client doesn't have the correct privileges.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
403 Response
The request wasn't authorized.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
404 Response
The requested resource couldn't be found.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
405 Response
This method is not allowed.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
409 Response
The request could not be processed due to the conflict with the existing state of the resource.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
500 Response
The system encountered an internal error.
Root Schema : Error
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Match All
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
The operation used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
object
Extensible
The Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
-
object
Error-allOf[1]
Nested Schema : Extensible
Type:
objectThe Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
Show Source
-
@baseType: string
The defines the super-class when sub-classing.
-
@schemaLocation: string
The URI to a JSON-Schema file that defines additional attributes and relationships
-
@type(required): string
The definition of the sub-class extensible name, when sub-classing.
Nested Schema : Error-allOf[1]
Type:
Show Source
object-
code(required): string
The application relevant detail, defined in the API or a common list.
-
message: string
The details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
The explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
The URI of documentation describing the error.
-
status: string
The HTTP Error code extension
Examples
Example 1: Get On-Demand Customer Bills by Account POID
The following example shows how to get on-demand bills for a specified account POID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
The request uses query parameters to show a maximum of two results, for a base object, for a specific account POID.
curl -X GET 'http://host:port/brm/customerBillManagement/version/customerBillOnDemand?limit=2&@type=CustomerBillOnDemand&billingAccount.id=0.0.0.1+-account+104221'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
[
{
"id": "0.0.0.1+-bill+427232",
"href": "http://host:port/brm/customerBillManagement/version/customerBillOnDemand/0.0.0.1+-bill+427232",
"description": null,
"lastUpdate": "2025-03-19T16:28:59+05:30",
"name": "PIN Bill NOW",
"billingAccount": {
"id": "0.0.0.1+-account+104221",
"href": null,
"name": "Grace Wang",
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": "billingAccount"
},
"customerBill": {
"id": "0.0.0.1+-bill+427232",
"href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+427232",
"@baseType": "CustomerBill",
"@schemaLocation": null,
"@type": "CustomerBill",
"@referredType": "CustomerBill"
},
"relatedParty": null,
"state": "DONE",
"@baseType": "CustomerBillOnDemand",
"@schemaLocation": null,
"@type": "CustomerBillOnDemand"
},
{
"id": "0.0.0.1+-bill+427233",
"href": "http://host:port/brm/customerBillManagement/version/customerBillOnDemand/0.0.0.1+-bill+427233",
"description": null,
"lastUpdate": "2025-04-18T16:28:59+05:30",
"name": "PIN Bill NOW",
"billingAccount": {
"id": "0.0.0.1+-account+104221",
"href": null,
"name": "Grace Wang",
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": "billingAccount"
},
"customerBill": {
"id": "0.0.0.1+-bill+427233",
"href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+427233",
"@baseType": "CustomerBill",
"@schemaLocation": null,
"@type": "CustomerBill",
"@referredType": "CustomerBill"
},
"relatedParty": null,
"state": "DONE",
"@baseType": "CustomerBillOnDemand",
"@schemaLocation": null,
"@type": "CustomerBillOnDemand"
}
]Example 2: Get On-Demand Customer Bills by Account Number
The following example shows how to get on-demand bills for a specified account number by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
The request uses query parameters to show a maximum of two results, for a base object, for a specific account POID.
curl -X GET 'http://host:port/brm/customerBillManagement/version/customerBillOnDemand?limit=2&@type=CustomerBillOnDemand&billingAccount.id=Account-65437'
Example of the Response Body
The following example shows the contents of the response body in JSON format.
[
{
"id": "0.0.0.1+-bill+427232",
"href": "http://host:port/brm/customerBillManagement/version/customerBillOnDemand/0.0.0.1+-bill+427232",
"description": null,
"lastUpdate": "2025-03-19T16:28:59+05:30",
"name": "PIN Bill NOW",
"billingAccount": {
"id": "Account-65437",
"href": null,
"name": "Carmen Garcia",
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": "billingAccount"
},
"customerBill": {
"id": "0.0.0.1+-bill+427232",
"href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+427232",
"@baseType": "CustomerBill",
"@schemaLocation": null,
"@type": "CustomerBill",
"@referredType": "CustomerBill"
},
"relatedParty": null,
"state": "DONE",
"@baseType": "CustomerBillOnDemand",
"@schemaLocation": null,
"@type": "CustomerBillOnDemand"
},
{
"id": "0.0.0.1+-bill+427233",
"href": "http://host:port/brm/customerBillManagement/version/customerBillOnDemand/0.0.0.1+-bill+427233",
"description": null,
"lastUpdate": "2025-04-18T16:28:59+05:30",
"name": "PIN Bill NOW",
"billingAccount": {
"id": "Account-65437",
"href": null,
"name": "Carmen Garcia",
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": "billingAccount"
},
"customerBill": {
"id": "0.0.0.1+-bill+427233",
"href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+427233",
"@baseType": "CustomerBill",
"@schemaLocation": null,
"@type": "CustomerBill",
"@referredType": "CustomerBill"
},
"relatedParty": null,
"state": "DONE",
"@baseType": "CustomerBillOnDemand",
"@schemaLocation": null,
"@type": "CustomerBillOnDemand"
}
]