Jump to

• Request
• Response
• Examples

Create an assigned payroll

post

/hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls

Request

Path Parameters

• payrollAssignmentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Payroll Assignments resource and used to uniquely identify an instance of Payroll Assignments. The client should not generate the hash key value. Instead, the client should query on the Payroll Assignments collection resource in order to navigate to a specific instance of Payroll Assignments to get the hash key.
• payrollRelationshipsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Payroll Relationships resource and used to uniquely identify an instance of Payroll Relationships. The client should not generate the hash key value. Instead, the client should query on the Payroll Relationships collection resource in order to navigate to a specific instance of Payroll Relationships to get the hash key.

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• assignedPayrollDates: array Assigned Payroll Dates
  Title: Assigned Payroll Dates

  The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.
• AssignedPayrollId: integer (int64)
  Unique identifier used to retrieve the assigned payroll record for an assignment.
• EffectiveEndDate(required): string (date)
  Title: Effective End Date

  Date at the end of the date range within which the payroll is effective.
• EffectiveStartDate(required): string (date)
  Title: Effective Start Date

  Date at the beginning of the date range within which the payroll is effective.
• EndDate(required): string (date)
  Title: End Date

  End date of the payroll assigned to the assignment.
• Lsed: string (date)
  Title: Close Date

  Last standard earning date of the payroll assigned to the assignment.
• OverridingPeriodId: integer (int64)
  Title: Overtime Period

  Overtime period for all assignments associated to the payroll, such as the FLSA period for US employees.
• PayrollId(required): integer (int64)
  Unique identifier for the payroll, such as the weekly payroll.
• StartDate(required): string (date)
  Title: Start Date

  Start date of the payroll assigned to the assignment.
• TimeCardRequired: string
  Title: Time Card Required

  Maximum Length: 30

  Associated with all assignments for a given payroll. Indicates whether the assignment must submit time cards for payroll purposes.

{
    "required":[
        "EffectiveEndDate",
        "EffectiveStartDate",
        "EndDate",
        "PayrollId",
        "StartDate"
    ],
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the payroll assigned to the assignment.",
            "format":"date",
            "nullable":false
        },
        "OverridingPeriodId":{
            "title":"Overtime Period",
            "type":"integer",
            "description":"Overtime period for all assignments associated to the payroll, such as the FLSA period for US employees.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "assignedPayrollDates":{
            "title":"Assigned Payroll Dates",
            "type":"array",
            "description":"The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.",
            "items":{
                "$ref":"#/components/schemas/payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-post-request"
            }
        },
        "TimeCardRequired":{
            "title":"Time Card Required",
            "maxLength":30,
            "type":"string",
            "description":"Associated with all assignments for a given payroll. Indicates whether the assignment must submit time cards for payroll purposes.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Lsed":{
            "title":"Close Date",
            "type":"string",
            "description":"Last standard earning date of the payroll assigned to the assignment.",
            "format":"date",
            "nullable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the date range within which the payroll is effective.",
            "format":"date",
            "nullable":false
        },
        "AssignedPayrollId":{
            "type":"integer",
            "description":"Unique identifier used to retrieve the assigned payroll record for an assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the payroll assigned to the assignment.",
            "format":"date",
            "nullable":false
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the date range within which the payroll is effective.",
            "format":"date",
            "nullable":false
        },
        "PayrollId":{
            "type":"integer",
            "description":"Unique identifier for the payroll, such as the weekly payroll.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Assigned Payroll Dates

Type: array

Title: Assigned Payroll Dates

The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.

Show Source

• Array of: object payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-post-request

{
    "title":"Assigned Payroll Dates",
    "type":"array",
    "description":"The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.",
    "items":{
        "$ref":"#/components/schemas/payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-post-request"
    }
}

Nested Schema : payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-post-request

Type: object

Show Source

• DateValue: string (date)
  Title: Termination Rule

  The date for the given time definition.
• PayDateId: integer (int64)
  Unique identifier used to retrieve a date, such as the payroll's last standard earnings date. The date is derived based on a time definition.

{
    "type":"object",
    "properties":{
        "PayDateId":{
            "type":"integer",
            "description":"Unique identifier used to retrieve a date, such as the payroll's last standard earnings date. The date is derived based on a time definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "DateValue":{
            "title":"Termination Rule",
            "type":"string",
            "description":"The date for the given time definition.",
            "format":"date",
            "nullable":false
        }
    }
}

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 : payrollRelationships-payrollAssignments-assignedPayrolls-item-response

Type: object

Show Source

• assignedPayrollDates: array Assigned Payroll Dates
  Title: Assigned Payroll Dates

  The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.
• AssignedPayrollId: integer (int64)
  Unique identifier used to retrieve the assigned payroll record for an assignment.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  Date at the end of the date range within which the payroll is effective.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  Date at the beginning of the date range within which the payroll is effective.
• EndDate: string (date)
  Title: End Date

  End date of the payroll assigned to the assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Lsed: string (date)
  Title: Close Date

  Last standard earning date of the payroll assigned to the assignment.
• OverridingPeriodId: integer (int64)
  Title: Overtime Period

  Overtime period for all assignments associated to the payroll, such as the FLSA period for US employees.
• PayrollId: integer (int64)
  Unique identifier for the payroll, such as the weekly payroll.
• StartDate: string (date)
  Title: Start Date

  Start date of the payroll assigned to the assignment.
• TimeCardRequired: string
  Title: Time Card Required

  Maximum Length: 30

  Associated with all assignments for a given payroll. Indicates whether the assignment must submit time cards for payroll purposes.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the payroll assigned to the assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OverridingPeriodId":{
            "title":"Overtime Period",
            "type":"integer",
            "description":"Overtime period for all assignments associated to the payroll, such as the FLSA period for US employees.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "assignedPayrollDates":{
            "title":"Assigned Payroll Dates",
            "type":"array",
            "description":"The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.",
            "items":{
                "$ref":"#/components/schemas/payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-response"
            }
        },
        "TimeCardRequired":{
            "title":"Time Card Required",
            "maxLength":30,
            "type":"string",
            "description":"Associated with all assignments for a given payroll. Indicates whether the assignment must submit time cards for payroll purposes.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Lsed":{
            "title":"Close Date",
            "type":"string",
            "description":"Last standard earning date of the payroll assigned to the assignment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"Date at the end of the date range within which the payroll is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssignedPayrollId":{
            "type":"integer",
            "description":"Unique identifier used to retrieve the assigned payroll record for an assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the payroll assigned to the assignment.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"Date at the beginning of the date range within which the payroll is effective.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PayrollId":{
            "type":"integer",
            "description":"Unique identifier for the payroll, such as the weekly payroll.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Assigned Payroll Dates

Type: array

Title: Assigned Payroll Dates

The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.

Show Source

• Array of: object payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-response

{
    "title":"Assigned Payroll Dates",
    "type":"array",
    "description":"The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.",
    "items":{
        "$ref":"#/components/schemas/payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-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 : payrollRelationships-payrollAssignments-assignedPayrolls-assignedPayrollDates-item-response

Type: object

Show Source

• DateValue: string (date)
  Title: Termination Rule

  The date for the given time definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayDateId: integer (int64)
  Unique identifier used to retrieve a date, such as the payroll's last standard earnings date. The date is derived based on a time definition.
• ShortName: string
  Read Only: true

  Maximum Length: 30

  Short name of the time definition.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ShortName":{
            "maxLength":30,
            "type":"string",
            "description":"Short name of the time definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayDateId":{
            "type":"integer",
            "description":"Unique identifier used to retrieve a date, such as the payroll's last standard earnings date. The date is derived based on a time definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DateValue":{
            "title":"Termination Rule",
            "type":"string",
            "description":"The date for the given time definition.",
            "format":"date",
            "nullable":false,
            "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

TimeCardRequiredLOV

Operation: /fscmRestApi/resources/11.13.18.05/commonLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: TimeCardRequired; Target Attribute: LookupCode
• Display Attribute: Meaning

assignedPayrollDates

Operation: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/child/assignedPayrollDates

Parameters:

• assignedPayrollsUniqID: $request.path.assignedPayrollsUniqID
• payrollAssignmentsUniqID: $request.path.payrollAssignmentsUniqID
• payrollRelationshipsUniqID: $request.path.payrollRelationshipsUniqID

The assignedPayrollDates resource is a child of the assignedPayrollDetails resource.It includes a list of all element duration dates for the given assigned payroll.

transferPayroll

Operation: /hcmRestApi/resources/11.13.18.05/payrollRelationships/{payrollRelationshipsUniqID}/child/payrollAssignments/{payrollAssignmentsUniqID}/child/assignedPayrolls/{assignedPayrollsUniqID}/action/transferPayroll

Parameters:

• assignedPayrollsUniqID: $request.path.assignedPayrollsUniqID
• payrollAssignmentsUniqID: $request.path.payrollAssignmentsUniqID
• payrollRelationshipsUniqID: $request.path.payrollRelationshipsUniqID

Assigns the payroll of a person with the new payroll passed. The existing payroll assigned to the person is closed.

Back to Top

Examples

The following example shows how to create an assigned payroll by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/payrollRelationships/00020000000EACED00057708000110F07B4AC8740000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B597419030000787077080000016A2DBE300078/child/payrollAssignments/00040000000EACED00057708000110F07B4AC8790000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000125E72E7800780000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800004EB9F6DD1400780000000EACED00057708000110F07B4AC879/child/assignedPayrolls

Example of Payload

The following is an example of the payload.

{ 
        "PayrollId": 300100072065867, 
        "StartDate": "2015-01-01", 
        "EffectiveStartDate": "2015-01-01" 
}

Example of Response Header

The following is an example of the response header.

HTTP/1.1 201  Created
Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
  "AssignedPayrollId" : 300100188296335,
  "PayrollId" : 300100072065867,
  "StartDate" : "2015-01-01",
  "EndDate" : "4712-12-31",
  "TimeCardRequired" : null,
  "OverridingPeriodId" : null,
  "EffectiveStartDate" : "2015-01-01",
  "EffectiveEndDate" : "4712-12-31",
  "Lsed" : null,
  "links": [
        {
          ...}
   ]
}

Back to Top