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

Creates a new invoicing forecast linked to an existing estimate or purchase order. A forecast represents a scheduled payment milestone with an expected date and amount.
Use when the user wants to add a cashflow forecast entry for an open document.
Distinct from creating a payment: a forecast is a future projection, not a recorded transaction.

Request body

object relatedDocumentId string required

Identifier of the related estimate or purchase order (24-character hex ObjectId)

relatedDocumentType string required

Type of the related document

Enum: estimate order 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

import requests

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

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

Responses

Success responses

201 Invoicing forecast created

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Related estimate or purchase order not found application/json 422 Validation error application/json 429 Rate limit exceeded application/json

Next →Edit an invoicing forecast →