1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Order Management
  4. Channel Claim Reasons

Update one claim reason

patch

/fscmRestApi/resources/11.13.18.05/channelClaimReasons/{ClaimReasonId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • 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.
  • Maximum Length: 120
    Name of the channel claim reason.
  • 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.
  • 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.
  • Maximum Length: 1000
    Description of the channel claim reason.
  • Date when the channel claim reason becomes inactive.
  • Date when the channel claim reason becomes active.
  • 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.
  • 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.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : channelClaimReasons-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Maximum Length: 120
    Name of the channel claim reason.
  • Maximum Length: 30
    Abbreviation that identifies the channel claim reason.
  • 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.
  • Read Only: true
    Maximum Length: 64
    User who created the record.
  • Read Only: true
    Date and time when the user created the record.
  • 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.
  • 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.
  • Maximum Length: 1000
    Description of the channel claim reason.
  • Date when the channel claim reason becomes inactive.
  • Read Only: true
    Date and time when the user most recently updated the record.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the record.
  • Links
  • 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.
  • Abbreviation that identifies the reference data set to which channel claim reason is assigned to.
  • Value that uniquely identifies the reference data set to which channel claim reason is assigned to.
  • Name of the reference data set to which channel claim reason is assigned to.
  • Date when the channel claim reason becomes active.
  • 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.
  • 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.
Back to Top

Examples

This example describes how to update a claim reason.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/channelClaimReasons/300100185730773"

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 updates. 

{
	"ClaimReason": "Agreement Performed",
	"ClaimReasonCode": "AGREEMENT",
	"Description": "Agreement Performed",
	"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 Performed",
	"CreditMemoReason": null,
	"CreditMemoReasonCode": null,
	"WriteoffAdjustmentReason": null,
	"WriteoffAdjustmentReasonCode": null,
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-02T11:33:24+00:00",
	"LastUpdateDate": "2020-06-02T11:50:18+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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelClaimReasons/300100185730773",
		"name": "channelClaimReasons",
		"kind": "item"
	}
	]
}
Back to Top