Knowledge Center

Knowledge Center > API > REST API > REST API Reference > Revenue Items > Update custom fields on revenue items by revenue event number

Update custom fields on revenue items by revenue event number

 

This REST API reference describes how to update custom fields on revenue items by specifying the revenue event number. Request and response field descriptions and sample code are provided.

Request

  • Production: PUT https://api.zuora.com/rest/v1/revenue-items/revenue-events/{event-number}
  • API Sandbox: PUT https://apisandbox-api.zuora.com/rest/v1/revenue-items/revenue-events/{event-number}

Request Header

The Accept request header is optional. Only JSON is returned.

Request Parameters

event-number

required

path

The number associated with the revenue event.

Request Body

revenueItems required

Revenue items are listed in ascending order by the accounting period start date.

accountingPeriodName

required

Name of the accounting period. The open-ended accounting period is named Open-Ended

 Include at least one custom field.

cf_txtn__c

optional

One or more optional custom fields, where n is the maximum number of custom fields allowed.

cf_pk1__c

optonal

One or more optional custom fields, where n is the maximum number of custom fields allowed.

Response

success

Returns true if the request is successful. Otherwise, returns false.

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

code

An eight-digit numeric error code.

message

A description of the error.

Examples

HTTP/JSON request:

PUT https://api.zuora.com/rest/v1/revenue-items/revenue-events/RE-00000001

JSON request:

{
   "revenueItems": [
      {
         "accountingPeriodName": "Oct'2014",
         "cf_phases__c": "Scoping Phase",
         "cf_project__c": "Security", }
      {
        "accountingPeriodName": "Nov'2014",
        "cf_phases__c": "Design Phase",
        "cf_project__c": "Security" }
   ]
}

JSON response:

{
"success": true
}
Last modified
18:39, 16 Aug 2016

Tags

Classifications

(not set)