Update a sales credit
patch
/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/products/{SubscriptionProductPuid}/child/salesCredits/{SalesCreditPuid}
Request
Path Parameters
-
SalesCreditPuid(required): string
The sales credit PUID.
-
SubscriptionNumber(required): string
The alternate identifier of the subscription.
-
SubscriptionProductPuid(required): string
The subscription product PUID.
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 credit card becomes invalid.
-
Percentage: number
The percentage of sales credit.
-
SalesCreditId: integer
(int64)
The unique identifier of the sales credit.
-
SalesCreditPuid: string
Maximum Length:
120
The sales credit PUID. -
SalesCreditTypeId: integer
(int64)
The unique identifier of the sales credit type.
-
SalesPerson: string
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 starts.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The subscription product ID.
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 : subscriptions-products-salesCredits-item-response
Type:
Show Source
object
-
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. -
EndDate: string
(date)
The date when the credit card becomes invalid.
-
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. -
Percentage: number
The percentage of sales credit.
-
QuotaFlag: boolean
Read Only:
true
Maximum Length:1
Indicates the quota of the sales credit. -
SalesCreditId: integer
(int64)
The unique identifier of the sales credit.
-
SalesCreditPuid: string
Maximum Length:
120
The sales credit PUID. -
SalesCreditType: string
The sales credit type.
-
SalesCreditTypeId: integer
(int64)
The unique identifier of the sales credit type.
-
SalesPerson: string
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 starts.
-
SubscriptionId: integer
(int64)
The unique identifier of the subscription.
-
SubscriptionProductId: integer
(int64)
The subscription product ID.
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.