Conga

Conga Forecast Billing API

The Forecast Billing API from Conga — 3 operation(s) for forecast billing.

GitHub OpenAPI

Operations 3

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

POST /forecast Create billing forecast data · Create forecast data #
Ask an LLM
“How do I generate a billing forecast?”
“Can I create forecast data from a specific transaction source?”
Tell an agent
Create forecast data from source {source}.
Generate billing forecasts for requests {requests}.
POST /forecast/regenerate-forecast-summary Regenerate a forecast summary · Regenerate forecast summary #
Ask an LLM
“Can I rebuild the forecast summary after changes?”
“How do I refresh summarized billing forecasts?”
Tell an agent
Regenerate the forecast summary for {requests}.
Rebuild the billing forecast summary using criterion {criterion}.
GET /forecast/{businessObjectType}/{businessObjectId} Get forecast data for a business object · Retrieve forecast data #
Ask an LLM
“What billing is forecast for a specific order or agreement?”
“Can I see the forecast for one business object?”
Tell an agent
Get the forecast for {type} {id}.
Show billing forecast data of {type} record {id}.

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-forecast-billing-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-forecast-billing-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-forecast-billing-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Billing Management Forecast Billing API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/billing/v1
security:
- Bearer: []
tags:
- name: Forecast Billing
paths:
  /forecast:
    post:
      tags:
      - Forecast Billing
      summary: Create forecast data
      description: Create forecast data for Proposal, Product Configuration, Order, LineItem, and OrderLineItem.
      requestBody:
        description: Forecast Request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForecastRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ForecastRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ForecastRequest'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
        '207':
          description: Multi-Status
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: postForecast
      x-operation-id-source: derived
  /forecast/regenerate-forecast-summary:
    post:
      tags:
      - Forecast Billing
      summary: Regenerate forecast summary
      description: Regenerate forecast summary for Proposal, Product Configuration, Order based on Summary Criteria passed.
      requestBody:
        description: Forecast Summary Request
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ForecastSummaryRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/ForecastSummaryRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/ForecastSummaryRequest'
      responses:
        '201':
          description: Created
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
        '207':
          description: Multi-Status
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ForecastSummaryResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: postForecastRegenerateForecastSummary
      x-operation-id-source: derived
  /forecast/{businessObjectType}/{businessObjectId}:
    get:
      tags:
      - Forecast Billing
      summary: Retrieve forecast data
      description: Retrieve forecast data for Proposal, Product Configuration, Order, LineItem, and OrderLineItem.
      parameters:
      - name: businessObjectType
        in: path
        description: Business object type can be Proposal, ProductConfiguration, Order, LineItem or  OrderLineItem
        required: true
        schema:
          type: string
      - name: businessObjectId
        in: path
        description: Id of the Business object
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ForecastScheduleResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastScheduleResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ForecastScheduleResponse'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ForecastScheduleResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastScheduleResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ForecastScheduleResponse'
        '500':
          description: Internal Server Error
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/ErrorApiResponse'
      operationId: getForecastByBusinessObjectTypeByBusinessObjectId
      x-operation-id-source: derived
components:
  schemas:
    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
    ErrorApiResponse:
      type: object
      properties:
        Errors:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ApiError'
      additionalProperties: false
    ForecastRequest:
      type: object
      properties:
        TransactionSource:
          type:
          - string
          - 'null'
          description: Transaction source(Conga, External)
        ForecastBillingRequests:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ForecastBillingRequest'
          description: Forecast Requests
        SummaryCriterion:
          type:
          - string
          - 'null'
          description: Criteria for forecast summary
      additionalProperties: false
    ForecastBillingRequest:
      type: object
      properties:
        BusinessObjectType:
          type:
          - string
          - 'null'
          description: Business Object Type schedule belongs to (LineItem, OrderLineItem, ProductConfiguration, Order)
        BusinessObjectId:
          type:
          - string
          - 'null'
          description: Business Object Id for which we need to generate schedules.
      additionalProperties: false
    ForecastBillingSummary:
      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'
        Currency:
          type:
          - string
          - 'null'
        TotalForecastFee:
          $ref: '#/components/schemas/CurrencyField'
        TotalOneTimeFee:
          $ref: '#/components/schemas/CurrencyField'
        TotalRecurringFee:
          $ref: '#/components/schemas/CurrencyField'
        CriterionName:
          type:
          - string
          - 'null'
        CriterionValue:
          type:
          - string
          - 'null'
        ProductConfiguration:
          $ref: '#/components/schemas/LookupObject'
        Order:
          $ref: '#/components/schemas/LookupObject'
        FBSMNumber:
          type:
          - string
          - 'null'
      additionalProperties: {}
    LookupObject:
      type: object
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
      additionalProperties: false
    ForecastBillingScheduleRecord:
      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'
        PeriodStartDate:
          type: string
          format: date-time
        PeriodEndDate:
          type: string
          format: date-time
        Currency:
          type:
          - string
          - 'null'
        ForecastedFeeAmount:
          $ref: '#/components/schemas/CurrencyField'
        ReadyForInvoiceDate:
          type: string
          format: date-time
        InvoiceStatus:
          type:
          - string
          - 'null'
        PaymentTerm:
          $ref: '#/components/schemas/LookupObject'
        Contracted:
          type: boolean
        LineItem:
          $ref: '#/components/schemas/LookupObject'
        ProductConfiguration:
          $ref: '#/components/schemas/LookupObject'
        OrderLineItem:
          $ref: '#/components/schemas/LookupObject'
        Order:
          $ref: '#/components/schemas/LookupObject'
        Product:
          $ref: '#/components/schemas/LookupObject'
        ChargeType:
          type:
          - string
          - 'null'
        BillTo:
          $ref: '#/components/schemas/LookupObject'
        ShipTo:
          $ref: '#/components/schemas/LookupObject'
        AccountLocation:
          $ref: '#/components/schemas/LookupObject'
        BillingRule:
          type:
          - string
          - 'null'
        BillingFrequency:
          type:
          - string
          - 'null'
        PriceType:
          type:
          - string
          - 'null'
        FBSRNumber:
          type:
          - string
          - 'null'
      additionalProperties: {}
    ForecastScheduleResponse:
      type: object
      properties:
        IsSuccess:
          type: boolean
        ErrorMessage:
          type:
          - string
          - 'null'
        ForecastBillingScheduleRecords:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ForecastBillingScheduleRecord'
          description: Forecast Billing Schedule Records
        ForecastBillingSummaries:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ForecastBillingSummary'
          description: Forecast Billing Summaries
      additionalProperties: false
    ForecastSummaryRequest:
      type: object
      properties:
        SummaryCriterion:
          type:
          - string
          - 'null'
          description: Criteria for forecast summary
        ForecastBillingSummaryRequests:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ForecastBillingSummaryRequest'
          description: Forecast billing summary requests
      additionalProperties: false
    ForecastSummaryResponse:
      type: object
      properties:
        IsSuccess:
          type: boolean
        ErrorMessage:
          type:
          - string
          - 'null'
        BusinessObjectType:
          type:
          - string
          - 'null'
          description: Business Object Type schedule belongs to (Product Configuration, Order, Proposal)
        BusinessObjectId:
          type:
          - string
          - 'null'
          description: Business Object Id for which we need to generate schedules.
      additionalProperties: false
    ForecastBillingSummaryRequest:
      type: object
      properties:
        BusinessObjectId:
          type:
          - string
          - 'null'
          description: Business Object Id for which we need to generate schedules.
        BusinessObjectType:
          type:
          - string
          - 'null'
          description: Business Object Type schedule belongs to (Product Configuration, Order, Proposal)
      additionalProperties: false
    ForecastResponse:
      type: object
      properties:
        IsSuccess:
          type: boolean
        ErrorMessage:
          type:
          - string
          - 'null'
        BusinessObjectType:
          type:
          - string
          - 'null'
          description: Business Object Type schedule belongs to (LineItem, OrderLineItem, ProductConfiguration, Order)
        BusinessObjectId:
          type:
          - string
          - 'null'
          description: Business Object Id for which we need to generate schedules.
      additionalProperties: false
    ApiError:
      type: object
      properties:
        Source:
          type:
          - string
          - 'null'
        Title:
          type:
          - string
          - 'null'
        Detail: {}
        Help:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please insert JWT with Bearer into field
      name: Authorization
      in: header