Back to PipelinerOpptyRevenueSchedules.create
Creates new opptyrevenueschedule
Input
type: object
properties:
parameters:
type: object
properties:
validation-level:
type: integer
format: int32
description: >-
Specify validation level of opptyrevenueschedule 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.
title: Parameters
data:
required:
- id
properties:
id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Unique identifier of entity. Must match with Opportunity id.
readOnly: true
is_deleted:
type: boolean
example: false
description: Specifies if the entity is considered deleted.
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
readOnly: true
cancelation_date:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
period_count:
type: integer
format: int32
example: 1
description: Whole natural number.
period_type:
type: integer
description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year'
example: 1
enum:
- 1
- 2
- 3
start_date:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
type: object
title: Data
Output
type: object
properties:
success:
type: boolean
example: true
description: True when response succeeded, false on error.
data:
required:
- is_delete_protected
- id
properties:
is_delete_protected:
type: boolean
example: false
description: >-
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.
readOnly: true
id:
type: string
format: uuid
example: 01234567-abcd-dcba-ffff-000000000000
description: Unique identifier of entity. Must match with Opportunity id.
readOnly: true
is_deleted:
type: boolean
example: false
description: Specifies if the entity is considered deleted.
modified:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Last modification time.
readOnly: true
created:
type: string
format: date-time
example: '2019-01-01T00:00:00.000Z'
description: Creation time.
readOnly: true
cancelation_date:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
period_count:
type: integer
format: int32
example: 1
description: Whole natural number.
period_type:
type: integer
description: 'Integer enum value: 1 - Month, 2 - Quarter, 3 - Year'
example: 1
enum:
- 1
- 2
- 3
start_date:
type: string
format: date
example: '2019-01-01T00:00:00.000Z'
description: Date information.
revision:
type: integer
format: int32
example: 1
description: Revision when entity was lastly changed.
periods:
type: array
description: Relations to OpptyRevenueSchedulePeriods.
items:
type: string
format: uri
description: >-
Relation to OpptyRevenueSchedulePeriod. By default it is returned as
URI to related resource. Using parameter 'expand', it will return
full entity. See: 'OpptyRevenueSchedulePeriod' object for
properties.
type: object