api.md

Finch

Methods:

• client.getAuthURL({ products, redirectUri, sandbox }) -> string
• client.withAccessToken(accessToken) -> Finch

Shared

Types:

• ConnectionStatusType
• OperationSupport
• OperationSupportMatrix
• Paging

AccessTokens

Types:

• CreateAccessTokenResponse

Methods:

• client.accessTokens.create({ ...params }) -> CreateAccessTokenResponse

HRIS

Types:

• Income
• Location
• Money

Company

Types:

• Company

Methods:

• client.hris.company.retrieve({ ...params }) -> Company

PayStatementItem

Types:

• PayStatementItemListResponse

Methods:

• client.hris.company.payStatementItem.list({ ...params }) -> PayStatementItemListResponsesPage

Rules

Types:

• RuleCreateResponse
• RuleUpdateResponse
• RuleListResponse
• RuleDeleteResponse

Methods:

• client.hris.company.payStatementItem.rules.create({ ...params }) -> RuleCreateResponse
• client.hris.company.payStatementItem.rules.update(ruleID, { ...params }) -> RuleUpdateResponse
• client.hris.company.payStatementItem.rules.list({ ...params }) -> RuleListResponsesPage
• client.hris.company.payStatementItem.rules.delete(ruleID, { ...params }) -> RuleDeleteResponse

Directory

Types:

• IndividualInDirectory

Methods:

• client.hris.directory.list({ ...params }) -> IndividualsPage

Individuals

Types:

• Individual
• IndividualResponse

Methods:

• client.hris.individuals.retrieveMany({ ...params }) -> IndividualResponsesPage

Employments

Types:

• EmploymentData
• EmploymentDataResponse

Methods:

• client.hris.employments.retrieveMany({ ...params }) -> EmploymentDataResponsesPage

Payments

Types:

• Payment

Methods:

• client.hris.payments.list({ ...params }) -> PaymentsSinglePage

PayStatements

Types:

• PayStatement
• PayStatementDataSyncInProgress
• PayStatementResponse
• PayStatementResponseBody

Methods:

• client.hris.payStatements.retrieveMany({ ...params }) -> PayStatementResponsesPage

Documents

Types:

• DocumentResponse
• W42005
• W42020
• DocumentListResponse
• DocumentRetreiveResponse

Methods:

• client.hris.documents.list({ ...params }) -> DocumentListResponse
• client.hris.documents.retreive(documentID, { ...params }) -> DocumentRetreiveResponse

Benefits

Types:

• BenefitContribution
• BenefitFeaturesAndOperations
• BenefitFrequency
• BenefitType
• BenefitsSupport
• CompanyBenefit
• CreateCompanyBenefitsResponse
• SupportPerBenefitType
• SupportedBenefit
• UpdateCompanyBenefitResponse
• BenfitContribution

Methods:

• client.hris.benefits.create({ ...params }) -> CreateCompanyBenefitsResponse
• client.hris.benefits.retrieve(benefitID, { ...params }) -> CompanyBenefit
• client.hris.benefits.update(benefitID, { ...params }) -> UpdateCompanyBenefitResponse
• client.hris.benefits.list({ ...params }) -> CompanyBenefitsSinglePage
• client.hris.benefits.listSupportedBenefits({ ...params }) -> SupportedBenefitsSinglePage

Individuals

Types:

• EnrolledIndividualBenefitResponse
• IndividualBenefit
• UnenrolledIndividualBenefitResponse
• IndividualEnrolledIDsResponse

Methods:

• client.hris.benefits.individuals.enrollMany(benefitID, [ ...individuals ]) -> EnrolledIndividualBenefitResponse
• client.hris.benefits.individuals.enrolledIDs(benefitID, { ...params }) -> IndividualEnrolledIDsResponse
• client.hris.benefits.individuals.retrieveManyBenefits(benefitID, { ...params }) -> IndividualBenefitsSinglePage
• client.hris.benefits.individuals.unenrollMany(benefitID, { ...params }) -> UnenrolledIndividualBenefitResponse

Providers

Types:

• Provider
• ProviderListResponse

Methods:

• client.providers.list() -> ProviderListResponsesSinglePage

Account

Types:

• DisconnectResponse
• Introspection

Methods:

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

Webhooks

Types:

• AccountUpdateEvent
• BaseWebhookEvent
• CompanyEvent
• DirectoryEvent
• EmploymentEvent
• IndividualEvent
• JobCompletionEvent
• PayStatementEvent
• PaymentEvent
• WebhookEvent

Methods:

• client.webhooks.unwrap(payload, headers, secret) -> WebhookEvent
• client.webhooks.verifySignature(body, headers, secret) -> void

RequestForwarding

Types:

• RequestForwardingForwardResponse

Methods:

• client.requestForwarding.forward({ ...params }) -> RequestForwardingForwardResponse

Jobs

Automated

Types:

• AutomatedAsyncJob
• AutomatedCreateResponse
• AutomatedListResponse

Methods:

• client.jobs.automated.create({ ...params }) -> AutomatedCreateResponse
• client.jobs.automated.retrieve(jobID) -> AutomatedAsyncJob
• client.jobs.automated.list({ ...params }) -> AutomatedListResponse

Manual

Types:

• ManualAsyncJob

Methods:

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

Sandbox

Connections

Types:

• ConnectionCreateResponse

Methods:

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

Accounts

Types:

• AccountCreateResponse
• AccountUpdateResponse

Methods:

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

Company

Types:

• CompanyUpdateResponse

Methods:

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

Directory

Types:

• DirectoryCreateResponse

Methods:

• client.sandbox.directory.create([ ...body ]) -> DirectoryCreateResponse

Individual

Types:

• IndividualUpdateResponse

Methods:

• client.sandbox.individual.update(individualID, { ...params }) -> IndividualUpdateResponse

Employment

Types:

• EmploymentUpdateResponse

Methods:

• client.sandbox.employment.update(individualID, { ...params }) -> EmploymentUpdateResponse

Payment

Types:

• PaymentCreateResponse

Methods:

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

Jobs

Types:

• JobCreateResponse

Methods:

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

Configuration

Types:

• SandboxJobConfiguration
• ConfigurationRetrieveResponse

Methods:

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

Payroll

PayGroups

Types:

• PayGroupRetrieveResponse
• PayGroupListResponse

Methods:

• client.payroll.payGroups.retrieve(payGroupID, { ...params }) -> PayGroupRetrieveResponse
• client.payroll.payGroups.list({ ...params }) -> PayGroupListResponsesSinglePage

Connect

Sessions

Types:

• SessionNewResponse
• SessionReauthenticateResponse

Methods:

• client.connect.sessions.new({ ...params }) -> SessionNewResponse
• client.connect.sessions.reauthenticate({ ...params }) -> SessionReauthenticateResponse