Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "Owner":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the person who owns the split claim.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "CopyAttachmentsFromSourceClaimFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "Reference":{
            "maxLength":"50",
            "type":"string",
            "description":"Reference passed to the split claim.",
            "nullable":true
        },
        "Amount":{
            "type":"number",
            "description":"Split claim amount.",
            "nullable":true
        },
        "OwnerPersonNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the split claim.",
            "nullable":true
        },
        "ClaimTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of split claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "SplitClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the split claim created in the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "ClaimType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of split claim.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "ClaimReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reason to create the split claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "ClaimReason":{
            "maxLength":"255",
            "type":"string",
            "description":"Reason for creating the split claim.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the split claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : channelCustomerClaims-splits-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Owner":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the person who owns the split claim.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CopyAttachmentsFromSourceClaimFlag":{
            "maxLength":"255",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SplitClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the split claim created in the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountedSplitAmount":{
            "type":"number",
            "description":"Split claim amount in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimType":{
            "maxLength":"255",
            "type":"string",
            "description":"Type of split claim.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ClaimReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reason to create the split claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ClaimReason":{
            "maxLength":"255",
            "type":"string",
            "description":"Reason for creating the split claim.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the split claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Status":{
            "maxLength":"255",
            "type":"string",
            "description":"Status of the split claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"System status of the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that indicates the split claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Reference":{
            "maxLength":"50",
            "type":"string",
            "description":"Reference passed to the split claim.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the system status of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Split claim amount.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerPersonNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the split claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of split claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AutomaticSplitFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the split claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"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

Back to Top