Update Rule

JavaScript

import Finch from '@tryfinch/finch-api';

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

const rule = await client.hris.payStatementItem.rules.update('rule_id');

console.log(rule.id);

package main

import (
	"context"
	"fmt"

	"github.com/Finch-API/finch-api-go/v2"
	"github.com/Finch-API/finch-api-go/v2/option"
)

func main() {
	client := finchgo.NewClient(
		option.WithAccessToken("My Access Token"),
	)
	rule, err := client.HRIS.PayStatementItem.Rules.Update(
		context.TODO(),
		"rule_id",
		finchgo.HRISPayStatementItemRuleUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", rule.ID)
}

package com.tryfinch.api.example;

import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisPayStatementItemRuleUpdateParams;
import com.tryfinch.api.models.RuleUpdateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        FinchClient client = FinchOkHttpClient.builder()
            .fromEnv()
            .accessToken("My Access Token")
            .build();

        RuleUpdateResponse rule = client.hris().payStatementItem().rules().update("rule_id");
    }
}

package com.tryfinch.api.example

import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.HrisPayStatementItemRuleUpdateParams
import com.tryfinch.api.models.RuleUpdateResponse

fun main() {
    val client: FinchClient = FinchOkHttpClient.builder()
        .fromEnv()
        .accessToken("My Access Token")
        .build()

    val rule: RuleUpdateResponse = client.hris().payStatementItem().rules().update("rule_id")
}

curl --request PUT \
  --url https://api.tryfinch.com/employer/pay-statement-item/rule/{rule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'Finch-API-Version: <finch-api-version>' \
  --data '
{
  "optionalProperty": "<unknown>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryfinch.com/employer/pay-statement-item/rule/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'optionalProperty' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: <content-type>",
    "Finch-API-Version: <finch-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
  "priority": 1,
  "effective_start_date": null,
  "effective_end_date": "2025-12-31",
  "conditions": [
    {
      "field": "name",
      "operator": "equals",
      "value": "Salary"
    }
  ],
  "attributes": {
    "metadata": {
      "myLabel": "My Value"
    }
  },
  "created_at": "2025-01-01T10:00:00Z",
  "updated_at": "2025-02-13T08:30:00Z"
}

PUT

employer

pay-statement-item

rule

{rule_id}

JavaScript

import Finch from '@tryfinch/finch-api';

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

const rule = await client.hris.payStatementItem.rules.update('rule_id');

console.log(rule.id);

package main

import (
	"context"
	"fmt"

	"github.com/Finch-API/finch-api-go/v2"
	"github.com/Finch-API/finch-api-go/v2/option"
)

func main() {
	client := finchgo.NewClient(
		option.WithAccessToken("My Access Token"),
	)
	rule, err := client.HRIS.PayStatementItem.Rules.Update(
		context.TODO(),
		"rule_id",
		finchgo.HRISPayStatementItemRuleUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", rule.ID)
}

package com.tryfinch.api.example;

import com.tryfinch.api.client.FinchClient;
import com.tryfinch.api.client.okhttp.FinchOkHttpClient;
import com.tryfinch.api.models.HrisPayStatementItemRuleUpdateParams;
import com.tryfinch.api.models.RuleUpdateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        FinchClient client = FinchOkHttpClient.builder()
            .fromEnv()
            .accessToken("My Access Token")
            .build();

        RuleUpdateResponse rule = client.hris().payStatementItem().rules().update("rule_id");
    }
}

package com.tryfinch.api.example

import com.tryfinch.api.client.FinchClient
import com.tryfinch.api.client.okhttp.FinchOkHttpClient
import com.tryfinch.api.models.HrisPayStatementItemRuleUpdateParams
import com.tryfinch.api.models.RuleUpdateResponse

fun main() {
    val client: FinchClient = FinchOkHttpClient.builder()
        .fromEnv()
        .accessToken("My Access Token")
        .build()

    val rule: RuleUpdateResponse = client.hris().payStatementItem().rules().update("rule_id")
}

curl --request PUT \
  --url https://api.tryfinch.com/employer/pay-statement-item/rule/{rule_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --header 'Finch-API-Version: <finch-api-version>' \
  --data '
{
  "optionalProperty": "<unknown>"
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.tryfinch.com/employer/pay-statement-item/rule/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'optionalProperty' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: <content-type>",
    "Finch-API-Version: <finch-api-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "id": "5d0b10a1-a09a-430f-81f1-20be735dc5e9",
  "priority": 1,
  "effective_start_date": null,
  "effective_end_date": "2025-12-31",
  "conditions": [
    {
      "field": "name",
      "operator": "equals",
      "value": "Salary"
    }
  ],
  "attributes": {
    "metadata": {
      "myLabel": "My Value"
    }
  },
  "created_at": "2025-01-01T10:00:00Z",
  "updated_at": "2025-02-13T08:30:00Z"
}

Authorizations

Authorization

string

header

required

Please use your Access Token

Headers

Finch-API-Version

string<date>

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

Path Parameters

rule_id

string

required

Query Parameters

entity_ids

string<uuid>[]

The entity IDs to update the rule for. Provide exactly one entity ID per request; a maximum of one is accepted. Required when the connection has more than one entity — omitting it returns a 400 invalid_request_error. Optional for single-entity connections.

Required array length: 1 element

Example:

["550e8400-e29b-41d4-a716-446655440000"]

Body

application/json

optionalProperty

any

Response

Successfully Updated

string<uuid>

Finch id (uuidv4) for the rule.

priority

integer

The priority of the rule.

created_at

string<date-time>

The datetime when the rule was created.

updated_at

string<date-time>

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[]

Show child attributes

attributes

object

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

Show child attributes

entity_type

enum<string>

The entity type to which the rule is applied.

Available options:

pay_statement_item

Organization

Payroll

Deductions

Benefits

Documents

Connect

Management

Sandbox

Development Guides

Authorizations

Headers

Path Parameters

Query Parameters

Body

Response