import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
// Automatically fetches more pages as needed.
for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
console.log(ruleListResponse.id);
}{
"responses": [
{
"id": "<string>",
"priority": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"effective_start_date": "<string>",
"effective_end_date": "<string>",
"conditions": [
{
"field": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"attributes": {
"metadata": {}
},
"entity_type": "pay_statement_item"
}
]
}Beta: this endpoint currently serves employers onboarded after March 4th and historical support will be added soon List all rules of a connection account.
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
// Automatically fetches more pages as needed.
for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
console.log(ruleListResponse.id);
}{
"responses": [
{
"id": "<string>",
"priority": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"effective_start_date": "<string>",
"effective_end_date": "<string>",
"conditions": [
{
"field": "<string>",
"operator": "equals",
"value": "<string>"
}
],
"attributes": {
"metadata": {}
},
"entity_type": "pay_statement_item"
}
]
}Please use your Access Token
Header used to specify the version for a given API request. Current version is 2020-09-17.
The entity IDs to retrieve rules for.
1 element["550e8400-e29b-41d4-a716-446655440000"]OK
Show child attributes
Finch id (uuidv4) for the rule.
The priority of the rule.
The datetime when the rule was created.
The datetime when the rule was last updated.
Specifies when the rule should begin applying based on the date.
Specifies when the rules should stop applying rules based on the date.
The entity type to which the rule is applied.
pay_statement_item Was this page helpful?