Skip to content
Revenue API
/
/
Retrieve a revenue contra...

Retrieve a revenue contract

Request

Purpose

Returns the header record of one revenue contract.

When to use

  • Read the current state, indicators, and amounts of a contract before you perform a manual action.
  • Confirm that a contract exists in the book you are working in.
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 GET \
  https://one.zuora.com/revenue/services/v1/contracts/111442 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'X-REV-BOOK-ID: 1' \
  -H 'Zuora-Request-Id: b8f1c2d4-6e1a-4c7b-9d2e-0f3a5b7c9e11'

Responses

The revenue contract header.

Headers
traceIdstring

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

Bodyapplication/json
idinteger, (int64)required

Revenue contract ID. Use it as rcId in other calls.

bookIdinteger, (int64)required

Revenue book the contract belongs to.

indicatorsobject(Indicators)

Status flags of the record. Each key is a flag name in camelCase and each value is a single-character code, usually Y or N. The set of keys depends on the record type and the Zuora Revenue release.

Example:
{
  "allocationEligible": "Y",
  "multiCurrency": "N"
}
totalCarveAmountstring or null

Total allocation (carve-in/carve-out) amount of the contract.

Example:"1000.00"
property name*anyadditional property
Response
{
  "id": 111442,
  "bookId": 1,
  "indicators": {
    "allocationEligible": "Y",
    "multiCurrency": "N"
  },
  "totalCarveAmount": "1250.00"
}