Get all plan balances
get
/hcmRestApi/resources/11.13.18.05/planBalances
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 all the plan balances that match the primary key criteria specified.
Finder Variables- personPlanEnrollmentId; integer; Unique identifier of a plan enrollment.
- findByAssignmentIdPlanIdLevelDate Finds plan balances based on the specified attributes.
Finder Variables- SysEffectiveDate; object;
- assignmentId; integer; Unique Identifier of the worker's assignment.
- balanceAsOfDate; string; Date for which balance is calculated.
- level; string; Level of detail expected in the response. Possible values are balanceSummary, balanceDetail or all.
- planId; integer; Unique identifier of the plan.
- findByCurrentDate Finds plan balances based on the current date.
Finder Variables- SysEffectiveDate; object;
- assignmentId; integer; Unique Identifier for the worker's assignment.
- personId; integer; Unique identifier for the person.
- planId; integer; Unique identifier for the plan.
- findByLastCalculationDate Finds the balance as of the last calculation date.
Finder Variables- SysEffectiveDate; object;
- assignmentId; integer; Unique Identifier of the worker's assignment.
- personId; integer; Unique identifier for the person.
- planId; integer; Unique identifier for the plan.
- findByPersonIdPlanIdLevelDate Finds plan balances based on the specified attributes.
Finder Variables- SysEffectiveDate; object;
- balanceAsOfDate; string; Date for which balance is calculated.
- level; string; Level of detail expected in the response. Possible values are balanceSummary, balanceDetail or all.
- personId; integer; Unique identifier of the person.
- planId; integer; Unique identifier of the plan.
- PrimaryKey Finds all the plan balances that match the primary key criteria specified.
-
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:- SysEffectiveDate; string
- assignmentId; integer; Unique identifier of the worker's assignment to which the plan is enrolled.
- assignmentName; string; Name of the worker's assignment to which the plan is enrolled.
- assignmentNumber; string; Number of the worker's assignment to which the plan is enrolled.
- balanceAsOfBalanceCalculationDate; number; Remaining plan balance amount for a person on the balance calculation date.
- balanceCalculationDate; string; Date on which accrual is run to calculate the balance for the person.
- ceilingAmount; number; Ceiling amount shown on the donation absence plan.
- effectiveEndDate; string
- effectiveStartDate; string
- enrollPositiveBalanceFlag; boolean; Disburse check box enabled in absence plan.
- enrollmentEndDate; string; Date on which the person is removed from plan when plan enrollment ends.
- enrollmentStartDate; string; Date on which the person is enrolled to the plan.
- formattedBalance; string; Remaining plan balance amount for a person on the balance calculation date, formatted according to user preference.
- level; string
- personId; integer; Unique identifier for the person.
- personPlanEnrollmentId; integer; Unique identifier for a worker's plan enrollment.
- planDisplayStatusFlag; boolean; Indicates whether the plan balance can be displayed to users, as defined in the absence type. If true, balance can be displayed to users. If false, balance can't be displayed to users.
- planEnrollmentStatus; string; Status of plan enrollment as of current date, such as Active or Inactive.
- planId; integer; Unique identifier of the plan.
- planName; string; Name of the plan.
- planPeriodEndDate; string; End date of the plan period.
- planPeriodStartDate; string; Start date of the plan period.
- planStatus; string; Status of plan, such as A for Active or V for Inactive.
- planStatusMeaning; string; Meaning of plan status, such as Active, Inactive.
- planType; string; Type of absence plan used to record an absence, such as Accrual, Donation.
- planTypeCode; string; Code of the plan type.
- planUnitOfMeasure; string; Unique identifier assigned to a unit of measure for absence plan, such as D or H.
- recipientAliasName; string; Alias name of the donation recipient.
- transferRule; string; Potential transfer of absence plan to be evaluated for transfer of plan balance after global transfer transaction.
- unitOfMeasureMeaning; string; Meaning of plan unit of measure, such as Days or Hours.
-
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
-
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.
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 : planBalances
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 : planBalances-item-response
Type:
Show Source
object
-
assignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Unique identifier of the worker's assignment to which the plan is enrolled. -
assignmentName: string
Title:
Assignment Name
Read Only:true
Maximum Length:80
Name of the worker's assignment to which the plan is enrolled. -
assignmentNumber: string
Title:
Assignment Number
Read Only:true
Maximum Length:30
Number of the worker's assignment to which the plan is enrolled. -
balanceAsOfBalanceCalculationDate: number
Remaining plan balance amount for a person on the balance calculation date.
-
balanceCalculationDate: string
(date)
Date on which accrual is run to calculate the balance for the person.
-
ceilingAmount: number
Ceiling amount shown on the donation absence plan.
-
details: array
Details
Title:
Details
The details resource is a child of the planBalances resource and provides details of each transaction type available for the absence plan. -
effectiveEndDate: string
(date)
Read Only:
true
-
effectiveStartDate: string
(date)
Read Only:
true
-
enrollmentEndDate: string
(date)
Date on which the person is removed from plan when plan enrollment ends.
-
enrollmentStartDate: string
(date)
Date on which the person is enrolled to the plan.
-
enrollPositiveBalanceFlag: boolean
Read Only:
true
Maximum Length:30
Disburse check box enabled in absence plan. -
formattedBalance: string
Read Only:
true
Maximum Length:255
Remaining plan balance amount for a person on the balance calculation date, formatted according to user preference. -
formattedCeilingAmount: string
Read Only:
true
Maximum Length:255
Format of the ceiling amount displayed on a donation plan. -
level: string
Read Only:
true
Maximum Length:150
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
multiYearCarryOverFlag: boolean
Read Only:
true
Indicates whether the plan has multiyear carryover enabled. If true, multiple years of carryover will be displayed. If false, carryover will only show for one year. -
personId: integer
(int64)
Unique identifier for the person.
-
personPlanEnrollmentId: integer
(int64)
Unique identifier for a worker's plan enrollment.
-
planBalanceDetails: array
Plan Balance Details
Title:
Plan Balance Details
The planBalanceDetails resource is a child of the planBalances resource and provides detailed information on all transactions that impact the balance on the plan. -
planBalanceSummary: array
Plan Balance Summaries
Title:
Plan Balance Summaries
The planBalanceSummary resource is a child of the planBalances resource and provides summary-level information on all transactions that impact the balance on the plan. -
planDisplayStatusFlag: boolean
Indicates whether the plan balance can be displayed to users, as defined in the absence type. If true, balance can be displayed to users. If false, balance can't be displayed to users.
-
planEnrollmentStatus: string
Read Only:
true
Status of plan enrollment as of current date, such as Active or Inactive. -
planId: integer
(int64)
Unique identifier of the plan.
-
planName: string
Name of the plan.
-
planPeriodEndDate: string
(date)
Read Only:
true
End date of the plan period. -
planPeriodStartDate: string
(date)
Read Only:
true
Start date of the plan period. -
planStatus: string
Read Only:
true
Maximum Length:30
Status of plan, such as A for Active or V for Inactive. -
planStatusMeaning: string
Meaning of plan status, such as Active, Inactive.
-
planType: string
Type of absence plan used to record an absence, such as Accrual, Donation.
-
planTypeCode: string
Read Only:
true
Maximum Length:30
Code of the plan type. -
planUnitOfMeasure: string
Read Only:
true
Maximum Length:30
Unique identifier assigned to a unit of measure for absence plan, such as D or H. -
recipientAliasName: string
Read Only:
true
Maximum Length:240
Alias name of the donation recipient. -
SysEffectiveDate: string
(date)
-
transferRule: string
Read Only:
true
Maximum Length:30
Potential transfer of absence plan to be evaluated for transfer of plan balance after global transfer transaction. -
unitOfMeasureMeaning: string
Meaning of plan unit of measure, such as Days or Hours.
-
unvestedDetails: array
Unvested Balance Details
Title:
Unvested Balance Details
The unvestedBalanceDetails resource is a child of the planBalances resource and provides the details of balance transactions that are unvested. -
yearEndDetails: array
Year End Details
Title:
Year End Details
The yearEndDetails resource is a child of the planBalances resource and provides the details for the plan year end transactions.
Nested Schema : Details
Type:
array
Title:
Details
The details resource is a child of the planBalances resource and provides details of each transaction type available for the absence plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Plan Balance Details
Type:
array
Title:
Plan Balance Details
The planBalanceDetails resource is a child of the planBalances resource and provides detailed information on all transactions that impact the balance on the plan.
Show Source
Nested Schema : Plan Balance Summaries
Type:
array
Title:
Plan Balance Summaries
The planBalanceSummary resource is a child of the planBalances resource and provides summary-level information on all transactions that impact the balance on the plan.
Show Source
Nested Schema : Unvested Balance Details
Type:
array
Title:
Unvested Balance Details
The unvestedBalanceDetails resource is a child of the planBalances resource and provides the details of balance transactions that are unvested.
Show Source
Nested Schema : Year End Details
Type:
array
Title:
Year End Details
The yearEndDetails resource is a child of the planBalances resource and provides the details for the plan year end transactions.
Show Source
Nested Schema : planBalances-details-item-response
Type:
Show Source
object
-
additionalInformation: string
Read Only:
true
Maximum Length:255
Display of additional information about the transaction. -
bucketSequence: integer
Read Only:
true
Displayed sequence of the transaction types for the plan. -
bucketType: string
Read Only:
true
Maximum Length:255
Name of the transaction type. -
carryoverExpiryDate: string
(date)
Read Only:
true
Date the carryover balance will expire. -
expiryDate: string
(date)
Read Only:
true
Expiration date of the transaction or balance. -
expiryDateOverReasonCode: string
Read Only:
true
Maximum Length:255
Code of the expiration date override. -
expiryDateOverReasonMeaning: string
Read Only:
true
Maximum Length:255
Reason the expiration date was overridden on the transaction. -
formattedRemainingBalance: string
Read Only:
true
Maximum Length:255
Format of the remaining carryover balance. -
formattedTransactionAmount: string
Read Only:
true
Maximum Length:255
Format of the absence transaction amount. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
manualAdjustmentReasonCode: string
Read Only:
true
Maximum Length:255
Code of the manual adjustment reason. -
manualAdjustmentReasonMeaning: string
Read Only:
true
Maximum Length:255
Reason for the manual adjustment transaction on the plan. -
planBalanceDetailsId: integer
Read Only:
true
Unique identifier of the plan balance details. -
planEndDate: string
(date)
Read Only:
true
End date of the absence plan term. -
projectedStatusFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the transaction type balance is projected. If true, the balance is a projected balance. If false, the balance is the actual balance. -
remainingBalance: number
Read Only:
true
Remaining balance available for carryover. -
transactionAmount: number
Read Only:
true
Amount of the absence transaction. -
transactionDate: string
(date)
Read Only:
true
Date of the absence transaction. -
transactionStatus: string
Read Only:
true
Maximum Length:255
Status of the absence transaction. -
transactionTypeCode: string
Read Only:
true
Maximum Length:255
Code of the transaction type. -
transactionTypeName: string
Read Only:
true
Maximum Length:255
Name of the transaction type. -
voidFlag: boolean
Read Only:
true
Indicates whether a transaction has been voided. If true, the transaction is no longer valid. If false, the transaction is still valid and not voided.
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.
Nested Schema : planBalances-planBalanceDetails-item-response
Type:
Show Source
object
-
additionalInformation: string
Maximum Length:
255
Any additional Information that qualifies the transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
personAccrualEntryDtlId: integer
Unique identifier for the plan balance detail record.
-
status: string
Maximum Length:
255
Status of a transaction detail record, such as Projected or Rejected. -
transactionDate: string
(date)
Date of the plan balance detail transaction.
-
transactionTypeCode: string
Maximum Length:
255
Transaction type identifier for a plan balance detail record, such as ACRL or ABS. -
transactionTypeName: string
Maximum Length:
255
Transaction type name for a plan balance detail record, such as Periodic Accrual or Absence. -
value: string
Maximum Length:
255
Transaction value expressed in the unit of measure of the absence plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planBalances-planBalanceSummary-item-response
Type:
Show Source
object
-
bucketSequence: integer
Read Only:
true
Sequence of the plan balance summary transactions. -
bucketTypeCode: string
Read Only:
true
Maximum Length:255
Type code of the plan balance summary transactions. -
bucketTypeName: string
Read Only:
true
Maximum Length:255
Name of the transaction type. -
formattedValue: string
Read Only:
true
Maximum Length:255
Format of plan balance summary transactions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
transactionTypeCode: string
Maximum Length:
255
Transaction type identifier for a plan balance summary record, such as ACRL or ABS. -
transactionTypeName: string
Maximum Length:
255
Transaction type name for a plan balance summary record, such as Accrual or Absence. -
value: string
Maximum Length:
255
Transaction value of absence type expressed in the unit of measure of the absence plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planBalances-unvestedDetails-item-response
Type:
Show Source
object
-
earnedAmount: number
Read Only:
true
Amount of accrual balance earned that's unvested. -
earnedDate: string
(date)
Read Only:
true
Date on which the unvested accrual amount was earned. -
formattedEarnedAmount: string
Read Only:
true
Maximum Length:255
Format of the earned unvested balance amount. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
projectedStatusFlag: boolean
Read Only:
true
Indicates whether the unvested balance amount is a projected balance. -
transactionStatus: string
Read Only:
true
Maximum Length:255
Status of the unvested balance transaction. -
unvestedDetailsId: integer
Read Only:
true
Unique identifier of the unvested balance transaction. -
vestingDate: string
(date)
Read Only:
true
Date on which the unvested balance will vest.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planBalances-yearEndDetails-item-response
Type:
Show Source
object
-
additionalInformation: string
Read Only:
true
Maximum Length:255
Display of additional information about the transaction. -
bucketSequence: integer
Read Only:
true
Sequence of the plan balance year-end transactions. -
carryOverExpiryDate: string
(date)
Read Only:
true
Date on which the carryover balance will expire. -
formattedTransactionAmount: string
Read Only:
true
Format of the absence transaction amount. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
planBalanceYearEndId: integer
Read Only:
true
Unique identifier of the plan year end details. -
planEndDate: string
(date)
Read Only:
true
End date of the absence plan term. -
projectedStatusFlag: boolean
Read Only:
true
Indicates whether the transaction type balance is projected. If true, the balance is a projected balance. If false, the balance is the actual balance. -
transactionAmount: number
Read Only:
true
Amount of the absence transaction. -
transactionDate: string
(date)
Read Only:
true
Date of the absence transaction. -
transactionTypeCode: string
Read Only:
true
Code of the transaction type. -
transactionTypeName: string
Read Only:
true
Name of the transaction type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source