Retrieve the revenue contract for an RC, sales order, or line

Request

Purpose

Resolves the revenue contract (RC) that contains a given revenue contract ID, sales order number or line ID, so you can link a journal entry line to its contract.

When to use

You have a sales order number, line ID or RC ID and need the revenue contract to link a journal entry line to (rcId).

Security

OneIdOAuth

Query

typestringrequired

What id represents: RC (revenue contract ID), SO (sales order number) or LINE (line ID). Case-insensitive.

Enum:"RC""SO""LINE"

Example:type=SO

idstringrequired

The identifier to resolve.

Example:id=SO-50012

bookIdinteger, (int32)required

Accounting book ID.

Example:bookId=1

cURL

curl -i -X GET \
  'https://one.zuora.com/revenue/services/v1/journal-entries/rc-redirection?type=SO&id=SO-50012&bookId=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Revenue contract found

Headers

traceIdstring

Identifier of the request. Quote it when you contact Zuora Support.

Bodyapplication/json

rcIdinteger or null, (int32)

Revenue contract ID that contains the given RC, sales order or line.

Example:1001

retCodestring or null

Return code from the lookup. 0 (or empty) indicates success.

Example:"0"

errMsgstring or null

Error message when the lookup failed.

Response

{
  "rcId": 1001,
  "retCode": "0",
  "errMsg": null
}