OpptyProductRelationRevenueSchedules.create

Creates new OpptyProductRelationRevenueSchedule

Request

Query Params

validation-level

integer <int32>

optional

Specify validation level of OpptyProductRelationRevenueSchedule on create. 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.

Body Params application / json

is_deleted

boolean

optional

Specifies if the entity is considered deleted.

Example:

false

cancelation_date

string <date>

optional

Date information.

Example:

2019-01-01

period_count

integer <int32>

optional

Whole natural number.

Example:

period_type

enum<integer>

optional

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

Allowed values:

123

Example:

start_date

string <date>

optional

Date information.

Example:

2019-01-01

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Creation confirmation. Returns created OpptyProductRelationRevenueSchedule

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (OpptyProductRelationRevenueSchedule)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity. Must match with OpptyProductRelation id.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

optional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

cancelation_date

string <date>

optional

Date information.

Example:

2019-01-01

period_count

integer <int32>

optional

Whole natural number.

Example:

period_type

enum<integer>

optional

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

Allowed values:

123

Example:

start_date

string <date>

optional

Date information.

Example:

2019-01-01

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

periods

array[string <uri>]

optional

Relations to OpptyProductRelationRevenueSchedulePeriods.

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "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,
        "periods": [
            "http://example.com"
        ]
    }
}

🔴500Server Error