Rules
Get Rules
Payroll
Deductions
Documents
Management
Sandbox
- POSTCreate a new Sandbox Connection
- POSTCreate a new sandbox account
- PUTUpdate a sandbox account
- GETGet configurations for sandbox jobs
- PUTUpdate configurations for sandbox jobs
- POSTAdd a new sandbox payment
- PUTUpdate sandbox individual
- PUTUpdate sandbox employment
- POSTAdd new individuals to a sandbox company
- PUTUpdate a sandbox company's data
- POSTEnqueue a new sandbox job
Development Guides
Rules
Get Rules
Beta: this endpoint currently serves employers onboarded after March 4th and historical support will be added soon List all rules of a connection account.
GET
/
employer
/
pay-statement-item
/
rule
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
// Automatically fetches more pages as needed.
for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
console.log(ruleListResponse.id);
}
}
main();
{
"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"
}
]
}
Authorizations
Please use your Access Token
Headers
Header used to specify the version for a given API request. Current version is 2020-09-17.
Response
200 - application/json
OK
The response is of type object
.
Was this page helpful?
import Finch from '@tryfinch/finch-api';
const client = new Finch({
accessToken: 'My Access Token',
});
async function main() {
// Automatically fetches more pages as needed.
for await (const ruleListResponse of client.hris.company.payStatementItem.rules.list()) {
console.log(ruleListResponse.id);
}
}
main();
{
"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"
}
]
}