Get all tax credit results
get
/hcmRestApi/resources/11.13.18.05/recruitingUITaxCreditResults
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 all tax credit results using a primary key.
Finder Variables- ProvisioningId; integer; Partner provisioning identifier used with primary key to find tax credit results.
- findBySubmissionId Finds all tax credits results by submission identifier.
Finder Variables- pSubmissionId; integer; Submission identifier used to find assessment results.
- PrimaryKey Finds all tax credit results using a 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:- Comments; string; Tax credit comments provided by the partner.
- CurrentPhaseId; integer; Current phase identifier of the job application.
- FederalCreditsEligibleFlag; boolean; Federal credits eligible indicator provided by the partner.
- FederalCreditsIdentifier; string; Federal credits identifier provided by the partner.
- PackageCode; string; Tax credits package code.
- PackageName; string; Tax credits package name.
- PackageResultId; integer; Tax credits package results identifier.
- PartnerActiveFlag; boolean; Tax credits partner active indicator.
- PartnerName; string; Tax credits partner name.
- ProvisioningId; integer; Tax credits partner provisioning identifier.
- RequestedBy; string; User that requested tax credits package.
- RequestedOn; string; Tax credits package requested date.
- StateCreditsEligibleFlag; boolean; State credits eligible indicator provided by the partner.
- StateCreditsIdentifier; string; State credits identifier provided by the partner.
- Status; string; Tax credits status.
- StatusCode; string; Tax credits status code.
- TotalCreditsEstimate; string; Total credits estimate provided by the partner.
-
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 : recruitingUITaxCreditResults
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 : recruitingUITaxCreditResults-item-response
Type:
Show Source
object
-
AdditionalResultAttributes: array
Recruiting Tax Credit Results Additional Attributes
Title:
Recruiting Tax Credit Results Additional Attributes
The AdditionalResultAttributes resource provides additional tax credit results. -
Comments: string
Read Only:
true
Maximum Length:255
Tax credit comments provided by the partner. -
CurrentPhaseId: integer
Read Only:
true
Current phase identifier of the job application. -
FederalCreditsEligibleFlag: boolean
Read Only:
true
Maximum Length:255
Federal credits eligible indicator provided by the partner. -
FederalCreditsIdentifier: string
Read Only:
true
Maximum Length:255
Federal credits identifier provided by the partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherEligibleCredits: array
Recruiting Tax Credit Results Other Eligible Credits
Title:
Recruiting Tax Credit Results Other Eligible Credits
The OtherEligibleCredits resource provides other eligible tax credit results. -
PackageCode: string
Read Only:
true
Maximum Length:255
Tax credits package code. -
PackageName: string
Read Only:
true
Maximum Length:255
Tax credits package name. -
PackageResultId: integer
Read Only:
true
Tax credits package results identifier. -
PartnerActiveFlag: boolean
Read Only:
true
Maximum Length:255
Tax credits partner active indicator. -
PartnerName: string
Read Only:
true
Maximum Length:255
Tax credits partner name. -
ProvisioningId: integer
Read Only:
true
Tax credits partner provisioning identifier. -
RequestedBy: string
Read Only:
true
Maximum Length:255
User that requested tax credits package. -
RequestedOn: string
(date)
Read Only:
true
Tax credits package requested date. -
StateCreditsEligibleFlag: boolean
Read Only:
true
Maximum Length:255
State credits eligible indicator provided by the partner. -
StateCreditsIdentifier: string
Read Only:
true
Maximum Length:255
State credits identifier provided by the partner. -
Status: string
Read Only:
true
Maximum Length:255
Tax credits status. -
StatusCode: string
Read Only:
true
Maximum Length:255
Tax credits status code. -
TotalCreditsEstimate: string
Read Only:
true
Maximum Length:255
Total credits estimate provided by the partner.
Nested Schema : Recruiting Tax Credit Results Additional Attributes
Type:
array
Title:
Recruiting Tax Credit Results Additional Attributes
The AdditionalResultAttributes resource provides additional tax credit results.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recruiting Tax Credit Results Other Eligible Credits
Type:
array
Title:
Recruiting Tax Credit Results Other Eligible Credits
The OtherEligibleCredits resource provides other eligible tax credit results.
Show Source
Nested Schema : recruitingUITaxCreditResults-AdditionalResultAttributes-item-response
Type:
Show Source
object
-
AttributeName: string
Read Only:
true
Additional result attribute name. -
AttributeValue: string
Read Only:
true
Maximum Length:255
Additional result attribute value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : recruitingUITaxCreditResults-OtherEligibleCredits-item-response
Type:
Show Source
object
-
AdditionalResultId: integer
Read Only:
true
Other eligible credits additional result identifier. -
Comments: string
Read Only:
true
Maximum Length:255
Other eligible credits comments. -
CreditsEligibleFlag: boolean
Read Only:
true
Other eligible credits eligible indicator. -
CreditsEstimate: string
Read Only:
true
Maximum Length:255
Other eligible credits estimate. -
CreditsEstimateCurrencyCode: string
Read Only:
true
Maximum Length:255
Other eligible credits estimate currency code. -
CreditsIdentifier: string
Read Only:
true
Maximum Length:255
Other eligible credits identifier. -
CreditsName: string
Read Only:
true
Maximum Length:255
Other eligible credits name. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- cancelRequest
-
Cancels tax credit requests to a partner.
- initiateRequest
-
Initiates a tax credit request to a partner.
- viewResults
-
View tax credit results from a partner.