Release revenue for a revenue contract

Revenue API

Release revenue for a revenue contract

Request

Purpose

Releases revenue previously deferred on the revenue contract, or on selected POBs of it, so it is recognized. Release the full amount, or part of it by amount or percentage.

When to use

The contingency behind a manual deferral is resolved.
Use releaseAmount or releasePercentage for a partial release.

Behavior notes

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

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

Bodyapplication/jsonrequired

commentsstring, non-emptyrequired

Reason for the action, recorded in the audit history.

startDatestring, (date)

Start of the date window the action applies to (yyyy-MM-dd).

endDatestring, (date)

End of the date window the action applies to (yyyy-MM-dd).

releaseAmountnumber, (double)

Amount to release. Used by release actions for a partial release.

releasePercentagenumber, (double)

Percentage to release. Used by release actions for a partial release.

contProsTypestring

Contingency processing type code configured in your tenant.

Default:""

objectVersioninteger, (int64)

Current version of the revenue contract, used for optimistic locking. Omit it to use the contract's current version. If you send a version that is no longer current, the revenue engine rejects the action.

Example:5

rcPobIdsArray of integers, (int64)

Limit the action to these POBs. Omit to act on the whole contract.

{
  "comments": "Acceptance received"
}

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": "Revenue released successfully"
}