Skip to content
Revenue API
/
/
Create a manual revenue c...

Create a manual revenue contract

Request

Purpose

Creates a new revenue contract by manually grouping whole contracts, or selected POBs and document lines.

When to use

  • Automatic grouping rules did not produce the contract you need, for example lines from different orders must be accounted for as one contract.
  • Set retain on a POB to keep it in its source contract as well.

Behavior notes

This operation has no rcId path parameter. The revenue engine validates that the selected objects are eligible. Every POB entry must include id.

Security
bearerAuth
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
Bodyapplication/jsonrequired
rcIdsArray of integers, (int64)

Whole contracts to group into the new contract.

rcPobIdsArray of objects(CreateManualRcPob)

POBs to group into the new contract.

docLineIdsArray of strings

Document lines to group into the new contract.

groupingTemplateinteger, (int64)

Revenue contract grouping template ID.

commentsstring

Comment recorded in the audit history.

Default:""
secAtrValstring

Organization (security attribute value) of the new contract, for multi-organization tenants.

Default:""
{
  "rcIds": [
    111450,
    111451
  ],
  "groupingTemplate": 5,
  "comments": "Manual grouping for Q2"
}

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 contract created successfully"
}