Jump to

• Request
• Response

Update a deduction element type

patch

/hcmRestApi/resources/11.13.18.05/payrollComponentsAndComponentGroups/{DeductionTypeId}/child/DeductionElementTypeRestD/{DeductionElementTypeRestDUniqID}

Request

Path Parameters

• DeductionElementTypeRestDUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- EffectiveEndDate, EffectiveStartDate and ElementTypeId ---for the Deduction Element Type resource and used to uniquely identify an instance of Deduction Element Type. The client should not generate the hash key value. Instead, the client should query on the Deduction Element Type collection resource with a filter on the primary key values in order to navigate to a specific instance of Deduction Element Type.
  
  For example: DeductionElementTypeRestD?q=EffectiveEndDate=<value1>;EffectiveStartDate=<value2>;ElementTypeId=<value3>
• DeductionTypeId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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

• SystemEffectiveDate: string (date)
  System effective data of the deduction element type.

{
    "type":"object",
    "properties":{
        "SystemEffectiveDate":{
            "type":"string",
            "description":"System effective data of the deduction element type.",
            "format":"date",
            "nullable":true
        }
    }
}

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 : payrollComponentsAndComponentGroups-DeductionElementTypeRestD-item-response

Type: object

Show Source

• BaseDeductionTypeId: integer (int64)
  Read Only: true

  Unique identifier of the base deduction type.
• BaseName: string
  Read Only: true

  Maximum Length: 240

  Name of the base deduction type.
• ClassificationName: string
  Read Only: true

  Maximum Length: 120

  Classification name of the element type in payroll component.
• DeductionCode: string
  Read Only: true

  Maximum Length: 240

  Code that identifies the deduction element type.
• DeductionGroupId: integer (int64)
  Read Only: true

  Unique identifier of the deduction group of the deduction element type.
• DeductionTypeId: integer (int64)
  Read Only: true

  Unique identifier of the deduction type of the deduction element type.
• DeductionTypeIdEO: integer (int64)
  Read Only: true

  Unique identifier of the deduction type.
• DefaultingFormulaId: integer (int64)
  Read Only: true

  Unique identifier of the defaulting formula of the deduction element type.
• Description: string
  Read Only: true

  Maximum Length: 240

  Text that describes the deduction element type.
• EffectiveEndDate: string (date)
  Read Only: true

  The date when the deduction element type ends.
• EffectiveStartDate: string (date)
  Read Only: true

  The date when the deduction element type starts.
• ElementName: string
  Read Only: true

  Maximum Length: 80

  Name of the element of the deduction element type.
• ElementTypeId: integer (int64)
  Read Only: true

  Unique identifier of the element type of the deduction element type.
• EndingTimeDefId: integer (int64)
  Read Only: true

  Unique identifier of the ending time definition of the deduction element type.
• LegislationCode: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the legislation.
• LegislationCodeEO: string
  Read Only: true

  Maximum Length: 30

  Code that identifies the legislation of the deduction element type.
• LegislativeDataGroupId: integer (int64)
  Read Only: true

  Unique identifier of the legislative data group of the deduction element type.
• LegislativeDataGroupIdEO: integer (int64)
  Read Only: true

  Unique identifier of the legislative data group of the deduction element type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Version number of the deduction element type.
• ObjectVersionNumberEO: integer (int32)
  Read Only: true

  Version number of the deduction element type.
• SystemEffectiveDate: string (date)
  System effective data of the deduction element type.
• ValidationFormulaId: integer (int64)
  Read Only: true

  Unique identifier of the validation formula of the deduction element type.
• ValidationOverrideMessage: string
  Read Only: true

  Maximum Length: 30

  Validation override message of the deduction element type.

{
    "type":"object",
    "properties":{
        "BaseDeductionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the base deduction type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the base deduction type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationName":{
            "maxLength":120,
            "type":"string",
            "description":"Classification name of the element type in payroll component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeductionCode":{
            "maxLength":240,
            "type":"string",
            "description":"Code that identifies the deduction element type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Unique identifier of the deduction group of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeductionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the deduction type of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeductionTypeIdEO":{
            "type":"integer",
            "description":"Unique identifier of the deduction type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultingFormulaId":{
            "type":"integer",
            "description":"Unique identifier of the defaulting formula of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Text that describes the deduction element type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date when the deduction element type ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date when the deduction element type starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the element of the deduction element type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Unique identifier of the element type of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndingTimeDefId":{
            "type":"integer",
            "description":"Unique identifier of the ending time definition of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the legislation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCodeEO":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the legislation of the deduction element type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LegislativeDataGroupIdEO":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the deduction element type.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ObjectVersionNumberEO":{
            "type":"integer",
            "description":"Version number of the deduction element type.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SystemEffectiveDate":{
            "type":"string",
            "description":"System effective data of the deduction element type.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ValidationFormulaId":{
            "type":"integer",
            "description":"Unique identifier of the validation formula of the deduction element type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ValidationOverrideMessage":{
            "maxLength":30,
            "type":"string",
            "description":"Validation override message of the deduction element type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top