Create claim reasons
post
/fscmRestApi/resources/11.13.18.05/channelClaimReasons
Request
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
-
BuySideFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the adjustment type will be enabled for the buy-side flows. If false, then the adjustment type will not be enabled for the buy-side flows. This attribute does not have a default value. -
ChargebackReason: string
Maximum Length:
255
Name of the chargeback reason. This chargeback reason is passed to receivables when invoice deductions using this claim reason are settled by chargeback. -
ChargebackReasonCode: string
Maximum Length:
30
Abbreviation that identifies the chargeback reason. This chargeback reason is passed to receivables when invoice deductions using this claim reason are settled by chargeback. -
ClaimReason: string
Maximum Length:
120
Name of the channel claim reason. -
ClaimReasonCode: string
Maximum Length:
30
Abbreviation that identifies the channel claim reason. -
CreditMemoReason: string
Name of the credit memo reason for a receivables credit memo. This credit memo reason is passed to receivables when claims or deductions using this claim reason are settled by a credit memo.
-
CreditMemoReasonCode: string
Maximum Length:
30
Abbreviation that identifies the credit memo reason for a receivables credit memo. This credit memo reason is passed to receivables when claims or deductions using this claim reason are settled by a credit memo. -
Description: string
Maximum Length:
1000
Description of the channel claim reason. -
EndDate: string
(date)
Date when the channel claim reason becomes inactive.
-
SellSideFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the adjustment type will be enabled for the sell-side flows. If false, then the adjustment type will not be enabled for the sell-side flows. This attribute does not have a default value. -
SetCode: string
Abbreviation that identifies the reference data set to which channel claim reason is assigned to.
-
SetId: integer
(int64)
Value that uniquely identifies the reference data set to which channel claim reason is assigned to.
-
SetName: string
Name of the reference data set to which channel claim reason is assigned to.
-
StartDate: string
(date)
Date when the channel claim reason becomes active.
-
WriteoffAdjustmentReason: string
Name of the adjustment reason for a receivables invoice write-off. This adjustment reason is passed to receivables when invoice deductions using this claim reason are settled by write-off.
-
WriteoffAdjustmentReasonCode: string
Maximum Length:
30
Abbreviation that identifies the adjustment reason for a receivables invoice write-off. This adjustment reason is passed to receivables when invoice deductions using this claim reason are settled by write-off.
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 : channelClaimReasons-item-response
Type:
Show Source
object
-
BuySideFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the adjustment type will be enabled for the buy-side flows. If false, then the adjustment type will not be enabled for the buy-side flows. This attribute does not have a default value. -
ChargebackReason: string
Maximum Length:
255
Name of the chargeback reason. This chargeback reason is passed to receivables when invoice deductions using this claim reason are settled by chargeback. -
ChargebackReasonCode: string
Maximum Length:
30
Abbreviation that identifies the chargeback reason. This chargeback reason is passed to receivables when invoice deductions using this claim reason are settled by chargeback. -
ClaimReason: string
Maximum Length:
120
Name of the channel claim reason. -
ClaimReasonCode: string
Maximum Length:
30
Abbreviation that identifies the channel claim reason. -
ClaimReasonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel claim reason. It is a primary key that the application generates when it creates the claim reason. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
CreditMemoReason: string
Name of the credit memo reason for a receivables credit memo. This credit memo reason is passed to receivables when claims or deductions using this claim reason are settled by a credit memo.
-
CreditMemoReasonCode: string
Maximum Length:
30
Abbreviation that identifies the credit memo reason for a receivables credit memo. This credit memo reason is passed to receivables when claims or deductions using this claim reason are settled by a credit memo. -
Description: string
Maximum Length:
1000
Description of the channel claim reason. -
EndDate: string
(date)
Date when the channel claim reason becomes inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SellSideFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the adjustment type will be enabled for the sell-side flows. If false, then the adjustment type will not be enabled for the sell-side flows. This attribute does not have a default value. -
SetCode: string
Abbreviation that identifies the reference data set to which channel claim reason is assigned to.
-
SetId: integer
(int64)
Value that uniquely identifies the reference data set to which channel claim reason is assigned to.
-
SetName: string
Name of the reference data set to which channel claim reason is assigned to.
-
StartDate: string
(date)
Date when the channel claim reason becomes active.
-
WriteoffAdjustmentReason: string
Name of the adjustment reason for a receivables invoice write-off. This adjustment reason is passed to receivables when invoice deductions using this claim reason are settled by write-off.
-
WriteoffAdjustmentReasonCode: string
Maximum Length:
30
Abbreviation that identifies the adjustment reason for a receivables invoice write-off. This adjustment reason is passed to receivables when invoice deductions using this claim reason are settled by write-off.
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
This example describes how to create claim reasons.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/channelClaimReasons"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "ClaimReason": "Agreement Performed", "ClaimReasonCode": "AGREEMENT", "Description": "Agreement", "SetName": "Vision Operations Set" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "ClaimReasonId": 300100185730773, "ClaimReason": "Agreement Performed", "ClaimReasonCode": "AGREEMENT", "Description": "Agreement", "CreditMemoReason": null, "CreditMemoReasonCode": null, "WriteoffAdjustmentReason": null, "WriteoffAdjustmentReasonCode": null, "CreatedBy": "channel_user", "CreationDate": "2020-06-02T11:33:24+00:00", "LastUpdateDate": "2020-06-02T11:33:24.090+00:00", "LastUpdatedBy": "channel_user", "StartDate": null, "EndDate": null, "SetId": 204, "SetName": "Vision Operations Set", "SetCode": "Vision Operations 204", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelClaimReasons/300100185730773", "name": "channelClaimReasons", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version//channelClaimReasons/300100185730773", "name": "channelClaimReasons", "kind": "item" } ] }