v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Lead & Opportunity

OpptyProductRelationRevenueSchedulePeriods.update

Modifies OpptyProductRelationRevenueSchedulePeriod or OpptyProductRelationRevenueSchedulePeriods with given id(s)

patch/entities/OpptyProductRelationRevenueSchedulePeriods/{id}

Path parameters

idstring uuid required

ID of OpptyProductRelationRevenueSchedulePeriod to update

Query parameters

validation-levelinteger

Specify validation level of OpptyProductRelationRevenueSchedulePeriod 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

datestring date

Recognition date of this period.

oppty_product_relation_revenue_schedule_idstring uuid

Id of the parent revenue schedule.

transaction_idstring uuid

Identifier linking the period to the recognition transaction.

valuenumber double

Amount recognised in this period.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "date": "2019-01-01",
  "oppty_product_relation_revenue_schedule_id": "01234567-abcd-dcba-ffff-000000000000",
  "transaction_id": "01234567-abcd-dcba-ffff-000000000000",
  "value": 4.32,
  "revision": 1
}

Response

Modification confirmation. Returns resulting OpptyProductRelationRevenueSchedulePeriod

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",
    "date": "2019-01-01",
    "oppty_product_relation_revenue_schedule_id": "01234567-abcd-dcba-ffff-000000000000",
    "transaction_id": "01234567-abcd-dcba-ffff-000000000000",
    "value": 4.32,
    "revision": 1
  }
}