Skip to content
Revenue API
/
/
Copy a line into a new ma...

Copy a line into a new manual POB

Request

Purpose

Creates a new manual POB and line in the revenue contract by copying a source line, optionally overriding its prices, quantity, and document fields.

When to use

  • Add a performance obligation that was not in the source data, for example a free service promised outside the order, using an existing line as a template.
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
Bodyapplication/jsonrequired
objectVersioninteger, (int64)required

Current version of the revenue contract. Required for this action.

Example:5
docLineIdstringrequired

Source document line ID to copy.

pobNamestringrequired

Name of the new manual POB.

pobTemplateIdinteger, (int64)required

POB template for the new POB.

fvPricenumber, (double)

Fair value price of the new line.

itemNumstring

Item number.

ordQtynumber, (double)

Ordered quantity.

unitListPrcnumber, (double)

Unit list price.

unitSellPrcnumber, (double)

Unit selling price.

extLstPrcnumber, (double)

Extended list price.

extSllPrcnumber, (double)

Extended selling price.

docNumstring

Document number.

docLineNumstring

Document line number.

docDatestring

Document date (yyyy-MM-dd).

commentsstring

Comment recorded in the audit history.

{
  "objectVersion": 5,
  "docLineId": "SO-1001-1",
  "pobName": "Free Training",
  "pobTemplateId": 100
}

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