Jump to

• Request
• Response

Create a recurring revenue

post

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/ChildRevenue/{ChildRevenueUniqID}/child/RecurringRevenue

Request

Path Parameters

• ChildRevenueUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Revenue Items resource and used to uniquely identify an instance of Revenue Items. The client should not generate the hash key value. Instead, the client should query on the Revenue Items collection resource in order to navigate to a specific instance of Revenue Items to get the hash key.
• OptyNumber(required): string
  The unique alternate identifier for the opportunity.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EffectiveDate: string (date)
  Title: Line Close Date

  Estimated close date for this revenue - defaulted from opportunity's close date.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The non recurring revenue amount on the revenue line.
• Quantity: number
  Title: Quantity

  Product quantity.
• RecurParentRevnId: integer (int64)
  Indicates the parent revenue id for the recurrence.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue amount on the revenue line.
• RevnAmount: number
  Title: Line Revenue

  Default Value: 0

  Revenue amount.
• RevnId: integer (int64)
  Revenue identifier.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue amount on the revenue line.

{
    "type":"object",
    "properties":{
        "EffectiveDate":{
            "title":"Line Close Date",
            "type":"string",
            "description":"Estimated close date for this revenue - defaulted from opportunity's close date.",
            "format":"date",
            "nullable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Product quantity.",
            "nullable":true
        },
        "RecurParentRevnId":{
            "type":"integer",
            "description":"Indicates the parent revenue id for the recurrence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"Revenue amount.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnId":{
            "type":"integer",
            "description":"Revenue identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":30,
            "type":"string",
            "description":"User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.",
            "nullable":false
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : opportunities-ChildRevenue-RecurringRevenue-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• EffectiveDate: string (date)
  Title: Line Close Date

  Estimated close date for this revenue - defaulted from opportunity's close date.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NonRecurringRevenue: number
  Title: Nonrecurring Revenue

  The non recurring revenue amount on the revenue line.
• Quantity: number
  Title: Quantity

  Product quantity.
• RecurParentRevnId: integer (int64)
  Indicates the parent revenue id for the recurrence.
• RecurRevenue: number
  Title: Recurring Revenue

  The recurring revenue amount on the revenue line.
• RevnAmount: number
  Title: Line Revenue

  Default Value: 0

  Revenue amount.
• RevnAmtCurcyCode: string
  Read Only: true

  The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
• RevnId: integer (int64)
  Revenue identifier.
• RevnNumber: string
  Title: Revenue Number

  Maximum Length: 30

  User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.
• UsageRevenue: number
  Title: Usage Revenue

  The usage revenue amount on the revenue line.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "title":"Line Close Date",
            "type":"string",
            "description":"Estimated close date for this revenue - defaulted from opportunity's close date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NonRecurringRevenue":{
            "title":"Nonrecurring Revenue",
            "type":"number",
            "description":"The non recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Product quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurParentRevnId":{
            "type":"integer",
            "description":"Indicates the parent revenue id for the recurrence.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecurRevenue":{
            "title":"Recurring Revenue",
            "type":"number",
            "description":"The recurring revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "RevnAmount":{
            "title":"Line Revenue",
            "type":"number",
            "description":"Revenue amount.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            },
            "x-queryable":true
        },
        "RevnAmtCurcyCode":{
            "type":"string",
            "description":"The currency code used to calculate the revenue for this opportunity. A list of valid values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RevnId":{
            "type":"integer",
            "description":"Revenue identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevnNumber":{
            "title":"Revenue Number",
            "maxLength":30,
            "type":"string",
            "description":"User editable revenue number. Defaulted from REVN_ID. Needs to be unique, cannot be NULL.",
            "nullable":false,
            "x-queryable":true
        },
        "UsageRevenue":{
            "title":"Usage Revenue",
            "type":"number",
            "description":"The usage revenue amount on the revenue line.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "Quantity",
                    "UnitPrice"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top