Create split claims
post
/fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/splits
Request
Path Parameters
-
ClaimId(required): integer(int64)
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
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
-
Amount: number
Split claim amount.
-
ClaimId: integer
(int64)
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
-
ClaimReason: string
Maximum Length:
255
Reason for creating the split claim. -
ClaimReasonId: integer
(int64)
Value that uniquely identifies the reason to create the split claim.
-
ClaimType: string
Maximum Length:
255
Type of split claim. -
ClaimTypeId: integer
(int64)
Value that uniquely identifies the type of split claim.
-
CopyAttachmentsFromSourceClaimFlag: boolean
Maximum Length:
255
Contains one of the following values: true or false. If true, then the attachment from the source claim will be copied to the split claim. If false, then attachments won't be copied. The default value for this attribute is false. -
Owner: string
Maximum Length:
255
Name of the person who owns the split claim. -
OwnerId: integer
(int64)
Value that uniquely identifies the person who owns the split claim.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the split claim. -
Reference: string
Maximum Length:
50
Reference passed to the split claim. -
SplitClaimId: integer
(int64)
Value that uniquely identifies the split claim created in the application.
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 : channelCustomerClaims-splits-item-response
Type:
Show Source
object
-
AccountedSplitAmount: number
Read Only:
true
Split claim amount in the functional currency. -
Amount: number
Split claim amount.
-
AutomaticSplitFlag: string
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the split was a systematic split . If false, then it???s a user created split. There is no default value. -
ClaimId: integer
(int64)
Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
-
ClaimNumber: string
Read Only:
true
Maximum Length:30
Number that indicates the split claim. -
ClaimReason: string
Maximum Length:
255
Reason for creating the split claim. -
ClaimReasonId: integer
(int64)
Value that uniquely identifies the reason to create the split claim.
-
ClaimType: string
Maximum Length:
255
Type of split claim. -
ClaimTypeId: integer
(int64)
Value that uniquely identifies the type of split claim.
-
CopyAttachmentsFromSourceClaimFlag: boolean
Maximum Length:
255
Contains one of the following values: true or false. If true, then the attachment from the source claim will be copied to the split claim. If false, then attachments won't be copied. The default value for this attribute is false. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Owner: string
Maximum Length:
255
Name of the person who owns the split claim. -
OwnerId: integer
(int64)
Value that uniquely identifies the person who owns the split claim.
-
OwnerPersonNumber: string
Maximum Length:
255
Number that uniquely identifies the person who owns the split claim. -
Reference: string
Maximum Length:
50
Reference passed to the split claim. -
SplitClaimId: integer
(int64)
Value that uniquely identifies the split claim created in the application.
-
Status: string
Read Only:
true
Maximum Length:255
Status of the split claim. -
StatusId: integer
(int64)
Read Only:
true
Value that uniquely identifies the status of the split claim. -
SystemStatus: string
Read Only:
true
Maximum Length:255
System status of the channel claim. -
SystemStatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the system status of the claim.
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.
Links
- ClaimReasonLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ClaimReason; Target Attribute: ReasonCodeName
- Display Attribute: ReasonCodeName
- ClaimTypeLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: ClaimType; Target Attribute: ClaimTypeName
- Display Attribute: ClaimTypeName
- OwnersLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: Owner; Target Attribute: Name
- Display Attribute: Name, PersonNumber