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

Get an Applied Customer Billing Rate by ID

get

/appliedCustomerBillingRate/{id}

Gets the specified applied customer billing rate.

Request

Path Parameters
  • The ID of the applied customer billing rate to get.
    Examples

Query Parameters
  • The type of object to return.
    Examples

  • The list of comma-separated fields to return in the response.
    Examples

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : Applied Customer Billing Rate
Type: object
Title: Applied Customer Billing Rate
An applied customer billing rate.
Show Source
Nested Schema : appliedTax
Type: array
The taxes applied to the applied customer billing rate.
Show Source
Nested Schema : Bill Ref
Type: object
Title: Bill Ref
A reference to a bill.
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 : characteristic
Type: array
The characteristics that define the applied customer billing rate.
Show Source
Nested Schema : Time Period
Type: object
Title: Time Period
A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
Show Source
Nested Schema : Product Ref
Type: object
Title: Product Ref
A reference to a product.
Show Source
Nested Schema : Money
Type: object
Title: Money
An amount of money.
Show Source
Nested Schema : Applied Billing Tax Rate
Type: object
Title: Applied Billing Tax Rate
The tax rate applied to a billing rate.
Show Source
Nested Schema : Applied Billing Rate Characteristic
Type: object
Title: Applied Billing Rate Characteristic
A characteristic of an applied billing rate, based on the service type, line of business, or other parameters.
Show Source
Nested Schema : Any
Type: 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

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

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

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 get the applied customer billing rate 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/appliedCustomerBillingRate/0.0.0.1+-item-cycle_forward+108525'

Example of the Response Body

The following example shows the contents of the response body in JSON format.

{
    "id": "0.0.0.1+-item-cycle_forward+108525",
    "href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-cycle_forward+108525",
    "date": "2020-05-02T01:14:14-07:00",
    "description": null,
    "isBilled": false,
    "name": "Cycle forward",
    "type": "/item/cycle_forward",
    "appliedTax": null,
    "bill": {
        "id": "0.0.0.1+-bill+106861",
        "href": "http://host:port/brm/customerBillManagement/version/customerBill/0.0.0.1+-bill+106861",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": "BillRef",
        "@referredType": "CustomerBill"
    },
    "billingAccount": {
        "id": "0.0.0.1+-account+107117",
        "href": null,
        "name": "Tanya Levy",
        "@baseType": null,
        "@schemaLocation": null,
        "@type": "BillingAccountRef",
        "@referredType": "billingAccount"
    },
    "characteristic": null,
    "periodCoverage": null,
    "product": null,
    "taxExcludedAmount": {
        "unit": "EUR",
        "value": 45.0
    },
    "taxIncludedAmount": {
        "unit": "EUR",
        "value": 45.0
    },
    "@baseType": "AppliedCustomerBillingRate",
    "@schemaLocation": null,
    "@type": "AppliedCustomerBillingRate"
}
Back to Top