REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Create a sales credit

post

/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits

Request

Path Parameters

SubscriptionProductPuid(required): string

The public unique identifier of the subscription product.

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

Root Schema : schema

Type: object

Show Source

EndDate: string (date)

Title: End Date

The date when the sales credit was ends.
Percentage: number

Title: Percent

The percentage
SalesCreditId: integer (int64)

The unique identifier of the sales credit.
SalesCreditPuid: string

Title: Number

Maximum Length: 120

The public unique identifier of the sales credit.
SalesCreditType: string

The type of the sales credit.
SalesCreditTypeId: integer (int64)

Title: Credit Type

The unique identifier of the type of the sales credit.
SalesPerson: string

The name of the sales person.
SalesPersonNumber: string

Title: Salesperson Number

The alternate identifier of a salesperson.
SalesrepId: integer (int64)

Title: Salesperson

The unique identifier of the sales representative.
StartDate: string (date)

Title: Start Date

The date when the sales credit started.
SubscriptionId: integer (int64)

The unique identifier of the subscription.
SubscriptionProductId: integer (int64)

Title: Subscription Product ID

The unique identifier of the subscription product.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the sales credit was ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            }
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SalesCreditPuid":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the sales credit.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The type of the sales credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SalesCreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"The unique identifier of the type of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.SalesCreditTypeVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SalesCreditTypeId"
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"The name of the sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "SalesrepId":{
            "title":"Salesperson",
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.AllSalesrepVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"PartyName",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ResourceSalesrepId"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the sales credit started.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.SubscriptionsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"SubscriptionNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionId"
            }
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.ProductsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"LineNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionProductId"
            }
        }
    }
}

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.

Root Schema : subscriptionProducts-salesCredits-item-response

Type: object

Show Source

CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the sales credit.
CreationDate: string (date-time)

Read Only: true

The date when the sales credit was created.
EndDate: string (date)

Title: End Date

The date when the sales credit was ends.
LastUpdateDate: string (date-time)

Read Only: true

The date when the sales credit was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the sales credit.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The login details of the user who last updated the sales credit.
links: array Links

Title: Links

The link relations associated with the resource instance.
Percentage: number

Title: Percent

The percentage
QuotaFlag: boolean

Read Only: true

Maximum Length: 1

Indicates whether the quota has been fulfilled.
SalesCreditId: integer (int64)

The unique identifier of the sales credit.
SalesCreditPuid: string

Title: Number

Maximum Length: 120

The public unique identifier of the sales credit.
SalesCreditType: string

The type of the sales credit.
SalesCreditTypeId: integer (int64)

Title: Credit Type

The unique identifier of the type of the sales credit.
SalesPerson: string

The name of the sales person.
SalesPersonNumber: string

Title: Salesperson Number

The alternate identifier of a salesperson.
SalesrepId: integer (int64)

Title: Salesperson

The unique identifier of the sales representative.
StartDate: string (date)

Title: Start Date

The date when the sales credit started.
SubscriptionId: integer (int64)

The unique identifier of the subscription.
SubscriptionProductId: integer (int64)

Title: Subscription Product ID

The unique identifier of the subscription product.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the sales credit was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the sales credit was ends.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the sales credit was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the sales credit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the sales credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Percentage":{
            "title":"Percent",
            "type":"number",
            "description":"The percentage",
            "nullable":false,
            "x-hints":{
                "precision":5,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "scale":2
            },
            "x-queryable":true
        },
        "QuotaFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the quota has been fulfilled.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesCreditId":{
            "type":"integer",
            "description":"The unique identifier of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "SalesCreditPuid":{
            "title":"Number",
            "maxLength":120,
            "type":"string",
            "description":"The public unique identifier of the sales credit.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "SalesCreditType":{
            "type":"string",
            "description":"The type of the sales credit.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesCreditTypeId":{
            "title":"Credit Type",
            "type":"integer",
            "description":"The unique identifier of the type of the sales credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.SalesCreditTypeVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Name",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SalesCreditTypeId"
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"The name of the sales person.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesPersonNumber":{
            "title":"Salesperson Number",
            "type":"string",
            "description":"The alternate identifier of a salesperson.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y",
                "sortable":false
            }
        },
        "SalesrepId":{
            "title":"Salesperson",
            "type":"integer",
            "description":"The unique identifier of the sales representative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.model.view.AllSalesrepVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"PartyName",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"ResourceSalesrepId"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the sales credit started.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.SubscriptionsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"SubscriptionNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionId"
            },
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "title":"Subscription Product ID",
            "type":"integer",
            "description":"The unique identifier of the subscription product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.subscriptions.subscriptionManagement.subscriptionService.view.ProductsVO",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"LineNumber",
                "fnd:FND_AUDIT_FK_VIEWOBJECT_QRY_FORCEEXEC":"true",
                "fnd:FND_AUDIT_FK_WHEREATTR":"SubscriptionProductId"
            },
            "x-queryable":true
        },
        "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."
        }
    }
}

Links

SalesrepVA

Operation: /crmRestApi/resources/11.13.18.05/salesreps

Parameters:

finder: OrgIdFinder

The list of values indicating sales person.

The following properties are defined on the LOV link relation:

Source Attribute: SalesPerson; Target Attribute: PartyName
Display Attribute: PartyName

Examples

The following example shows how to create a sales credit by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/300100182015426/child/salesCredits

Example of Request Body

The following example shows the contents of the request body in JSON format.

{
    "SalesCreditPuid": "GP-5678-PRDT-1-SLCR-3",
    "SalesCreditTypeId": 1,
    "SalesrepId": 100000008147775,
    "Percentage": 100
}

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "CreatedBy": "SALES_ADMIN",
  "CreationDate": "2019-08-20T09:01:37+00:00",
  "EndDate": null,
  "LastUpdateDate": "2019-08-20T09:01:37.437+00:00",
  "LastUpdateLogin": "9062D47DF31EDAF6E0533EFDF40A2696",
  "LastUpdatedBy": "SALES_ADMIN",
  "Percentage": 100,
  "SalesCreditId": 300100192686415,
  "SalesCreditPuid": "GP-5678-PRDT-1-SLCR-3",
  "SalesCreditTypeId": 1,
  "SalesrepId": 100000008147775,
  "StartDate": null,
  "SubscriptionId": 300100181994494,
  "SubscriptionProductId": 300100192686405,
  "SalesPerson": "Abhijit Chan",
  "SalesCreditType": "Quota Sales Credit",
  "QuotaFlag": true,
  "links":
	...
}