Create sales credits
post
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SalesCredit
Request
Path Parameters
-
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.
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.
-
Upsert-Mode:
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:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:false
Active Flag -
EndDate: string
(date)
Title:
End Date
sales Credit End Date -
ExternalReferenceKey: string
Maximum Length:
120
External Reference Key -
ExternalSourceKey: string
Maximum Length:
120
External Source Key -
Id: integer
(int64)
Sales Credit Id
-
MajorVersion: integer
(int64)
Major Version
-
Percent: number
Title:
Percent
Sales Credit Percent -
SalesCreditPuid: string
Title:
Sales Credit PUID
Maximum Length:120
sales Credit PUID -
SalesCreditType: string
Maximum Length:
240
Sales Credit Type -
SalesCreditTypeId: integer
Title:
Credit Type
Sales Credit Type Id -
SalesrepId: integer
(int64)
Salesrep Id
-
SalesrepName: string
Title:
Salesperson
Maximum Length:360
Sales Representative Name -
StartDate: string
(date)
Title:
Start Date
sales Credit Start Date
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 : contracts-SalesCredit-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Maximum Length:
1
Default Value:false
Active Flag -
EndDate: string
(date)
Title:
End Date
sales Credit End Date -
ExternalReferenceKey: string
Maximum Length:
120
External Reference Key -
ExternalSourceKey: string
Maximum Length:
120
External Source Key -
Id: integer
(int64)
Sales Credit Id
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Major Version
-
Percent: number
Title:
Percent
Sales Credit Percent -
SalesCreditPuid: string
Title:
Sales Credit PUID
Maximum Length:120
sales Credit PUID -
SalesCreditType: string
Maximum Length:
240
Sales Credit Type -
SalesCreditTypeId: integer
Title:
Credit Type
Sales Credit Type Id -
SalesrepId: integer
(int64)
Salesrep Id
-
SalesrepName: string
Title:
Salesperson
Maximum Length:360
Sales Representative Name -
StartDate: string
(date)
Title:
Start Date
sales Credit Start Date
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 create sales credits by submitting a post request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/SalesCredit
Example of Request Body
The following shows an example of the request body in JSON format.
{ "Percent": 40, "SalesrepId": 100000008143336, "ActiveFlag": false, "StartDate": "2018-11-21", "SalesCreditTypeId": "2" } { "Percent": 20, "ActiveFlag": false, "SalesrepName": "Aaron Wang", "StartDate": "2018-11-21" "SalesCreditType": "Non-quota Sales Credit" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "Id": 999990000046325, "MajorVersion": 1, "Percent": 20, "SalesrepId": 100000000177714, "SalesCreditTypeId": 1, "ActiveFlag": true, "SalesrepName": "Francis Scott", "StartDate": null, "EndDate": null, "ExternalSourceKey": null, "ExternalReferenceKey": null, "SalesCreditType": "Quota Sales Credit", "SalesCreditPuid": "SCRD-410-1", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430837/child/SalesCredit/00020000000EACED0005770800038D7C50BB50F50000000EACED000577080000000000000001", "name": "SalesCredit", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430837/child/SalesCredit/00020000000EACED0005770800038D7C50BB50F50000000EACED000577080000000000000001", "name": "SalesCredit", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430837", "name": "contracts", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430837/child/SalesCredit/00020000000EACED0005770800038D7C50BB50F50000000EACED000577080000000000000001/lov/SalesCreditTypeVO1", "name": "SalesCreditTypeVO1", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contracts/100100069430837/child/SalesCredit/00020000000EACED0005770800038D7C50BB50F50000000EACED000577080000000000000001/lov/SalesrepVO1", "name": "SalesrepVO1", "kind": "collection" } ] } ] }