REST Services Manager API for Billing and Revenue Management

Get Applied Customer Billing Rates

get

/appliedCustomerBillingRate

Gets the applied customer billing rates that match the query criteria.

Request

Query Parameters

@type: string
The type of object to return.
Example:
```
AppliedCustomerBillingRate
```
bill.id: string
Retrieves applied customer billing rates for the specified billId.
Example:
```
0.0.0.1+-bill+1
```
fields: string
The list of comma-separated fields to return in the response.
Example:
```
bill,billingAccount
```
id: string
The ID of the applied customer billing rate to get.
Example:
```
0.0.0.1+-item-usage+1
```
isBilled: string
Retrieves applied customer billing rates with the specified status. Use isBilled=true to retrieve open and closed applied customer billing rates or isBilled=false to retrieve pending applied customer billing rates.
Example:
```
true
```
limit: integer
The maximum number of results to return. For example, use limit=10 to return the first 10 results only.
Example:
```
10
```
offset: integer
The maximum number of results to return. For example, use offset=10 to return results 10 and higher.
Example:
```
10
```

There's no request body for this operation.

Response

Supported Media Types

application/json;charset=utf-8

200 Response

Success

Headers

X-Result-Count(required):

The number of items returned in the response body.
X-Total-Count(required):

The total number of items that matched the criteria.

Root Schema : schema

Type: array

The applied customer billing rates that matched the search criteria.

Show Source

Array of: object Applied Customer Billing Rate

Title: Applied Customer Billing Rate

An applied customer billing rate.

{
    "type":"array",
    "description":"The applied customer billing rates that matched the search criteria.",
    "items":{
        "$ref":"#/components/schemas/AppliedCustomerBillingRate"
    }
}

Nested 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 array appliedTax

The taxes applied to the applied customer billing rate.
bill: object object Bill Ref

Title: Bill Ref

A reference to a bill.
billingAccount: object object Billing Account Ref

Title: Billing Account Ref

A billing account reference.
characteristic: array 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 object Time Period

Title: Time Period

A period of time. You can specify only endDateTime or both endDateTime and startDateTime.
product: object object Product Ref

Title: Product Ref

A reference to a product.
taxExcludedAmount: object object Money

Title: Money

An amount of money.
taxIncludedAmount: object object Money

Title: Money

An amount of 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.)

{
    "type":"object",
    "title":"Applied Customer Billing Rate",
    "description":"An applied customer billing rate.",
    "required":[
        "id",
        "href"
    ],
    "properties":{
        "id":{
            "type":"string",
            "title":"Applied Customer Billing Rate ID",
            "description":"The applied customer billing rate's ID."
        },
        "href":{
            "type":"string",
            "title":"Applied Customer Billing Rate Href",
            "description":"The applied customer billing rate's href."
        },
        "date":{
            "type":"string",
            "title":"Applied Customer Billing Rate Created Date",
            "format":"date-time",
            "description":"The date the applied customer billing rate was created."
        },
        "description":{
            "type":"string",
            "title":"Description",
            "description":"The applied customer billing rate's description."
        },
        "isBilled":{
            "type":"boolean",
            "title":"Billed",
            "description":"Whether the applied customer billing rate has been billed (<b>true</b>) or not (<b>false</b>). If true, also provide a value for the <b>bill</b> property. If false, also provide a value for the <b>billingAccount</b> property."
        },
        "name":{
            "type":"string",
            "title":"Applied Customer Billing Rate Name",
            "description":"The applied customer billing rate's name."
        },
        "type":{
            "type":"string",
            "title":"Applied Billing Rate Type",
            "description":"The applied customer billing rate's type. For example, <b>appliedBillingCharge</b> (for recurring, one time, and usage charges), <b>appliedBillingCredit</b> (for rebates or product alteration credits), or <b>appliedPenaltyCharge</b> (for penalty charges like late fees or payment rejection fees.)"
        },
        "appliedTax":{
            "type":"array",
            "description":"The taxes applied to the applied customer billing rate.",
            "items":{
                "$ref":"#/components/schemas/AppliedBillingTaxRate"
            }
        },
        "bill":{
            "description":"The bill associated with the applied customer billing rate. Specify this if <b>isBilled</b> is set to <b>true</b>.",
            "$ref":"#/components/schemas/BillRef"
        },
        "billingAccount":{
            "description":"The billing account associated with the applied customer billing rate. Specify this if <b>isBilled</b> is set to <b>false</b>.",
            "$ref":"#/components/schemas/BillingAccountRef"
        },
        "characteristic":{
            "type":"array",
            "description":"The characteristics that define the applied customer billing rate.",
            "items":{
                "$ref":"#/components/schemas/AppliedBillingRateCharacteristic"
            }
        },
        "periodCoverage":{
            "description":"The time period that the applied customer billing rate covers.",
            "$ref":"#/components/schemas/TimePeriod"
        },
        "product":{
            "description":"A product associated with the applied customer billing rate.",
            "$ref":"#/components/schemas/ProductRef"
        },
        "taxExcludedAmount":{
            "description":"The amount of the applied customer billing rate, excluding taxes.",
            "$ref":"#/components/schemas/Money"
        },
        "taxIncludedAmount":{
            "description":"The amount of the applied customer billing rate, including taxes.",
            "$ref":"#/components/schemas/Money"
        },
        "@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."
        }
    }
}

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.

{
    "type":"array",
    "description":"The taxes applied to the applied customer billing rate.",
    "items":{
        "$ref":"#/components/schemas/AppliedBillingTaxRate"
    }
}

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: string

Title: Bill Href

The bill's href.
id: 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."
        }
    }
}

Nested Schema : Billing Account Ref

Type: object

Title: Billing Account Ref

A billing account reference.

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: Billing Account Href

The billing account reference's href.
id(required): string

Title: Billing Account ID

The billing account reference's ID.
name: string

Title: Billing Account Name

The billing account reference's name.

{
    "type":"object",
    "title":"Billing Account Ref",
    "description":"A billing account reference.",
    "properties":{
        "id":{
            "type":"string",
            "title":"Billing Account ID",
            "description":"The billing account reference's ID."
        },
        "href":{
            "type":"string",
            "title":"Billing Account Href",
            "description":"The billing account reference's href."
        },
        "name":{
            "type":"string",
            "title":"Billing Account Name",
            "description":"The billing account reference's name."
        },
        "@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 object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        }
    },
    "required":[
        "id"
    ]
}

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.

{
    "type":"array",
    "description":"The characteristics that define the applied customer billing rate.",
    "items":{
        "$ref":"#/components/schemas/AppliedBillingRateCharacteristic"
    }
}

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

@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.
endDateTime: string (date-time)

Title: End DateTime

The end of the time period in IETC-RFC-3339 format.

Example: 1985-04-12T23:20:50.520Z
startDateTime: string (date-time)

Title: Start DateTime

The start of the time period in IETC-RFC-3339 format. If you specify this, you must also specify endDateTime.

Example: 1985-04-12T23:20:50.520Z

{
    "type":"object",
    "title":"Time Period",
    "properties":{
        "endDateTime":{
            "type":"string",
            "title":"End DateTime",
            "description":"The end of the time period in IETC-RFC-3339 format.",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.520Z"
        },
        "startDateTime":{
            "type":"string",
            "title":"Start DateTime",
            "description":"The start of the time period in IETC-RFC-3339 format. If you specify this, you must also specify <b>endDateTime</b>.",
            "format":"date-time",
            "example":"1985-04-12T23:20:50.520Z"
        },
        "@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":"A period of time. You can specify only <b>endDateTime</b> or both <b>endDateTime</b> and <b>startDateTime</b>."
}

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.

{
    "required":[
        "id"
    ],
    "type":"object",
    "title":"Product Ref",
    "description":"A reference to a product.",
    "properties":{
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@referredType":{
            "type":"string",
            "title":"Referred Type",
            "description":"The object's type in the target system, if <b>baseType</b> and <b>type</b> need further disambiguation."
        },
        "@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."
        },
        "href":{
            "type":"string",
            "title":"Product Href",
            "description":"The product's href."
        },
        "id":{
            "type":"string",
            "title":"Product ID",
            "description":"The product's ID."
        },
        "name":{
            "type":"string",
            "title":"Product Name",
            "description":"The product's name."
        }
    }
}

Nested Schema : Money

Type: object

Title: Money

An amount of money.

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.
unit: string

Title: Currency

An ISO 4217 three letter currency code.
value: number (float)

Title: Amount

A positive floating point number.

{
    "type":"object",
    "title":"Money",
    "properties":{
        "unit":{
            "type":"string",
            "title":"Currency",
            "description":"An ISO 4217 three letter currency code."
        },
        "value":{
            "type":"number",
            "title":"Amount",
            "description":"A positive floating point number.",
            "format":"float"
        },
        "@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":"An amount of money."
}

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 object Money

Title: Money

An amount of money.
taxCategory: string

Title: Tax Category

The applied billing tax's category.
taxRate: number (float)

Title: Tax Rate

The applied billing tax rate.

{
    "type":"object",
    "title":"Applied Billing Tax Rate",
    "description":"The tax rate applied to a billing rate.",
    "properties":{
        "taxCategory":{
            "type":"string",
            "title":"Tax Category",
            "description":"The applied billing tax's category."
        },
        "taxRate":{
            "type":"number",
            "title":"Tax Rate",
            "format":"float",
            "description":"The applied billing tax rate."
        },
        "taxAmount":{
            "description":"The applied billing tax amount.",
            "$ref":"#/components/schemas/Money"
        },
        "@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."
        }
    }
}

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):
valueType: string

Title: Characteristic Type

The data type of the characteristic's value.

{
    "type":"object",
    "title":"Applied Billing Rate Characteristic",
    "description":"A characteristic of an applied billing rate, based on the service type, line of business, or other parameters.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "title":"Characteristic Name",
            "description":"The characteristic's name."
        },
        "valueType":{
            "type":"string",
            "title":"Characteristic Type",
            "description":"The data type of the characteristic's value."
        },
        "value":{
            "description":"The characteristic's value.",
            "$ref":"#/components/schemas/Any"
        },
        "@baseType":{
            "type":"string",
            "title":"Base Type",
            "description":"The object's superclass."
        },
        "@schemaLocation":{
            "type":"string",
            "title":"Scheme 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."
        }
    }
}

400 Response

Bad Request

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 error code.
message: string

Title: Error Message

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":{
        "@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."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "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

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 error code.
message: string

Title: Error Message

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":{
        "@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."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "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

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 error code.
message: string

Title: Error Message

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":{
        "@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."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "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

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 error code.
message: string

Title: Error Message

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":{
        "@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."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "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

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 error code.
message: string

Title: Error Message

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":{
        "@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."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "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

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 error code.
message: string

Title: Error Message

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":{
        "@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."
        },
        "code":{
            "type":"string",
            "title":"Error Code",
            "description":"An error code."
        },
        "message":{
            "type":"string",
            "title":"Error Message",
            "description":"Details and corrective actions related to the error."
        },
        "reason":{
            "type":"string",
            "title":"Reason",
            "description":"The reason for the error."
        },
        "referenceError":{
            "type":"string",
            "title":"Reference Error",
            "description":"A URI to documentation describing the error.",
            "format":"uri"
        },
        "status":{
            "type":"string",
            "title":"Error Status",
            "description":"The HTTP Error code extension."
        }
    },
    "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

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 error code.
message: string

Title: Error Message

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

Examples

The following example shows how to get applied customer billing rates by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

The request uses the offset and limit query parameters to restrict the results.

curl -X GET 'http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate?offset=5&limit=2'

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 K",
            "@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",
    },
    {
        "id": "0.0.0.1+-item-misc+107373",
        "href": "http://host:port/brm/customerBillManagement/version/appliedCustomerBillingRate/0.0.0.1+-item-misc+107373",
        "date": "2020-05-02T01:14:13-07:00",
        "description": null,
        "isBilled": false,
        "name": "Usage",
        "type": "/item/misc",
        "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": 0.0
        },
        "taxIncludedAmount": {
            "unit": "EUR",
            "value": 0.0
        },
        "@baseType": "AppliedCustomerBillingRate",
        "@schemaLocation": null,
        "@type": "AppliedCustomerBillingRate",
    }
]