Skip to content
Revenue API
/Forecast/
Generate the revenue fore...

Generate the revenue forecast

Request

Purpose

Regenerates the forecast revenue schedules of the revenue contract in real time.

When to use

  • After a change to the contract (for example an edit or a hold release) when you need the forecast to be current immediately, without waiting for the scheduled job.

Behavior notes

No request body is needed. Errors from the revenue engine for this operation are returned as HTTP 200 with success: false and the generic message shown in the examples, not as 4xx/5xx responses.

Security
bearerAuth
Path
rcIdinteger, (int64)required

Revenue contract ID.

Example:111442
Headers
X-REV-BOOK-IDinteger, (int64)

Revenue book to work in. Defaults to 1 (the primary book). Ignored by the revenue hold definition endpoints, because hold definitions are shared across books.

Default:1
Example:1
Zuora-Request-Idstring, <= 64 characters

Optional correlation ID, echoed in the traceId response header.

Example:b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11
cURL
curl -i -X POST \
  https://one.zuora.com/revenue/services/v1/revenue-management/contracts/111442/generate-forecast \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-REV-BOOK-ID: 1' \
  -H 'Zuora-Request-Id: b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11'

Responses

Processed. success: true means the action completed; success: false means a business rule rejected it and message explains why.

Headers
traceIdstring

Correlation ID of the request. Quote it when you contact Zuora Global Support.

Bodyapplication/json
successbooleanrequired

true when the action completed. false when the revenue engine rejected it under a business rule; see message.

processIdstringrequired

Unique ID generated for this request. Quote it when you contact Zuora Global Support.

messagestring

Result message from the revenue engine. May be empty on success.

changeIdsstring

Comma-separated IDs of records changed by the action, when the action reports them. Omitted otherwise.

Response
{
  "success": true,
  "processId": "3f1c2a7e-9b4d-4c1e-8a55-2d6f0e9b1c11",
  "message": "Forecast Generated Successfully"
}