Query Parameter Extensions

You can extend the BRM REST Services Manager API to use additional query parameters.

This document shows the additional query parameters that are supported for each TMF Open API:

Note:

You can also use the extended response payload attributes in the fields query parameter. See "Response Payload Extensions" for more information about these attributes.

TMF 666: Account Management API

You can extend query parameters in the following Account Management API endpoints.

Get Billing Cycle Specifications endpoint

  • Extended query parameters:

    • Get billing cycle specifications for an account (billingAccount.id)

    • Get billing cycle specifications for an account number (accountNo)

  • Example URL syntax:

    Get billing cycle specifications with the billingAccount.id query parameter. 

    https://hostname:port/brm/accountManagement/version/billingCycleSpecification?@type=BillingCycleSpecificationOracle&billingAccount.id=0.0.0.1+-account+57943

TMF 678: Customer Bill Management API

You can extend query parameters in the following Customer Bill Management API endpoints.

Get Customer Bills endpoint

  • Extended query parameters:

    Get customer bills for a billing cycle specification (billingCycleSpecification.id)

  • Example URL syntax:

    To get bills with the billingCycleSpecification.id query parameter. 

    http://hostname:port/brm/customerBillManagement/version/customerBill?billingAccount.id=0.0.0.1+-account+354831&billingCycleSpecification.id=0.0.0.1+-billinfo+352527&@type=CustomerBillOracle

Get Applied Customer Billing Rates endpoint

  • Extended query parameters:

    Get applied customer billing rates for a service ID (serviceId)

  • Example URL syntax:

    Get applied customer billing rate with the serviceId query parameter. 

    http://hostname:port/brm/customerBillManagement/version/appliedCustomerBillingRate?serviceId=0.0.0.1+-service-telco-gsm+375335&@type=AppliedCustomerBillingRateOracle

TMF 676: Payment Management API

You can extend query parameters in the following Payment Management API endpoints.

Get Payments endpoint

  • Extended query parameters:

    • Get payments for a bill ID (bill.id)
    • Get payments for a billing cycle specification (billingCycleSpecification.id)

  • Example URL syntax:

    Get payments with the bill.id and billingCycleSpecification.id query parameters. 

    http://hostname:port/brm/payment/version/payment?bill.id=0.0.0.1+-bill+85169&billingCycleSpecification.id=0.0.0.1+-billinfo+76203&@type=PaymentOracle

Get Refunds endpoint

  • Extended query parameters:

    • Get refunds for a specified bill ID or bill number (bill.id)
    • Get refunds for a billing cycle specification (billingCycleSpecification.id)

  • Example URL syntax:

    Get refunds with the bill.id and billingCycleSpecification.id query parameters. 

    http://hostname:port/brm/payment/version/refund?bill.id=0.0.0.1+-bill+85169&billingCycleSpecification.id=0.0.0.1+-billinfo+76203&@type=RefundOracle

TMF 654: Prepay Balance Management API

You can extend query parameters in the following Prepay Balance Management API endpoints.

Get Adjusted Balances endpoint

  • Extended query parameters:

    • Get adjusted balances for a billing cycle specification (billingCycleSpecification.id)
    • Get adjusted balances for a bill item ID or bill item number (billItem.id)
    • Get adjusted balances for a bill ID or bill number (bill.id)

  • Example URL syntax:

    Get adjusted balances with the billingCycleSpecification.id query parameter: 

    http://hostname:port/brm/prepayBalanceManagement/version/adjustBalance?@type=AdjustBalanceOracle&billingCycleSpecification.id=0.0.0.1+-billinfo+496290

Get Accumulated Balances endpoint

  • Extended query parameters:

    Get accumulated balances for a billing cycle specification ID (billingCycleSpecification.id)

  • Example URL syntax:

    Get accumulated balances with the billingCycleSpecification.id query parameter. 

    http://hostname:port/brm/prepayBalanceManagement/version/accumulatedBalance?@type=AccumulatedBalanceOracle&billingCycleSpecification.id=0.0.0.1+billinfo+69271

Get Bucket Balances endpoint

  • Extended query parameters:

    • Get non-currency balances for a bucket (nonCurrencyFlag)
    • Get bucket balances for a billing cycle specification ID (billingCycleSpecification.id)

  • Example URL syntax:

    Get bucket balances with the nonCurrencyFlag and billingCycleSpecificationRef.id query parameters. 

    https://hostname:port/brm/prepayBalanceManagement/version/bucket?@type=BucketOracle&nonCurrencyFlag=true&billingCycleSpecification.id=0.0.0.1+-billinfo+370767

TMF 635: Usage Management API

You can extend query parameters in the following Usage Management API endpoints.

Get Usage endpoint

  • Extended query parameters:

    • Get usage for an applied customer billing rate ID or number (appliedCustomerBillingRate.id)
    • Get usage for an event name (description)
    • Get usage for an external event ID or network session ID (id)
    • Get usage for a start date (usageDate) and end date (endTime) range

  • Example URL syntax:

    Get usage with the appliedCustomerBillingRate.id query parameter. 

    https://hostname:port/brm/usageManagement/version/usage?appliedCustomerBillingRate.id=0.0.0.1+-item-misc+84251&@type=UsageOracle