COcoevera
Lead & Opportunity

OpptyRevenueSchedules.update

Changes fields of the OpptyRevenueSchedule record with the given id; fields left out keep their values.

patch/entities/OpptyRevenueSchedules/{id}

Request

Path parameters

idstring uuid required

Id of the OpptyRevenueSchedule record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

is_deletedboolean

Specifies if the entity is considered deleted.

cancelation_datestring date

Date when the revenue schedule was cancelled. Empty for active schedules.

period_countinteger

Number of periods the opportunity value is split into.

period_type1 | 2 | 3

Length of each period (e.g. Monthly, Quarterly, Yearly).

Integer enum value: 1 - Month, 2 - Quarter, 3 - Year

start_datestring date

Date when revenue recognition for the opportunity begins.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "cancelation_date": "2019-01-01",
  "period_count": 1,
  "period_type": 1,
  "start_date": "2019-01-01",
  "revision": 1
}

Response

The changed OpptyRevenueSchedule record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "cancelation_date": "2019-01-01",
    "period_count": 1,
    "period_type": 1,
    "start_date": "2019-01-01",
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.