Edit custom attributes of a contract line

Revenue API

Edit custom attributes of a contract line

Request

Purpose

Updates the custom attributes of one revenue contract line: text attributes atr1-atr60, number attributes num1-num15, and date attributes date1-date5. Only the attributes you send change.

When to use

Correct or enrich reporting attributes (region, segment, product family) on a line after it was collected.
Prices, quantities, and transaction dates cannot be changed with this operation.

Security

bearerAuth

Path

rcIdinteger, (int64)required

Revenue contract ID.

Example:111442

lineIdinteger, (int64)required

Revenue contract line ID.

Example:85922

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

commentsstring, non-emptyrequired

Reason for the edit, recorded in the audit history.

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

atr1string

Custom text attribute 1.

atr2string

Custom text attribute 2.

atr3string

Custom text attribute 3.

atr4string

Custom text attribute 4.

atr5string

Custom text attribute 5.

atr6string

Custom text attribute 6.

atr7string

Custom text attribute 7.

atr8string

Custom text attribute 8.

atr9string

Custom text attribute 9.

atr10string

Custom text attribute 10.

atr11string

Custom text attribute 11.

atr12string

Custom text attribute 12.

atr13string

Custom text attribute 13.

atr14string

Custom text attribute 14.

atr15string

Custom text attribute 15.

atr16string

Custom text attribute 16.

atr17string

Custom text attribute 17.

atr18string

Custom text attribute 18.

atr19string

Custom text attribute 19.

atr20string

Custom text attribute 20.

atr21string

Custom text attribute 21.

atr22string

Custom text attribute 22.

atr23string

Custom text attribute 23.

atr24string

Custom text attribute 24.

atr25string

Custom text attribute 25.

atr26string

Custom text attribute 26.

atr27string

Custom text attribute 27.

atr28string

Custom text attribute 28.

atr29string

Custom text attribute 29.

atr30string

Custom text attribute 30.

atr31string

Custom text attribute 31.

atr32string

Custom text attribute 32.

atr33string

Custom text attribute 33.

atr34string

Custom text attribute 34.

atr35string

Custom text attribute 35.

atr36string

Custom text attribute 36.

atr37string

Custom text attribute 37.

atr38string

Custom text attribute 38.

atr39string

Custom text attribute 39.

atr40string

Custom text attribute 40.

atr41string

Custom text attribute 41.

atr42string

Custom text attribute 42.

atr43string

Custom text attribute 43.

atr44string

Custom text attribute 44.

atr45string

Custom text attribute 45.

atr46string

Custom text attribute 46.

atr47string

Custom text attribute 47.

atr48string

Custom text attribute 48.

atr49string

Custom text attribute 49.

atr50string

Custom text attribute 50.

atr51string

Custom text attribute 51.

atr52string

Custom text attribute 52.

atr53string

Custom text attribute 53.

atr54string

Custom text attribute 54.

atr55string

Custom text attribute 55.

atr56string

Custom text attribute 56.

atr57string

Custom text attribute 57.

atr58string

Custom text attribute 58.

atr59string

Custom text attribute 59.

atr60string

Custom text attribute 60.

num1number, (double)

Custom number attribute 1.

num2number, (double)

Custom number attribute 2.

num3number, (double)

Custom number attribute 3.

num4number, (double)

Custom number attribute 4.

num5number, (double)

Custom number attribute 5.

num6number, (double)

Custom number attribute 6.

num7number, (double)

Custom number attribute 7.

num8number, (double)

Custom number attribute 8.

num9number, (double)

Custom number attribute 9.

num10number, (double)

Custom number attribute 10.

num11number, (double)

Custom number attribute 11.

num12number, (double)

Custom number attribute 12.

num13number, (double)

Custom number attribute 13.

num14number, (double)

Custom number attribute 14.

num15number, (double)

Custom number attribute 15.

date1string, (date)

Custom date attribute 1 (yyyy-MM-dd).

date2string, (date)

Custom date attribute 2 (yyyy-MM-dd).

date3string, (date)

Custom date attribute 3 (yyyy-MM-dd).

date4string, (date)

Custom date attribute 4 (yyyy-MM-dd).

date5string, (date)

Custom date attribute 5 (yyyy-MM-dd).

{
  "comments": "Segment correction",
  "atr1": "EMEA"
}

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": "Line updated successfully"
}