Create a Customer Bill On Demand
post
/customerBillOnDemand
Creates a bill.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json;charset=utf-8
Root Schema : Customer Bill OnDemand Create
Type:
object
Title:
Customer Bill OnDemand Create
An on-demand customer bill, used in the create request. The id and href properties are not used in the create request.
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
Billing Account Ref
Title:
Billing Account Ref
A billing account is a detailed description of a bill structure. -
customerBill: object
Bill Ref
Title:
Bill Ref
A reference to a bill. -
description: string
Title:
Bill Description
The on-demand bill's description. -
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 Related Party Ref
-
state: 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 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 unique ID for the billing account.
-
name: string
The name of the billing account.
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(required): string
Title:
Bill Href
The bill's href. -
id(required): 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.
Response
Supported Media Types
- application/json;charset=utf-8
201 Response
Created
Root 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
Billing Account Ref
Title:
Billing Account Ref
A billing account is a detailed description of a bill structure. -
customerBill: 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 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 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 unique ID for the billing account.
-
name: string
The name of the billing account.
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(required): string
Title:
Bill Href
The bill's href. -
id(required): 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
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
401 Response
Unauthorized
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
403 Response
Forbidden
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
405 Response
Method Not allowed
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
409 Response
Conflict
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
500 Response
Internal Server Error
Root Schema : Error
Type:
object
This is used when an API throws an error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
Show Source
-
@baseType: string
This defines the super-class when sub-classing.
-
@schemaLocation: string
(uri)
A URI to a JSON-schema file that defines additional attributes and relationships.
-
@type: string
This defines the sub-class entity name when sub-classing.
-
code(required): string
Refers to application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
Displays the HTTP error code extension.
Examples
The following example shows how to create a customer bill on demand 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/customerBillManagement/version/customerBillOnDemand' -d @billCreate.json
Example of Request Body
The following is an example of the contents of the billCreate.json file sent as the request body.
{ "billingAccount":{ "id":"0.0.0.1+-account+341286" } }
Example of Response Body
The following is an example of the response body in JSON format.
{ "id": "0.0.0.1+-bill+494205", "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+494205", "description": null, "lastUpdate": "2020-04-29T:18:34:02", "name": null, "billingAccount": { "id": "0.0.0.1+-account+341286", "href": null, "name": "Grace Wang", "@baseType": null, "@schemaLocation": null, "@type": "BillingAccountRef", "@referredType": null }, "customerBill": { "id": "0.0.0.1+-bill+494205", "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+494205", "@baseType": null, "@schemaLocation": null, "@type": "BillRef", "@referredType": "CustomerBill" }, "relatedParty": null, "state": "DONE", "@baseType": "CustomerBillOnDemand", "@schemaLocation": null, "@type": "CustomerBillOnDemand" }