Jump to

• Request
• Response

Get all payroll components and component groups

get

/hcmRestApi/resources/11.13.18.05/payrollComponentsAndComponentGroups

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds payroll components and component groups with the specified primary key.
    Finder Variables
    • DeductionTypeId; integer; Primary key value of the deduction type identifier.
  • findByDeductionType Finds payroll components and component groups that match the specified deduction type.
    Finder Variables
    • DeductionTypeId; integer; Search by deduction type identifier.
  • findByLdg Finds payroll components and component groups that match the specified LDG.
    Finder Variables
    • LegislativeDataGroupId; integer; Search by LDG ID
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BaseDeductionTypeId; integer; Unique identifier of the base deduction type of the payroll component or component group.
  • BaseName; string; Base name of the payroll component or component group.
  • CreatedBy; string; User who created the payroll component or component group.
  • CreationDate; string; The date when the payroll component or component group was created.
  • DeductionCode; string; Code that identifies the deduction for the payroll component or component group.
  • DeductionGroupId; integer; Unique identifier of the deduction group of the payroll component or component group.
  • DeductionTypeId; integer; Unique identifier of the deduction type of the payroll component or component group.
  • DisplaySequence; integer; Sequence that controls the display order of the payroll component or component group.
  • LastUpdateDate; string; The date when the payroll component or component group was last updated.
  • LastUpdateLogin; string; Last login to update the payroll component or component group.
  • LastUpdatedBy; string; User who last updated the payroll component or component group.
  • LegislationCode; string; Code that identifies the legislation of the payroll component or component group.
  • LegislativeDataGroupId; integer; Unique identifier of the legislative data group of the payroll component or component group.
  • ModuleId; string; Unique identifier of the module of the payroll component or component group.
  • Name; string; Name of the payroll component or component group.
  • ObjectVersionNumber; integer; Version number of the payroll component or component group.
  • SeedStatus; string; Status of the predefined record of the payroll component or component group.
  • UseAllTaxUnits; string; Indicates whether all tax reporting units are used.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object payrollComponentsAndComponentGroups-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-item-response"
    }
}

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

Type: object

Show Source

• BaseDeductionTypeId: integer (int64)
  Title: Global Deduction

  Unique identifier of the base deduction type of the payroll component or component group.
• BaseName: string
  Maximum Length: 240

  Base name of the payroll component or component group.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the payroll component or component group.
• CreationDate: string (date-time)
  Read Only: true

  The date when the payroll component or component group was created.
• DeductionCode: string
  Title: Short Name

  Maximum Length: 240

  Code that identifies the deduction for the payroll component or component group.
• DeductionContextUsageRest: array Deduction Context Usage
  Title: Deduction Context Usage

  The DeductionContextUsageRest resource provides access to deduction context usage
• DeductionElementTypeRestD: array Deduction Element Type
  Title: Deduction Element Type

  The DeductionElementTypeRestD resource provides access to deduction element type.
• DeductionGroupId: integer (int64)
  Title: Component Group

  Unique identifier of the deduction group of the payroll component or component group.
• DeductionGroupRest: array Deduction Group
  Title: Deduction Group

  The DeductionGroupRest resourceProvides access to deduction group.
• DeductionReportUseRest: array Deduction Report Use
  Title: Deduction Report Use

  The DeductionReportUseRest resource provides access to deduction report use.
• DeductionTypeId: integer (int64)
  Unique identifier of the deduction type of the payroll component or component group.
• DisplaySequence: integer (int64)
  Title: Sequence in Component Group

  Sequence that controls the display order of the payroll component or component group.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the payroll component or component group was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the payroll component or component group.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last login to update the payroll component or component group.
• LegislationCode: string
  Title: Country

  Maximum Length: 30

  Code that identifies the legislation of the payroll component or component group.
• LegislationDiscriminator: string
  Title: Country

  Read Only: true

  Value that distinguishes the legislation context of the payroll component or component group.
• LegislativeDataGroupId: integer (int64)
  Title: Legislative Data Group

  Unique identifier of the legislative data group of the payroll component or component group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  Unique identifier of the module of the payroll component or component group.
• Name: string
  Title: Name

  Maximum Length: 240

  Name of the payroll component or component group.
• ObjectVersionNumber: integer (int32)
  Version number of the payroll component or component group.
• SeedStatus: string
  Maximum Length: 1

  Status of the predefined record of the payroll component or component group.
• UseAllTaxUnits: string
  Title: All tax reporting units

  Maximum Length: 30

  Default Value: true

  Indicates whether all tax reporting units are used.

{
    "type":"object",
    "properties":{
        "BaseDeductionTypeId":{
            "title":"Global Deduction",
            "type":"integer",
            "description":"Unique identifier of the base deduction type of the payroll component or component group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseName":{
            "maxLength":240,
            "type":"string",
            "description":"Base name of the payroll component or component group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"S"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the payroll component or component group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the payroll component or component group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeductionCode":{
            "title":"Short Name",
            "maxLength":240,
            "type":"string",
            "description":"Code that identifies the deduction for the payroll component or component group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"S"
            },
            "x-queryable":true
        },
        "DeductionContextUsageRest":{
            "title":"Deduction Context Usage",
            "type":"array",
            "description":"The DeductionContextUsageRest resource provides access to deduction context usage",
            "items":{
                "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionContextUsageRest-item-response"
            }
        },
        "DeductionElementTypeRestD":{
            "title":"Deduction Element Type",
            "type":"array",
            "description":"The DeductionElementTypeRestD resource provides access to deduction element type.",
            "items":{
                "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionElementTypeRestD-item-response"
            }
        },
        "DeductionGroupId":{
            "title":"Component Group",
            "type":"integer",
            "description":"Unique identifier of the deduction group of the payroll component or component group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "HCM_SEED_DATA_EXTEND_MODE":"S"
            },
            "x-queryable":true
        },
        "DeductionGroupRest":{
            "title":"Deduction Group",
            "type":"array",
            "description":"The DeductionGroupRest resourceProvides access to deduction group.",
            "items":{
                "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionGroupRest-item-response"
            }
        },
        "DeductionReportUseRest":{
            "title":"Deduction Report Use",
            "type":"array",
            "description":"The DeductionReportUseRest resource provides access to deduction report use.",
            "items":{
                "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionReportUseRest-item-response"
            }
        },
        "DeductionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the deduction type of the payroll component or component group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Sequence in Component Group",
            "type":"integer",
            "description":"Sequence that controls the display order of the payroll component or component group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "HCM_SEED_DATA_EXTEND_MODE":"S"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the payroll component or component group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last login to update the payroll component or component group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the payroll component or component group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the legislation of the payroll component or component group.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislationDiscriminator":{
            "title":"Country",
            "type":"string",
            "description":"Value that distinguishes the legislation context of the payroll component or component group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LegislationCode",
                    "LegislativeDataGroupId"
                ]
            }
        },
        "LegislativeDataGroupId":{
            "title":"Legislative Data Group",
            "type":"integer",
            "description":"Unique identifier of the legislative data group of the payroll component or component group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the module of the payroll component or component group.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the payroll component or component group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"C"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the payroll component or component group.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SeedStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the predefined record of the payroll component or component group.",
            "nullable":true,
            "x-queryable":true
        },
        "UseAllTaxUnits":{
            "title":"All tax reporting units",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether all tax reporting units are used.",
            "nullable":false,
            "default":"true",
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"S"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Deduction Context Usage

Type: array

Title: Deduction Context Usage

The DeductionContextUsageRest resource provides access to deduction context usage

Show Source

• Array of: object payrollComponentsAndComponentGroups-DeductionContextUsageRest-item-response

{
    "title":"Deduction Context Usage",
    "type":"array",
    "description":"The DeductionContextUsageRest resource provides access to deduction context usage",
    "items":{
        "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionContextUsageRest-item-response"
    }
}

Nested Schema : Deduction Element Type

Type: array

Title: Deduction Element Type

The DeductionElementTypeRestD resource provides access to deduction element type.

Show Source

• Array of: object payrollComponentsAndComponentGroups-DeductionElementTypeRestD-item-response

{
    "title":"Deduction Element Type",
    "type":"array",
    "description":"The DeductionElementTypeRestD resource provides access to deduction element type.",
    "items":{
        "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionElementTypeRestD-item-response"
    }
}

Nested Schema : Deduction Group

Type: array

Title: Deduction Group

The DeductionGroupRest resourceProvides access to deduction group.

Show Source

• Array of: object payrollComponentsAndComponentGroups-DeductionGroupRest-item-response

{
    "title":"Deduction Group",
    "type":"array",
    "description":"The DeductionGroupRest resourceProvides access to deduction group.",
    "items":{
        "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionGroupRest-item-response"
    }
}

Nested Schema : Deduction Report Use

Type: array

Title: Deduction Report Use

The DeductionReportUseRest resource provides access to deduction report use.

Show Source

• Array of: object payrollComponentsAndComponentGroups-DeductionReportUseRest-item-response

{
    "title":"Deduction Report Use",
    "type":"array",
    "description":"The DeductionReportUseRest resource provides access to deduction report use.",
    "items":{
        "$ref":"#/components/schemas/payrollComponentsAndComponentGroups-DeductionReportUseRest-item-response"
    }
}

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

Type: object

Show Source

• ContextId: integer (int64)
  Title: Reference

  Unique identifier of the context of the deduction context usage.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the deduction context usage.
• CreationDate: string (date-time)
  Read Only: true

  The date when the deduction context usage was created.
• DeductionContextUsageId: integer (int64)
  Unique identifier of the deduction context usage.
• DeductionTypeId: integer (int64)
  Unique identifier of the deduction type of the deduction context usage.
• DirCardCOMPDefiId: integer (int64)
  Unique identifier of the calculation card component definition of the deduction context usage.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the deduction context usage.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Last login to update the deduction context usage.
• LegislationCode: string
  Maximum Length: 30

  Code that identifies the legislation of the deduction context usage.
• LegislativeDataGroupId: integer (int64)
  Unique identifier of the legislative data group of the deduction context usage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  Unique identifier of the module.
• NavigationUse: string
  Title: Display in Overview

  Maximum Length: 30

  Default Value: false

  Purpose of the navigation use.
• ObjectVersionNumber: integer (int32)
  Version number of the deduction context usage.
• SeedStatus: string
  Maximum Length: 1

  Status of the predefined record of the deduction context usage.
• Sequence: integer (int64)
  Title: Sequence

  Default Value: 1

  Sequence number for deduction context usage.
• SGUID: string
  Maximum Length: 32

  Unique identifier for the deduction context usage.
• SpecialPurpose: string
  Maximum Length: 30

  Special purpose of the deduction context usage.
• UsageType: string
  Maximum Length: 30

  Default Value: C

  Type of usage for the deduction context usage.

{
    "type":"object",
    "properties":{
        "ContextId":{
            "title":"Reference",
            "type":"integer",
            "description":"Unique identifier of the context of the deduction context usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the deduction context usage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the deduction context usage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeductionContextUsageId":{
            "type":"integer",
            "description":"Unique identifier of the deduction context usage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeductionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the deduction type of the deduction context usage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirCardCOMPDefiId":{
            "type":"integer",
            "description":"Unique identifier of the calculation card component definition of the deduction context usage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Last login to update the deduction context usage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the deduction context usage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the legislation of the deduction context usage.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group of the deduction context usage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the module.",
            "nullable":true,
            "x-queryable":true
        },
        "NavigationUse":{
            "title":"Display in Overview",
            "maxLength":30,
            "type":"string",
            "description":"Purpose of the navigation use.",
            "nullable":true,
            "default":"false",
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the deduction context usage.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SGUID":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier for the deduction context usage.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the predefined record of the deduction context usage.",
            "nullable":true,
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number for deduction context usage.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SpecialPurpose":{
            "maxLength":30,
            "type":"string",
            "description":"Special purpose of the deduction context usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UsageType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of usage for the deduction context usage.",
            "nullable":false,
            "default":"C",
            "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."
        }
    }
}

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

Type: object

Show Source

• BaseDeductionGroupId: integer (int64)
  Unique identifier of the base deduction group.
• BaseName: string
  Title: Name

  Maximum Length: 240

  Name of the base deduction group.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the deduction group.
• CreationDate: string (date-time)
  Read Only: true

  The date when the deduction group was created.
• DeductionGroupId: integer (int64)
  Unique identifier of the deduction group.
• DeductionGroupIdForFk: integer (int64)
  Read Only: true

  Unique identifier of the deduction group foreign key.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the deduction group was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the deduction group.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign in used for the last update.
• LegislationCode: string
  Title: Country

  Maximum Length: 30

  Code that identifies the legislation of the deduction group.
• LegislativeDataGroupId: integer
  Read Only: true

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

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  Unique identifier of the module of the deduction group.
• Name: string
  Title: Component Group

  Maximum Length: 240

  Name of the deduction group.
• ObjectVersionNumber: integer (int32)
  Version number of the deduction group record.
• SeedStatus: string
  Maximum Length: 1

  Status of the predefined deduction group.

{
    "type":"object",
    "properties":{
        "BaseDeductionGroupId":{
            "type":"integer",
            "description":"Unique identifier of the base deduction group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BaseName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the base deduction group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"S"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the deduction group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the deduction group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeductionGroupId":{
            "type":"integer",
            "description":"Unique identifier of the deduction group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeductionGroupIdForFk":{
            "type":"integer",
            "description":"Unique identifier of the deduction group foreign key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the deduction group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Sign in used for the last update.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the deduction group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegislationCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies the legislation of the deduction group.",
            "nullable":true,
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group of the deduction group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of the module of the deduction group.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Component Group",
            "maxLength":240,
            "type":"string",
            "description":"Name of the deduction group.",
            "nullable":false,
            "x-hints":{
                "HCM_SEED_DATA_EXTEND_MODE":"C"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the deduction group record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "SeedStatus":{
            "maxLength":1,
            "type":"string",
            "description":"Status of the predefined deduction group.",
            "nullable":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 : payrollComponentsAndComponentGroups-DeductionReportUseRest-item-response

Type: object

Show Source

• DednReportUseId: integer (int64)
  Unique identifier of the deduction report use.
• DeductionTypeId: integer (int64)
  Unique identifier of the deduction type of the deduction report.
• Editable: string
  Read Only: true

  Default Value: Y

  Type of action for assigned payroll such as add, edit or transfer.
• LegislativeDataGroupId: integer (int64)
  Unique identifier of the legislative data group of the deduction report.
• links: array Links
  Title: Links

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

  Version number of the deduction report use record.
• RowEditable: string
  Type of action for assigned payroll such as add, edit or transfer.
• TaxUnitId: integer (int64)
  Title: Name

  Unique identifier of the tax reporting unit of the deduction report.

{
    "type":"object",
    "properties":{
        "DednReportUseId":{
            "type":"integer",
            "description":"Unique identifier of the deduction report use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeductionTypeId":{
            "type":"integer",
            "description":"Unique identifier of the deduction type of the deduction report.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Editable":{
            "type":"string",
            "description":"Type of action for assigned payroll such as add, edit or transfer.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":true
        },
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group of the deduction report.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number of the deduction report use record.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "RowEditable":{
            "type":"string",
            "description":"Type of action for assigned payroll such as add, edit or transfer.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxUnitId":{
            "title":"Name",
            "type":"integer",
            "description":"Unique identifier of the tax reporting unit of the deduction report.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Back to Top