Create claim sources
post
/fscmRestApi/resources/11.13.18.05/channelClaimSources
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
-
ClaimClass: string
Name of the predefined claim class. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_CLASS.
-
ClaimClassCode(required): string
Maximum Length:
30
Abbreviation that identifies the predefined claim class. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_CLASS. -
ClaimPrefix(required): string
Maximum Length:
5
Prefix of the claim number when creating the claim. -
ClaimSource: string
Name of the predefined claim sources. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_SOURCE.
-
ClaimSourceCode(required): string
Maximum Length:
30
Abbreviation that identifies the predefined claim sources. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_SOURCE. -
DefaultClaimReason: string
Default name of the claim reason that is used when creating a claim.
-
DefaultClaimReasonId: integer
(int64)
Value that uniquely identifies the claim reason that is used when creating a claim.
-
DefaultClaimType: string
Default name of the claim type that is used when creating a claim.
-
DefaultClaimTypeId: integer
(int64)
Value that uniquely identifies the claim type that is used when creating a claim.
-
Description: string
Maximum Length:
1000
Description of the channel claim source mapping. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the claim source mapping is enabled. If false, then the claim source mapping is not enabled. This attribute does not have a default value. -
SeededFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the claim source mapping is predefined. If false, then the claim source mapping is not predefined. This attribute does not have a default value. -
SetCode: string
Abbreviation that identifies the reference data set to which claim source mapping is assigned to.
-
SetId(required): integer
(int64)
Value that uniquely identifies the reference data set to which channel claim source mapping is assigned to.
-
SetName: string
Name of the reference data set to which channel claim source mapping is assigned to.
-
settlementMethods: array
Settlement Methods
Title:
Settlement Methods
The Settlement Methods resource manages the claim settlement methods mapped to the claim source map identifier.
Nested Schema : Settlement Methods
Type:
array
Title:
Settlement Methods
The Settlement Methods resource manages the claim settlement methods mapped to the claim source map identifier.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AccountingFor: string
Name of the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.
-
AccountingForCode: string
Maximum Length:
30
Abbreviation that identifies the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods. -
DefaultFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then set the settlement method as the default settlement method for the claim source mapping. If false, then do not set the settlement method as the default settlement method for the claims source mapping. This attribute does not have a default value. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the settlement method is enabled in the claim source mapping. If false, then the settlement method is not enabled. This attribute does not have a default value. -
SeededFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the settlement method is predefined. If false, then the settlement method is not predefined. This attribute does not have a default value. -
SettlementMethod: string
Name of claim settlement method added to the claim source mapping.
-
SettlementMethodCode: string
Maximum Length:
30
Abbreviation that identifies the settlement method added to the claim source mapping.
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 : channelClaimSources-item-response
Type:
Show Source
object
-
ClaimClass: string
Name of the predefined claim class. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_CLASS.
-
ClaimClassCode: string
Maximum Length:
30
Abbreviation that identifies the predefined claim class. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_CLASS. -
ClaimPrefix: string
Maximum Length:
5
Prefix of the claim number when creating the claim. -
ClaimSource: string
Name of the predefined claim sources. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_SOURCE.
-
ClaimSourceCode: string
Maximum Length:
30
Abbreviation that identifies the predefined claim sources. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_SOURCE. -
ClaimSourceMapId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel claim source mapping. It is a primary key that the application generates when it creates the claim source mapping. -
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. -
DefaultClaimReason: string
Default name of the claim reason that is used when creating a claim.
-
DefaultClaimReasonId: integer
(int64)
Value that uniquely identifies the claim reason that is used when creating a claim.
-
DefaultClaimType: string
Default name of the claim type that is used when creating a claim.
-
DefaultClaimTypeId: integer
(int64)
Value that uniquely identifies the claim type that is used when creating a claim.
-
Description: string
Maximum Length:
1000
Description of the channel claim source mapping. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the claim source mapping is enabled. If false, then the claim source mapping is not enabled. This attribute does not have a default value. -
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. -
SeededFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the claim source mapping is predefined. If false, then the claim source mapping is not predefined. This attribute does not have a default value. -
SetCode: string
Abbreviation that identifies the reference data set to which claim source mapping is assigned to.
-
SetId: integer
(int64)
Value that uniquely identifies the reference data set to which channel claim source mapping is assigned to.
-
SetName: string
Name of the reference data set to which channel claim source mapping is assigned to.
-
settlementMethods: array
Settlement Methods
Title:
Settlement Methods
The Settlement Methods resource manages the claim settlement methods mapped to the claim source map identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Settlement Methods
Type:
array
Title:
Settlement Methods
The Settlement Methods resource manages the claim settlement methods mapped to the claim source map identifier.
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.
Nested Schema : channelClaimSources-settlementMethods-item-response
Type:
Show Source
object
-
AccountingFor: string
Name of the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.
-
AccountingForCode: string
Maximum Length:
30
Abbreviation that identifies the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods. -
ClaimSourceMapId: integer
(int64)
Read Only:
true
Value that uniquely identifies the channel claim source mapping. -
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. -
DefaultFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then set the settlement method as the default settlement method for the claim source mapping. If false, then do not set the settlement method as the default settlement method for the claims source mapping. This attribute does not have a default value. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:false
Contains one of the following values: true or false. If true, then the settlement method is enabled in the claim source mapping. If false, then the settlement method is not enabled. This attribute does not have a default value. -
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. -
SeededFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the settlement method is predefined. If false, then the settlement method is not predefined. This attribute does not have a default value. -
SettlementMethod: string
Name of claim settlement method added to the claim source mapping.
-
SettlementMethodCode: string
Maximum Length:
30
Abbreviation that identifies the settlement method added to the claim source mapping. -
SourceSettlementMethodId: integer
(int64)
Read Only:
true
Value that uniquely identifies the settlement method added to a claim source mapping. It is a primary key that the application generates when it creates the settlement method.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- settlementMethods
-
Operation: /fscmRestApi/resources/11.13.18.05/channelClaimSources/{ClaimSourceMapId}/child/settlementMethodsParameters:
- ClaimSourceMapId:
$request.path.ClaimSourceMapId
The Settlement Methods resource manages the claim settlement methods mapped to the claim source map identifier. - ClaimSourceMapId:
Examples
This example describes how to create claim sources.
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/channelClaimSources"
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.
{ "SetName": "Vision Operations Set", "ClaimSource": "Supplier Ship and Debit - Claim", "ClaimSourceCode": "SSD_CLAIM", "ClaimClass": "Claim", "ClaimClassCode": "CLAIM", "ClaimPrefix": "CLA", "DefaultClaimType": "Vendor Claim", "DefaultClaimReason": "Agreement Performed", "EnabledFlag": true }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "SetId": 204, "SetCode": "Vision Operations 204", "SetName": "Vision Operations Set", "ClaimSource": "Supplier Ship and Debit - Claim", "ClaimSourceCode": "SSD_CLAIM", "ClaimSourceMapId": 300100181565229, "ClaimClass": "Claim", "ClaimClassCode": "CLAIM", "Description": null, "ClaimPrefix": "CLA", "DefaultClaimType": "Vendor Claim", "DefaultClaimTypeId": 300100185728700, "DefaultClaimReason": "Agreement Performed", "DefaultClaimReasonId": 300100185730773, "EnabledFlag": true, "CreatedBy": "channel_user", "CreationDate": "2019-08-29T08:30:03+00:00", "LastUpdatedBy": "channel_user", "LastUpdateDate": "2020-06-01T06:42:44+00:00", "SeededFlag": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/300100181565229", "name": "channelClaimSources", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelClaimSources/300100181565229", "name": "channelClaimSources", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelClaimSources/300100181565229/child/settlementMethods", "name": "settlementMethods", "kind": "collection" } ] }