v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Lead & Opportunity

OpptyRevenueSchedules.update

Modifies OpptyRevenueSchedule or OpptyRevenueSchedules with given id(s)

patch/entities/OpptyRevenueSchedules/{id}

Path parameters

idstring uuid required

ID of OpptyRevenueSchedule to update

Query parameters

validation-levelinteger

Specify validation level of OpptyRevenueSchedule on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

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

Modification confirmation. Returns resulting OpptyRevenueSchedule

successboolean

True when response 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
  }
}