Upsert Rating Method

API Reference (1.0)

Billing Platform API

Download OpenAPI description

cwid_206_manual.json

cwid_206_manual.yaml

Overview

URL http://support.billingplatform.com

API Support support@billingplatform.com

License Apache 2.0

Servers

Mock server

https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/

https://my.billingplatform.com/demogm/

CONTRACT

CONTRACT API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY

COUNTRY API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

DESTINATION_COUNTRY_CODE

Operations

LABEL_VERSION

LABEL_VERSION API Reference

Operations

LANGUAGE

LANGUAGE API Reference

Operations

ORIGINATION_COUNTRY_CODE

Operations

PACKAGE

PACKAGE API Reference

Operations

PACKAGE_CURRENCY

PACKAGE_CURRENCY API Reference

Operations

PACKAGE_PRODUCT

PACKAGE_PRODUCT API Reference

Operations

PARENT_PACKAGE_PRODUCT

Operations

PRICING

PRICING API Reference

Operations

PRODUCT

Configure the Products in your product catalog

Operations

RATE_CLASS

RATE_CLASS API Reference

Operations

RATE_CLASS_PRODUCT

RATE_CLASS_PRODUCT API Reference

Operations

RATING_METHOD

RATING_METHOD API Reference

Operations

Retrieve By Id Rating Method

Request

Get Rating Method By Id

Path

idintegerrequired

Id of the record

Headers

sessionIdstringrequired

curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/RATING_METHOD/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "TaxApplicableTo": "string",
    "AutoRefill": 0,
    "FormulaValue": "string",
    "SubscriptionCycle": "string",
    "TaxApplication": "string",
    "ChargeType": "string",
    "CMTTaxFlag": 0,
    "EligibleActivityFilterLogic": "string",
    "DesignateDiscountEligableChargesBy": "string",
    "TrialUsePer": "string",
    "TrialTarget": "string",
    "ZeroRatedDisplayFlag": "string",
    "TaxProductFilterLogic": "string",
    "ProrateSubscription": "string",
    "DiscountEligUnitMeas": "string",
    "FormulaParamIdent": "string",
    "TrialDuration": "string",
    "ProrateBand": 0,
    "FormulaFlag": 0,
    "UseHistoricalInvoiceForPrepayment": 0,
    "CMTInclusionLogic": "string",
    "CMTRateMethod": "string",
    "UseFlatRate": "string",
    "ChargeInAdvanceUnit": "string",
    "MinMaxZeroQuantityTrueUp": 0,
    "TaxRateDate": "string",
    "DiscountUsePer": "string",
    "SubscriptionModel": "string",
    "ActivationChargePlace": "string",
    "DiscountItemize": 0,
    "ProrateCreditAfterPeriod": "string",
    "CMTTermDuration": "string",
    "DiscountEligableFilterLogic": "string",
    "TrialMaxNumberUses": "string",
    "ApplyChargeOnComponent": 0,
    "TrialRateType": "string",
    "FlatRate": 0,
    "DiscountLimitedUsage": 0,
    "DiscountMaxNumberOfUses": "string",
    "CMTScope": "string",
    "AccumResetPeriod": "string",
    "RecalculateOnRateChange": 0,
    "GenerateFlatFee": 0,
    "DiscountTargetFilterLogic": "string",
    "TrueUpCreditType": "string",
    "ChargeInSubsequentPer": "string",
    "ObligatoryIntlRate": 0,
    "FormulaQuantity": "string",
    "PricingType": "string",
    "SplitUsage": 0,
    "DependentType": "string",
    "ForceGenerateActivity": 0,
    "DesignateDiscountTargetChargesBy": "string",
    "CalculateEffectiveRate": 0,
    "NonBillableFlag": 0,
    "ChargeInSubsequentUnit": "string",
    "LateFeeType": "string",
    "SubAggrLevel": "string",
    "DiscountType": "string",
    "DiscountApplMethod": "string",
    "DiscountPricingType": "string",
    "TrueUpMethod": "string",
    "ChargeInAdvancePeriod": "string",
    "MinMaxGenerateOnNegative": 0,
    "DiscountApplyTo": "string",
    "AggregationLevel": "string",
    "IntervalSubscriptionDays": "string",
    "CycleType": "string",
    "TaxType": "string",
    "formulaOnInvoiceClose": 0,
    "FormulaFilterLogic": "string",
    "SplitBySubAccount": 0,
    "CMTInputMethod": "string",
    "CMTQuantity": "string",
    "TrueUpProduct": 0,
    "RatingMethodType": "string",
    "AggregateRateType": "string",
    "PropagateInvLevelCharge": 0,
    "LateFeeAgainstBalance": "string",
    "DiscountPriority": "string",
    "EarlyTerminationOption": "string",
    "ZeroRateBanded": 0,
    "AccumFlag": "string",
    "AccumStartDate": "string",
    "AutoCalculateCredit": 0,
    "SSPProfileId": 0,
    "IncludedUsageAmountsId": "string",
    "QuoteProductDraftId": 0,
    "QuoteProductId": 0,
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "Id": "string",
    "IncrementAmount": "string",
    "ExcludeComponents": "string",
    "NumberOfCharges": "string",
    "DiscountEligCond": "string",
    "DefaultRateFlag": 0,
    "OverrideTypePackage": 0,
    "commitmentApplicableProduct": "string",
    "ForbidChargeInPreviousPeriod": 0,
    "ItemizeTrialDiscounts": "string",
    "ProductId": 0,
    "AccountProductId": 0,
    "OnEndDate": "string",
    "RenewalOrChangeTerm": "string",
    "ChangeToProductByDefault": 0,
    "Created": "string",
    "AllowInternationalPricing": 0,
    "ExternalKey": "string"
  }
}

Retrieve Filtered Rating Method

Request

Get record(s) using filters

Query

queryAnsiSqlstringrequired

SQL Where part

Headers

sessionIdstringrequired

curl -i -X GET \
  'https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/RATING_METHOD?queryAnsiSql=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'sessionId: string'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "TaxApplicableTo": "string",
    "AutoRefill": 0,
    "FormulaValue": "string",
    "SubscriptionCycle": "string",
    "TaxApplication": "string",
    "ChargeType": "string",
    "CMTTaxFlag": 0,
    "EligibleActivityFilterLogic": "string",
    "DesignateDiscountEligableChargesBy": "string",
    "TrialUsePer": "string",
    "TrialTarget": "string",
    "ZeroRatedDisplayFlag": "string",
    "TaxProductFilterLogic": "string",
    "ProrateSubscription": "string",
    "DiscountEligUnitMeas": "string",
    "FormulaParamIdent": "string",
    "TrialDuration": "string",
    "ProrateBand": 0,
    "FormulaFlag": 0,
    "UseHistoricalInvoiceForPrepayment": 0,
    "CMTInclusionLogic": "string",
    "CMTRateMethod": "string",
    "UseFlatRate": "string",
    "ChargeInAdvanceUnit": "string",
    "MinMaxZeroQuantityTrueUp": 0,
    "TaxRateDate": "string",
    "DiscountUsePer": "string",
    "SubscriptionModel": "string",
    "ActivationChargePlace": "string",
    "DiscountItemize": 0,
    "ProrateCreditAfterPeriod": "string",
    "CMTTermDuration": "string",
    "DiscountEligableFilterLogic": "string",
    "TrialMaxNumberUses": "string",
    "ApplyChargeOnComponent": 0,
    "TrialRateType": "string",
    "FlatRate": 0,
    "DiscountLimitedUsage": 0,
    "DiscountMaxNumberOfUses": "string",
    "CMTScope": "string",
    "AccumResetPeriod": "string",
    "RecalculateOnRateChange": 0,
    "GenerateFlatFee": 0,
    "DiscountTargetFilterLogic": "string",
    "TrueUpCreditType": "string",
    "ChargeInSubsequentPer": "string",
    "ObligatoryIntlRate": 0,
    "FormulaQuantity": "string",
    "PricingType": "string",
    "SplitUsage": 0,
    "DependentType": "string",
    "ForceGenerateActivity": 0,
    "DesignateDiscountTargetChargesBy": "string",
    "CalculateEffectiveRate": 0,
    "NonBillableFlag": 0,
    "ChargeInSubsequentUnit": "string",
    "LateFeeType": "string",
    "SubAggrLevel": "string",
    "DiscountType": "string",
    "DiscountApplMethod": "string",
    "DiscountPricingType": "string",
    "TrueUpMethod": "string",
    "ChargeInAdvancePeriod": "string",
    "MinMaxGenerateOnNegative": 0,
    "DiscountApplyTo": "string",
    "AggregationLevel": "string",
    "IntervalSubscriptionDays": "string",
    "CycleType": "string",
    "TaxType": "string",
    "formulaOnInvoiceClose": 0,
    "FormulaFilterLogic": "string",
    "SplitBySubAccount": 0,
    "CMTInputMethod": "string",
    "CMTQuantity": "string",
    "TrueUpProduct": 0,
    "RatingMethodType": "string",
    "AggregateRateType": "string",
    "PropagateInvLevelCharge": 0,
    "LateFeeAgainstBalance": "string",
    "DiscountPriority": "string",
    "EarlyTerminationOption": "string",
    "ZeroRateBanded": 0,
    "AccumFlag": "string",
    "AccumStartDate": "string",
    "AutoCalculateCredit": 0,
    "SSPProfileId": 0,
    "IncludedUsageAmountsId": "string",
    "QuoteProductDraftId": 0,
    "QuoteProductId": 0,
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "Id": "string",
    "IncrementAmount": "string",
    "ExcludeComponents": "string",
    "NumberOfCharges": "string",
    "DiscountEligCond": "string",
    "DefaultRateFlag": 0,
    "OverrideTypePackage": 0,
    "commitmentApplicableProduct": "string",
    "ForbidChargeInPreviousPeriod": 0,
    "ItemizeTrialDiscounts": "string",
    "ProductId": 0,
    "AccountProductId": 0,
    "OnEndDate": "string",
    "RenewalOrChangeTerm": "string",
    "ChangeToProductByDefault": 0,
    "Created": "string",
    "AllowInternationalPricing": 0,
    "ExternalKey": "string"
  }
}

Save Rating Method

Request

Save Rating Method

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X POST \
  https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/RATING_METHOD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "TaxApplicableTo": "string",
      "AutoRefill": 0,
      "FormulaValue": "string",
      "SubscriptionCycle": "string",
      "TaxApplication": "string",
      "ChargeType": "string",
      "CMTTaxFlag": 0,
      "EligibleActivityFilterLogic": "string",
      "DesignateDiscountEligableChargesBy": "string",
      "TrialUsePer": "string",
      "TrialTarget": "string",
      "ZeroRatedDisplayFlag": "string",
      "TaxProductFilterLogic": "string",
      "ProrateSubscription": "string",
      "DiscountEligUnitMeas": "string",
      "FormulaParamIdent": "string",
      "TrialDuration": "string",
      "ProrateBand": 0,
      "FormulaFlag": 0,
      "UseHistoricalInvoiceForPrepayment": 0,
      "CMTInclusionLogic": "string",
      "CMTRateMethod": "string",
      "UseFlatRate": "string",
      "ChargeInAdvanceUnit": "string",
      "MinMaxZeroQuantityTrueUp": 0,
      "TaxRateDate": "string",
      "DiscountUsePer": "string",
      "SubscriptionModel": "string",
      "ActivationChargePlace": "string",
      "DiscountItemize": 0,
      "ProrateCreditAfterPeriod": "string",
      "CMTTermDuration": "string",
      "DiscountEligableFilterLogic": "string",
      "TrialMaxNumberUses": "string",
      "ApplyChargeOnComponent": 0,
      "TrialRateType": "string",
      "FlatRate": 0,
      "DiscountLimitedUsage": 0,
      "DiscountMaxNumberOfUses": "string",
      "CMTScope": "string",
      "AccumResetPeriod": "string",
      "RecalculateOnRateChange": 0,
      "GenerateFlatFee": 0,
      "DiscountTargetFilterLogic": "string",
      "TrueUpCreditType": "string",
      "ChargeInSubsequentPer": "string",
      "ObligatoryIntlRate": 0,
      "FormulaQuantity": "string",
      "PricingType": "string",
      "SplitUsage": 0,
      "DependentType": "string",
      "ForceGenerateActivity": 0,
      "DesignateDiscountTargetChargesBy": "string",
      "CalculateEffectiveRate": 0,
      "NonBillableFlag": 0,
      "ChargeInSubsequentUnit": "string",
      "LateFeeType": "string",
      "SubAggrLevel": "string",
      "DiscountType": "string",
      "DiscountApplMethod": "string",
      "DiscountPricingType": "string",
      "TrueUpMethod": "string",
      "ChargeInAdvancePeriod": "string",
      "MinMaxGenerateOnNegative": 0,
      "DiscountApplyTo": "string",
      "AggregationLevel": "string",
      "IntervalSubscriptionDays": "string",
      "CycleType": "string",
      "TaxType": "string",
      "formulaOnInvoiceClose": 0,
      "FormulaFilterLogic": "string",
      "SplitBySubAccount": 0,
      "CMTInputMethod": "string",
      "CMTQuantity": "string",
      "TrueUpProduct": 0,
      "RatingMethodType": "string",
      "AggregateRateType": "string",
      "PropagateInvLevelCharge": 0,
      "LateFeeAgainstBalance": "string",
      "DiscountPriority": "string",
      "EarlyTerminationOption": "string",
      "ZeroRateBanded": 0,
      "AccumFlag": "string",
      "AccumStartDate": "string",
      "AutoCalculateCredit": 0,
      "SSPProfileId": 0,
      "IncludedUsageAmountsId": "string",
      "QuoteProductDraftId": 0,
      "QuoteProductId": 0,
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "Id": "string",
      "IncrementAmount": "string",
      "ExcludeComponents": "string",
      "NumberOfCharges": "string",
      "DiscountEligCond": "string",
      "DefaultRateFlag": 0,
      "OverrideTypePackage": 0,
      "commitmentApplicableProduct": "string",
      "ForbidChargeInPreviousPeriod": 0,
      "ItemizeTrialDiscounts": "string",
      "ProductId": 0,
      "AccountProductId": 0,
      "OnEndDate": "string",
      "RenewalOrChangeTerm": "string",
      "ChangeToProductByDefault": 0,
      "Created": "string",
      "AllowInternationalPricing": 0,
      "ExternalKey": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "TaxApplicableTo": "string",
    "AutoRefill": 0,
    "FormulaValue": "string",
    "SubscriptionCycle": "string",
    "TaxApplication": "string",
    "ChargeType": "string",
    "CMTTaxFlag": 0,
    "EligibleActivityFilterLogic": "string",
    "DesignateDiscountEligableChargesBy": "string",
    "TrialUsePer": "string",
    "TrialTarget": "string",
    "ZeroRatedDisplayFlag": "string",
    "TaxProductFilterLogic": "string",
    "ProrateSubscription": "string",
    "DiscountEligUnitMeas": "string",
    "FormulaParamIdent": "string",
    "TrialDuration": "string",
    "ProrateBand": 0,
    "FormulaFlag": 0,
    "UseHistoricalInvoiceForPrepayment": 0,
    "CMTInclusionLogic": "string",
    "CMTRateMethod": "string",
    "UseFlatRate": "string",
    "ChargeInAdvanceUnit": "string",
    "MinMaxZeroQuantityTrueUp": 0,
    "TaxRateDate": "string",
    "DiscountUsePer": "string",
    "SubscriptionModel": "string",
    "ActivationChargePlace": "string",
    "DiscountItemize": 0,
    "ProrateCreditAfterPeriod": "string",
    "CMTTermDuration": "string",
    "DiscountEligableFilterLogic": "string",
    "TrialMaxNumberUses": "string",
    "ApplyChargeOnComponent": 0,
    "TrialRateType": "string",
    "FlatRate": 0,
    "DiscountLimitedUsage": 0,
    "DiscountMaxNumberOfUses": "string",
    "CMTScope": "string",
    "AccumResetPeriod": "string",
    "RecalculateOnRateChange": 0,
    "GenerateFlatFee": 0,
    "DiscountTargetFilterLogic": "string",
    "TrueUpCreditType": "string",
    "ChargeInSubsequentPer": "string",
    "ObligatoryIntlRate": 0,
    "FormulaQuantity": "string",
    "PricingType": "string",
    "SplitUsage": 0,
    "DependentType": "string",
    "ForceGenerateActivity": 0,
    "DesignateDiscountTargetChargesBy": "string",
    "CalculateEffectiveRate": 0,
    "NonBillableFlag": 0,
    "ChargeInSubsequentUnit": "string",
    "LateFeeType": "string",
    "SubAggrLevel": "string",
    "DiscountType": "string",
    "DiscountApplMethod": "string",
    "DiscountPricingType": "string",
    "TrueUpMethod": "string",
    "ChargeInAdvancePeriod": "string",
    "MinMaxGenerateOnNegative": 0,
    "DiscountApplyTo": "string",
    "AggregationLevel": "string",
    "IntervalSubscriptionDays": "string",
    "CycleType": "string",
    "TaxType": "string",
    "formulaOnInvoiceClose": 0,
    "FormulaFilterLogic": "string",
    "SplitBySubAccount": 0,
    "CMTInputMethod": "string",
    "CMTQuantity": "string",
    "TrueUpProduct": 0,
    "RatingMethodType": "string",
    "AggregateRateType": "string",
    "PropagateInvLevelCharge": 0,
    "LateFeeAgainstBalance": "string",
    "DiscountPriority": "string",
    "EarlyTerminationOption": "string",
    "ZeroRateBanded": 0,
    "AccumFlag": "string",
    "AccumStartDate": "string",
    "AutoCalculateCredit": 0,
    "SSPProfileId": 0,
    "IncludedUsageAmountsId": "string",
    "QuoteProductDraftId": 0,
    "QuoteProductId": 0,
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "Id": "string",
    "IncrementAmount": "string",
    "ExcludeComponents": "string",
    "NumberOfCharges": "string",
    "DiscountEligCond": "string",
    "DefaultRateFlag": 0,
    "OverrideTypePackage": 0,
    "commitmentApplicableProduct": "string",
    "ForbidChargeInPreviousPeriod": 0,
    "ItemizeTrialDiscounts": "string",
    "ProductId": 0,
    "AccountProductId": 0,
    "OnEndDate": "string",
    "RenewalOrChangeTerm": "string",
    "ChangeToProductByDefault": 0,
    "Created": "string",
    "AllowInternationalPricing": 0,
    "ExternalKey": "string"
  }
}

Update Rating Method

Request

Update Rating Method

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/RATING_METHOD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "TaxApplicableTo": "string",
      "AutoRefill": 0,
      "FormulaValue": "string",
      "SubscriptionCycle": "string",
      "TaxApplication": "string",
      "ChargeType": "string",
      "CMTTaxFlag": 0,
      "EligibleActivityFilterLogic": "string",
      "DesignateDiscountEligableChargesBy": "string",
      "TrialUsePer": "string",
      "TrialTarget": "string",
      "ZeroRatedDisplayFlag": "string",
      "TaxProductFilterLogic": "string",
      "ProrateSubscription": "string",
      "DiscountEligUnitMeas": "string",
      "FormulaParamIdent": "string",
      "TrialDuration": "string",
      "ProrateBand": 0,
      "FormulaFlag": 0,
      "UseHistoricalInvoiceForPrepayment": 0,
      "CMTInclusionLogic": "string",
      "CMTRateMethod": "string",
      "UseFlatRate": "string",
      "ChargeInAdvanceUnit": "string",
      "MinMaxZeroQuantityTrueUp": 0,
      "TaxRateDate": "string",
      "DiscountUsePer": "string",
      "SubscriptionModel": "string",
      "ActivationChargePlace": "string",
      "DiscountItemize": 0,
      "ProrateCreditAfterPeriod": "string",
      "CMTTermDuration": "string",
      "DiscountEligableFilterLogic": "string",
      "TrialMaxNumberUses": "string",
      "ApplyChargeOnComponent": 0,
      "TrialRateType": "string",
      "FlatRate": 0,
      "DiscountLimitedUsage": 0,
      "DiscountMaxNumberOfUses": "string",
      "CMTScope": "string",
      "AccumResetPeriod": "string",
      "RecalculateOnRateChange": 0,
      "GenerateFlatFee": 0,
      "DiscountTargetFilterLogic": "string",
      "TrueUpCreditType": "string",
      "ChargeInSubsequentPer": "string",
      "ObligatoryIntlRate": 0,
      "FormulaQuantity": "string",
      "PricingType": "string",
      "SplitUsage": 0,
      "DependentType": "string",
      "ForceGenerateActivity": 0,
      "DesignateDiscountTargetChargesBy": "string",
      "CalculateEffectiveRate": 0,
      "NonBillableFlag": 0,
      "ChargeInSubsequentUnit": "string",
      "LateFeeType": "string",
      "SubAggrLevel": "string",
      "DiscountType": "string",
      "DiscountApplMethod": "string",
      "DiscountPricingType": "string",
      "TrueUpMethod": "string",
      "ChargeInAdvancePeriod": "string",
      "MinMaxGenerateOnNegative": 0,
      "DiscountApplyTo": "string",
      "AggregationLevel": "string",
      "IntervalSubscriptionDays": "string",
      "CycleType": "string",
      "TaxType": "string",
      "formulaOnInvoiceClose": 0,
      "FormulaFilterLogic": "string",
      "SplitBySubAccount": 0,
      "CMTInputMethod": "string",
      "CMTQuantity": "string",
      "TrueUpProduct": 0,
      "RatingMethodType": "string",
      "AggregateRateType": "string",
      "PropagateInvLevelCharge": 0,
      "LateFeeAgainstBalance": "string",
      "DiscountPriority": "string",
      "EarlyTerminationOption": "string",
      "ZeroRateBanded": 0,
      "AccumFlag": "string",
      "AccumStartDate": "string",
      "AutoCalculateCredit": 0,
      "SSPProfileId": 0,
      "IncludedUsageAmountsId": "string",
      "QuoteProductDraftId": 0,
      "QuoteProductId": 0,
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "Id": "string",
      "IncrementAmount": "string",
      "ExcludeComponents": "string",
      "NumberOfCharges": "string",
      "DiscountEligCond": "string",
      "DefaultRateFlag": 0,
      "OverrideTypePackage": 0,
      "commitmentApplicableProduct": "string",
      "ForbidChargeInPreviousPeriod": 0,
      "ItemizeTrialDiscounts": "string",
      "ProductId": 0,
      "AccountProductId": 0,
      "OnEndDate": "string",
      "RenewalOrChangeTerm": "string",
      "ChangeToProductByDefault": 0,
      "Created": "string",
      "AllowInternationalPricing": 0,
      "ExternalKey": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "TaxApplicableTo": "string",
    "AutoRefill": 0,
    "FormulaValue": "string",
    "SubscriptionCycle": "string",
    "TaxApplication": "string",
    "ChargeType": "string",
    "CMTTaxFlag": 0,
    "EligibleActivityFilterLogic": "string",
    "DesignateDiscountEligableChargesBy": "string",
    "TrialUsePer": "string",
    "TrialTarget": "string",
    "ZeroRatedDisplayFlag": "string",
    "TaxProductFilterLogic": "string",
    "ProrateSubscription": "string",
    "DiscountEligUnitMeas": "string",
    "FormulaParamIdent": "string",
    "TrialDuration": "string",
    "ProrateBand": 0,
    "FormulaFlag": 0,
    "UseHistoricalInvoiceForPrepayment": 0,
    "CMTInclusionLogic": "string",
    "CMTRateMethod": "string",
    "UseFlatRate": "string",
    "ChargeInAdvanceUnit": "string",
    "MinMaxZeroQuantityTrueUp": 0,
    "TaxRateDate": "string",
    "DiscountUsePer": "string",
    "SubscriptionModel": "string",
    "ActivationChargePlace": "string",
    "DiscountItemize": 0,
    "ProrateCreditAfterPeriod": "string",
    "CMTTermDuration": "string",
    "DiscountEligableFilterLogic": "string",
    "TrialMaxNumberUses": "string",
    "ApplyChargeOnComponent": 0,
    "TrialRateType": "string",
    "FlatRate": 0,
    "DiscountLimitedUsage": 0,
    "DiscountMaxNumberOfUses": "string",
    "CMTScope": "string",
    "AccumResetPeriod": "string",
    "RecalculateOnRateChange": 0,
    "GenerateFlatFee": 0,
    "DiscountTargetFilterLogic": "string",
    "TrueUpCreditType": "string",
    "ChargeInSubsequentPer": "string",
    "ObligatoryIntlRate": 0,
    "FormulaQuantity": "string",
    "PricingType": "string",
    "SplitUsage": 0,
    "DependentType": "string",
    "ForceGenerateActivity": 0,
    "DesignateDiscountTargetChargesBy": "string",
    "CalculateEffectiveRate": 0,
    "NonBillableFlag": 0,
    "ChargeInSubsequentUnit": "string",
    "LateFeeType": "string",
    "SubAggrLevel": "string",
    "DiscountType": "string",
    "DiscountApplMethod": "string",
    "DiscountPricingType": "string",
    "TrueUpMethod": "string",
    "ChargeInAdvancePeriod": "string",
    "MinMaxGenerateOnNegative": 0,
    "DiscountApplyTo": "string",
    "AggregationLevel": "string",
    "IntervalSubscriptionDays": "string",
    "CycleType": "string",
    "TaxType": "string",
    "formulaOnInvoiceClose": 0,
    "FormulaFilterLogic": "string",
    "SplitBySubAccount": 0,
    "CMTInputMethod": "string",
    "CMTQuantity": "string",
    "TrueUpProduct": 0,
    "RatingMethodType": "string",
    "AggregateRateType": "string",
    "PropagateInvLevelCharge": 0,
    "LateFeeAgainstBalance": "string",
    "DiscountPriority": "string",
    "EarlyTerminationOption": "string",
    "ZeroRateBanded": 0,
    "AccumFlag": "string",
    "AccumStartDate": "string",
    "AutoCalculateCredit": 0,
    "SSPProfileId": 0,
    "IncludedUsageAmountsId": "string",
    "QuoteProductDraftId": 0,
    "QuoteProductId": 0,
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "Id": "string",
    "IncrementAmount": "string",
    "ExcludeComponents": "string",
    "NumberOfCharges": "string",
    "DiscountEligCond": "string",
    "DefaultRateFlag": 0,
    "OverrideTypePackage": 0,
    "commitmentApplicableProduct": "string",
    "ForbidChargeInPreviousPeriod": 0,
    "ItemizeTrialDiscounts": "string",
    "ProductId": 0,
    "AccountProductId": 0,
    "OnEndDate": "string",
    "RenewalOrChangeTerm": "string",
    "ChangeToProductByDefault": 0,
    "Created": "string",
    "AllowInternationalPricing": 0,
    "ExternalKey": "string"
  }
}

Upsert Rating Method

Request

Upsert Rating Method

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

externalIDFieldNamestring

Value"QuoteProductDraftId"

curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/RATING_METHOD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "TaxApplicableTo": "string",
      "AutoRefill": 0,
      "FormulaValue": "string",
      "SubscriptionCycle": "string",
      "TaxApplication": "string",
      "ChargeType": "string",
      "CMTTaxFlag": 0,
      "EligibleActivityFilterLogic": "string",
      "DesignateDiscountEligableChargesBy": "string",
      "TrialUsePer": "string",
      "TrialTarget": "string",
      "ZeroRatedDisplayFlag": "string",
      "TaxProductFilterLogic": "string",
      "ProrateSubscription": "string",
      "DiscountEligUnitMeas": "string",
      "FormulaParamIdent": "string",
      "TrialDuration": "string",
      "ProrateBand": 0,
      "FormulaFlag": 0,
      "UseHistoricalInvoiceForPrepayment": 0,
      "CMTInclusionLogic": "string",
      "CMTRateMethod": "string",
      "UseFlatRate": "string",
      "ChargeInAdvanceUnit": "string",
      "MinMaxZeroQuantityTrueUp": 0,
      "TaxRateDate": "string",
      "DiscountUsePer": "string",
      "SubscriptionModel": "string",
      "ActivationChargePlace": "string",
      "DiscountItemize": 0,
      "ProrateCreditAfterPeriod": "string",
      "CMTTermDuration": "string",
      "DiscountEligableFilterLogic": "string",
      "TrialMaxNumberUses": "string",
      "ApplyChargeOnComponent": 0,
      "TrialRateType": "string",
      "FlatRate": 0,
      "DiscountLimitedUsage": 0,
      "DiscountMaxNumberOfUses": "string",
      "CMTScope": "string",
      "AccumResetPeriod": "string",
      "RecalculateOnRateChange": 0,
      "GenerateFlatFee": 0,
      "DiscountTargetFilterLogic": "string",
      "TrueUpCreditType": "string",
      "ChargeInSubsequentPer": "string",
      "ObligatoryIntlRate": 0,
      "FormulaQuantity": "string",
      "PricingType": "string",
      "SplitUsage": 0,
      "DependentType": "string",
      "ForceGenerateActivity": 0,
      "DesignateDiscountTargetChargesBy": "string",
      "CalculateEffectiveRate": 0,
      "NonBillableFlag": 0,
      "ChargeInSubsequentUnit": "string",
      "LateFeeType": "string",
      "SubAggrLevel": "string",
      "DiscountType": "string",
      "DiscountApplMethod": "string",
      "DiscountPricingType": "string",
      "TrueUpMethod": "string",
      "ChargeInAdvancePeriod": "string",
      "MinMaxGenerateOnNegative": 0,
      "DiscountApplyTo": "string",
      "AggregationLevel": "string",
      "IntervalSubscriptionDays": "string",
      "CycleType": "string",
      "TaxType": "string",
      "formulaOnInvoiceClose": 0,
      "FormulaFilterLogic": "string",
      "SplitBySubAccount": 0,
      "CMTInputMethod": "string",
      "CMTQuantity": "string",
      "TrueUpProduct": 0,
      "RatingMethodType": "string",
      "AggregateRateType": "string",
      "PropagateInvLevelCharge": 0,
      "LateFeeAgainstBalance": "string",
      "DiscountPriority": "string",
      "EarlyTerminationOption": "string",
      "ZeroRateBanded": 0,
      "AccumFlag": "string",
      "AccumStartDate": "string",
      "AutoCalculateCredit": 0,
      "SSPProfileId": 0,
      "IncludedUsageAmountsId": "string",
      "QuoteProductDraftId": 0,
      "QuoteProductId": 0,
      "Updated": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "Id": "string",
      "IncrementAmount": "string",
      "ExcludeComponents": "string",
      "NumberOfCharges": "string",
      "DiscountEligCond": "string",
      "DefaultRateFlag": 0,
      "OverrideTypePackage": 0,
      "commitmentApplicableProduct": "string",
      "ForbidChargeInPreviousPeriod": 0,
      "ItemizeTrialDiscounts": "string",
      "ProductId": 0,
      "AccountProductId": 0,
      "OnEndDate": "string",
      "RenewalOrChangeTerm": "string",
      "ChangeToProductByDefault": 0,
      "Created": "string",
      "AllowInternationalPricing": 0,
      "ExternalKey": "string"
    },
    "externalIDFieldName": "QuoteProductDraftId"
  }'

Responses

Response with id of updated object

Bodyapplication/json

upsertResponseArray of objects

Response

application/json

{
  "upsertResponse": [
    { … }
  ]
}

Delete Rating Method

Request

Delete Rating Method

Headers

sessionIdstringrequired

Bodyapplication/json; charset=utf-8required

brmObjectsobject

curl -i -X DELETE \
  https://bp-api-docs-v3.redocly.app/_mock/cwid_206_manual/rest/2.0/delete/RATING_METHOD \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string"
    }
  }'

Responses

Successful response with requested data

Bodyapplication/json

retrieveResponseobject

Response

application/json

{
  "retrieveResponse": {
    "TaxApplicableTo": "string",
    "AutoRefill": 0,
    "FormulaValue": "string",
    "SubscriptionCycle": "string",
    "TaxApplication": "string",
    "ChargeType": "string",
    "CMTTaxFlag": 0,
    "EligibleActivityFilterLogic": "string",
    "DesignateDiscountEligableChargesBy": "string",
    "TrialUsePer": "string",
    "TrialTarget": "string",
    "ZeroRatedDisplayFlag": "string",
    "TaxProductFilterLogic": "string",
    "ProrateSubscription": "string",
    "DiscountEligUnitMeas": "string",
    "FormulaParamIdent": "string",
    "TrialDuration": "string",
    "ProrateBand": 0,
    "FormulaFlag": 0,
    "UseHistoricalInvoiceForPrepayment": 0,
    "CMTInclusionLogic": "string",
    "CMTRateMethod": "string",
    "UseFlatRate": "string",
    "ChargeInAdvanceUnit": "string",
    "MinMaxZeroQuantityTrueUp": 0,
    "TaxRateDate": "string",
    "DiscountUsePer": "string",
    "SubscriptionModel": "string",
    "ActivationChargePlace": "string",
    "DiscountItemize": 0,
    "ProrateCreditAfterPeriod": "string",
    "CMTTermDuration": "string",
    "DiscountEligableFilterLogic": "string",
    "TrialMaxNumberUses": "string",
    "ApplyChargeOnComponent": 0,
    "TrialRateType": "string",
    "FlatRate": 0,
    "DiscountLimitedUsage": 0,
    "DiscountMaxNumberOfUses": "string",
    "CMTScope": "string",
    "AccumResetPeriod": "string",
    "RecalculateOnRateChange": 0,
    "GenerateFlatFee": 0,
    "DiscountTargetFilterLogic": "string",
    "TrueUpCreditType": "string",
    "ChargeInSubsequentPer": "string",
    "ObligatoryIntlRate": 0,
    "FormulaQuantity": "string",
    "PricingType": "string",
    "SplitUsage": 0,
    "DependentType": "string",
    "ForceGenerateActivity": 0,
    "DesignateDiscountTargetChargesBy": "string",
    "CalculateEffectiveRate": 0,
    "NonBillableFlag": 0,
    "ChargeInSubsequentUnit": "string",
    "LateFeeType": "string",
    "SubAggrLevel": "string",
    "DiscountType": "string",
    "DiscountApplMethod": "string",
    "DiscountPricingType": "string",
    "TrueUpMethod": "string",
    "ChargeInAdvancePeriod": "string",
    "MinMaxGenerateOnNegative": 0,
    "DiscountApplyTo": "string",
    "AggregationLevel": "string",
    "IntervalSubscriptionDays": "string",
    "CycleType": "string",
    "TaxType": "string",
    "formulaOnInvoiceClose": 0,
    "FormulaFilterLogic": "string",
    "SplitBySubAccount": 0,
    "CMTInputMethod": "string",
    "CMTQuantity": "string",
    "TrueUpProduct": 0,
    "RatingMethodType": "string",
    "AggregateRateType": "string",
    "PropagateInvLevelCharge": 0,
    "LateFeeAgainstBalance": "string",
    "DiscountPriority": "string",
    "EarlyTerminationOption": "string",
    "ZeroRateBanded": 0,
    "AccumFlag": "string",
    "AccumStartDate": "string",
    "AutoCalculateCredit": 0,
    "SSPProfileId": 0,
    "IncludedUsageAmountsId": "string",
    "QuoteProductDraftId": 0,
    "QuoteProductId": 0,
    "Updated": "string",
    "CreatedUserId": "string",
    "UpdatedUserId": "string",
    "Id": "string",
    "IncrementAmount": "string",
    "ExcludeComponents": "string",
    "NumberOfCharges": "string",
    "DiscountEligCond": "string",
    "DefaultRateFlag": 0,
    "OverrideTypePackage": 0,
    "commitmentApplicableProduct": "string",
    "ForbidChargeInPreviousPeriod": 0,
    "ItemizeTrialDiscounts": "string",
    "ProductId": 0,
    "AccountProductId": 0,
    "OnEndDate": "string",
    "RenewalOrChangeTerm": "string",
    "ChangeToProductByDefault": 0,
    "Created": "string",
    "AllowInternationalPricing": 0,
    "ExternalKey": "string"
  }
}

ACCOUNT

ACCOUNT API Reference

Operations

ACCOUNT_PRODUCT

ACCOUNT_PRODUCT API Reference

Operations

ACCOUNT_PACKAGE

ACCOUNT_PACKAGE API Reference

Operations

ACCOUNT_PRODUCT_QUOTE

ACCOUNT_PRODUCT_QUOTE API Reference

Operations

BILLING_PROFILE

BILLING_PROFILE API Reference

Operations

CONTRACT

CONTRACT API Reference

Operations

CONTRACT_CURRENCY

CONTRACT_CURRENCY API Reference

Operations

CONTRACT_RATE

CONTRACT_RATE API Reference

Operations

COUNTRY_CODE

COUNTRY_CODE API Reference

Operations

COUNTRY_CODE_MAP

COUNTRY_CODE_MAP API Reference

Operations

CURRENCY

CURRENCY API Reference

Operations

PRICING

PRICING API Reference

Operations

SHARING_GROUP

SHARING_GROUP API Reference

Operations

SHARING_GROUP_RULE

SHARING_GROUP_RULE API Reference

Operations

SHARING_GROUP_USER

SHARING_GROUP_USER API Reference

Operations

TIME_ZONE

TIME_ZONE API Reference

Operations

ACTIVITY

ACTIVITY API Reference

Operations

ACTIVITY_COLLECTOR

ACTIVITY_COLLECTOR API Reference

Operations

BILLING_IDENTIFIER

BILLING_IDENTIFIER API Reference

Operations

COLLECTOR_FIELDS

COLLECTOR_FIELDS API Reference

Operations

CREDIT

CREDIT API Reference

Operations

CREDIT_ALLOCATION

CREDIT_ALLOCATION API Reference

Operations

CREDIT_TYPE

CREDIT_TYPE API Reference

Operations

DUNNING_INTERVAL

DUNNING_INTERVAL API Reference

Operations

INVOICE

INVOICE API Reference

Operations

INVOICE_TEMPLATE

INVOICE_TEMPLATE API Reference

Operations

PAYMENT

PAYMENT API Reference

Operations

REFUND

REFUND API Reference

Operations

REFUND_TYPE

REFUND_TYPE API Reference

Operations

TAX_DETAIL

TAX_DETAIL API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

TAX_ENGINE_AUDIT

TAX_ENGINE_AUDIT API Reference

Operations

ACCOUNT_CONTACT

ACCOUNT_CONTACT API Reference

Operations

CONTACT_TYPE

CONTACT_TYPE API Reference

Operations

CS_ACCOUNT_ACTION

CS_ACCOUNT_ACTION API Reference

Operations

CS_ACTION

CS_ACTION API Reference

Operations

CS_ACTION_TYPE

CS_ACTION_TYPE API Reference

Operations

CS_STRATEGY

CS_STRATEGY API Reference

Operations

INVOICE_WALLET

INVOICE_WALLET API Reference

Operations

PAYMENT_ALLOCATION

PAYMENT_ALLOCATION API Reference

Operations

PAYMENT_TYPE

PAYMENT_TYPE API Reference

Operations

STATEMENT_TEMPLATE

STATEMENT_TEMPLATE API Reference

Operations

GENERAL_LEDGER_TRANSACTION

GENERAL_LEDGER_TRANSACTION API Reference

Operations

PROCESS_QUEUE_REVENUE_COMMITMENT

PROCESS_QUEUE_REVENUE_COMMITMENT API Reference

Operations

REVREC_CONTRACT

REVREC_CONTRACT API Reference

Operations

ENTITY

ENTITY API Reference

Operations

ENTITY_FIELD

ENTITY_FIELD API Reference

Operations

ENTITY_FIELD_ROLE

ENTITY_FIELD_ROLE API Reference

Operations

ENTITY_FIELD_VALUES

ENTITY_FIELD_VALUES API Reference

Operations

BULK_DATA_LOADER

BULK_DATA_LOADER API Reference

Operations

QUOTE

QUOTE API Reference

Operations

QUOTE_DRAFT

QUOTE_DRAFT API Reference

Operations

QUOTE_PRODUCT

QUOTE_PRODUCT API Reference

Operations

QUOTE_PERIOD

QUOTE_PERIOD API Reference

Operations

QUOTE_PRODUCT_PERIOD

QUOTE_PRODUCT_PERIOD API Reference

Operations

TAX_ENGINE

TAX_ENGINE API Reference

Operations

API Reference (1.0)

CONTRACT

CONTRACT_RATE

COUNTRY

COUNTRY_CODE_MAP

DESTINATION_COUNTRY_CODE

LABEL_VERSION

LANGUAGE

ORIGINATION_COUNTRY_CODE

PACKAGE

PACKAGE_CURRENCY

PACKAGE_PRODUCT

PARENT_PACKAGE_PRODUCT

PRICING

PRODUCT

RATE_CLASS

RATE_CLASS_PRODUCT

RATING_METHOD

Retrieve By Id Rating Method

Request

Responses

Was this helpful?

Retrieve Filtered Rating Method

Request

Responses

Was this helpful?

Save Rating Method

Request

Responses

Was this helpful?

Update Rating Method

Request

Responses

Was this helpful?

Upsert Rating Method

Request

Responses

Was this helpful?

Delete Rating Method

Request

Responses

Was this helpful?

ACCOUNT

ACCOUNT_PRODUCT

ACCOUNT_PACKAGE

ACCOUNT_PRODUCT_QUOTE

BILLING_PROFILE

CONTRACT

CONTRACT_CURRENCY

CONTRACT_RATE

COUNTRY_CODE

COUNTRY_CODE_MAP

CURRENCY

PRICING

SHARING_GROUP

SHARING_GROUP_RULE

SHARING_GROUP_USER

TIME_ZONE

ACTIVITY

ACTIVITY_COLLECTOR

BILLING_IDENTIFIER

COLLECTOR_FIELDS

CREDIT

CREDIT_ALLOCATION

CREDIT_TYPE

DUNNING_INTERVAL

INVOICE

INVOICE_TEMPLATE

PAYMENT

REFUND

REFUND_TYPE

TAX_DETAIL

TAX_ENGINE

TAX_ENGINE_AUDIT

ACCOUNT_CONTACT

CONTACT_TYPE

CS_ACCOUNT_ACTION

CS_ACTION

CS_ACTION_TYPE

CS_STRATEGY