Get Applied Customer Billing Rates

get

/brm/customerBillManagement/v4/appliedCustomerBillingRate

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

Request

Query Parameters
  • The type of object to return.
    Examples

  • Retrieves applied customer billing rates for the specified billId or billNumber.
    Examples

  • Retrieves applied customer billing rates for the specified account ID or account number.
    Examples

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

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

  • Retrieves applied customer billing rates with the specified status.
    Examples

  • The maximum number of results to return.
    Examples

  • The number of results to offset the response by.
    Examples

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Headers
Body ()
Root Schema : schema
Type: array
The applied customer billing rates that matched the search criteria.
Show Source
Nested 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