Allocation

Reallocate the transaction price and change allocation treatment.

Operations

Reallocate or mark a contract allocation-eligible

Request

Purpose

Runs an allocation action on the revenue contract. REALLOCATE re-runs the allocation of the transaction price across the contract's POBs based on standalone selling prices (SSP). ALLOCATION_ELIGIBLE makes the contract eligible for allocation.

When to use

REALLOCATE: after SSPs, prices, or POB structure changed and the allocation must be recalculated.
ALLOCATION_ELIGIBLE: when a contract that was excluded from allocation must now be allocated.

Behavior notes

action is case-sensitive.

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

actionstringrequired

Allocation action. REALLOCATE re-runs the allocation of the transaction price across the contract's POBs. ALLOCATION_ELIGIBLE marks the contract as eligible for allocation. Values are case-sensitive.

Enum:"REALLOCATE""ALLOCATION_ELIGIBLE"

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

{
  "action": "REALLOCATE"
}

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": "Allocation performed successfully"
}