Jump to

• Request
• Response

Retrieves all charge sets for the specified quote belonging to the user based on the proper access rights

get

/ccstore/v1/selfservice/quotes/{id}/lines/{documentNumber}/charges

If the profile is not logged in or is anonymous then the endpoint will fail. The user will be granted required access rights based on which the quote line chargeSet api will return all the chargeSet belonging to the quote line

Request

Supported Media Types

• application/json

Path Parameters

• documentNumber(required): string
  The document number of the each quote line items
• id(required): string
  Id of the Quote

Query Parameters

• limit: string
  The batch size of the quote line chargeSet to be fetched together. Maximum limit is 250. Default value is 10
• offset: string
  The offset of the page. By default, offset is 0, which means first page will be returned.
• orderby: string
  Specifies a comma-separated list of pairs to order the response by.
• totalResults: boolean
  Indicates if the total results should be included in the response.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Response containing the quote line chargeSet

Body ()

Root Schema : GetQuoteLineChargeSetResponse

Example:

{
    "offset":0,
    "limit":10,
    "count":2,
    "hasMore":false,
    "items":[
        {
            "_document_number":2,
            "_chargeSet_rateCardName":null,
            "_chargeSet_chargeType":{
                "displayValue":"Sales Price",
                "value":"ORA_SALE"
            },
            "_chargeSet_usageUOM":null,
            "_chargeSet_rateCardStructure":null,
            "_chargeSet_netPrice":{
                "currency":"USD",
                "value":2
            },
            "_chargeSet_dynamicPricingType":"static",
            "_chargeSet_discountType":null,
            "_chargeSet_rateCardVariableName":null,
            "_transaction_currency_pref":{
                "id":5190368,
                "currencyCode":"USD"
            },
            "_sequence_number":1,
            "_chargeSet_calculationInfo":"[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\",\"_runningUnitPrice\":2.0}]",
            "_chargeSet_netAmount":{
                "currency":"USD",
                "value":2
            },
            "_chargeSet_chargeDefinition":"Recurring Pricing",
            "_chargeSet_rateCardInHTML":null,
            "_chargeSet_chargeDefinitionCode":"recurringPricing_c",
            "_chargeSet_chargeDefIntegrationId":"CPQ_RECURRING_SALE_CHARGE",
            "_chargeSet_discountAmount":{
                "currency":"USD",
                "value":0
            },
            "_chargeSet_pricePeriod":{
                "displayValue":"Daily",
                "value":"daily"
            },
            "_chargeSet_priceType":{
                "displayValue":"Recurring",
                "value":"Recurring"
            },
            "_bs_id":38461976,
            "_chargeSet_unitPrice":{
                "currency":"USD",
                "value":2
            },
            "_row_number":1,
            "_chargeSet_discountValue":null
        },
        {
            "_document_number":2,
            "_chargeSet_rateCardName":null,
            "_chargeSet_chargeType":{
                "displayValue":"Activation Fee",
                "value":"activationFee_c"
            },
            "_chargeSet_usageUOM":null,
            "_chargeSet_rateCardStructure":null,
            "_chargeSet_netPrice":{
                "currency":"USD",
                "value":190
            },
            "_chargeSet_dynamicPricingType":"static",
            "_chargeSet_discountType":null,
            "_chargeSet_rateCardVariableName":null,
            "_transaction_currency_pref":{
                "id":5190368,
                "currencyCode":"USD"
            },
            "_sequence_number":2,
            "_chargeSet_calculationInfo":"[{\"_priceProfileVar\":\"_defaultPriceModel\",\"_priceProfileName\":\"Base Price Model\",\"_pricingEngineRuleVar\":\"_defaultPricingRule\",\"_pricingEngineRuleName\":\"Base Pricing Rule\",\"_runningUnitPrice\":190.0}]",
            "_chargeSet_netAmount":{
                "currency":"USD",
                "value":190
            },
            "_chargeSet_chargeDefinition":"Activation Fee",
            "_chargeSet_rateCardInHTML":null,
            "_chargeSet_chargeDefinitionCode":"activationFee_c",
            "_chargeSet_chargeDefIntegrationId":"OSS_AF",
            "_chargeSet_discountAmount":{
                "currency":"USD",
                "value":0
            },
            "_chargeSet_pricePeriod":null,
            "_chargeSet_priceType":{
                "displayValue":"One Time",
                "value":"One Time"
            },
            "_bs_id":38461976,
            "_chargeSet_unitPrice":{
                "currency":"USD",
                "value":190
            },
            "_row_number":2,
            "_chargeSet_discountValue":null
        }
    ]
}

400 Response

Bad query params in the request

Body ()

Root Schema : Error

Type: object

Show Source

• message: string
  The error message
• status: string
  The Error code

{
    "type":"object",
    "properties":{
        "message":{
            "description":"The error message",
            "type":"string"
        },
        "status":{
            "description":"The Error code",
            "type":"string"
        }
    }
}

Back to Top