List invoicing forecasts
Scope: accounting:cashflow.read https://api.alladdin.com/api/v2/treasury/cashflow/invoicing-forecasts
Returns a cursor-paginated list of invoicing forecasts for the authenticated account. Each forecast represents a scheduled payment milestone linked to an estimate or purchase order.
Use when the user asks to list, search or browse cashflow invoicing forecasts, optionally filtered by the source document.
Distinct from the Remittances endpoint: invoicing forecasts model future payment milestones on open documents, not batch SEPA transfers.
Parameters
Query parameters
document_id string optional
Filter by the related estimate or purchase order identifier
document_type string optional
Filter by related document type
"estimate" "order" cursor string optional
Opaque cursor for pagination
limit integer optional = 50
Maximum number of forecasts to return per page. Defaults to 50, maximum 200.
Request
import requests
url = "https://api.alladdin.com/api/v2/treasury/cashflow/invoicing-forecasts?document_id=507f1f77bcf86cd799439011&document_type=value&cursor=value"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Success responses
200 Paginated list of invoicing forecasts
Error responses
400 Invalid document_type filter application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json