1. REST Services Manager API for Billing and Revenue Management
  2. Tasks
  3. Customer Bill Management
  4. Customer Bill On Demand

Create a Customer Bill On Demand

post

/customerBillOnDemand

Creates a bill.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - 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
Nested Schema : Billing Account Ref
Type: object
Title: Billing Account Ref
A billing account is a detailed description of a bill structure.
Show Source
Nested Schema : Bill Ref
Type: object
Title: Bill Ref
A reference to a bill.
Show Source
Nested Schema : Related Party Ref
Type: object
Title: Related Party Ref
A reference to the party related to an object.
Show Source
Back to Top

Response

Supported Media Types

201 Response

Created
Body ()
Root Schema : Customer Bill OnDemand
Type: object
Title: Customer Bill OnDemand
A customer bill created on demand.
Show Source
Nested Schema : Billing Account Ref
Type: object
Title: Billing Account Ref
A billing account is a detailed description of a bill structure.
Show Source
Nested Schema : Bill Ref
Type: object
Title: Bill Ref
A reference to a bill.
Show Source
Nested Schema : Related Party Ref
Type: object
Title: Related Party Ref
A reference to the party related to an object.
Show Source

400 Response

Bad Request
Body ()
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

401 Response

Unauthorized
Body ()
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

403 Response

Forbidden
Body ()
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

405 Response

Method Not allowed
Body ()
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

409 Response

Conflict
Body ()
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

500 Response

Internal Server Error
Body ()
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
Back to Top

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": "2025-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"
}
Back to Top