Get an Applied Customer Billing Rate by ID
get
/appliedCustomerBillingRate/{id}
Gets the specified applied customer billing rate.
Request
Path Parameters
-
id(required): string
The ID of the applied customer billing rate to get.Example:
0.0.0.1+-item-usage+1
Query Parameters
-
@type: string
The type of object to return.Example:
Use @type=AppliedCustomerBillingRate for a base object or @type=AppliedCustomerBillingRateOracle for an extended object.
-
fields: string
The list of comma-separated fields to return in the response.Example:
fields=isBilled,name
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json;charset=utf-8
200 Response
Success
Root Schema : Applied Customer Billing Rate
Type:
object
Title:
Applied Customer Billing Rate
An applied customer billing rate.
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. -
appliedTax: array
appliedTax
The taxes applied to the applied customer billing rate.
-
bill: object
Bill Ref
Title:
Bill Ref
A reference to a bill. -
billingAccount: object
Billing Account Ref
Title:
Billing Account Ref
A billing account is a detailed description of a bill structure. -
characteristic: array
characteristic
The characteristics that define the applied customer billing rate.
-
date: string
(date-time)
Title:
Applied Customer Billing Rate Created Date
The date the applied customer billing rate was created. -
description: string
Title:
Description
The applied customer billing rate's description. -
href(required): string
Title:
Applied Customer Billing Rate Href
The applied customer billing rate's href. -
id(required): string
Title:
Applied Customer Billing Rate ID
The applied customer billing rate's ID. -
isBilled: boolean
Title:
Billed
Whether the applied customer billing rate has been billed (true) or not (false). If true, also provide a value for the bill property. If false, also provide a value for the billingAccount property. -
name: string
Title:
Applied Customer Billing Rate Name
The applied customer billing rate's name. -
periodCoverage: object
TimePeriod
A period of time.
-
product: object
Product Ref
Title:
Product Ref
A reference to a product. -
taxExcludedAmount: object
Money
A base / value business entity used to represent money.
-
taxIncludedAmount: object
Money
A base / value business entity used to represent money.
-
type: string
Title:
Applied Billing Rate Type
The applied customer billing rate's type. For example, appliedBillingCharge (for recurring, one time, and usage charges), appliedBillingCredit (for rebates or product alteration credits), or appliedPenaltyCharge (for penalty charges like late fees or payment rejection fees.)
Nested Schema : appliedTax
Type:
array
The taxes applied to the applied customer billing rate.
Show Source
-
Array of:
object Applied Billing Tax Rate
Title:
Applied Billing Tax Rate
The tax rate applied to a billing rate.
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 : 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 : characteristic
Type:
array
The characteristics that define the applied customer billing rate.
Show Source
-
Array of:
object Applied Billing Rate Characteristic
Title:
Applied Billing Rate Characteristic
A characteristic of an applied billing rate, based on the service type, line of business, or other parameters.
Nested Schema : TimePeriod
Type:
object
A period of time.
Show Source
-
endDateTime: string
(date-time)
Title:
End Time Period
The end of the time period in IETC-RFC-3339 format. -
startDateTime: string
(date-time)
Title:
Start Time Period
The start of the time period in IETC-RFC-3339 format.
Nested Schema : Product Ref
Type:
object
Title:
Product Ref
A reference to a product.
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:
Product Href
The product's href. -
id(required): string
Title:
Product ID
The product's ID. -
name: string
Title:
Product Name
The product's name.
Nested Schema : Money
Type:
object
A base / value business entity used to represent money.
Show Source
-
unit(required): string
Refers to the currency (ISO4217 norm uses 3 letters to define the currency).
-
value(required): number
(float)
A positive floating point number.
Nested Schema : Applied Billing Tax Rate
Type:
object
Title:
Applied Billing Tax Rate
The tax rate applied to a billing rate.
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. -
taxAmount: object
Money
A base / value business entity used to represent money.
-
taxCategory: string
Title:
Tax Category
The applied billing tax's category. -
taxRate: number
(float)
Title:
Tax Rate
The applied billing tax rate.
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
-
@baseType: string
Title:
Base Type
The object's superclass. -
@schemaLocation: string
(uri)
Title:
Scheme Location
A URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
Type
The object's subclass. -
name(required): string
Title:
Characteristic Name
The characteristic's name. -
value(required): object
Any
-
valueType: string
Title:
Characteristic Type
The data type of the characteristic's value.
Nested Schema : Any
Type:
object
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.
404 Response
Not Found
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 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" }