Conga

Conga Waterfall Rule Entry API

The WaterfallRuleEntry API from Conga — 2 operation(s) for waterfallruleentry.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /waterfall-rules/{ParentId}/entries Delete several entries from a waterfall rule · Delete waterfall rule entries #
Ask an LLM
“Can I remove many entries from a condition or dimension waterfall rule at once?”
“Does the bulk entry delete return a status per entry?”
Tell an agent destructive · confirm first
Bulk-delete these entries from waterfall rule {ParentId}.
Remove the listed rule entries under waterfall rule {ParentId}.
GET /waterfall-rules/{ParentId}/entries List the entries in a waterfall rule · Retrieve waterfall rule entries #
Ask an LLM
“Which entries make up a given waterfall rule in Conga CPQ?”
“Can I page through a waterfall rule's entries with a filter?”
Tell an agent
List the entries in waterfall rule {ParentId}.
Show waterfall rule {ParentId} entries matching {filter}, page {page}.
PATCH /waterfall-rules/{ParentId}/entries Update several entries in a waterfall rule · Update waterfall rule entries #
Ask an LLM
“Can I edit fields on many waterfall rule entries together?”
“Is the entry ID changeable when I bulk-update rule entries?”
Tell an agent
Bulk-update these entries on waterfall rule {ParentId}.
Apply field changes to multiple entries of waterfall rule {ParentId}.
POST /waterfall-rules/{ParentId}/entries Add entries to a waterfall rule · Create waterfall rule entries #
Ask an LLM
“How many entries can I create on one waterfall rule?”
“How do I add condition or dimension entries to a waterfall rule?”
Tell an agent
Create these entries on waterfall rule {ParentId}.
Add up to 100 new rule entries to waterfall rule {ParentId}.
DELETE /waterfall-rules/{ParentId}/entries/{Id} Delete one waterfall rule entry · Delete a waterfall rule entry #
Ask an LLM
“Is there a way to delete just one entry from a waterfall rule?”
“Will removing a single rule entry affect the other entries?”
Tell an agent destructive · confirm first
Delete entry {Id} from waterfall rule {ParentId}.
Remove only rule entry {Id} in waterfall rule {ParentId}.
GET /waterfall-rules/{ParentId}/entries/{Id} Get one waterfall rule entry · Retrieve a waterfall rule entry #
Ask an LLM
“What are the details of a single entry in a waterfall rule?”
“Can I look up one rule entry by its ID?”
Tell an agent
Show entry {Id} in waterfall rule {ParentId}.
Get the single rule entry {Id} from waterfall rule {ParentId}.
PATCH /waterfall-rules/{ParentId}/entries/{Id} Update one waterfall rule entry · Update a waterfall rule entry #
Ask an LLM
“Can I change a single entry on a waterfall rule?”
“Which call edits one waterfall rule entry document?”
Tell an agent
Update entry {Id} in waterfall rule {ParentId}.
Edit just rule entry {Id} under waterfall rule {ParentId}.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-waterfallruleentry-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-waterfallruleentry-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-waterfallruleentry-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Administration Waterfall Rule Entry API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/revenue-admin/v1
security:
- Bearer: []
tags:
- name: WaterfallRuleEntry
paths:
  /waterfall-rules/{ParentId}/entries:
    delete:
      tags:
      - WaterfallRuleEntry
      summary: Delete waterfall rule entries
      description: 'Deletes one or more waterfall rule entries from a specific waterfall rule of type condition or dimension.


        When executed, this API returns one or more records with the delete status of each associated record ID.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent waterfall rule
        required: true
        schema:
          type: string
      requestBody:
        description: The list of records to delete
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WaterfallRuleEntry'
            example:
            - Id: Id of the record to delete
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WaterfallRuleEntry'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WaterfallRuleEntry'
      responses:
        '200':
          description: OK
      operationId: deleteWaterfallRulesByParentIdEntries
      x-operation-id-source: derived
    get:
      tags:
      - WaterfallRuleEntry
      summary: Retrieve waterfall rule entries
      description: 'Retrieves all waterfall rule entries in a waterfall rule, with their details. Use query parameters to further narrow down the retrieved results.


        When executed, this API returns all waterfall rule entries in a waterfall rule.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent waterfall rule
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: An optional array of filters
        schema:
          type: array
          items:
            type: string
      - name: sort
        in: query
        description: An optional sort criteria
        schema:
          type: string
      - name: page
        in: query
        description: The page number for pagination
        schema:
          type: integer
          format: int32
          default: 1
      - name: limit
        in: query
        description: The maximum number of records per page
        schema:
          type: integer
          format: int32
          default: 50
      - name: includes
        in: query
        description: An optional array of included fields
        schema:
          type: array
          items:
            type: string
      - name: field
        in: query
        description: Pass Comma separated mulitple fields
        schema:
          type: array
          items:
            type: string
      - name: filterExpression
        in: query
        description: ''
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getWaterfallRulesByParentIdEntries
      x-operation-id-source: derived
    patch:
      tags:
      - WaterfallRuleEntry
      summary: Update waterfall rule entries
      description: 'Updates specific fields on one or more waterfall rule entries. It can update any fields except waterfall rule entry ID.


        When executed, this API returns the updated waterfall rule entry or waterfall rule entries.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent waterfall rule
        required: true
        schema:
          type: string
      requestBody:
        description: The list of records to be updated
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
            example:
            - Name: Name of the record
              Sequence: 1
              WaterfallRule:
                Id: WaterFallRule-Id
                Name: WaterFallRule-Name
              AdjustmentType: '% Discount'
              AdjustmentAmount: 100
              Dimension1Value: 3af14e4a-d597-417e-b14e-e001fae5bdec
              Id: Id of the record
          text/json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
          application/*+json:
            schema:
              type: array
              items:
                type: object
                additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchWaterfallRulesByParentIdEntries
      x-operation-id-source: derived
    post:
      tags:
      - WaterfallRuleEntry
      summary: Create waterfall rule entries
      description: 'Ccreates one or more waterfall rule entries. It can create a maximum of 100 waterfall rule entries for a particular waterfall rule.


        When executed, this API returns a unique waterfall rule entry ID (string) that CPQ automatically generates.'
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent waterfall rule
        required: true
        schema:
          type: string
      requestBody:
        description: The list of waterfall rule entries to add to the collection
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WaterfallRuleEntry'
          text/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WaterfallRuleEntry'
          application/*+json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/WaterfallRuleEntry'
      responses:
        '200':
          description: OK
      operationId: postWaterfallRulesByParentIdEntries
      x-operation-id-source: derived
  /waterfall-rules/{ParentId}/entries/{Id}:
    delete:
      tags:
      - WaterfallRuleEntry
      summary: Delete a waterfall rule entry
      description: Deletes a single waterfall rule entry document based on the identifier and parent waterfall rule.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent waterfall rule
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the waterfall rule entry
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
      operationId: deleteWaterfallRulesByParentIdEntriesById
      x-operation-id-source: derived
    get:
      tags:
      - WaterfallRuleEntry
      summary: Retrieve a waterfall rule entry
      description: Retrieves a single waterfall rule entry document based on the identifier and parent waterfall rule.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent waterfall rule
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the waterfall rule entry
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '204':
          description: No Content
      operationId: getWaterfallRulesByParentIdEntriesById
      x-operation-id-source: derived
    patch:
      tags:
      - WaterfallRuleEntry
      summary: Update a waterfall rule entry
      description: Updates a single waterfall rule entry document based on the identifier and parent waterfall rule.
      parameters:
      - name: ParentId
        in: path
        description: The identifier of the parent waterfall rule
        required: true
        schema:
          type: string
      - name: Id
        in: path
        description: The identifier of the waterfall rule entry
        required: true
        schema:
          type: string
      requestBody:
        description: The updated state of the waterfall rule entry
        content:
          application/json:
            schema:
              type: object
              additionalProperties: {}
            example:
              Name: Name of the record
              Sequence: 1
              WaterfallRule:
                Id: WaterFallRule-Id
                Name: WaterFallRule-Name
              AdjustmentType: '% Discount'
              AdjustmentAmount: 100
              Dimension1Value: 3af14e4a-d597-417e-b14e-e001fae5bdec
          text/json:
            schema:
              type: object
              additionalProperties: {}
          application/*+json:
            schema:
              type: object
              additionalProperties: {}
      responses:
        '200':
          description: OK
      operationId: patchWaterfallRulesByParentIdEntriesById
      x-operation-id-source: derived
components:
  schemas:
    WaterfallRuleEntry:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
        CreatedBy:
          $ref: '#/components/schemas/LookupObject'
        CreatedDate:
          type: string
          format: date-time
        ModifiedBy:
          $ref: '#/components/schemas/LookupObject'
        ModifiedDate:
          type: string
          format: date-time
        ExternalId:
          type:
          - string
          - 'null'
        ETag:
          type:
          - string
          - 'null'
        AdjustmentAmount:
          type:
          - number
          - 'null'
          format: double
        AdjustmentAmountSource:
          $ref: '#/components/schemas/LookupObject'
        AdjustmentReason:
          type:
          - string
          - 'null'
        AdjustmentType:
          type:
          - string
          - 'null'
        AdjustmentUom:
          type:
          - string
          - 'null'
        AdjustmentValueSource:
          type:
          - string
          - 'null'
        AdjustmentValueType:
          type:
          - string
          - 'null'
        BandSize:
          type:
          - number
          - 'null'
          format: double
        ChargeTypes:
          type:
          - array
          - 'null'
          items:
            type: string
        Condition:
          type:
          - string
          - 'null'
        Currency:
          type:
          - string
          - 'null'
        Dimension1ListValue:
          type:
          - string
          - 'null'
        Dimension1Value:
          type:
          - string
          - 'null'
        Dimension2ListValue:
          type:
          - string
          - 'null'
        Dimension2Value:
          type:
          - string
          - 'null'
        Dimension3ListValue:
          type:
          - string
          - 'null'
        Dimension3Value:
          type:
          - string
          - 'null'
        Dimension4ListValue:
          type:
          - string
          - 'null'
        Dimension4Value:
          type:
          - string
          - 'null'
        Dimension5ListValue:
          type:
          - string
          - 'null'
        Dimension5Value:
          type:
          - string
          - 'null'
        Dimension6ListValue:
          type:
          - string
          - 'null'
        Dimension6Value:
          type:
          - string
          - 'null'
        EndFactor:
          type:
          - number
          - 'null'
          format: double
        MatchInAsset:
          type:
          - boolean
          - 'null'
        MatchProductGroup:
          $ref: '#/components/schemas/LookupObject'
        MaxProducts:
          type:
          - number
          - 'null'
          format: double
        MaxQuantity:
          type:
          - number
          - 'null'
          format: double
        MinProducts:
          type:
          - number
          - 'null'
          format: double
        MinQuantity:
          type:
          - number
          - 'null'
          format: double
        PeriodEndDate:
          type:
          - string
          - 'null'
          format: date-time
        PeriodStartDate:
          type:
          - string
          - 'null'
          format: date-time
        PriceOverride:
          $ref: '#/components/schemas/CurrencyField'
        ProductCategory:
          type:
          - string
          - 'null'
        ProductFamilies:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductFamily:
          type:
          - string
          - 'null'
        ProductGroup:
          $ref: '#/components/schemas/LookupObject'
        ProductGroups:
          type:
          - array
          - 'null'
          items:
            type: string
        Products:
          type:
          - array
          - 'null'
          items:
            type: string
        ProductsOper:
          type:
          - string
          - 'null'
        Quantity:
          type:
          - number
          - 'null'
          format: double
        Sequence:
          type:
          - number
          - 'null'
          format: double
        StartFactor:
          type:
          - number
          - 'null'
          format: double
        Term:
          type:
          - number
          - 'null'
          format: double
        TermPeriodStart:
          type:
          - string
          - 'null'
        UniqueSequenceKey:
          type:
          - string
          - 'null'
        WaterfallRule:
          $ref: '#/components/schemas/LookupObject'
        AdjustmentSource:
          type:
          - string
          - 'null'
      additionalProperties: {}
      example:
        Name: Name of the record
        Sequence: 1
        WaterfallRule:
          Id: WaterFallRule-Id
          Name: WaterFallRule-Name
        AdjustmentType: '% Discount'
        AdjustmentAmount: 100
        Dimension1Value: 3af14e4a-d597-417e-b14e-e001fae5bdec
    CurrencyField:
      type: object
      properties:
        Value:
          type: number
          format: double
        DisplayValue:
          type: number
          format: double
          readOnly: true
        CurrencyCode:
          type:
          - string
          - 'null'
          readOnly: true
        CurrencySymbol:
          type:
          - string
          - 'null'
          readOnly: true
      additionalProperties: false
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header