PUT

Edit an invoicing forecast

Scope: accounting:cashflow.write https://api.alladdin.com/api/v2/treasury/cashflow/invoicing-forecasts/{forecastId}

Replaces all editable fields of an existing invoicing forecast. This is a full resource replacement.
Use when the user wants to update the dates, amount, percentage or description of an existing cashflow forecast.
Distinct from the Create endpoint: the forecast must already exist and is identified by forecastId.

Parameters

Path parameters

forecastId string required

Invoicing forecast identifier (24-character hex ObjectId)

Request body

object issueDate string<date> required

Expected issue date in ISO 8601 format (YYYY-MM-DD)

dueDate string<date> required

Payment due date in ISO 8601 format (YYYY-MM-DD)

description string optional

Optional description of the forecast entry

amount string required

Forecast amount as decimal string. Provide a positive value; forecasts linked to a purchase order are stored and returned as negative (cash outflow).

percentage number<float> required

Percentage of the total document amount this forecast covers (0–100)

Request

python

import requests

url = "https://api.alladdin.com/api/v2/treasury/cashflow/invoicing-forecasts/507f1f77bcf86cd799439011"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "issueDate": "2026-06-01",
    "dueDate": "2026-07-01",
    "description": "First milestone payment",
    "amount": "5000.00",
    "percentage": 50
}
response = requests.put(url, headers=headers, json=payload)
print(response.json())

Responses

Success responses

204 Invoicing forecast updated

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Invoicing forecast not found application/json 422 Validation error application/json 429 Rate limit exceeded application/json

← PreviousCreate an invoicing forecast →

Next →List invoicing forecasts →

Alladdin