Apply impairment to contract lines

Revenue API

Apply impairment to contract lines

Request

Purpose

Flags one or more revenue contract lines with an impairment type, so the revenue engine applies the matching impairment accounting.

When to use

A contract modification or credit event requires impairment accounting for specific lines.
Impairment types: 1 contract impairment, 2 new POB ratable, 4 R and R within SSP, N none.

Behavior notes

Errors from the revenue engine for this operation are returned as HTTP 200 with success: false and the generic message shown in the examples, not as 4xx/5xx responses.

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

linesArray of objects, non-empty(ImpairmentLine)required

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

{
  "lines": [
    { … }
  ]
}

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": "Impairment applied successfully"
}