finch-api 2.1.0__tar.gz → 2.3.0__tar.gz

finch_api-2.3.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.3.0"
+}

{finch_api-2.1.0 → finch_api-2.3.0}/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 2.3.0 (2026-07-15)
+
+Full Changelog: [v2.2.0...v2.3.0](https://github.com/Finch-API/finch-api-python/compare/v2.2.0...v2.3.0)
+
+### Features
+
+* **api:** api update ([0ce8204](https://github.com/Finch-API/finch-api-python/commit/0ce82044eb0ab15456c6e0f5a920c43db35802e8))
+
+## 2.2.0 (2026-07-13)
+
+Full Changelog: [v2.1.0...v2.2.0](https://github.com/Finch-API/finch-api-python/compare/v2.1.0...v2.2.0)
+
+### Features
+
+* **api:** api update ([2e8eab2](https://github.com/Finch-API/finch-api-python/commit/2e8eab2ee284482e6ed1070156bb378570cbc194))
+
 ## 2.1.0 (2026-07-01)
 
 Full Changelog: [v2.0.0...v2.1.0](https://github.com/Finch-API/finch-api-python/compare/v2.0.0...v2.1.0)

{finch_api-2.1.0 → finch_api-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: finch-api
-Version: 2.1.0
+Version: 2.3.0
 Summary: The official Python library for the Finch API
 Project-URL: Homepage, https://github.com/Finch-API/finch-api-python
 Project-URL: Repository, https://github.com/Finch-API/finch-api-python

{finch_api-2.1.0 → finch_api-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "finch-api"
-version = "2.1.0"
+version = "2.3.0"
 description = "The official Python library for the Finch API"
 dynamic = ["readme"]
 license = "Apache-2.0"

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "finch"
-__version__ = "2.1.0"  # x-release-please-version
+__version__ = "2.3.0"  # x-release-please-version

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/benefits/benefits.py

@@ -88,7 +88,8 @@ class Benefits(SyncAPIResource):
         `/providers` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           company_contribution: The company match for this benefit.
 
@@ -146,7 +147,8 @@ class Benefits(SyncAPIResource):
         Lists deductions and contributions information for a given item
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -188,7 +190,8 @@ class Benefits(SyncAPIResource):
         Updates an existing company-wide deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           description: Updated name or description.
 
@@ -231,7 +234,8 @@ class Benefits(SyncAPIResource):
         List all company-wide deductions and contributions.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -270,7 +274,8 @@ class Benefits(SyncAPIResource):
         Get deductions metadata
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -316,7 +321,8 @@ class Benefits(SyncAPIResource):
         Please use the `/provider` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           frequency: The frequency of the benefit deduction/contribution.
 
@@ -397,7 +403,8 @@ class AsyncBenefits(AsyncAPIResource):
         `/providers` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           company_contribution: The company match for this benefit.
 
@@ -457,7 +464,8 @@ class AsyncBenefits(AsyncAPIResource):
         Lists deductions and contributions information for a given item
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -501,7 +509,8 @@ class AsyncBenefits(AsyncAPIResource):
         Updates an existing company-wide deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           description: Updated name or description.
 
@@ -546,7 +555,8 @@ class AsyncBenefits(AsyncAPIResource):
         List all company-wide deductions and contributions.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -585,7 +595,8 @@ class AsyncBenefits(AsyncAPIResource):
         Get deductions metadata
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -631,7 +642,8 @@ class AsyncBenefits(AsyncAPIResource):
         Please use the `/provider` endpoint to view available types for each provider.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           frequency: The frequency of the benefit deduction/contribution.
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/benefits/individuals.py

@@ -69,7 +69,8 @@ class Individuals(SyncAPIResource):
         enrollments, but will continue to set the state of the existing enrollment.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individuals: Array of the individual_id to enroll and a configuration object.
 
@@ -115,7 +116,8 @@ class Individuals(SyncAPIResource):
         Lists individuals currently enrolled in a given deduction.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -159,7 +161,8 @@ class Individuals(SyncAPIResource):
         Get enrollment information for the given individuals.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -211,7 +214,8 @@ class Individuals(SyncAPIResource):
         Unenroll individuals from a deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individual_ids: Array of individual_ids to unenroll.
 
@@ -285,7 +289,8 @@ class AsyncIndividuals(AsyncAPIResource):
         enrollments, but will continue to set the state of the existing enrollment.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individuals: Array of the individual_id to enroll and a configuration object.
 
@@ -331,7 +336,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Lists individuals currently enrolled in a given deduction.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -375,7 +381,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Get enrollment information for the given individuals.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individual_ids: comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -427,7 +434,8 @@ class AsyncIndividuals(AsyncAPIResource):
         Unenroll individuals from a deduction or contribution
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individual_ids: Array of individual_ids to unenroll.
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/company.py

@@ -52,7 +52,8 @@ class CompanyResource(SyncAPIResource):
         Read basic company data
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -111,7 +112,8 @@ class AsyncCompanyResource(AsyncAPIResource):
         Read basic company data
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/directory.py

@@ -57,9 +57,10 @@ class Directory(SyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 
@@ -110,9 +111,10 @@ class Directory(SyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 
@@ -172,9 +174,10 @@ class AsyncDirectory(AsyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 
@@ -225,9 +228,10 @@ class AsyncDirectory(AsyncAPIResource):
         Read company directory and organization structure
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
-          limit: Number of employees to return (defaults to all)
+          limit: Number of employees to return (defaults to 100, maximum 10000)
 
           offset: Index to start from (defaults to 0)
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/documents.py

@@ -62,7 +62,8 @@ class Documents(SyncAPIResource):
         company-wide documents.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -122,7 +123,8 @@ class Documents(SyncAPIResource):
         specific document by its ID.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -194,7 +196,8 @@ class AsyncDocuments(AsyncAPIResource):
         company-wide documents.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           individual_ids: Comma-delimited list of stable Finch uuids for each individual. If empty,
               defaults to all individuals
@@ -254,7 +257,8 @@ class AsyncDocuments(AsyncAPIResource):
         specific document by its ID.
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/employments.py

@@ -56,9 +56,10 @@ class Employments(SyncAPIResource):
         Read individual employment and income data
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10000 items per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -123,9 +124,10 @@ class AsyncEmployments(AsyncAPIResource):
         Read individual employment and income data
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10000 items per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/individuals.py

@@ -43,9 +43,9 @@ class Individuals(SyncAPIResource):
     def retrieve_many(
         self,
         *,
+        requests: Iterable[individual_retrieve_many_params.Request],
         entity_ids: SequenceNotStr[str] | Omit = omit,
         options: Optional[individual_retrieve_many_params.Options] | Omit = omit,
-        requests: Iterable[individual_retrieve_many_params.Request] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -57,7 +57,10 @@ class Individuals(SyncAPIResource):
         Read individual data, excluding income and employment data
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          requests: The array of batch requests. Maximum 10000 items per request.
+
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -72,8 +75,8 @@ class Individuals(SyncAPIResource):
             page=SyncResponsesPage[IndividualResponse],
             body=maybe_transform(
                 {
-                    "options": options,
                     "requests": requests,
+                    "options": options,
                 },
                 individual_retrieve_many_params.IndividualRetrieveManyParams,
             ),
@@ -115,9 +118,9 @@ class AsyncIndividuals(AsyncAPIResource):
     def retrieve_many(
         self,
         *,
+        requests: Iterable[individual_retrieve_many_params.Request],
         entity_ids: SequenceNotStr[str] | Omit = omit,
         options: Optional[individual_retrieve_many_params.Options] | Omit = omit,
-        requests: Iterable[individual_retrieve_many_params.Request] | Omit = omit,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -129,7 +132,10 @@ class AsyncIndividuals(AsyncAPIResource):
         Read individual data, excluding income and employment data
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          requests: The array of batch requests. Maximum 10000 items per request.
+
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -144,8 +150,8 @@ class AsyncIndividuals(AsyncAPIResource):
             page=AsyncResponsesPage[IndividualResponse],
             body=maybe_transform(
                 {
-                    "options": options,
                     "requests": requests,
+                    "options": options,
                 },
                 individual_retrieve_many_params.IndividualRetrieveManyParams,
             ),

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/pay_statement_item/pay_statement_item.py

@@ -81,7 +81,8 @@ class PayStatementItem(SyncAPIResource):
           end_date: The end date to retrieve pay statement items by via their last seen pay date in
               `YYYY-MM-DD` format.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           name: Case-insensitive partial match search by pay statement item name.
 
@@ -174,7 +175,8 @@ class AsyncPayStatementItem(AsyncAPIResource):
           end_date: The end date to retrieve pay statement items by via their last seen pay date in
               `YYYY-MM-DD` format.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           name: Case-insensitive partial match search by pay statement item name.
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/pay_statement_item/rules.py

@@ -72,7 +72,8 @@ class Rules(SyncAPIResource):
         retrieved where pay statement item information is available.
 
         Args:
-          entity_ids: The entity IDs to create the rule for.
+          entity_ids: The entity IDs to create the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           attributes: Specifies the fields to be applied when the condition is met.
 
@@ -130,7 +131,8 @@ class Rules(SyncAPIResource):
         Update a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to update the rule for.
+          entity_ids: The entity IDs to update the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -171,7 +173,8 @@ class Rules(SyncAPIResource):
         List all rules of a connection account.
 
         Args:
-          entity_ids: The entity IDs to retrieve rules for.
+          entity_ids: The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
+              a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -211,7 +214,8 @@ class Rules(SyncAPIResource):
         Delete a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to delete the rule for.
+          entity_ids: The entity IDs to delete the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -280,7 +284,8 @@ class AsyncRules(AsyncAPIResource):
         retrieved where pay statement item information is available.
 
         Args:
-          entity_ids: The entity IDs to create the rule for.
+          entity_ids: The entity IDs to create the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           attributes: Specifies the fields to be applied when the condition is met.
 
@@ -338,7 +343,8 @@ class AsyncRules(AsyncAPIResource):
         Update a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to update the rule for.
+          entity_ids: The entity IDs to update the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -381,7 +387,8 @@ class AsyncRules(AsyncAPIResource):
         List all rules of a connection account.
 
         Args:
-          entity_ids: The entity IDs to retrieve rules for.
+          entity_ids: The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
+              a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -421,7 +428,8 @@ class AsyncRules(AsyncAPIResource):
         Delete a rule for a pay statement item.
 
         Args:
-          entity_ids: The entity IDs to delete the rule for.
+          entity_ids: The entity IDs to delete the rule for. Provide exactly one entity ID per
+              request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/pay_statements.py

@@ -59,9 +59,10 @@ class PayStatements(SyncAPIResource):
         supports Benefits.
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10 payment_ids per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -131,9 +132,10 @@ class AsyncPayStatements(AsyncAPIResource):
         supports Benefits.
 
         Args:
-          requests: The array of batch requests.
+          requests: The array of batch requests. Maximum 10 payment_ids per request.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/hris/payments.py

@@ -64,7 +64,8 @@ class Payments(SyncAPIResource):
           start_date: The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
               format. Filters payments by their **pay_date** field.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -139,7 +140,8 @@ class AsyncPayments(AsyncAPIResource):
           start_date: The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
               format. Filters payments by their **pay_date** field.
 
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/resources/payroll/pay_groups.py

@@ -55,7 +55,8 @@ class PayGroups(SyncAPIResource):
         Read information from a single pay group
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -97,7 +98,8 @@ class PayGroups(SyncAPIResource):
         Read company pay groups and frequencies
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -165,7 +167,8 @@ class AsyncPayGroups(AsyncAPIResource):
         Read information from a single pay group
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 
@@ -209,7 +212,8 @@ class AsyncPayGroups(AsyncAPIResource):
         Read company pay groups and frequencies
 
         Args:
-          entity_ids: The entity IDs to specify which entities' data to access.
+          entity_ids: The entity IDs to specify which entities' data to access. Provide exactly one
+              entity ID per request; a maximum of one is accepted.
 
           extra_headers: Send extra headers
 

{finch_api-2.1.0 → finch_api-2.3.0}/src/finch/types/base_webhook_event.py

@@ -16,11 +16,7 @@ class BaseWebhookEvent(BaseModel):
     """
 
     company_id: str
-    """[DEPRECATED] Unique Finch ID of the company for which data has been updated.
-
-    Use `connection_id` instead to identify the connection associated with this
-    event.
-    """
+    """Unique Finch ID of the company for which data has been updated."""
 
     connection_id: Optional[str] = None
     """Unique Finch ID of the connection associated with the webhook event."""