Jump to

• Request
• Response
• Examples

Get an On-Demand Customer Bill by ID

get

/customerBillOnDemand/{id}

Gets the specified on-demand customer bill.

Request

Path Parameters

• id(required): string
  The ID of the on-demand customer bill to get.

  Examples

  Select an example 0.0.0.1+-bill+106861

Query Parameters

• @type: string
  The type of object to return.

  Examples

  Select an example Use @type=CustomerBillOnDemand for a base object or @type=CustomerBillOnDemandOracle for an extended object.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8

200 Response

Success

Body ()

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
  Title: Related Party Ref

  A reference to the party related to an object.
• state(required): string
  Title: State Values

  Allowed Values: [ "inProgress", "rejected", "done", "terminatedWithError" ]

  Possible values for an on-demand bill's state.

{
    "title":"Customer Bill OnDemand",
    "required":[
        "billingAccount",
        "href",
        "id",
        "state"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Bill ID",
            "type":"string",
            "description":"The on-demand bill's ID."
        },
        "href":{
            "title":"Bill Href",
            "type":"string",
            "description":"The on-demand bill's href."
        },
        "description":{
            "title":"Bill Description",
            "type":"string",
            "description":"The on-demand bill's description."
        },
        "lastUpdate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date that the on-demand bill was last updated."
        },
        "name":{
            "title":"Bill Name",
            "type":"string",
            "description":"The on-demand bill's name."
        },
        "billingAccount":{
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "customerBill":{
            "$ref":"#/components/schemas/BillRef"
        },
        "relatedParty":{
            "$ref":"#/components/schemas/RelatedPartyRef"
        },
        "state":{
            "$ref":"#/components/schemas/StateValues"
        },
        "@baseType":{
            "title":"Base Type",
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "title":"Schema Location",
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "title":"Type",
            "type":"string",
            "description":"The object's subclass."
        }
    },
    "description":"A customer bill created on demand."
}

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.

{
    "type":"object",
    "title":"Billing Account Ref",
    "description":"A billing account is a detailed description of a bill structure.",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique ID for the billing account."
        },
        "accountNumber":{
            "type":"string",
            "description":"The account number."
        },
        "href":{
            "type":"string",
            "description":"A reference for the billing account."
        },
        "name":{
            "type":"string",
            "description":"The name of the billing account."
        },
        "@baseType":{
            "type":"string",
            "description":"The super-class when sub-classing."
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-schema file that defines additional attributes and relationships."
        },
        "@type":{
            "type":"string",
            "description":"The sub-class entity name when sub-classing."
        },
        "@referredType":{
            "type":"string",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    }
}

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.

{
    "type":"object",
    "title":"Bill Ref",
    "description":"A reference to a bill.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Bill ID",
            "description":"The bill's ID."
        },
        "href":{
            "type":"string",
            "title":"Bill Href",
            "description":"The bill's href."
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Schema Location",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "title":"Type",
            "description":"The object's subclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The actual type of the target instance when needed for disambiguation."
        }
    },
    "required":[
        "id",
        "href"
    ]
}

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.

{
    "title":"Related Party Ref",
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "title":"Related Party ID",
            "type":"string",
            "description":"The related party's ID."
        },
        "href":{
            "title":"Related Party Href",
            "type":"string",
            "description":"The related party's href."
        },
        "name":{
            "title":"Related Party Name",
            "type":"string",
            "description":"The related party's name."
        },
        "role":{
            "title":"Related Party Role",
            "type":"string",
            "description":"The related party's role."
        },
        "@baseType":{
            "title":"Base Type",
            "type":"string",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "title":"Schema Location",
            "type":"string",
            "description":"A URI to a JSON schema file that defines additional attributes and relationships.",
            "format":"uri"
        },
        "@type":{
            "title":"Type",
            "type":"string",
            "description":"The object's subclass."
        },
        "@referredType":{
            "title":"Referred Type",
            "type":"string",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "description":"A reference to the party related to an object."
}

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

• @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 application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More 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":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@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."
        }
    },
    "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

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

• @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 application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More 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":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@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."
        }
    },
    "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

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

• @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 application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More 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":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@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."
        }
    },
    "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

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

• @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 application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More 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":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@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."
        }
    },
    "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

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

• @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 application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More 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":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@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."
        }
    },
    "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

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

• @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 application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

  More 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":{
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An application's error code, defined in the API or a common list."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"More details and corrective actions related to the error."
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension"
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "@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."
        }
    },
    "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

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

• @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 application's error code, defined in the API or a common list.
• message: string
  Title: Error Message

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

Back to Top

Examples

The following example shows how to get the on-demand bill with the specified ID by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET 'http://host:port/brm/customerBillManagement/version/customerBillOnDemand/0.0.0.1+-bill+427232'

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"
   }
}

Back to Top