Skip to content

Feed the forecast from your pipeline

Goal: deals in your CRM with a close date and a probability show up in the COMMITLY forecast as expected inflows, and move or vanish when the deal changes.

  1. Pick the category for expected revenue with GET /categories/ (a category with is_category: true).

  2. Create a forecast budget per deal. Use the deal ID as external_id and your CRM as external_source. Weight the amount by probability if that is how you plan.

    POST /api/forecast/budgets/
    {
    "category": 12345,
    "name": "Deal: Nordform AG, annual licence",
    "amount": 24000,
    "settlement_date": "2026-11-15",
    "external_id": "deal-4711",
    "external_source": "crm",
    "tags": ["pipeline"]
    }
  3. Update when the deal changes. New close date or amount: PATCH /api/forecast/budgets/external/deal-4711/.

  4. Delete when the deal is lost — or when it is won and the invoice arrives as an open item, so the amount is not counted twice: DELETE /api/forecast/budgets/external/deal-4711/.

More on external IDs: Budgets and external IDs.