Skip to content
Revenue API
/
/
Link contracts into a rev...

Link contracts into a revenue contract

Request

Purpose

Merges other revenue contracts into the contract in the path.

When to use

  • Contracts that belong together (for example a sale and its later add-on) were created separately and must be allocated together.

Behavior notes

The contract version is checked with optimistic locking. The revenue engine validates that the contract and the referenced objects are eligible.

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
Bodyapplication/jsonrequired
targetRcIdsArray of integers, (int64), non-emptyrequired

Contracts to merge into the contract in the path.

commentsstring

Comment recorded in the contract's audit history.

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
{
  "targetRcIds": [
    111450,
    111451
  ],
  "comments": "Regrouping per contract review"
}

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": "Link completed successfully"
}