Update a sales credit
patch
/crmRestApi/resources/11.13.18.05/subscriptionProducts/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Request
Path Parameters
-
SalesCreditPuid(required): string
The public unique identifier of the sales credit.
-
SubscriptionProductPuid(required): string
The public unique identifier of the subscription product.
Header Parameters
-
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
EndDate: string
(date)
The date when the sales credit was ends.
-
Percentage: number
The percentage
-
SalesCreditId: integer
(int64)
The unique identifier of the sales credit.
-
SalesCreditPuid: string
Maximum Length:
120
The public unique identifier of the sales credit. -
SalesCreditTypeId: integer
(int64)
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)
The unique identifier of the sales representative.
-
StartDate: string
(date)
The date when the sales credit started.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
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:
Show Source
object
-
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)
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
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
Maximum Length:
120
The public unique identifier of the sales credit. -
SalesCreditType: string
The type of the sales credit.
-
SalesCreditTypeId: integer
(int64)
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)
The unique identifier of the sales representative.
-
StartDate: string
(date)
The date when the sales credit started.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The unique identifier of the subscription product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to update a sales credit by submitting a PATCH request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X PATCH -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionProducts/300100182015426/child/salesCredits/GP-5678-PRDT-1-SLCR-3
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "QuotaFlag": true }
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": ... }