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. Use @type=CustomerBillOnDemand for a base object or @type=CustomerBillOnDemandOracle for an extended object.Example:
CustomerBillOnDemand
-
billingAccount.id: string
Retrieves the on-demand customer bills for the specified account ID.Example:
0.0.0.1+-account+107117
-
id: string
Retrieves the on-demand customer bill for the specified bill ID.Example:
0.0.0.1+-bill+106861
-
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 maximum number of results to return. For example, use offset=10 to return results 10 and higher.Example:
10
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Root Schema : schema
Type:
Show Source
array
-
Array of:
object Customer Bill OnDemand
Title:
Customer Bill OnDemand
A customer bill created on demand.
Nested Schema : Customer Bill OnDemand
Type:
object
Title:
Customer Bill OnDemand
A customer bill created on demand.
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. -
billingAccount(required): object
object
Billing Account Ref
Title:
Billing Account Ref
A billing account reference. -
customerBill: object
object
Bill Ref
Title:
Bill Ref
A reference to a bill. -
description: string
Title:
Bill Description
The on-demand bill's description. -
href(required): string
Title:
Bill Href
The on-demand bill's href. -
id(required): string
Title:
Bill ID
The on-demand bill's ID. -
lastUpdate: string
Title:
Last Updated Date
The date that the on-demand bill was last updated. -
name: string
Title:
Bill Name
The on-demand bill's name. - relatedParty: object object Related Party Ref
-
state(required): string
Title:
State Values
Allowed Values:[ "inProgress", "rejected", "done", "terminatedWithError" ]
Possible values for an on-demand bill's state.
Nested Schema : Billing Account Ref
Type:
object
Title:
Billing Account Ref
A billing account reference.
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:
Billing Account Href
The billing account reference's href. -
id(required): string
Title:
Billing Account ID
The billing account reference's ID. -
name: string
Title:
Billing Account Name
The billing account reference's name.
Nested Schema : Bill Ref
Type:
object
Title:
Bill Ref
A reference to a bill.
Show Source
-
@baseType: string
Title:
Base Type
The object's superclass. -
@referredType: string
Title:
Referred Type
The actual type of the target instance when needed for 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:
Bill Href
The bill's href. -
id: string
Title:
Bill ID
The bill's ID.
Nested Schema : Related Party Ref
Type:
object
Title:
Related Party Ref
A reference to the party related to an object.
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:
Related Party Href
The related party's href. -
id(required): string
Title:
Related Party ID
The related party's ID. -
name: string
Title:
Related Party Name
The related party's name. -
role: string
Title:
Related Party Role
The related party's role.
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.
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.
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.
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.
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.
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.
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.
Examples
The following example shows how to get on-demand bills 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 billing account.
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": "2021-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": "2021-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" } ]