Get many labor schedule costs.
get
/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts
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 the labor schedule cost with the specified primary key.
Finder Variables- LdInterfaceId; integer; The unique identifier of the labor cost.
- findLaborScheduleCosts Finds labor schedule costs for a standard set of variables.
Finder Variables- assignmentId; integer; Finds labor schedule costs associated with the assignment identifier passed.
- awardId; integer; Finds labor schedule costs associated with the award identifier passed.
- awardNumber; string; Finds labor schedule costs associated with the award number passed.
- batchName; string; Finds labor schedule costs with the associated batch name.
- organizationId; integer; Finds labor schedule costs associated to the entered business unit.
- originalTransactionReference; string; Finds labor schedule costs associated with the original transaction reference value passed.
- payElementId; string; Finds labor schedule costs associated with the pay element type identifier passed.
- payPeriodStartFrom; string; The pay period start date for the labor cost.
- payPeriodStartTo; string; The pay period start date for the labor cost.
- payrollId; string; Finds labor schedule costs associated with the payroll identifier passed.
- payrollName; string; Finds labor schedule costs associated with the payroll name passed.
- personEmail; string; Finds labor schedule costs using the associated email address.
- personId; integer; Finds labor schedule costs associated to the person identifier passed.
- personName; string; Finds labor schedule costs associated to the person name passed.
- personNumber; string; Finds labor schedule costs associated to the person number passed.
- projectId; integer; Finds labor schedule costs associated to the project identifier passed.
- projectNumber; string; Finds labor schedule costs associated to the project number passed.
- statusCode; string; Finds labor schedule costs associated to the status code passed.
- transactionSource; string; Finds labor schedule costs associated with the transaction source code passed.
- PrimaryKey Finds the labor schedule cost with the specified primary key.
-
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:- AssignmentId; integer; Unique identifier of the assignment for this Person Assignment Labor Schedule header.
- AssignmentName; string; Name of the assignment for this Person Assignment Labor Schedule header.
- AssignmentNumber; string; Number of the assignment for this Person Assignment Labor Schedule header.
- BatchName; string; The user created batch name for this labor cost.
- CurrencyCode; string; The currency for this labor cost.
- DocumentCode; string; The document code associated with this cost. This will be Payroll_Costs if the cost is imported directly from Oracle Cloud Payroll.
- DocumentId; integer; The unique identifier of the transaction document associated with this cost.
- LdInterfaceId; integer; The unique identifier of the labor cost. This value can be used to connect the labor schedule costs and distributions rest services to get all distributions excluding the original distributions that were adjusted. To get all distributions including all adjustment records use the original reference value.
- NetZeroAdjustmentFlag; boolean; Indicates whether this cost is offsetting another cost and resulting in a total of zero. This is used for costs imported directly from Oracle Cloud Payroll.
- OrganizationId; integer; The business unit identifier derived from the person assignment.
- OriginalTransactionReference; string; A unique identifier for this cost from the generating source. This field should be used to connect the cost and all distributed costs on the labor schedules cost distributions rest service, including any adjustments that have been done.
- PayAmount; number; The amount of the labor cost.
- PayElement; string; The pay element for the labor cost.
- PayElementId; integer; The unique identifier of the payroll cost pay element type used in a labor schedule distributed cost.
- PayPeriodEndDate; string; The pay period end date for the labor cost.
- PayPeriodStartDate; string; The pay period start date for the labor cost.
- PayrollId; integer; The unique identifier of the payroll associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll.
- PayrollName; string; The payroll name associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll.
- PersonEmail; string; Email of the person.
- PersonId; integer; Unique identifier of the person.
- PersonName; string; Full name, first then last, of the person.
- PersonNumber; string; Human Resources number of the person.
- Status; string; The status value of the labor cost based on the distribution through the labor schedule.
- StatusCode; string; The status code of the labor cost based on distributing through the labor schedule.
- StatusSummary; string; The summary status for all error and success status codes.
- TransactionSource; string; The transaction source code associated with the cost.
- TransactionSourceId; integer; The unique identifier of the transaction source associated with this cost.
- UserTransactionSource; string; The transaction source name associated with the cost.
-
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:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : laborSchedulesCosts
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : laborSchedulesCosts-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
Unique identifier of the assignment for this Person Assignment Labor Schedule header. -
AssignmentName: string
Read Only:
true
Maximum Length:80
Name of the assignment for this Person Assignment Labor Schedule header. -
AssignmentNumber: string
Read Only:
true
Maximum Length:50
Number of the assignment for this Person Assignment Labor Schedule header. -
BatchName: string
Read Only:
true
Maximum Length:200
The user created batch name for this labor cost. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
The currency for this labor cost. -
DocumentCode: string
Read Only:
true
Maximum Length:20
The document code associated with this cost. This will be Payroll_Costs if the cost is imported directly from Oracle Cloud Payroll. -
DocumentId: integer
(int64)
Read Only:
true
The unique identifier of the transaction document associated with this cost. -
laborSchedulesCostDistributions: array
Labor Schedule Cost Distributions
Title:
Labor Schedule Cost Distributions
The Labor Schedule Cost Distributions resource used to see the distributions associated to a project, task, or raw labor cost. -
LdInterfaceId: integer
(int64)
Read Only:
true
The unique identifier of the labor cost. This value can be used to connect the labor schedule costs and distributions rest services to get all distributions excluding the original distributions that were adjusted. To get all distributions including all adjustment records use the original reference value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetZeroAdjustmentFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether this cost is offsetting another cost and resulting in a total of zero. This is used for costs imported directly from Oracle Cloud Payroll. -
OrganizationId: integer
(int64)
Read Only:
true
The business unit identifier derived from the person assignment. -
OriginalTransactionReference: string
Title:
Original Transaction Reference
Read Only:true
Maximum Length:120
A unique identifier for this cost from the generating source. This field should be used to connect the cost and all distributed costs on the labor schedules cost distributions rest service, including any adjustments that have been done. -
PayAmount: number
Read Only:
true
The amount of the labor cost. -
PayElement: string
Read Only:
true
Maximum Length:80
The pay element for the labor cost. -
PayElementId: integer
(int64)
Read Only:
true
The unique identifier of the payroll cost pay element type used in a labor schedule distributed cost. -
PayPeriodEndDate: string
(date)
Read Only:
true
The pay period end date for the labor cost. -
PayPeriodStartDate: string
(date)
Read Only:
true
The pay period start date for the labor cost. -
PayrollId: integer
(int64)
Read Only:
true
The unique identifier of the payroll associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll. -
PayrollName: string
Read Only:
true
Maximum Length:80
The payroll name associated with this cost. This value will exist if this cost is imported directly from Oracle Cloud Payroll. -
PersonEmail: string
Read Only:
true
Maximum Length:240
Email of the person. -
PersonId: integer
(int64)
Read Only:
true
Unique identifier of the person. -
PersonName: string
Read Only:
true
Maximum Length:240
Full name, first then last, of the person. -
PersonNumber: string
Read Only:
true
Maximum Length:30
Human Resources number of the person. -
Status: string
Read Only:
true
Maximum Length:3
The status value of the labor cost based on the distribution through the labor schedule. -
StatusCode: string
Read Only:
true
Maximum Length:3
The status code of the labor cost based on distributing through the labor schedule. -
StatusSummary: string
Read Only:
true
Maximum Length:80
The summary status for all error and success status codes. -
TransactionSource: string
Read Only:
true
Maximum Length:30
The transaction source code associated with the cost. -
TransactionSourceId: integer
(int64)
Read Only:
true
The unique identifier of the transaction source associated with this cost. -
UserTransactionSource: string
Read Only:
true
Maximum Length:240
The transaction source name associated with the cost.
Nested Schema : Labor Schedule Cost Distributions
Type:
array
Title:
Labor Schedule Cost Distributions
The Labor Schedule Cost Distributions resource used to see the distributions associated to a project, task, or raw labor cost.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : laborSchedulesCosts-laborSchedulesCostDistributions-item-response
Type:
Show Source
object
-
AssignmentId: integer
(int64)
Read Only:
true
Assignment identifier associated to the cost. -
AssignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Assignment name associated to the cost. -
AssignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Assignment number associated to the cost. -
BillableFlag: boolean
Read Only:
true
Maximum Length:1
Identifies if the charge is billable or not. -
CapitalizableFlag: boolean
Read Only:
true
Maximum Length:1
Information that indicates if a project-related item is eligible for capitalization. -
ContractId: integer
(int64)
Read Only:
true
Identifier of contract, used with Oracle Contract Billing or Oracle Grants Management. -
ContractLineId: integer
(int64)
Read Only:
true
Tracks contract line information. Not used currently. -
ContractName: string
Title:
Name
Read Only:true
Maximum Length:300
Name associated to the contract ID. -
ContractNumber: string
Title:
Number
Read Only:true
Maximum Length:120
Number associated to the contract ID. -
costDistributionErrors: array
Labor Schedule Cost Distribution Errors
Title:
Labor Schedule Cost Distribution Errors
The Labor Schedule Cost Distribution Errors resource used to see the errors associated to distributions for resolution. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
DifferentialDistributionFlag: boolean
Read Only:
true
Maximum Length:1
Identifies this cost distribution as the differential to sum up to one hundred percent of the labor cost, if labor schedule is less than one hundred percent. -
ErrorExistsFlag: boolean
Read Only:
true
Identifies whether this cost has errors to resolve. -
ExpenditureItemDate: string
(date)
Read Only:
true
Date on which a project-related transaction is incurred. -
ExpenditureItemId: integer
(int64)
Read Only:
true
Identifier of the expenditure created for this cost distribution. -
ExpenditureOrganizationId: integer
(int64)
Read Only:
true
Identifier for expenditure organization used to build the transaction descriptive flexfield for project-related transaction distributions. -
ExpenditureOrganizationName: string
Title:
Organization
Read Only:true
Maximum Length:240
Name for expenditure organization. -
ExpenditureTypeId: integer
(int64)
Read Only:
true
Expenditure type used to build the transaction descriptive flexfield for project-related transaction distributions. -
ExpenditureTypeName: string
Title:
Expenditure Type
Read Only:true
Maximum Length:240
Name of the expenditure type for this cost distribution. -
FundingAllocationId: integer
(int64)
Read Only:
true
Specifies the name of the project funding override. Not used currently. -
FundingSourceId: string
Read Only:
true
Maximum Length:150
Identifier of the funding source for this distribution. -
FundingSourceName: string
Title:
Name
Read Only:true
Maximum Length:360
Funding source name. -
FundingSourceNumber: string
Read Only:
true
Maximum Length:50
Funding source number associated to this distribution. -
FundsStatus: string
Read Only:
true
Maximum Length:255
Identifies whether this cost passed or failed funds checking. -
GLAccount: string
Read Only:
true
GL Account for this distribution, if the rule is to a GL account. -
GLAccountCombinationId: integer
(int64)
Read Only:
true
The GL Account code combination identifier, if the rule is set to a GL account. -
LaborSchedulePayElement: string
Title:
Element Name
Read Only:true
Maximum Length:80
The payroll element code from the labor schedule that created this distribution. Applies to labor schedules of type element. -
LaborSchedulePayElementId: integer
(int64)
Read Only:
true
The payroll element identifier from the labor schedule that created this distribution. Applies to labor schedules of type element. -
LaborSchedulePayElementName: string
Read Only:
true
Maximum Length:80
The payroll element name from the labor schedule that created this distribution. Applies to labor schedules of type element. -
LaborScheduleType: string
Read Only:
true
Maximum Length:80
The name for the type from the labor schedule that created this distribution. -
LaborScheduleTypeCode: string
Read Only:
true
Maximum Length:30
The code of the type from the labor schedule that created this distribution -
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated By -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated Date -
LdInterfaceId: integer
(int64)
Read Only:
true
The unique identifier of the labor cost. This value can be used to connect the labor schedule costs and distributions rest services to get all distributions excluding the original distributions that were adjusted. To get all distributions including all adjustment records use the original reference value. -
LineNumber: number
Read Only:
true
Labor schedule distribution line number for this cost distribution. -
LinePercent: number
Read Only:
true
The percentage for this distribution rule, to be applied to the total cost for distribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
true
The business unit identifier derived from the person assignment. -
OriginalTransactionReference: string
Read Only:
true
Maximum Length:120
A unique identifier for this cost from the generating source. This field should be used to connect the cost and all distributed costs on the labor schedules cost distributions rest service, including any adjustments that have been done. -
PayElement: string
Read Only:
true
Maximum Length:80
Pay element associated to the cost. -
PayPeriodEndDate: string
(date)
Read Only:
true
Pay period end date associated to cost. -
PayPeriodStartDate: string
(date)
Read Only:
true
Pay period start date associated to cost. -
PersonEmail: string
Title:
Email
Read Only:true
Maximum Length:240
Email associated to the cost. -
PersonId: integer
(int64)
Read Only:
true
Person identifier associated to the cost. -
PersonName: string
Title:
Name
Read Only:true
Maximum Length:240
Person name associated to the cost. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
Person number associated to the cost. -
ProcessingEndDate: string
(date)
Read Only:
true
Date used to drive the end date of the cost and the daily rate to calculation. -
ProcessingStartDate: string
(date)
Read Only:
true
Date used to drive the start date of the cost and the daily rate to calculation. -
ProjectId: integer
(int64)
Read Only:
true
Identifier of the project for this distribution rule, if it's a project distribution. -
ProjectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
Name of the project associated to this distribution if it's a project distribution. -
ProjectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
Number of the project associated to this distribution if it's a project distribution. -
RunTargetId: integer
(int64)
Read Only:
true
Primary key identifier. -
TaskId: integer
(int64)
Read Only:
true
Identifier of the task for this distribution rule, if it's a project distribution. -
TaskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
Name of the task associated to this distribution if it's a project distribution. -
TaskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
Task number associated with this distribution. -
TotalAllocation: number
Read Only:
true
Total allocation amount for this distribution. -
TransactionReference: string
Read Only:
true
Maximum Length:255
Transaction number associated to the cost for reference in accounting. -
VersionEndDate: string
(date)
Read Only:
true
The end date of the labor schedule version. -
VersionId: integer
(int64)
Read Only:
true
Concatenated foreign key with line_num back to personAssignmentLaborSchedules.distributionRules REST service -
VersionName: string
Title:
Version Name
Read Only:true
Maximum Length:300
Labor schedule version for this cost distribution. -
VersionStartDate: string
(date)
Read Only:
true
The start date of the labor schedule version. -
WorkTypeId: integer
(int64)
Read Only:
true
Identifier for project-related classification of the worked performed.
Nested Schema : Labor Schedule Cost Distribution Errors
Type:
array
Title:
Labor Schedule Cost Distribution Errors
The Labor Schedule Cost Distribution Errors resource used to see the errors associated to distributions for resolution.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : laborSchedulesCosts-laborSchedulesCostDistributions-costDistributionErrors-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Created By -
CreationDate: string
(date-time)
Read Only:
true
Creation Date -
ExceptionCode: string
Read Only:
true
Maximum Length:30
The unique code for the error. -
ExceptionId: integer
(int64)
Read Only:
true
The unique identifier for the error. -
ExceptionType: string
Read Only:
true
Maximum Length:1
The type of error. -
ExceptionUserAction: string
Read Only:
true
Maximum Length:255
The cause and action that should be taken as result of the error. -
ExceptionUserDetails: string
Read Only:
true
Maximum Length:255
The description of the error. -
ExpenditureItemId: integer
(int64)
Read Only:
true
Identifier of the expenditure created for this cost distribution. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last Updated By -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last Updated Date -
LevelCode: string
Read Only:
true
Maximum Length:2
Level of the error. The valid values are R - Rule, S - Source, T -Target, B - Basis, or O - Offset. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RunTargetId: integer
(int64)
Read Only:
true
The unique identifier of the target associated to this error.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- deleteErrors
-
Delete one or more labor costs in Error status depending on the parameters passed. If multiple parameters are provided they will be combined to filter the set of labor costs in Error status.
Examples
The following example shows how to get many labor schedule costs by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts
Response Body Example
The following shows an example of the response body in JSON format of all project templates.
{ "items": [ { "AssignmentId": 300100185241843, "AssignmentName": "Project Manager", "AssignmentNumber": "E955160008191829", "BatchName": "multi-BU-Diff1", "CurrencyCode": "USD", "PersonEmail": null, "LdInterfaceId": 10081, "OrganizationId": 204, "OriginalTransactionReference": "BUTEST1", "PayAmount": 4211.11, "PayElement": "Regular Salary", "PayPeriodEndDate": "2017-01-31", "PayPeriodStartDate": "2017-01-01", "PersonId": 300100185241828, "PersonName": "Eric Puls", "PersonNumber": "955160008191829", "StatusCode": "RS", "Status": "Release success", "StatusSummary": "Success", "links": [ { "rel": "self", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/10081", "name": "laborSchedulesCosts", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/10081", "name": "laborSchedulesCosts", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com: port/fscmRestApi/resources/11.13.18.05/laborSchedulesCosts/10081/child/laborSchedulesCostDistributions", "name": "laborSchedulesCostDistributions", "kind": "collection" } ] } }