POST
/
employer
/
pay-statement-item
/
rule
import Finch from '@tryfinch/finch-api';

const client = new Finch({
  accessToken: 'My Access Token',
});

async function main() {
  const rule = await client.hris.company.payStatementItem.rules.create();

  console.log(rule.id);
}

main();
{
  "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
  "priority": 1,
  "effective_start_date": "2025-01-01",
  "effective_end_date": "2025-12-31",
  "conditions": [
    {
      "field": "name",
      "operator": "equals",
      "value": "Salary"
    }
  ],
  "attributes": {
    "metadata": {
      "myLabel": "My Value"
    }
  },
  "entity_type": "pay_statement_item",
  "created_at": "2025-01-01T10:00:00Z",
  "updated_at": "2025-01-01T10:00:00Z"
}

Authorizations

​
Authorization
string
header
required

Please use your Access Token

Headers

​
Finch-API-Version
string
default:2020-09-17
required

Header used to specify the version for a given API request. Current version is 2020-09-17.

​
Content-Type
string
default:application/json
required

Used to indicate the original media type of the resource

Body

application/json
​
effective_start_date
string | null

Specifies when the rule should begin applying based on the date.

​
effective_end_date
string | null

Specifies when the rules should stop applying rules based on the date.

​
conditions
object[]
​
attributes
object

Specifies the fields to be applied when the condition is met.

​
entity_type
enum<string>

The entity type to which the rule is applied.

Available options:
pay_statement_item

Response

201
application/json
Successfully Created
​
id
string

Finch id (uuidv4) for the rule.

​
priority
integer

The priority of the rule.

​
created_at
string

The datetime when the rule was created.

​
updated_at
string

The datetime when the rule was last updated.

​
effective_start_date
string | null

Specifies when the rule should begin applying based on the date.

​
effective_end_date
string | null

Specifies when the rules should stop applying rules based on the date.

​
conditions
object[]
​
attributes
object

Specifies the fields to be applied when the condition is met.

​
entity_type
enum<string>

The entity type to which the rule is applied.

Available options:
pay_statement_item