api.md

Shared Types

from finch.types import ConnectionStatusType, OperationSupport, OperationSupportMatrix, Paging

Finch

Methods:

• client.get_auth_url(*args) -> str
• client.with_access_token(*args) -> Self

AccessTokens

Types:

from finch.types import CreateAccessTokenResponse

Methods:

• client.access_tokens.create(**params) -> CreateAccessTokenResponse

HRIS

Types:

from finch.types import Income, Location, Money

Company

Types:

from finch.types.hris import Company

Methods:

• client.hris.company.retrieve() -> Company

Directory

Types:

from finch.types.hris import IndividualInDirectory

Methods:

• client.hris.directory.list(**params) -> SyncIndividualsPage[IndividualInDirectory]

Individuals

Types:

from finch.types.hris import Individual, IndividualResponse

Methods:

• client.hris.individuals.retrieve_many(**params) -> SyncResponsesPage[IndividualResponse]

Employments

Types:

from finch.types.hris import EmploymentData, EmploymentDataResponse

Methods:

• client.hris.employments.retrieve_many(**params) -> SyncResponsesPage[EmploymentDataResponse]

Payments

Types:

from finch.types.hris import Payment

Methods:

• client.hris.payments.list(**params) -> SyncSinglePage[Payment]

PayStatements

Types:

from finch.types.hris import PayStatement, PayStatementResponse, PayStatementResponseBody

Methods:

• client.hris.pay_statements.retrieve_many(**params) -> SyncResponsesPage[PayStatementResponse]

Benefits

Types:

from finch.types.hris import (
    BenefitContribution,
    BenefitFeaturesAndOperations,
    BenefitFrequency,
    BenefitType,
    BenefitsSupport,
    BenfitContribution,
    CompanyBenefit,
    CreateCompanyBenefitsResponse,
    SupportPerBenefitType,
    SupportedBenefit,
    UpdateCompanyBenefitResponse,
)

Methods:

• client.hris.benefits.create(**params) -> CreateCompanyBenefitsResponse
• client.hris.benefits.retrieve(benefit_id) -> CompanyBenefit
• client.hris.benefits.update(benefit_id, **params) -> UpdateCompanyBenefitResponse
• client.hris.benefits.list() -> SyncSinglePage[CompanyBenefit]
• client.hris.benefits.list_supported_benefits() -> SyncSinglePage[SupportedBenefit]

Individuals

Types:

from finch.types.hris.benefits import (
    EnrolledIndividual,
    IndividualBenefit,
    UnenrolledIndividual,
    IndividualEnrolledIDsResponse,
)

Methods:

• client.hris.benefits.individuals.enroll_many(benefit_id, **params) -> SyncSinglePage[EnrolledIndividual]
• client.hris.benefits.individuals.enrolled_ids(benefit_id) -> IndividualEnrolledIDsResponse
• client.hris.benefits.individuals.retrieve_many_benefits(benefit_id, **params) -> SyncSinglePage[IndividualBenefit]
• client.hris.benefits.individuals.unenroll_many(benefit_id, **params) -> SyncSinglePage[UnenrolledIndividual]

Providers

Types:

from finch.types import Provider

Methods:

• client.providers.list() -> SyncSinglePage[Provider]

Account

Types:

from finch.types import DisconnectResponse, Introspection

Methods:

• client.account.disconnect() -> DisconnectResponse
• client.account.introspect() -> Introspection

Webhooks

Types:

from finch.types import (
    AccountUpdateEvent,
    BaseWebhookEvent,
    CompanyEvent,
    DirectoryEvent,
    EmploymentEvent,
    IndividualEvent,
    JobCompletionEvent,
    PayStatementEvent,
    PaymentEvent,
    WebhookEvent,
)

Methods:

• client.webhooks.unwrap(*args) -> WebhookEvent
• client.webhooks.verify_signature(*args) -> None

RequestForwarding

Types:

from finch.types import RequestForwardingForwardResponse

Methods:

• client.request_forwarding.forward(**params) -> RequestForwardingForwardResponse

Jobs

Automated

Types:

from finch.types.jobs import AutomatedAsyncJob, AutomatedCreateResponse

Methods:

• client.jobs.automated.create(**params) -> AutomatedCreateResponse
• client.jobs.automated.retrieve(job_id) -> AutomatedAsyncJob
• client.jobs.automated.list(**params) -> SyncPage[AutomatedAsyncJob]

Manual

Types:

from finch.types.jobs import ManualAsyncJob

Methods:

• client.jobs.manual.retrieve(job_id) -> ManualAsyncJob

Sandbox

Connections

Types:

from finch.types.sandbox import ConnectionCreateResponse

Methods:

• client.sandbox.connections.create(**params) -> ConnectionCreateResponse

Accounts

Types:

from finch.types.sandbox.connections import AccountCreateResponse, AccountUpdateResponse

Methods:

• client.sandbox.connections.accounts.create(**params) -> AccountCreateResponse
• client.sandbox.connections.accounts.update(**params) -> AccountUpdateResponse

Company

Types:

from finch.types.sandbox import CompanyUpdateResponse

Methods:

• client.sandbox.company.update(**params) -> CompanyUpdateResponse

Directory

Types:

from finch.types.sandbox import DirectoryCreateResponse

Methods:

• client.sandbox.directory.create(**params) -> DirectoryCreateResponse

Individual

Types:

from finch.types.sandbox import IndividualUpdateResponse

Methods:

• client.sandbox.individual.update(individual_id, **params) -> IndividualUpdateResponse

Employment

Types:

from finch.types.sandbox import EmploymentUpdateResponse

Methods:

• client.sandbox.employment.update(individual_id, **params) -> EmploymentUpdateResponse

Payment

Types:

from finch.types.sandbox import PaymentCreateResponse

Methods:

• client.sandbox.payment.create(**params) -> PaymentCreateResponse

Jobs

Types:

from finch.types.sandbox import JobCreateResponse

Methods:

• client.sandbox.jobs.create(**params) -> JobCreateResponse

Configuration

Types:

from finch.types.sandbox.jobs import SandboxJobConfiguration, ConfigurationRetrieveResponse

Methods:

• client.sandbox.jobs.configuration.retrieve() -> ConfigurationRetrieveResponse
• client.sandbox.jobs.configuration.update(**params) -> SandboxJobConfiguration