Actions

The ballerinax/sap.successfactors.ecglobalbenefits package exposes the following clients:

Available clients:

Client	Purpose
`Client`	Manages ecglobalbenefits objects: BenefitEmployeeClaim, BenefitSavingsPlanSubType, BenefitInsurancePlan, BenefitBalanceCarryForwardDetail, EmployeeWithEmployerMatchContributions, BenefitProgramEnrollment, EmployeeWithEmployerMatchContributionEntries, BenefitInsuranceCoverage…, over the SAP SuccessFactors OData v2 API.

Client

You can use these APIs to maintain the global and local benefits beyond regular compensation for employees.

Configuration

ConnectionConfig

Provides a set of configurations for controlling the behaviours when communicating with the SAP SuccessFactors OData endpoint. Passed as the argument to the client initializer.

Field	Type	Default	Description
`auth`	`http:CredentialsConfig`	Required	Configurations related to client authentication
`httpVersion`	`http:HttpVersion`	See default	The HTTP version understood by the client
`http1Settings`	`http:ClientHttp1Settings`	See default	Configurations related to HTTP/1.x protocol
`http2Settings`	`http:ClientHttp2Settings`	See default	Configurations related to HTTP/2 protocol
`timeout`	`decimal`	See default	The maximum time to wait (in seconds) for a response before closing the connection
`forwarded`	`string`	See default	The choice of setting `forwarded`/`x-forwarded` header
`followRedirects`	`http:FollowRedirects`	Optional	Configurations associated with Redirection
`poolConfig`	`http:PoolConfiguration`	Optional	Configurations associated with request pooling
`cache`	`http:CacheConfig`	See default	HTTP caching related configurations
`compression`	`http:Compression`	See default	Specifies the way of handling compression (`accept-encoding`) header
`circuitBreaker`	`http:CircuitBreakerConfig`	Optional	Configurations associated with the behaviour of the Circuit Breaker
`retryConfig`	`http:RetryConfig`	Optional	Configurations associated with retrying
`cookieConfig`	`http:CookieConfig`	Optional	Configurations associated with cookies
`responseLimits`	`http:ResponseLimitConfigs`	See default	Configurations associated with inbound response size limits
`secureSocket`	`http:ClientSecureSocket`	Optional	SSL/TLS-related options
`proxy`	`http:ProxyConfig`	Optional	Proxy server related options
`socketConfig`	`http:ClientSocketConfig`	See default	Provides settings related to client socket configuration
`validation`	`boolean`	See default	Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
`laxDataBinding`	`boolean`	See default	Enables relaxed data binding on the client side. When enabled, `nil` values are treated as optional, and absent fields are handled as `nilable` types. Enabled by default.

The client also accepts a hostname string parameter (the SAP SuccessFactors API server host) and an optional port (defaults to 443).

Initializing the client

import ballerinax/sap.successfactors.ecglobalbenefits;

configurable string hostname = ?;
configurable string username = ?;
configurable string password = ?;

ecglobalbenefits:Client client = check new (
    {
        auth: { username, password }
    },
    hostname
);

Operations

BenefitEmployeeClaim

listBenefitEmployeeClaims

Queries the BenefitEmployeeClaim collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEmployeeClaimsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEmployeeClaims();

getBenefitEmployeeClaim

Retrieves a single BenefitEmployeeClaim entity identified by its key property.

Parameters:

Name	Type	Required	Description
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEmployeeClaimQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEmployeeClaim(id);

BenefitSavingsPlanSubType

listBenefitSavingsPlanSubTypes

Queries the BenefitSavingsPlanSubType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanSubTypesQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanSubTypesResponse|error

Sample code:

ListBenefitSavingsPlanSubTypesResponse result = check client->listBenefitSavingsPlanSubTypes();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitSavingsPlanSubType

Retrieves a single BenefitSavingsPlanSubType entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`benefitSavingsPlanID`	`string`	Yes	key: benefitSavingsPlanID
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanSubTypeQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanSubType|error

Sample code:

BenefitSavingsPlanSubType result = check client->getBenefitSavingsPlanSubType(benefitSavingsPlanID, effectiveStartDate);

Sample response:

{
  "d": {}
}

BenefitInsurancePlan

listBenefitInsurancePlans

Queries the BenefitInsurancePlan collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsurancePlansQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsurancePlans();

getBenefitInsurancePlan

Retrieves a single BenefitInsurancePlan entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsurancePlanQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsurancePlan(effectiveStartDate, id);

BenefitBalanceCarryForwardDetail

listBenefitBalanceCarryForwardDetails

Queries the BenefitBalanceCarryForwardDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitBalanceCarryForwardDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitBalanceCarryForwardDetailsResponse|error

Sample code:

ListBenefitBalanceCarryForwardDetailsResponse result = check client->listBenefitBalanceCarryForwardDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitBalanceCarryForwardDetail

Retrieves a single BenefitBalanceCarryForwardDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitClaimAccumulation_externalCode`	`int`	Yes	key: BenefitClaimAccumulation_externalCode
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitBalanceCarryForwardDetailQueries`	No	Queries to be sent with the request

Returns: BenefitBalanceCarryForwardDetail|error

Sample code:

BenefitBalanceCarryForwardDetail result = check client->getBenefitBalanceCarryForwardDetail(BenefitClaimAccumulation_externalCode, externalCode);

Sample response:

{
  "d": {}
}

EmployeeWithEmployerMatchContributions

listEmployeeWithEmployerMatchContributionss

Queries the EmployeeWithEmployerMatchContributions collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListEmployeeWithEmployerMatchContributionssQueries`	No	Queries to be sent with the request

Returns: ListEmployeeWithEmployerMatchContributionssResponse|error

Sample code:

ListEmployeeWithEmployerMatchContributionssResponse result = check client->listEmployeeWithEmployerMatchContributionss();

Sample response:

{
  "d": {
    "results": [
      {
        "configurationId": "1000",
        "effectiveStartDate": "2026-01-01",
        "employeeWithEmployerMatchContributionEntries": {}
      }
    ]
  }
}

getEmployeeWithEmployerMatchContributions

Retrieves a single EmployeeWithEmployerMatchContributions entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`configurationId`	`string`	Yes	key: configurationId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetEmployeeWithEmployerMatchContributionsQueries`	No	Queries to be sent with the request

Returns: EmployeeWithEmployerMatchContributions|error

Sample code:

EmployeeWithEmployerMatchContributions result = check client->getEmployeeWithEmployerMatchContributions(configurationId, effectiveStartDate);

Sample response:

{
  "configurationId": "1000",
  "effectiveStartDate": "2026-01-01",
  "employeeWithEmployerMatchContributionEntries": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

BenefitProgramEnrollment

listBenefitProgramEnrollments

Queries the BenefitProgramEnrollment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitProgramEnrollmentsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitProgramEnrollments();

getBenefitProgramEnrollment

Retrieves a single BenefitProgramEnrollment entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitProgramEnrollmentQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitProgramEnrollment(effectiveStartDate, id);

EmployeeWithEmployerMatchContributionEntries

listEmployeeWithEmployerMatchContributionEntriess

Queries the EmployeeWithEmployerMatchContributionEntries collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListEmployeeWithEmployerMatchContributionEntriessQueries`	No	Queries to be sent with the request

Returns: ListEmployeeWithEmployerMatchContributionEntriessResponse|error

Sample code:

ListEmployeeWithEmployerMatchContributionEntriessResponse result = check client->listEmployeeWithEmployerMatchContributionEntriess();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getEmployeeWithEmployerMatchContributionEntries

Retrieves a single EmployeeWithEmployerMatchContributionEntries entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`EmployeeWithEmployerMatchContributions_configurationId`	`string`	Yes	key: EmployeeWithEmployerMatchContributions_configurationId
`EmployeeWithEmployerMatchContributions_effectiveStartDate`	`string`	Yes	key: EmployeeWithEmployerMatchContributions_effectiveStartDate
`eeERMatchValuesID`	`string`	Yes	key: eeERMatchValuesID
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetEmployeeWithEmployerMatchContributionEntriesQueries`	No	Queries to be sent with the request

Returns: EmployeeWithEmployerMatchContributionEntries|error

Sample code:

EmployeeWithEmployerMatchContributionEntries result = check client->getEmployeeWithEmployerMatchContributionEntries(EmployeeWithEmployerMatchContributions_configurationId, EmployeeWithEmployerMatchContributions_effectiveStartDate, eeERMatchValuesID);

Sample response:

{
  "d": {}
}

BenefitInsuranceCoverage

listBenefitInsuranceCoverages

Queries the BenefitInsuranceCoverage collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceCoveragesQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceCoverages();

getBenefitInsuranceCoverage

Retrieves a single BenefitInsuranceCoverage entity identified by its key property.

Parameters:

Name	Type	Required	Description
`coverageId`	`string`	Yes	key: coverageId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceCoverageQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceCoverage(coverageId);

BenefitProgram

listBenefitPrograms

Queries the BenefitProgram collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitProgramsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitPrograms();

getBenefitProgram

Retrieves a single BenefitProgram entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`programId`	`string`	Yes	key: programId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitProgramQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitProgram(effectiveStartDate, programId);

BenefitCompanyCarLeaseServiceProvider

listBenefitCompanyCarLeaseServiceProviders

Queries the BenefitCompanyCarLeaseServiceProvider collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyCarLeaseServiceProvidersQueries`	No	Queries to be sent with the request

Returns: ListBenefitCompanyCarLeaseServiceProvidersResponse|error

Sample code:

ListBenefitCompanyCarLeaseServiceProvidersResponse result = check client->listBenefitCompanyCarLeaseServiceProviders();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitCompanyCarLeaseServiceProvider

Retrieves a single BenefitCompanyCarLeaseServiceProvider entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyCarLeaseServiceProviderQueries`	No	Queries to be sent with the request

Returns: BenefitCompanyCarLeaseServiceProvider|error

Sample code:

BenefitCompanyCarLeaseServiceProvider result = check client->getBenefitCompanyCarLeaseServiceProvider(effectiveStartDate, externalCode);

Sample response:

{
  "d": {}
}

BenefitInsuranceRateChart

listBenefitInsuranceRateCharts

Queries the BenefitInsuranceRateChart collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceRateChartsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceRateCharts();

getBenefitInsuranceRateChart

Retrieves a single BenefitInsuranceRateChart entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`rateChartId`	`string`	Yes	key: rateChartId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceRateChartQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceRateChart(effectiveStartDate, rateChartId);

BenefitEmployeeLifeEventDeclarationForm

listBenefitEmployeeLifeEventDeclarationForms

Queries the BenefitEmployeeLifeEventDeclarationForm collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEmployeeLifeEventDeclarationFormsQueries`	No	Queries to be sent with the request

Returns: ListBenefitEmployeeLifeEventDeclarationFormsResponse|error

Sample code:

ListBenefitEmployeeLifeEventDeclarationFormsResponse result = check client->listBenefitEmployeeLifeEventDeclarationForms();

Sample response:

{
  "d": {
    "results": [
      {
        "employeeLifeEventId": "1000",
        "lifeEventIdNav": {}
      }
    ]
  }
}

createBenefitEmployeeLifeEventDeclarationForm

Creates a new BenefitEmployeeLifeEventDeclarationForm entity from the supplied payload.

Parameters:

Name	Type	Required	Description
`payload`	`BenefitEmployeeLifeEventDeclarationForm`	Yes	New entity
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: CreatedBenefitEmployeeLifeEventDeclarationForm|error

Sample code:

CreatedBenefitEmployeeLifeEventDeclarationForm result = check client->createBenefitEmployeeLifeEventDeclarationForm(payload);

Sample response:

{
  "d": {
    "employeeLifeEventId": "1000",
    "lifeEventIdNav": {
      "d": {}
    }
  }
}

getBenefitEmployeeLifeEventDeclarationForm

Retrieves a single BenefitEmployeeLifeEventDeclarationForm entity identified by its key property.

Parameters:

Name	Type	Required	Description
`employeeLifeEventId`	`string`	Yes	key: employeeLifeEventId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEmployeeLifeEventDeclarationFormQueries`	No	Queries to be sent with the request

Returns: BenefitEmployeeLifeEventDeclarationForm|error

Sample code:

BenefitEmployeeLifeEventDeclarationForm result = check client->getBenefitEmployeeLifeEventDeclarationForm(employeeLifeEventId);

Sample response:

{
  "employeeLifeEventId": "1000",
  "lifeEventIdNav": {
    "d": {}
  }
}

updateBenefitEmployeeLifeEventDeclarationForm

Updates the BenefitEmployeeLifeEventDeclarationForm identified by its key property with the supplied payload.

Parameters:

Name	Type	Required	Description
`employeeLifeEventId`	`string`	Yes	key: employeeLifeEventId
`payload`	`ModifiedBenefitEmployeeLifeEventDeclarationForm`	Yes	New property values
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBenefitEmployeeLifeEventDeclarationForm(employeeLifeEventId, payload);

deleteBenefitEmployeeLifeEventDeclarationForm

Deletes the BenefitEmployeeLifeEventDeclarationForm identified by its key property.

Parameters:

Name	Type	Required	Description
`employeeLifeEventId`	`string`	Yes	key: employeeLifeEventId
`headers`	`DeleteBenefitEmployeeLifeEventDeclarationFormHeaders`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBenefitEmployeeLifeEventDeclarationForm(employeeLifeEventId);

BenefitInsuranceProvider

listBenefitInsuranceProviders

Queries the BenefitInsuranceProvider collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceProvidersQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceProviders();

getBenefitInsuranceProvider

Retrieves a single BenefitInsuranceProvider entity identified by its key property.

Parameters:

Name	Type	Required	Description
`providerId`	`string`	Yes	key: providerId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceProviderQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceProvider(providerId);

ImputedCostForAgeRanges

listImputedCostForAgeRangess

Queries the ImputedCostForAgeRanges collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListImputedCostForAgeRangessQueries`	No	Queries to be sent with the request

Returns: ListImputedCostForAgeRangessResponse|error

Sample code:

ListImputedCostForAgeRangessResponse result = check client->listImputedCostForAgeRangess();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getImputedCostForAgeRanges

Retrieves a single ImputedCostForAgeRanges entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`IRSPremiumTable_configurationId`	`string`	Yes	key: IRSPremiumTable_configurationId
`IRSPremiumTable_effectiveStartDate`	`string`	Yes	key: IRSPremiumTable_effectiveStartDate
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetImputedCostForAgeRangesQueries`	No	Queries to be sent with the request

Returns: ImputedCostForAgeRanges|error

Sample code:

ImputedCostForAgeRanges result = check client->getImputedCostForAgeRanges(IRSPremiumTable_configurationId, IRSPremiumTable_effectiveStartDate, externalCode);

Sample response:

{
  "d": {}
}

BenefitInsurancePlanEnrollmentDetails

listBenefitInsurancePlanEnrollmentDetails

Queries the BenefitInsurancePlanEnrollmentDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsurancePlanEnrollmentDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsurancePlanEnrollmentDetails();

getBenefitInsurancePlanEnrollmentDetails

Retrieves a single BenefitInsurancePlanEnrollmentDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsurancePlanEnrollmentDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsurancePlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, externalCode);

BenefitEffectiveDateConfiguration

listBenefitEffectiveDateConfigurations

Queries the BenefitEffectiveDateConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEffectiveDateConfigurationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEffectiveDateConfigurations();

getBenefitEffectiveDateConfiguration

Retrieves a single BenefitEffectiveDateConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitLifeEventConfiguration_configurationId`	`string`	Yes	key: BenefitLifeEventConfiguration_configurationId
`BenefitLifeEventConfiguration_effectiveStartDate`	`string`	Yes	key: BenefitLifeEventConfiguration_effectiveStartDate
`benefit`	`string`	Yes	key: benefit
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEffectiveDateConfigurationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEffectiveDateConfiguration(BenefitLifeEventConfiguration_configurationId, BenefitLifeEventConfiguration_effectiveStartDate, benefit);

BenefitEvent

listBenefitEvents

Queries the BenefitEvent collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEventsQueries`	No	Queries to be sent with the request

Returns: ListBenefitEventsResponse|error

Sample code:

ListBenefitEventsResponse result = check client->listBenefitEvents();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitEvent

Retrieves a single BenefitEvent entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`eventCode`	`string`	Yes	key: eventCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEventQueries`	No	Queries to be sent with the request

Returns: BenefitEvent|error

Sample code:

BenefitEvent result = check client->getBenefitEvent(effectiveStartDate, eventCode);

Sample response:

{
  "d": {}
}

BenefitSchedules

listBenefitScheduless

Queries the BenefitSchedules collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSchedulessQueries`	No	Queries to be sent with the request

Returns: ListBenefitSchedulessResponse|error

Sample code:

ListBenefitSchedulessResponse result = check client->listBenefitScheduless();

Sample response:

{
  "d": {
    "results": [
      {
        "id": "1000",
        "periods": {}
      }
    ]
  }
}

getBenefitSchedules

Retrieves a single BenefitSchedules entity identified by its key property.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSchedulesQueries`	No	Queries to be sent with the request

Returns: BenefitSchedules|error

Sample code:

BenefitSchedules result = check client->getBenefitSchedules(id);

Sample response:

{
  "id": "1000",
  "periods": {
    "results": [
      {
        "id": "1000"
      }
    ]
  }
}

BenefitProgramExceptionDetails

listBenefitProgramExceptionDetails

Queries the BenefitProgramExceptionDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitProgramExceptionDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitProgramExceptionDetails();

getBenefitProgramExceptionDetails

Retrieves a single BenefitProgramExceptionDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitsException_exceptionId`	`int`	Yes	key: BenefitsException_exceptionId
`benefitProgram`	`string`	Yes	key: benefitProgram
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitProgramExceptionDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitProgramExceptionDetails(BenefitsException_exceptionId, benefitProgram);

SavingsAccountDeductionDetails

listSavingsAccountDeductionDetails

Queries the SavingsAccountDeductionDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListSavingsAccountDeductionDetailsQueries`	No	Queries to be sent with the request

Returns: ListSavingsAccountDeductionDetailsResponse|error

Sample code:

ListSavingsAccountDeductionDetailsResponse result = check client->listSavingsAccountDeductionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "SavingsAccountBenefitDetails_externalCode": "1000",
        "SavingsAccountUSA_externalCode": "1000",
        "deductionDetailId": "1000"
      }
    ]
  }
}

getSavingsAccountDeductionDetails

Retrieves a single SavingsAccountDeductionDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`SavingsAccountBenefitDetails_externalCode`	`int`	Yes	key: SavingsAccountBenefitDetails_externalCode
`SavingsAccountUSA_externalCode`	`int`	Yes	key: SavingsAccountUSA_externalCode
`deductionDetailId`	`int`	Yes	key: deductionDetailId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetSavingsAccountDeductionDetailsQueries`	No	Queries to be sent with the request

Returns: SavingsAccountDeductionDetails|error

Sample code:

SavingsAccountDeductionDetails result = check client->getSavingsAccountDeductionDetails(Benefit_benefitId, Benefit_effectiveStartDate, SavingsAccountBenefitDetails_externalCode, SavingsAccountUSA_externalCode, deductionDetailId);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "SavingsAccountBenefitDetails_externalCode": "1000",
  "SavingsAccountUSA_externalCode": "1000",
  "deductionDetailId": "1000"
}

BenefitPaymentOptions

listBenefitPaymentOptionss

Queries the BenefitPaymentOptions collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPaymentOptionssQueries`	No	Queries to be sent with the request

Returns: ListBenefitPaymentOptionssResponse|error

Sample code:

ListBenefitPaymentOptionssResponse result = check client->listBenefitPaymentOptionss();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitPaymentOptions

Retrieves a single BenefitPaymentOptions entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`payComponent`	`string`	Yes	key: payComponent
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPaymentOptionsQueries`	No	Queries to be sent with the request

Returns: BenefitPaymentOptions|error

Sample code:

BenefitPaymentOptions result = check client->getBenefitPaymentOptions(Benefit_benefitId, Benefit_effectiveStartDate, payComponent);

Sample response:

{
  "d": {}
}

BenefitSavingsPlanSubTypeCountryLookup

listBenefitSavingsPlanSubTypeCountryLookups

Queries the BenefitSavingsPlanSubTypeCountryLookup collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanSubTypeCountryLookupsQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanSubTypeCountryLookupsResponse|error

Sample code:

ListBenefitSavingsPlanSubTypeCountryLookupsResponse result = check client->listBenefitSavingsPlanSubTypeCountryLookups();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "effectiveStartDate": "2026-01-01",
        "benefitSavingsPlanSubTypes": {}
      }
    ]
  }
}

getBenefitSavingsPlanSubTypeCountryLookup

Retrieves a single BenefitSavingsPlanSubTypeCountryLookup entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`country`	`string`	Yes	key: country
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanSubTypeCountryLookupQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanSubTypeCountryLookup|error

Sample code:

BenefitSavingsPlanSubTypeCountryLookup result = check client->getBenefitSavingsPlanSubTypeCountryLookup(country, effectiveStartDate);

Sample response:

{
  "country": "string",
  "effectiveStartDate": "2026-01-01",
  "benefitSavingsPlanSubTypes": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

LifeEventForBenefit

listLifeEventForBenefits

Queries the LifeEventForBenefit collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListLifeEventForBenefitsQueries`	No	Queries to be sent with the request

Returns: ListLifeEventForBenefitsResponse|error

Sample code:

ListLifeEventForBenefitsResponse result = check client->listLifeEventForBenefits();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getLifeEventForBenefit

Retrieves a single LifeEventForBenefit entity identified by its key property.

Parameters:

Name	Type	Required	Description
`lifeEventId`	`string`	Yes	key: lifeEventId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetLifeEventForBenefitQueries`	No	Queries to be sent with the request

Returns: LifeEventForBenefit|error

Sample code:

LifeEventForBenefit result = check client->getLifeEventForBenefit(lifeEventId);

Sample response:

{
  "d": {}
}

BenefitInsurancePlanUSA

listBenefitInsurancePlanUSAs

Queries the BenefitInsurancePlanUSA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsurancePlanUSAsQueries`	No	Queries to be sent with the request

Returns: ListBenefitInsurancePlanUSAsResponse|error

Sample code:

ListBenefitInsurancePlanUSAsResponse result = check client->listBenefitInsurancePlanUSAs();

Sample response:

{
  "d": {
    "results": [
      {
        "BenefitInsurancePlan_effectiveStartDate": "2026-01-01",
        "BenefitInsurancePlan_id": "1000",
        "id": "1000",
        "IRSPremiumTableNav": {}
      }
    ]
  }
}

getBenefitInsurancePlanUSA

Retrieves a single BenefitInsurancePlanUSA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitInsurancePlan_effectiveStartDate`	`string`	Yes	key: BenefitInsurancePlan_effectiveStartDate
`BenefitInsurancePlan_id`	`string`	Yes	key: BenefitInsurancePlan_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsurancePlanUSAQueries`	No	Queries to be sent with the request

Returns: BenefitInsurancePlanUSA|error

Sample code:

BenefitInsurancePlanUSA result = check client->getBenefitInsurancePlanUSA(BenefitInsurancePlan_effectiveStartDate, BenefitInsurancePlan_id, id);

Sample response:

{
  "BenefitInsurancePlan_effectiveStartDate": "2026-01-01",
  "BenefitInsurancePlan_id": "1000",
  "id": "1000",
  "IRSPremiumTableNav": {
    "results": [
      {
        "configurationId": "1000",
        "effectiveStartDate": "2026-01-01",
        "imputedCostForAgeRanges": {}
      }
    ]
  }
}

SavingsAccountBenefitDetails

listSavingsAccountBenefitDetails

Queries the SavingsAccountBenefitDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListSavingsAccountBenefitDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listSavingsAccountBenefitDetails();

getSavingsAccountBenefitDetails

Retrieves a single SavingsAccountBenefitDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetSavingsAccountBenefitDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getSavingsAccountBenefitDetails(Benefit_benefitId, Benefit_effectiveStartDate, externalCode);

IRSPremiumTable

listIRSPremiumTables

Queries the IRSPremiumTable collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListIRSPremiumTablesQueries`	No	Queries to be sent with the request

Returns: ListIRSPremiumTablesResponse|error

Sample code:

ListIRSPremiumTablesResponse result = check client->listIRSPremiumTables();

Sample response:

{
  "d": {
    "results": [
      {
        "configurationId": "1000",
        "effectiveStartDate": "2026-01-01",
        "imputedCostForAgeRanges": {}
      }
    ]
  }
}

getIRSPremiumTable

Retrieves a single IRSPremiumTable entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`configurationId`	`string`	Yes	key: configurationId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetIRSPremiumTableQueries`	No	Queries to be sent with the request

Returns: IRSPremiumTable|error

Sample code:

IRSPremiumTable result = check client->getIRSPremiumTable(configurationId, effectiveStartDate);

Sample response:

{
  "configurationId": "1000",
  "effectiveStartDate": "2026-01-01",
  "imputedCostForAgeRanges": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

BenefitSchedulePeriod

listBenefitSchedulePeriods

Queries the BenefitSchedulePeriod collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSchedulePeriodsQueries`	No	Queries to be sent with the request

Returns: ListBenefitSchedulePeriodsResponse|error

Sample code:

ListBenefitSchedulePeriodsResponse result = check client->listBenefitSchedulePeriods();

Sample response:

{
  "d": {
    "results": [
      {
        "id": "1000"
      }
    ]
  }
}

getBenefitSchedulePeriod

Retrieves a single BenefitSchedulePeriod entity identified by its key property.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSchedulePeriodQueries`	No	Queries to be sent with the request

Returns: BenefitSchedulePeriod|error

Sample code:

BenefitSchedulePeriod result = check client->getBenefitSchedulePeriod(id);

Sample response:

{
  "id": "1000"
}

BenefitOpenEnrollmentCycleConfiguration

listBenefitOpenEnrollmentCycleConfigurations

Queries the BenefitOpenEnrollmentCycleConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitOpenEnrollmentCycleConfigurationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitOpenEnrollmentCycleConfigurations();

getBenefitOpenEnrollmentCycleConfiguration

Retrieves a single BenefitOpenEnrollmentCycleConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`openEnrollmentId`	`string`	Yes	key: openEnrollmentId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitOpenEnrollmentCycleConfigurationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitOpenEnrollmentCycleConfiguration(effectiveStartDate, openEnrollmentId);

PensionBandingConfiguration

listPensionBandingConfigurations

Queries the PensionBandingConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListPensionBandingConfigurationsQueries`	No	Queries to be sent with the request

Returns: ListPensionBandingConfigurationsResponse|error

Sample code:

ListPensionBandingConfigurationsResponse result = check client->listPensionBandingConfigurations();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPensionBandingConfiguration

Retrieves a single PensionBandingConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`bandingConfigurationId`	`string`	Yes	key: bandingConfigurationId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPensionBandingConfigurationQueries`	No	Queries to be sent with the request

Returns: PensionBandingConfiguration|error

Sample code:

PensionBandingConfiguration result = check client->getPensionBandingConfiguration(bandingConfigurationId, effectiveStartDate);

Sample response:

{
  "d": {}
}

BenefitInsuranceDependentDetail

listBenefitInsuranceDependentDetails

Queries the BenefitInsuranceDependentDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceDependentDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitInsuranceDependentDetailsResponse|error

Sample code:

ListBenefitInsuranceDependentDetailsResponse result = check client->listBenefitInsuranceDependentDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitInsuranceDependentDetail

Retrieves a single BenefitInsuranceDependentDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`BenefitInsurancePlanEnrollmentDetails_externalCode`	`int`	Yes	key: BenefitInsurancePlanEnrollmentDetails_externalCode
`dependentName`	`string`	Yes	key: dependentName
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceDependentDetailQueries`	No	Queries to be sent with the request

Returns: BenefitInsuranceDependentDetail|error

Sample code:

BenefitInsuranceDependentDetail result = check client->getBenefitInsuranceDependentDetail(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, BenefitInsurancePlanEnrollmentDetails_externalCode, dependentName);

Sample response:

{
  "d": {}
}

BenefitProgramEnrollmentDetail

listBenefitProgramEnrollmentDetails

Queries the BenefitProgramEnrollmentDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitProgramEnrollmentDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitProgramEnrollmentDetails();

getBenefitProgramEnrollmentDetail

Retrieves a single BenefitProgramEnrollmentDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitProgramEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitProgramEnrollment_effectiveStartDate
`BenefitProgramEnrollment_id`	`int`	Yes	key: BenefitProgramEnrollment_id
`selectionId`	`int`	Yes	key: selectionId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitProgramEnrollmentDetailQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitProgramEnrollmentDetail(BenefitProgramEnrollment_effectiveStartDate, BenefitProgramEnrollment_id, selectionId);

ACAReportingInformation

listACAReportingInformations

Queries the ACAReportingInformation collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListACAReportingInformationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listACAReportingInformations();

getACAReportingInformation

Retrieves a single ACAReportingInformation entity identified by its key property.

Parameters:

Name	Type	Required	Description
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetACAReportingInformationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getACAReportingInformation(externalCode);

BenefitEmployeeClaimDetail

listBenefitEmployeeClaimDetails

Queries the BenefitEmployeeClaimDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEmployeeClaimDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitEmployeeClaimDetailsResponse|error

Sample code:

ListBenefitEmployeeClaimDetailsResponse result = check client->listBenefitEmployeeClaimDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitEmployeeClaimDetail

Retrieves a single BenefitEmployeeClaimDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEmployeeClaim_id`	`int`	Yes	key: BenefitEmployeeClaim_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEmployeeClaimDetailQueries`	No	Queries to be sent with the request

Returns: BenefitEmployeeClaimDetail|error

Sample code:

BenefitEmployeeClaimDetail result = check client->getBenefitEmployeeClaimDetail(BenefitEmployeeClaim_id, id);

Sample response:

{
  "d": {}
}

BenefitFuelReimbursement

listBenefitFuelReimbursements

Queries the BenefitFuelReimbursement collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitFuelReimbursementsQueries`	No	Queries to be sent with the request

Returns: ListBenefitFuelReimbursementsResponse|error

Sample code:

ListBenefitFuelReimbursementsResponse result = check client->listBenefitFuelReimbursements();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitFuelReimbursement

Retrieves a single BenefitFuelReimbursement entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEmployeeClaim_id`	`int`	Yes	key: BenefitEmployeeClaim_id
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitFuelReimbursementQueries`	No	Queries to be sent with the request

Returns: BenefitFuelReimbursement|error

Sample code:

BenefitFuelReimbursement result = check client->getBenefitFuelReimbursement(BenefitEmployeeClaim_id, externalCode);

Sample response:

{
  "d": {}
}

InsuranceEnrollmentFieldsConfiguration

listInsuranceEnrollmentFieldsConfigurations

Queries the InsuranceEnrollmentFieldsConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListInsuranceEnrollmentFieldsConfigurationsQueries`	No	Queries to be sent with the request

Returns: ListInsuranceEnrollmentFieldsConfigurationsResponse|error

Sample code:

ListInsuranceEnrollmentFieldsConfigurationsResponse result = check client->listInsuranceEnrollmentFieldsConfigurations();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "InsuranceBenefitDetails_externalCode": "1000",
        "configurationId": "1000"
      }
    ]
  }
}

getInsuranceEnrollmentFieldsConfiguration

Retrieves a single InsuranceEnrollmentFieldsConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`InsuranceBenefitDetails_externalCode`	`int`	Yes	key: InsuranceBenefitDetails_externalCode
`configurationId`	`int`	Yes	key: configurationId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetInsuranceEnrollmentFieldsConfigurationQueries`	No	Queries to be sent with the request

Returns: InsuranceEnrollmentFieldsConfiguration|error

Sample code:

InsuranceEnrollmentFieldsConfiguration result = check client->getInsuranceEnrollmentFieldsConfiguration(Benefit_benefitId, Benefit_effectiveStartDate, InsuranceBenefitDetails_externalCode, configurationId);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "InsuranceBenefitDetails_externalCode": "1000",
  "configurationId": "1000"
}

BenefitCompanyCar

listBenefitCompanyCars

Queries the BenefitCompanyCar collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyCarsQueries`	No	Queries to be sent with the request

Returns: ListBenefitCompanyCarsResponse|error

Sample code:

ListBenefitCompanyCarsResponse result = check client->listBenefitCompanyCars();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "benefitCompanyCarId": "1000",
        "benCompanyCarAllowedModels": {},
        "benCompanyCarRecommendedVendors": {},
        "carLeaseServiceProviders": {}
      }
    ]
  }
}

getBenefitCompanyCar

Retrieves a single BenefitCompanyCar entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`benefitCompanyCarId`	`int`	Yes	key: benefitCompanyCarId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyCarQueries`	No	Queries to be sent with the request

Returns: BenefitCompanyCar|error

Sample code:

BenefitCompanyCar result = check client->getBenefitCompanyCar(Benefit_benefitId, Benefit_effectiveStartDate, benefitCompanyCarId);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "benefitCompanyCarId": "1000",
  "benCompanyCarAllowedModels": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "benCompanyCarRecommendedVendors": {
    "results": [
      {
        "d": {}
      }
    ]
  },
  "carLeaseServiceProviders": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

BenefitCompanyHousing

listBenefitCompanyHousings

Queries the BenefitCompanyHousing collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyHousingsQueries`	No	Queries to be sent with the request

Returns: ListBenefitCompanyHousingsResponse|error

Sample code:

ListBenefitCompanyHousingsResponse result = check client->listBenefitCompanyHousings();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "id": "1000"
      }
    ]
  }
}

getBenefitCompanyHousing

Retrieves a single BenefitCompanyHousing entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyHousingQueries`	No	Queries to be sent with the request

Returns: BenefitCompanyHousing|error

Sample code:

BenefitCompanyHousing result = check client->getBenefitCompanyHousing(Benefit_benefitId, Benefit_effectiveStartDate, id);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "id": "1000"
}

BenefitPensionAdditionalContributionLimits

listBenefitPensionAdditionalContributionLimitss

Queries the BenefitPensionAdditionalContributionLimits collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionAdditionalContributionLimitssQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionAdditionalContributionLimitssResponse|error

Sample code:

ListBenefitPensionAdditionalContributionLimitssResponse result = check client->listBenefitPensionAdditionalContributionLimitss();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitPensionAdditionalContributionLimits

Retrieves a single BenefitPensionAdditionalContributionLimits entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`contributionLimitId`	`string`	Yes	key: contributionLimitId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionAdditionalContributionLimitsQueries`	No	Queries to be sent with the request

Returns: BenefitPensionAdditionalContributionLimits|error

Sample code:

BenefitPensionAdditionalContributionLimits result = check client->getBenefitPensionAdditionalContributionLimits(contributionLimitId, effectiveStartDate);

Sample response:

{
  "d": {}
}

BenefitPensionNonDependentNominees

listBenefitPensionNonDependentNomineess

Queries the BenefitPensionNonDependentNominees collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionNonDependentNomineessQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionNonDependentNomineessResponse|error

Sample code:

ListBenefitPensionNonDependentNomineessResponse result = check client->listBenefitPensionNonDependentNomineess();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitPensionNonDependentNominees

Retrieves a single BenefitPensionNonDependentNominees entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`nomineesId`	`int`	Yes	key: nomineesId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionNonDependentNomineesQueries`	No	Queries to be sent with the request

Returns: BenefitPensionNonDependentNominees|error

Sample code:

BenefitPensionNonDependentNominees result = check client->getBenefitPensionNonDependentNominees(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, nomineesId);

Sample response:

{
  "d": {}
}

BenefitExceptionDetails

listBenefitExceptionDetails

Queries the BenefitExceptionDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitExceptionDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitExceptionDetails();

getBenefitExceptionDetails

Retrieves a single BenefitExceptionDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitsException_exceptionId`	`int`	Yes	key: BenefitsException_exceptionId
`benefit`	`string`	Yes	key: benefit
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitExceptionDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitExceptionDetails(BenefitsException_exceptionId, benefit);

InsuranceBenefitDetails

listInsuranceBenefitDetails

Queries the InsuranceBenefitDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListInsuranceBenefitDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listInsuranceBenefitDetails();

getInsuranceBenefitDetails

Retrieves a single InsuranceBenefitDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetInsuranceBenefitDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getInsuranceBenefitDetails(Benefit_benefitId, Benefit_effectiveStartDate, externalCode);

Benefit

listBenefits

Queries the Benefit collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefits();

getBenefit

Retrieves a single Benefit entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`benefitId`	`string`	Yes	key: benefitId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefit(benefitId, effectiveStartDate);

BenefitInsuranceCoverageDetails

listBenefitInsuranceCoverageDetails

Queries the BenefitInsuranceCoverageDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceCoverageDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceCoverageDetails();

getBenefitInsuranceCoverageDetails

Retrieves a single BenefitInsuranceCoverageDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitInsuranceCoverageOptions_externalCode`	`int`	Yes	key: BenefitInsuranceCoverageOptions_externalCode
`BenefitInsurancePlan_effectiveStartDate`	`string`	Yes	key: BenefitInsurancePlan_effectiveStartDate
`BenefitInsurancePlan_id`	`string`	Yes	key: BenefitInsurancePlan_id
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceCoverageDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceCoverageDetails(BenefitInsuranceCoverageOptions_externalCode, BenefitInsurancePlan_effectiveStartDate, BenefitInsurancePlan_id, externalCode);

BenefitInsuranceEnrolleeOptions

listBenefitInsuranceEnrolleeOptionss

Queries the BenefitInsuranceEnrolleeOptions collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceEnrolleeOptionssQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceEnrolleeOptionss();

getBenefitInsuranceEnrolleeOptions

Retrieves a single BenefitInsuranceEnrolleeOptions entity identified by its key property.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceEnrolleeOptionsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceEnrolleeOptions(id);

BenefitPensionFundEnrollmentContributionDetail

listBenefitPensionFundEnrollmentContributionDetails

Queries the BenefitPensionFundEnrollmentContributionDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionFundEnrollmentContributionDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionFundEnrollmentContributionDetailsResponse|error

Sample code:

ListBenefitPensionFundEnrollmentContributionDetailsResponse result = check client->listBenefitPensionFundEnrollmentContributionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitPensionFundEnrollmentContributionDetail

Retrieves a single BenefitPensionFundEnrollmentContributionDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionFundEnrollmentContributionDetailQueries`	No	Queries to be sent with the request

Returns: BenefitPensionFundEnrollmentContributionDetail|error

Sample code:

BenefitPensionFundEnrollmentContributionDetail result = check client->getBenefitPensionFundEnrollmentContributionDetail(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, id);

Sample response:

{
  "d": {}
}

BenefitPensionEnrollmentContributionDetail

listBenefitPensionEnrollmentContributionDetails

Queries the BenefitPensionEnrollmentContributionDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionEnrollmentContributionDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionEnrollmentContributionDetailsResponse|error

Sample code:

ListBenefitPensionEnrollmentContributionDetailsResponse result = check client->listBenefitPensionEnrollmentContributionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitPensionEnrollmentContributionDetail

Retrieves a single BenefitPensionEnrollmentContributionDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`contributionId`	`int`	Yes	key: contributionId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionEnrollmentContributionDetailQueries`	No	Queries to be sent with the request

Returns: BenefitPensionEnrollmentContributionDetail|error

Sample code:

BenefitPensionEnrollmentContributionDetail result = check client->getBenefitPensionEnrollmentContributionDetail(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, contributionId);

Sample response:

{
  "d": {}
}

BenefitPensionMinMaxContributionLimits

listBenefitPensionMinMaxContributionLimitss

Queries the BenefitPensionMinMaxContributionLimits collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionMinMaxContributionLimitssQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionMinMaxContributionLimitssResponse|error

Sample code:

ListBenefitPensionMinMaxContributionLimitssResponse result = check client->listBenefitPensionMinMaxContributionLimitss();

Sample response:

{
  "d": {
    "results": [
      {
        "configurationTableId": "1000",
        "effectiveStartDate": "2026-01-01"
      }
    ]
  }
}

getBenefitPensionMinMaxContributionLimits

Retrieves a single BenefitPensionMinMaxContributionLimits entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`configurationTableId`	`string`	Yes	key: configurationTableId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionMinMaxContributionLimitsQueries`	No	Queries to be sent with the request

Returns: BenefitPensionMinMaxContributionLimits|error

Sample code:

BenefitPensionMinMaxContributionLimits result = check client->getBenefitPensionMinMaxContributionLimits(configurationTableId, effectiveStartDate);

Sample response:

{
  "configurationTableId": "1000",
  "effectiveStartDate": "2026-01-01"
}

BenefitDependentDetail

listBenefitDependentDetails

Queries the BenefitDependentDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitDependentDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitDependentDetailsResponse|error

Sample code:

ListBenefitDependentDetailsResponse result = check client->listBenefitDependentDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "BenefitEmployeeClaim_id": "1000",
        "dependentName": "string"
      }
    ]
  }
}

getBenefitDependentDetail

Retrieves a single BenefitDependentDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEmployeeClaim_id`	`int`	Yes	key: BenefitEmployeeClaim_id
`dependentName`	`string`	Yes	key: dependentName
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitDependentDetailQueries`	No	Queries to be sent with the request

Returns: BenefitDependentDetail|error

Sample code:

BenefitDependentDetail result = check client->getBenefitDependentDetail(BenefitEmployeeClaim_id, dependentName);

Sample response:

{
  "BenefitEmployeeClaim_id": "1000",
  "dependentName": "string"
}

BenefitCompanyCarEnrollment

listBenefitCompanyCarEnrollments

Queries the BenefitCompanyCarEnrollment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyCarEnrollmentsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitCompanyCarEnrollments();

getBenefitCompanyCarEnrollment

Retrieves a single BenefitCompanyCarEnrollment entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyCarEnrollmentQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitCompanyCarEnrollment(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, id);

BenefitPensionEmployerContributionDetail

listBenefitPensionEmployerContributionDetails

Queries the BenefitPensionEmployerContributionDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionEmployerContributionDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionEmployerContributionDetailsResponse|error

Sample code:

ListBenefitPensionEmployerContributionDetailsResponse result = check client->listBenefitPensionEmployerContributionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "id": "1000"
      }
    ]
  }
}

getBenefitPensionEmployerContributionDetail

Retrieves a single BenefitPensionEmployerContributionDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionEmployerContributionDetailQueries`	No	Queries to be sent with the request

Returns: BenefitPensionEmployerContributionDetail|error

Sample code:

BenefitPensionEmployerContributionDetail result = check client->getBenefitPensionEmployerContributionDetail(Benefit_benefitId, Benefit_effectiveStartDate, id);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "id": "1000"
}

BenefitsConfigUIScreenLookup

listBenefitsConfigUIScreenLookups

Queries the BenefitsConfigUIScreenLookup collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitsConfigUIScreenLookupsQueries`	No	Queries to be sent with the request

Returns: ListBenefitsConfigUIScreenLookupsResponse|error

Sample code:

ListBenefitsConfigUIScreenLookupsResponse result = check client->listBenefitsConfigUIScreenLookups();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitsConfigUIScreenLookup

Retrieves a single BenefitsConfigUIScreenLookup entity identified by its key property.

Parameters:

Name	Type	Required	Description
`objectType`	`string`	Yes	key: objectType
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitsConfigUIScreenLookupQueries`	No	Queries to be sent with the request

Returns: BenefitsConfigUIScreenLookup|error

Sample code:

BenefitsConfigUIScreenLookup result = check client->getBenefitsConfigUIScreenLookup(objectType);

Sample response:

{
  "d": {}
}

BenefitDocuments

listBenefitDocumentss

Queries the BenefitDocuments collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitDocumentssQueries`	No	Queries to be sent with the request

Returns: ListBenefitDocumentssResponse|error

Sample code:

ListBenefitDocumentssResponse result = check client->listBenefitDocumentss();

Sample response:

{
  "d": {
    "results": [
      {
        "effectiveStartDate": "2026-01-01",
        "id": "1000"
      }
    ]
  }
}

getBenefitDocuments

Retrieves a single BenefitDocuments entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitDocumentsQueries`	No	Queries to be sent with the request

Returns: BenefitDocuments|error

Sample code:

BenefitDocuments result = check client->getBenefitDocuments(effectiveStartDate, id);

Sample response:

{
  "effectiveStartDate": "2026-01-01",
  "id": "1000"
}

BenefitPensionFund

listBenefitPensionFunds

Queries the BenefitPensionFund collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionFundsQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionFundsResponse|error

Sample code:

ListBenefitPensionFundsResponse result = check client->listBenefitPensionFunds();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "id": "1000"
      }
    ]
  }
}

getBenefitPensionFund

Retrieves a single BenefitPensionFund entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionFundQueries`	No	Queries to be sent with the request

Returns: BenefitPensionFund|error

Sample code:

BenefitPensionFund result = check client->getBenefitPensionFund(Benefit_benefitId, Benefit_effectiveStartDate, id);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "id": "1000"
}

PensionBandingConfigurationDetails

listPensionBandingConfigurationDetails

Queries the PensionBandingConfigurationDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListPensionBandingConfigurationDetailsQueries`	No	Queries to be sent with the request

Returns: ListPensionBandingConfigurationDetailsResponse|error

Sample code:

ListPensionBandingConfigurationDetailsResponse result = check client->listPensionBandingConfigurationDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getPensionBandingConfigurationDetails

Retrieves a single PensionBandingConfigurationDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`PensionBandingConfiguration_bandingConfigurationId`	`string`	Yes	key: PensionBandingConfiguration_bandingConfigurationId
`PensionBandingConfiguration_effectiveStartDate`	`string`	Yes	key: PensionBandingConfiguration_effectiveStartDate
`bandingDetailsId`	`string`	Yes	key: bandingDetailsId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetPensionBandingConfigurationDetailsQueries`	No	Queries to be sent with the request

Returns: PensionBandingConfigurationDetails|error

Sample code:

PensionBandingConfigurationDetails result = check client->getPensionBandingConfigurationDetails(PensionBandingConfiguration_bandingConfigurationId, PensionBandingConfiguration_effectiveStartDate, bandingDetailsId);

Sample response:

{
  "d": {}
}

BenefitsException

listBenefitsExceptions

Queries the BenefitsException collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitsExceptionsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitsExceptions();

getBenefitsException

Retrieves a single BenefitsException entity identified by its key property.

Parameters:

Name	Type	Required	Description
`exceptionId`	`int`	Yes	key: exceptionId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitsExceptionQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitsException(exceptionId);

BenefitInsuranceRateChartFixedAmount

listBenefitInsuranceRateChartFixedAmounts

Queries the BenefitInsuranceRateChartFixedAmount collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceRateChartFixedAmountsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceRateChartFixedAmounts();

getBenefitInsuranceRateChartFixedAmount

Retrieves a single BenefitInsuranceRateChartFixedAmount entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitInsuranceRateChart_effectiveStartDate`	`string`	Yes	key: BenefitInsuranceRateChart_effectiveStartDate
`BenefitInsuranceRateChart_rateChartId`	`string`	Yes	key: BenefitInsuranceRateChart_rateChartId
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceRateChartFixedAmountQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceRateChartFixedAmount(BenefitInsuranceRateChart_effectiveStartDate, BenefitInsuranceRateChart_rateChartId, externalCode);

BenefitLegalEntity

listBenefitLegalEntitys

Queries the BenefitLegalEntity collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitLegalEntitysQueries`	No	Queries to be sent with the request

Returns: ListBenefitLegalEntitysResponse|error

Sample code:

ListBenefitLegalEntitysResponse result = check client->listBenefitLegalEntitys();

Sample response:

{
  "d": {
    "results": [
      {
        "company": "string"
      }
    ]
  }
}

getBenefitLegalEntity

Retrieves a single BenefitLegalEntity entity identified by its key property.

Parameters:

Name	Type	Required	Description
`company`	`string`	Yes	key: company
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitLegalEntityQueries`	No	Queries to be sent with the request

Returns: BenefitLegalEntity|error

Sample code:

BenefitLegalEntity result = check client->getBenefitLegalEntity(company);

Sample response:

{
  "company": "string"
}

BenefitSavingsPlanEnrollmentContributionDetail

listBenefitSavingsPlanEnrollmentContributionDetails

Queries the BenefitSavingsPlanEnrollmentContributionDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanEnrollmentContributionDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanEnrollmentContributionDetailsResponse|error

Sample code:

ListBenefitSavingsPlanEnrollmentContributionDetailsResponse result = check client->listBenefitSavingsPlanEnrollmentContributionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "BenefitEnrollment_effectiveStartDate": "2026-01-01",
        "BenefitEnrollment_id": "1000",
        "id": "1000",
        "pensionFundNav": {}
      }
    ]
  }
}

getBenefitSavingsPlanEnrollmentContributionDetail

Retrieves a single BenefitSavingsPlanEnrollmentContributionDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanEnrollmentContributionDetailQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanEnrollmentContributionDetail|error

Sample code:

BenefitSavingsPlanEnrollmentContributionDetail result = check client->getBenefitSavingsPlanEnrollmentContributionDetail(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, id);

Sample response:

{
  "BenefitEnrollment_effectiveStartDate": "2026-01-01",
  "BenefitEnrollment_id": "1000",
  "id": "1000",
  "pensionFundNav": {
    "Benefit_benefitId": "1000",
    "Benefit_effectiveStartDate": "2026-01-01",
    "id": "1000"
  }
}

BenefitCompanyCarRecommendedVendors

listBenefitCompanyCarRecommendedVendorss

Queries the BenefitCompanyCarRecommendedVendors collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyCarRecommendedVendorssQueries`	No	Queries to be sent with the request

Returns: ListBenefitCompanyCarRecommendedVendorssResponse|error

Sample code:

ListBenefitCompanyCarRecommendedVendorssResponse result = check client->listBenefitCompanyCarRecommendedVendorss();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitCompanyCarRecommendedVendors

Retrieves a single BenefitCompanyCarRecommendedVendors entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyCarRecommendedVendorsQueries`	No	Queries to be sent with the request

Returns: BenefitCompanyCarRecommendedVendors|error

Sample code:

BenefitCompanyCarRecommendedVendors result = check client->getBenefitCompanyCarRecommendedVendors(effectiveStartDate, externalCode);

Sample response:

{
  "d": {}
}

BenefitInsuranceEnrolleeType

listBenefitInsuranceEnrolleeTypes

Queries the BenefitInsuranceEnrolleeType collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceEnrolleeTypesQueries`	No	Queries to be sent with the request

Returns: ListBenefitInsuranceEnrolleeTypesResponse|error

Sample code:

ListBenefitInsuranceEnrolleeTypesResponse result = check client->listBenefitInsuranceEnrolleeTypes();

Sample response:

{
  "d": {
    "results": [
      {
        "mdfSystemEffectiveStartDate": "2026-01-01",
        "relationShipType": "string"
      }
    ]
  }
}

getBenefitInsuranceEnrolleeType

Retrieves a single BenefitInsuranceEnrolleeType entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`mdfSystemEffectiveStartDate`	`string`	Yes	key: mdfSystemEffectiveStartDate
`relationShipType`	`string`	Yes	key: relationShipType
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceEnrolleeTypeQueries`	No	Queries to be sent with the request

Returns: BenefitInsuranceEnrolleeType|error

Sample code:

BenefitInsuranceEnrolleeType result = check client->getBenefitInsuranceEnrolleeType(mdfSystemEffectiveStartDate, relationShipType);

Sample response:

{
  "mdfSystemEffectiveStartDate": "2026-01-01",
  "relationShipType": "string"
}

BenefitClaimAccumulation

listBenefitClaimAccumulations

Queries the BenefitClaimAccumulation collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitClaimAccumulationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitClaimAccumulations();

getBenefitClaimAccumulation

Retrieves a single BenefitClaimAccumulation entity identified by its key property.

Parameters:

Name	Type	Required	Description
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitClaimAccumulationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitClaimAccumulation(externalCode);

BenefitCompanyCarClaim

listBenefitCompanyCarClaims

Queries the BenefitCompanyCarClaim collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyCarClaimsQueries`	No	Queries to be sent with the request

Returns: ListBenefitCompanyCarClaimsResponse|error

Sample code:

ListBenefitCompanyCarClaimsResponse result = check client->listBenefitCompanyCarClaims();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitCompanyCarClaim

Retrieves a single BenefitCompanyCarClaim entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEmployeeClaim_id`	`int`	Yes	key: BenefitEmployeeClaim_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyCarClaimQueries`	No	Queries to be sent with the request

Returns: BenefitCompanyCarClaim|error

Sample code:

BenefitCompanyCarClaim result = check client->getBenefitCompanyCarClaim(BenefitEmployeeClaim_id, id);

Sample response:

{
  "d": {}
}

BenefitLifeEventConfiguration

listBenefitLifeEventConfigurations

Queries the BenefitLifeEventConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitLifeEventConfigurationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitLifeEventConfigurations();

getBenefitLifeEventConfiguration

Retrieves a single BenefitLifeEventConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`configurationId`	`string`	Yes	key: configurationId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitLifeEventConfigurationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitLifeEventConfiguration(configurationId, effectiveStartDate);

BenefitEnrollment

listBenefitEnrollments

Queries the BenefitEnrollment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEnrollmentsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEnrollments();

getBenefitEnrollment

Retrieves a single BenefitEnrollment entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEnrollmentQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEnrollment(effectiveStartDate, id);

BenefitPensionDependentNominees

listBenefitPensionDependentNomineess

Queries the BenefitPensionDependentNominees collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionDependentNomineessQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionDependentNomineessResponse|error

Sample code:

ListBenefitPensionDependentNomineessResponse result = check client->listBenefitPensionDependentNomineess();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitPensionDependentNominees

Retrieves a single BenefitPensionDependentNominees entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`dependentName`	`string`	Yes	key: dependentName
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionDependentNomineesQueries`	No	Queries to be sent with the request

Returns: BenefitPensionDependentNominees|error

Sample code:

BenefitPensionDependentNominees result = check client->getBenefitPensionDependentNominees(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, dependentName);

Sample response:

{
  "d": {}
}

BenefitContact

listBenefitContacts

Queries the BenefitContact collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitContactsQueries`	No	Queries to be sent with the request

Returns: ListBenefitContactsResponse|error

Sample code:

ListBenefitContactsResponse result = check client->listBenefitContacts();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000"
      }
    ]
  }
}

getBenefitContact

Retrieves a single BenefitContact entity identified by its key property.

Parameters:

Name	Type	Required	Description
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitContactQueries`	No	Queries to be sent with the request

Returns: BenefitContact|error

Sample code:

BenefitContact result = check client->getBenefitContact(externalCode);

Sample response:

{
  "externalCode": "1000"
}

BenefitFuelReimbursementClaimDetail

listBenefitFuelReimbursementClaimDetails

Queries the BenefitFuelReimbursementClaimDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitFuelReimbursementClaimDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitFuelReimbursementClaimDetailsResponse|error

Sample code:

ListBenefitFuelReimbursementClaimDetailsResponse result = check client->listBenefitFuelReimbursementClaimDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitFuelReimbursementClaimDetail

Retrieves a single BenefitFuelReimbursementClaimDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEmployeeClaim_id`	`int`	Yes	key: BenefitEmployeeClaim_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitFuelReimbursementClaimDetailQueries`	No	Queries to be sent with the request

Returns: BenefitFuelReimbursementClaimDetail|error

Sample code:

BenefitFuelReimbursementClaimDetail result = check client->getBenefitFuelReimbursementClaimDetail(BenefitEmployeeClaim_id, id);

Sample response:

{
  "d": {}
}

BenefitPensionStatutoryMinimumLookup

listBenefitPensionStatutoryMinimumLookups

Queries the BenefitPensionStatutoryMinimumLookup collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionStatutoryMinimumLookupsQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionStatutoryMinimumLookupsResponse|error

Sample code:

ListBenefitPensionStatutoryMinimumLookupsResponse result = check client->listBenefitPensionStatutoryMinimumLookups();

Sample response:

{
  "d": {
    "results": [
      {
        "effectiveStartDate": "2026-01-01",
        "externalCode": "1000"
      }
    ]
  }
}

getBenefitPensionStatutoryMinimumLookup

Retrieves a single BenefitPensionStatutoryMinimumLookup entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionStatutoryMinimumLookupQueries`	No	Queries to be sent with the request

Returns: BenefitPensionStatutoryMinimumLookup|error

Sample code:

BenefitPensionStatutoryMinimumLookup result = check client->getBenefitPensionStatutoryMinimumLookup(effectiveStartDate, externalCode);

Sample response:

{
  "effectiveStartDate": "2026-01-01",
  "externalCode": "1000"
}

BenefitInsuranceCoverageOptions

listBenefitInsuranceCoverageOptionss

Queries the BenefitInsuranceCoverageOptions collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceCoverageOptionssQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceCoverageOptionss();

getBenefitInsuranceCoverageOptions

Retrieves a single BenefitInsuranceCoverageOptions entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitInsurancePlan_effectiveStartDate`	`string`	Yes	key: BenefitInsurancePlan_effectiveStartDate
`BenefitInsurancePlan_id`	`string`	Yes	key: BenefitInsurancePlan_id
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceCoverageOptionsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceCoverageOptions(BenefitInsurancePlan_effectiveStartDate, BenefitInsurancePlan_id, externalCode);

BenefitLeaveTravelReimbursementClaim

listBenefitLeaveTravelReimbursementClaims

Queries the BenefitLeaveTravelReimbursementClaim collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitLeaveTravelReimbursementClaimsQueries`	No	Queries to be sent with the request

Returns: ListBenefitLeaveTravelReimbursementClaimsResponse|error

Sample code:

ListBenefitLeaveTravelReimbursementClaimsResponse result = check client->listBenefitLeaveTravelReimbursementClaims();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitLeaveTravelReimbursementClaim

Retrieves a single BenefitLeaveTravelReimbursementClaim entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEmployeeClaim_id`	`int`	Yes	key: BenefitEmployeeClaim_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitLeaveTravelReimbursementClaimQueries`	No	Queries to be sent with the request

Returns: BenefitLeaveTravelReimbursementClaim|error

Sample code:

BenefitLeaveTravelReimbursementClaim result = check client->getBenefitLeaveTravelReimbursementClaim(BenefitEmployeeClaim_id, id);

Sample response:

{
  "d": {}
}

BenefitBalanceCarryForward

listBenefitBalanceCarryForwards

Queries the BenefitBalanceCarryForward collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitBalanceCarryForwardsQueries`	No	Queries to be sent with the request

Returns: ListBenefitBalanceCarryForwardsResponse|error

Sample code:

ListBenefitBalanceCarryForwardsResponse result = check client->listBenefitBalanceCarryForwards();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitBalanceCarryForward

Retrieves a single BenefitBalanceCarryForward entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitBalanceCarryForwardQueries`	No	Queries to be sent with the request

Returns: BenefitBalanceCarryForward|error

Sample code:

BenefitBalanceCarryForward result = check client->getBenefitBalanceCarryForward(Benefit_benefitId, Benefit_effectiveStartDate, externalCode);

Sample response:

{
  "d": {}
}

BenefitCompanyCarAllowedModels

listBenefitCompanyCarAllowedModelss

Queries the BenefitCompanyCarAllowedModels collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyCarAllowedModelssQueries`	No	Queries to be sent with the request

Returns: ListBenefitCompanyCarAllowedModelssResponse|error

Sample code:

ListBenefitCompanyCarAllowedModelssResponse result = check client->listBenefitCompanyCarAllowedModelss();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitCompanyCarAllowedModels

Retrieves a single BenefitCompanyCarAllowedModels entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyCarAllowedModelsQueries`	No	Queries to be sent with the request

Returns: BenefitCompanyCarAllowedModels|error

Sample code:

BenefitCompanyCarAllowedModels result = check client->getBenefitCompanyCarAllowedModels(effectiveStartDate, externalCode);

Sample response:

{
  "d": {}
}

BenefitsConfirmationStatementConfiguration

listBenefitsConfirmationStatementConfigurations

Queries the BenefitsConfirmationStatementConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitsConfirmationStatementConfigurationsQueries`	No	Queries to be sent with the request

Returns: ListBenefitsConfirmationStatementConfigurationsResponse|error

Sample code:

ListBenefitsConfirmationStatementConfigurationsResponse result = check client->listBenefitsConfirmationStatementConfigurations();

Sample response:

{
  "d": {
    "results": [
      {
        "effectiveStartDate": "2026-01-01",
        "legalEntity": "string",
        "legalEntityNav": {}
      }
    ]
  }
}

getBenefitsConfirmationStatementConfiguration

Retrieves a single BenefitsConfirmationStatementConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`legalEntity`	`string`	Yes	key: legalEntity
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitsConfirmationStatementConfigurationQueries`	No	Queries to be sent with the request

Returns: BenefitsConfirmationStatementConfiguration|error

Sample code:

BenefitsConfirmationStatementConfiguration result = check client->getBenefitsConfirmationStatementConfiguration(effectiveStartDate, legalEntity);

Sample response:

{
  "effectiveStartDate": "2026-01-01",
  "legalEntity": "string",
  "legalEntityNav": {
    "company": "string"
  }
}

BenefitEnrollmentGroup

listBenefitEnrollmentGroups

Queries the BenefitEnrollmentGroup collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEnrollmentGroupsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEnrollmentGroups();

getBenefitEnrollmentGroup

Retrieves a single BenefitEnrollmentGroup entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEnrollmentGroupQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEnrollmentGroup(effectiveStartDate, id);

SavingsAccountTierConfiguration

listSavingsAccountTierConfigurations

Queries the SavingsAccountTierConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListSavingsAccountTierConfigurationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listSavingsAccountTierConfigurations();

getSavingsAccountTierConfiguration

Retrieves a single SavingsAccountTierConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`SavingsAccountBenefitDetails_externalCode`	`int`	Yes	key: SavingsAccountBenefitDetails_externalCode
`SavingsAccountUSA_externalCode`	`int`	Yes	key: SavingsAccountUSA_externalCode
`coverageTier`	`string`	Yes	key: coverageTier
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetSavingsAccountTierConfigurationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getSavingsAccountTierConfiguration(Benefit_benefitId, Benefit_effectiveStartDate, SavingsAccountBenefitDetails_externalCode, SavingsAccountUSA_externalCode, coverageTier);

SavingsAccountUSA

listSavingsAccountUSAs

Queries the SavingsAccountUSA collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListSavingsAccountUSAsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listSavingsAccountUSAs();

getSavingsAccountUSA

Retrieves a single SavingsAccountUSA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`SavingsAccountBenefitDetails_externalCode`	`int`	Yes	key: SavingsAccountBenefitDetails_externalCode
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetSavingsAccountUSAQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getSavingsAccountUSA(Benefit_benefitId, Benefit_effectiveStartDate, SavingsAccountBenefitDetails_externalCode, externalCode);

BenefitCompanyHousingEnrollment

listBenefitCompanyHousingEnrollments

Queries the BenefitCompanyHousingEnrollment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitCompanyHousingEnrollmentsQueries`	No	Queries to be sent with the request

Returns: ListBenefitCompanyHousingEnrollmentsResponse|error

Sample code:

ListBenefitCompanyHousingEnrollmentsResponse result = check client->listBenefitCompanyHousingEnrollments();

Sample response:

{
  "d": {
    "results": [
      {
        "BenefitEnrollment_effectiveStartDate": "2026-01-01",
        "BenefitEnrollment_id": "1000",
        "id": "1000"
      }
    ]
  }
}

getBenefitCompanyHousingEnrollment

Retrieves a single BenefitCompanyHousingEnrollment entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`int`	Yes	key: BenefitEnrollment_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitCompanyHousingEnrollmentQueries`	No	Queries to be sent with the request

Returns: BenefitCompanyHousingEnrollment|error

Sample code:

BenefitCompanyHousingEnrollment result = check client->getBenefitCompanyHousingEnrollment(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, id);

Sample response:

{
  "BenefitEnrollment_effectiveStartDate": "2026-01-01",
  "BenefitEnrollment_id": "1000",
  "id": "1000"
}

BenefitPensionEmployeeContributionDetail

listBenefitPensionEmployeeContributionDetails

Queries the BenefitPensionEmployeeContributionDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionEmployeeContributionDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionEmployeeContributionDetailsResponse|error

Sample code:

ListBenefitPensionEmployeeContributionDetailsResponse result = check client->listBenefitPensionEmployeeContributionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "id": "1000"
      }
    ]
  }
}

getBenefitPensionEmployeeContributionDetail

Retrieves a single BenefitPensionEmployeeContributionDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionEmployeeContributionDetailQueries`	No	Queries to be sent with the request

Returns: BenefitPensionEmployeeContributionDetail|error

Sample code:

BenefitPensionEmployeeContributionDetail result = check client->getBenefitPensionEmployeeContributionDetail(Benefit_benefitId, Benefit_effectiveStartDate, id);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "id": "1000"
}

BenefitInsuranceRateChartEnrollee

listBenefitInsuranceRateChartEnrollees

Queries the BenefitInsuranceRateChartEnrollee collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitInsuranceRateChartEnrolleesQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitInsuranceRateChartEnrollees();

getBenefitInsuranceRateChartEnrollee

Retrieves a single BenefitInsuranceRateChartEnrollee entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitInsuranceRateChart_effectiveStartDate`	`string`	Yes	key: BenefitInsuranceRateChart_effectiveStartDate
`BenefitInsuranceRateChart_rateChartId`	`string`	Yes	key: BenefitInsuranceRateChart_rateChartId
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitInsuranceRateChartEnrolleeQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitInsuranceRateChartEnrollee(BenefitInsuranceRateChart_effectiveStartDate, BenefitInsuranceRateChart_rateChartId, externalCode);

BenefitDeductibleAllowanceEnrollment

listBenefitDeductibleAllowanceEnrollments

Queries the BenefitDeductibleAllowanceEnrollment collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitDeductibleAllowanceEnrollmentsQueries`	No	Queries to be sent with the request

Returns: ListBenefitDeductibleAllowanceEnrollmentsResponse|error

Sample code:

ListBenefitDeductibleAllowanceEnrollmentsResponse result = check client->listBenefitDeductibleAllowanceEnrollments();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitDeductibleAllowanceEnrollment

Retrieves a single BenefitDeductibleAllowanceEnrollment entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`string`	Yes	key: BenefitEnrollment_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitDeductibleAllowanceEnrollmentQueries`	No	Queries to be sent with the request

Returns: BenefitDeductibleAllowanceEnrollment|error

Sample code:

BenefitDeductibleAllowanceEnrollment result = check client->getBenefitDeductibleAllowanceEnrollment(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, id);

Sample response:

{
  "d": {}
}

BenefitSavingsPlanTierConfiguration

listBenefitSavingsPlanTierConfigurations

Queries the BenefitSavingsPlanTierConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanTierConfigurationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitSavingsPlanTierConfigurations();

getBenefitSavingsPlanTierConfiguration

Retrieves a single BenefitSavingsPlanTierConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`coverageTier`	`string`	Yes	key: coverageTier
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanTierConfigurationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitSavingsPlanTierConfiguration(Benefit_benefitId, Benefit_effectiveStartDate, coverageTier);

BenefitSavingsPlanERContributionConfig

listBenefitSavingsPlanERContributionConfigs

Queries the BenefitSavingsPlanERContributionConfig collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanERContributionConfigsQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanERContributionConfigsResponse|error

Sample code:

ListBenefitSavingsPlanERContributionConfigsResponse result = check client->listBenefitSavingsPlanERContributionConfigs();

Sample response:

{
  "d": {
    "results": [
      {
        "effectiveStartDate": "2026-01-01",
        "employerContributionId": "1000",
        "employerContributionDetail": {}
      }
    ]
  }
}

getBenefitSavingsPlanERContributionConfig

Retrieves a single BenefitSavingsPlanERContributionConfig entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`employerContributionId`	`string`	Yes	key: employerContributionId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanERContributionConfigQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanERContributionConfig|error

Sample code:

BenefitSavingsPlanERContributionConfig result = check client->getBenefitSavingsPlanERContributionConfig(effectiveStartDate, employerContributionId);

Sample response:

{
  "effectiveStartDate": "2026-01-01",
  "employerContributionId": "1000",
  "employerContributionDetail": {
    "results": [
      {
        "BenefitSavingsPlanERContributionConfig_effectiveStartDate": "2026-01-01",
        "BenefitSavingsPlanERContributionConfig_employerContributionId": "1000",
        "employerContributionDetailId": "1000"
      }
    ]
  }
}

BenefitSavingsPlanERContributionConfigDetail

listBenefitSavingsPlanERContributionConfigDetails

Queries the BenefitSavingsPlanERContributionConfigDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanERContributionConfigDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanERContributionConfigDetailsResponse|error

Sample code:

ListBenefitSavingsPlanERContributionConfigDetailsResponse result = check client->listBenefitSavingsPlanERContributionConfigDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "BenefitSavingsPlanERContributionConfig_effectiveStartDate": "2026-01-01",
        "BenefitSavingsPlanERContributionConfig_employerContributionId": "1000",
        "employerContributionDetailId": "1000"
      }
    ]
  }
}

getBenefitSavingsPlanERContributionConfigDetail

Retrieves a single BenefitSavingsPlanERContributionConfigDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitSavingsPlanERContributionConfig_effectiveStartDate`	`string`	Yes	key: BenefitSavingsPlanERContributionConfig_effectiveStartDate
`BenefitSavingsPlanERContributionConfig_employerContributionId`	`string`	Yes	key: BenefitSavingsPlanERContributionConfig_employerContributionId
`employerContributionDetailId`	`int`	Yes	key: employerContributionDetailId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanERContributionConfigDetailQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanERContributionConfigDetail|error

Sample code:

BenefitSavingsPlanERContributionConfigDetail result = check client->getBenefitSavingsPlanERContributionConfigDetail(BenefitSavingsPlanERContributionConfig_effectiveStartDate, BenefitSavingsPlanERContributionConfig_employerContributionId, employerContributionDetailId);

Sample response:

{
  "BenefitSavingsPlanERContributionConfig_effectiveStartDate": "2026-01-01",
  "BenefitSavingsPlanERContributionConfig_employerContributionId": "1000",
  "employerContributionDetailId": "1000"
}

BenefitSavingsPlanCatchUpDetail

listBenefitSavingsPlanCatchUpDetails

Queries the BenefitSavingsPlanCatchUpDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanCatchUpDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanCatchUpDetailsResponse|error

Sample code:

ListBenefitSavingsPlanCatchUpDetailsResponse result = check client->listBenefitSavingsPlanCatchUpDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "catchUpDetailCode": "1000",
        "effectiveStartDate": "2026-01-01"
      }
    ]
  }
}

getBenefitSavingsPlanCatchUpDetail

Retrieves a single BenefitSavingsPlanCatchUpDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`catchUpDetailCode`	`string`	Yes	key: catchUpDetailCode
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanCatchUpDetailQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanCatchUpDetail|error

Sample code:

BenefitSavingsPlanCatchUpDetail result = check client->getBenefitSavingsPlanCatchUpDetail(catchUpDetailCode, effectiveStartDate);

Sample response:

{
  "catchUpDetailCode": "1000",
  "effectiveStartDate": "2026-01-01"
}

BenefitsIntegrationOneTimeInfo

listBenefitsIntegrationOneTimeInfos

Queries the BenefitsIntegrationOneTimeInfo collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitsIntegrationOneTimeInfosQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitsIntegrationOneTimeInfos();

getBenefitsIntegrationOneTimeInfo

Retrieves a single BenefitsIntegrationOneTimeInfo entity identified by its key property.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitsIntegrationOneTimeInfoQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitsIntegrationOneTimeInfo(id);

BenefitEnrollmentDependencyDetails

listBenefitEnrollmentDependencyDetails

Queries the BenefitEnrollmentDependencyDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEnrollmentDependencyDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEnrollmentDependencyDetails();

getBenefitEnrollmentDependencyDetails

Retrieves a single BenefitEnrollmentDependencyDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollmentDependencyConfiguration_benefitDependencyId`	`string`	Yes	key: BenefitEnrollmentDependencyConfiguration_benefitDependencyId
`BenefitEnrollmentDependencyConfiguration_effectiveStartDate`	`string`	Yes	key: BenefitEnrollmentDependencyConfiguration_effectiveStartDate
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEnrollmentDependencyDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEnrollmentDependencyDetails(BenefitEnrollmentDependencyConfiguration_benefitDependencyId, BenefitEnrollmentDependencyConfiguration_effectiveStartDate, externalCode);

deleteBenefitEnrollmentDependencyDetails

Deletes the BenefitEnrollmentDependencyDetails identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollmentDependencyConfiguration_benefitDependencyId`	`string`	Yes	key: BenefitEnrollmentDependencyConfiguration_benefitDependencyId
`BenefitEnrollmentDependencyConfiguration_effectiveStartDate`	`string`	Yes	key: BenefitEnrollmentDependencyConfiguration_effectiveStartDate
`externalCode`	`int`	Yes	key: externalCode
`headers`	`DeleteBenefitEnrollmentDependencyDetailsHeaders`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBenefitEnrollmentDependencyDetails(BenefitEnrollmentDependencyConfiguration_benefitDependencyId, BenefitEnrollmentDependencyConfiguration_effectiveStartDate, externalCode);

BenefitEnrollmentDependencyConfiguration

listBenefitEnrollmentDependencyConfigurations

Queries the BenefitEnrollmentDependencyConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEnrollmentDependencyConfigurationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEnrollmentDependencyConfigurations();

getBenefitEnrollmentDependencyConfiguration

Retrieves a single BenefitEnrollmentDependencyConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`benefitDependencyId`	`string`	Yes	key: benefitDependencyId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEnrollmentDependencyConfigurationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEnrollmentDependencyConfiguration(benefitDependencyId, effectiveStartDate);

deleteBenefitEnrollmentDependencyConfiguration

Deletes the BenefitEnrollmentDependencyConfiguration identified by its key properties.

Parameters:

Name	Type	Required	Description
`benefitDependencyId`	`string`	Yes	key: benefitDependencyId
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`headers`	`DeleteBenefitEnrollmentDependencyConfigurationHeaders`	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBenefitEnrollmentDependencyConfiguration(benefitDependencyId, effectiveStartDate);

BenefitSavingsPlanPrimaryBeneficiary

listBenefitSavingsPlanPrimaryBeneficiarys

Queries the BenefitSavingsPlanPrimaryBeneficiary collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanPrimaryBeneficiarysQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanPrimaryBeneficiarysResponse|error

Sample code:

ListBenefitSavingsPlanPrimaryBeneficiarysResponse result = check client->listBenefitSavingsPlanPrimaryBeneficiarys();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitSavingsPlanPrimaryBeneficiary

Retrieves a single BenefitSavingsPlanPrimaryBeneficiary entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`string`	Yes	key: BenefitEnrollment_id
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanPrimaryBeneficiaryQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanPrimaryBeneficiary|error

Sample code:

BenefitSavingsPlanPrimaryBeneficiary result = check client->getBenefitSavingsPlanPrimaryBeneficiary(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, externalCode);

Sample response:

{
  "d": {}
}

BenefitSavingsPlanContingentBeneficiary

listBenefitSavingsPlanContingentBeneficiarys

Queries the BenefitSavingsPlanContingentBeneficiary collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanContingentBeneficiarysQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanContingentBeneficiarysResponse|error

Sample code:

ListBenefitSavingsPlanContingentBeneficiarysResponse result = check client->listBenefitSavingsPlanContingentBeneficiarys();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitSavingsPlanContingentBeneficiary

Retrieves a single BenefitSavingsPlanContingentBeneficiary entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`string`	Yes	key: BenefitEnrollment_id
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanContingentBeneficiaryQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanContingentBeneficiary|error

Sample code:

BenefitSavingsPlanContingentBeneficiary result = check client->getBenefitSavingsPlanContingentBeneficiary(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, externalCode);

Sample response:

{
  "d": {}
}

BenefitHyperlinkConfiguration

listBenefitHyperlinkConfigurations

Queries the BenefitHyperlinkConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitHyperlinkConfigurationsQueries`	No	Queries to be sent with the request

Returns: ListBenefitHyperlinkConfigurationsResponse|error

Sample code:

ListBenefitHyperlinkConfigurationsResponse result = check client->listBenefitHyperlinkConfigurations();

Sample response:

{
  "d": {
    "results": [
      {
        "Benefit_benefitId": "1000",
        "Benefit_effectiveStartDate": "2026-01-01",
        "id": "1000"
      }
    ]
  }
}

getBenefitHyperlinkConfiguration

Retrieves a single BenefitHyperlinkConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitHyperlinkConfigurationQueries`	No	Queries to be sent with the request

Returns: BenefitHyperlinkConfiguration|error

Sample code:

BenefitHyperlinkConfiguration result = check client->getBenefitHyperlinkConfiguration(Benefit_benefitId, Benefit_effectiveStartDate, id);

Sample response:

{
  "Benefit_benefitId": "1000",
  "Benefit_effectiveStartDate": "2026-01-01",
  "id": "1000"
}

BenefitOverviewHyperlinkConfiguration

listBenefitOverviewHyperlinkConfigurations

Queries the BenefitOverviewHyperlinkConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitOverviewHyperlinkConfigurationsQueries`	No	Queries to be sent with the request

Returns: ListBenefitOverviewHyperlinkConfigurationsResponse|error

Sample code:

ListBenefitOverviewHyperlinkConfigurationsResponse result = check client->listBenefitOverviewHyperlinkConfigurations();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitOverviewHyperlinkConfiguration

Retrieves a single BenefitOverviewHyperlinkConfiguration entity identified by its key property.

Parameters:

Name	Type	Required	Description
`hyperlinkConfigurationId`	`string`	Yes	key: hyperlinkConfigurationId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitOverviewHyperlinkConfigurationQueries`	No	Queries to be sent with the request

Returns: BenefitOverviewHyperlinkConfiguration|error

Sample code:

BenefitOverviewHyperlinkConfiguration result = check client->getBenefitOverviewHyperlinkConfiguration(hyperlinkConfigurationId);

Sample response:

{
  "d": {}
}

BenefitOverviewHyperlinkDetails

listBenefitOverviewHyperlinkDetails

Queries the BenefitOverviewHyperlinkDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitOverviewHyperlinkDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitOverviewHyperlinkDetailsResponse|error

Sample code:

ListBenefitOverviewHyperlinkDetailsResponse result = check client->listBenefitOverviewHyperlinkDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "BenefitOverviewHyperlinkConfiguration_hyperlinkConfigurationId": "1000",
        "id": "1000"
      }
    ]
  }
}

getBenefitOverviewHyperlinkDetails

Retrieves a single BenefitOverviewHyperlinkDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitOverviewHyperlinkConfiguration_hyperlinkConfigurationId`	`string`	Yes	key: BenefitOverviewHyperlinkConfiguration_hyperlinkConfigurationId
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitOverviewHyperlinkDetailsQueries`	No	Queries to be sent with the request

Returns: BenefitOverviewHyperlinkDetails|error

Sample code:

BenefitOverviewHyperlinkDetails result = check client->getBenefitOverviewHyperlinkDetails(BenefitOverviewHyperlinkConfiguration_hyperlinkConfigurationId, id);

Sample response:

{
  "BenefitOverviewHyperlinkConfiguration_hyperlinkConfigurationId": "1000",
  "id": "1000"
}

BenefitEmployeeOptoutRequests

listBenefitEmployeeOptoutRequestss

Queries the BenefitEmployeeOptoutRequests collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEmployeeOptoutRequestssQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEmployeeOptoutRequestss();

getBenefitEmployeeOptoutRequests

Retrieves a single BenefitEmployeeOptoutRequests entity identified by its key property.

Parameters:

Name	Type	Required	Description
`workerId`	`string`	Yes	key: workerId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEmployeeOptoutRequestsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEmployeeOptoutRequests(workerId);

BenefitEnrollmentOptoutDetails

listBenefitEnrollmentOptoutDetails

Queries the BenefitEnrollmentOptoutDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitEnrollmentOptoutDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitEnrollmentOptoutDetails();

getBenefitEnrollmentOptoutDetails

Retrieves a single BenefitEnrollmentOptoutDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEmployeeOptoutRequests_workerId`	`string`	Yes	key: BenefitEmployeeOptoutRequests_workerId
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitEnrollmentOptoutDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitEnrollmentOptoutDetails(BenefitEmployeeOptoutRequests_workerId, id);

BenefitHSAEmployerContribution

listBenefitHSAEmployerContributions

Queries the BenefitHSAEmployerContribution collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitHSAEmployerContributionsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitHSAEmployerContributions();

getBenefitHSAEmployerContribution

Retrieves a single BenefitHSAEmployerContribution entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`effectiveStartDate`	`string`	Yes	key: effectiveStartDate
`externalCode`	`string`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitHSAEmployerContributionQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitHSAEmployerContribution(effectiveStartDate, externalCode);

BenefitHSAEmployerContributionDetail

listBenefitHSAEmployerContributionDetails

Queries the BenefitHSAEmployerContributionDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitHSAEmployerContributionDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitHSAEmployerContributionDetails();

getBenefitHSAEmployerContributionDetail

Retrieves a single BenefitHSAEmployerContributionDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitHSAEmployerContribution_effectiveStartDate`	`string`	Yes	key: BenefitHSAEmployerContribution_effectiveStartDate
`BenefitHSAEmployerContribution_externalCode`	`string`	Yes	key: BenefitHSAEmployerContribution_externalCode
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitHSAEmployerContributionDetailQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitHSAEmployerContributionDetail(BenefitHSAEmployerContribution_effectiveStartDate, BenefitHSAEmployerContribution_externalCode, externalCode);

BenefitHSAEmployerContributionTierDetail

listBenefitHSAEmployerContributionTierDetails

Queries the BenefitHSAEmployerContributionTierDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitHSAEmployerContributionTierDetailsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitHSAEmployerContributionTierDetails();

getBenefitHSAEmployerContributionTierDetail

Retrieves a single BenefitHSAEmployerContributionTierDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitHSAEmployerContributionDetail_externalCode`	`int`	Yes	key: BenefitHSAEmployerContributionDetail_externalCode
`BenefitHSAEmployerContribution_effectiveStartDate`	`string`	Yes	key: BenefitHSAEmployerContribution_effectiveStartDate
`BenefitHSAEmployerContribution_externalCode`	`string`	Yes	key: BenefitHSAEmployerContribution_externalCode
`coverageTier`	`string`	Yes	key: coverageTier
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitHSAEmployerContributionTierDetailQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitHSAEmployerContributionTierDetail(BenefitHSAEmployerContributionDetail_externalCode, BenefitHSAEmployerContribution_effectiveStartDate, BenefitHSAEmployerContribution_externalCode, coverageTier);

BenefitAutomaticActionConfiguration

listBenefitAutomaticActionConfigurations

Queries the BenefitAutomaticActionConfiguration collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitAutomaticActionConfigurationsQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitAutomaticActionConfigurations();

getBenefitAutomaticActionConfiguration

Retrieves a single BenefitAutomaticActionConfiguration entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitLifeEventConfiguration_configurationId`	`string`	Yes	key: BenefitLifeEventConfiguration_configurationId
`BenefitLifeEventConfiguration_effectiveStartDate`	`string`	Yes	key: BenefitLifeEventConfiguration_effectiveStartDate
`id`	`string`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitAutomaticActionConfigurationQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitAutomaticActionConfiguration(BenefitLifeEventConfiguration_configurationId, BenefitLifeEventConfiguration_effectiveStartDate, id);

BenefitPensionAdditionalEmployeeContributionDetail

listBenefitPensionAdditionalEmployeeContributionDetails

Queries the BenefitPensionAdditionalEmployeeContributionDetail collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitPensionAdditionalEmployeeContributionDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitPensionAdditionalEmployeeContributionDetailsResponse|error

Sample code:

ListBenefitPensionAdditionalEmployeeContributionDetailsResponse result = check client->listBenefitPensionAdditionalEmployeeContributionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitPensionAdditionalEmployeeContributionDetail

Retrieves a single BenefitPensionAdditionalEmployeeContributionDetail entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`avcContributionId`	`int`	Yes	key: avcContributionId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitPensionAdditionalEmployeeContributionDetailQueries`	No	Queries to be sent with the request

Returns: BenefitPensionAdditionalEmployeeContributionDetail|error

Sample code:

BenefitPensionAdditionalEmployeeContributionDetail result = check client->getBenefitPensionAdditionalEmployeeContributionDetail(Benefit_benefitId, Benefit_effectiveStartDate, avcContributionId);

Sample response:

{
  "d": {}
}

BenefitsIntegrationRecurringInfo

listBenefitsIntegrationRecurringInfos

Queries the BenefitsIntegrationRecurringInfo collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitsIntegrationRecurringInfosQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listBenefitsIntegrationRecurringInfos();

getBenefitsIntegrationRecurringInfo

Retrieves a single BenefitsIntegrationRecurringInfo entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`id`	`string`	Yes	key: id
`payCompBeginDate`	`string`	Yes	key: payCompBeginDate
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitsIntegrationRecurringInfoQueries`	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getBenefitsIntegrationRecurringInfo(id, payCompBeginDate);

BenefitSavingsPlanEnrollmentDetails

listBenefitSavingsPlanEnrollmentDetails

Queries the BenefitSavingsPlanEnrollmentDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitSavingsPlanEnrollmentDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitSavingsPlanEnrollmentDetailsResponse|error

Sample code:

ListBenefitSavingsPlanEnrollmentDetailsResponse result = check client->listBenefitSavingsPlanEnrollmentDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitSavingsPlanEnrollmentDetails

Retrieves a single BenefitSavingsPlanEnrollmentDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`BenefitEnrollment_effectiveStartDate`	`string`	Yes	key: BenefitEnrollment_effectiveStartDate
`BenefitEnrollment_id`	`string`	Yes	key: BenefitEnrollment_id
`id`	`int`	Yes	key: id
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitSavingsPlanEnrollmentDetailsQueries`	No	Queries to be sent with the request

Returns: BenefitSavingsPlanEnrollmentDetails|error

Sample code:

BenefitSavingsPlanEnrollmentDetails result = check client->getBenefitSavingsPlanEnrollmentDetails(BenefitEnrollment_effectiveStartDate, BenefitEnrollment_id, id);

Sample response:

{
  "d": {}
}

ACAReportingDependentDetails

listACAReportingDependentDetails

Queries the ACAReportingDependentDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListACAReportingDependentDetailsQueries`	No	Queries to be sent with the request

Returns: ListACAReportingDependentDetailsResponse|error

Sample code:

ListACAReportingDependentDetailsResponse result = check client->listACAReportingDependentDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "ACAReportingInformation_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

getACAReportingDependentDetails

Retrieves a single ACAReportingDependentDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`ACAReportingInformation_externalCode`	`string`	Yes	key: ACAReportingInformation_externalCode
`externalCode`	`int`	Yes	key: externalCode
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetACAReportingDependentDetailsQueries`	No	Queries to be sent with the request

Returns: ACAReportingDependentDetails|error

Sample code:

ACAReportingDependentDetails result = check client->getACAReportingDependentDetails(ACAReportingInformation_externalCode, externalCode);

Sample response:

{
  "ACAReportingInformation_externalCode": "1000",
  "externalCode": "1000"
}

BenefitDeductionDetails

listBenefitDeductionDetails

Queries the BenefitDeductionDetails collection and returns a page of entities, optionally filtered, sorted, and paged via OData query options.

Parameters:

Name	Type	Required	Description
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`ListBenefitDeductionDetailsQueries`	No	Queries to be sent with the request

Returns: ListBenefitDeductionDetailsResponse|error

Sample code:

ListBenefitDeductionDetailsResponse result = check client->listBenefitDeductionDetails();

Sample response:

{
  "d": {
    "results": [
      {
        "d": {}
      }
    ]
  }
}

getBenefitDeductionDetails

Retrieves a single BenefitDeductionDetails entity identified by its key properties.

Parameters:

Name	Type	Required	Description
`Benefit_benefitId`	`string`	Yes	key: Benefit_benefitId
`Benefit_effectiveStartDate`	`string`	Yes	key: Benefit_effectiveStartDate
`dedcutionDetailId`	`int`	Yes	key: dedcutionDetailId
`headers`	`map<string\|string[]>`	No	Headers to be sent with the request
`queries`	`GetBenefitDeductionDetailsQueries`	No	Queries to be sent with the request

Returns: BenefitDeductionDetails|error

Sample code:

BenefitDeductionDetails result = check client->getBenefitDeductionDetails(Benefit_benefitId, Benefit_effectiveStartDate, dedcutionDetailId);

Sample response:

{
  "d": {}
}

Client​

Configuration​

ConnectionConfig​

Initializing the client​

Operations​

BenefitEmployeeClaim​

BenefitSavingsPlanSubType​

BenefitInsurancePlan​

BenefitBalanceCarryForwardDetail​

EmployeeWithEmployerMatchContributions​

BenefitProgramEnrollment​

EmployeeWithEmployerMatchContributionEntries​

BenefitInsuranceCoverage​

BenefitProgram​

BenefitCompanyCarLeaseServiceProvider​

BenefitInsuranceRateChart​

BenefitEmployeeLifeEventDeclarationForm​

BenefitInsuranceProvider​

ImputedCostForAgeRanges​

BenefitInsurancePlanEnrollmentDetails​

BenefitEffectiveDateConfiguration​

BenefitEvent​

BenefitSchedules​

BenefitProgramExceptionDetails​

SavingsAccountDeductionDetails​

BenefitPaymentOptions​

BenefitSavingsPlanSubTypeCountryLookup​

LifeEventForBenefit​

BenefitInsurancePlanUSA​

SavingsAccountBenefitDetails​

IRSPremiumTable​

BenefitSchedulePeriod​

BenefitOpenEnrollmentCycleConfiguration​

PensionBandingConfiguration​

BenefitInsuranceDependentDetail​

BenefitProgramEnrollmentDetail​

ACAReportingInformation​

BenefitEmployeeClaimDetail​

BenefitFuelReimbursement​

InsuranceEnrollmentFieldsConfiguration​

BenefitCompanyCar​

BenefitCompanyHousing​

BenefitPensionAdditionalContributionLimits​

BenefitPensionNonDependentNominees​

BenefitExceptionDetails​

InsuranceBenefitDetails​

Benefit​

BenefitInsuranceCoverageDetails​

BenefitInsuranceEnrolleeOptions​

BenefitPensionFundEnrollmentContributionDetail​

BenefitPensionEnrollmentContributionDetail​

BenefitPensionMinMaxContributionLimits​

BenefitDependentDetail​

BenefitCompanyCarEnrollment​

BenefitPensionEmployerContributionDetail​

BenefitsConfigUIScreenLookup​

BenefitDocuments​

BenefitPensionFund​

PensionBandingConfigurationDetails​

BenefitsException​

BenefitInsuranceRateChartFixedAmount​

BenefitLegalEntity​

BenefitSavingsPlanEnrollmentContributionDetail​

BenefitCompanyCarRecommendedVendors​

BenefitInsuranceEnrolleeType​

BenefitClaimAccumulation​

BenefitCompanyCarClaim​

BenefitLifeEventConfiguration​

BenefitEnrollment​

BenefitPensionDependentNominees​

BenefitContact​

BenefitFuelReimbursementClaimDetail​

BenefitPensionStatutoryMinimumLookup​

BenefitInsuranceCoverageOptions​

BenefitLeaveTravelReimbursementClaim​

BenefitBalanceCarryForward​

BenefitCompanyCarAllowedModels​

BenefitsConfirmationStatementConfiguration​

BenefitEnrollmentGroup​

SavingsAccountTierConfiguration​

Client

Configuration

ConnectionConfig

Initializing the client

Operations

BenefitEmployeeClaim

BenefitSavingsPlanSubType

BenefitInsurancePlan

BenefitBalanceCarryForwardDetail

EmployeeWithEmployerMatchContributions

BenefitProgramEnrollment

EmployeeWithEmployerMatchContributionEntries

BenefitInsuranceCoverage

BenefitProgram

BenefitCompanyCarLeaseServiceProvider

BenefitInsuranceRateChart

BenefitEmployeeLifeEventDeclarationForm

BenefitInsuranceProvider

ImputedCostForAgeRanges

BenefitInsurancePlanEnrollmentDetails

BenefitEffectiveDateConfiguration

BenefitEvent

BenefitSchedules

BenefitProgramExceptionDetails

SavingsAccountDeductionDetails

BenefitPaymentOptions

BenefitSavingsPlanSubTypeCountryLookup

LifeEventForBenefit

BenefitInsurancePlanUSA

SavingsAccountBenefitDetails

IRSPremiumTable

BenefitSchedulePeriod

BenefitOpenEnrollmentCycleConfiguration

PensionBandingConfiguration

BenefitInsuranceDependentDetail

BenefitProgramEnrollmentDetail

ACAReportingInformation

BenefitEmployeeClaimDetail

BenefitFuelReimbursement

InsuranceEnrollmentFieldsConfiguration

BenefitCompanyCar

BenefitCompanyHousing

BenefitPensionAdditionalContributionLimits

BenefitPensionNonDependentNominees

BenefitExceptionDetails

InsuranceBenefitDetails

Benefit

BenefitInsuranceCoverageDetails

BenefitInsuranceEnrolleeOptions

BenefitPensionFundEnrollmentContributionDetail

BenefitPensionEnrollmentContributionDetail

BenefitPensionMinMaxContributionLimits

BenefitDependentDetail

BenefitCompanyCarEnrollment

BenefitPensionEmployerContributionDetail

BenefitsConfigUIScreenLookup

BenefitDocuments

BenefitPensionFund

PensionBandingConfigurationDetails

BenefitsException

BenefitInsuranceRateChartFixedAmount

BenefitLegalEntity

BenefitSavingsPlanEnrollmentContributionDetail

BenefitCompanyCarRecommendedVendors

BenefitInsuranceEnrolleeType

BenefitClaimAccumulation

BenefitCompanyCarClaim

BenefitLifeEventConfiguration

BenefitEnrollment

BenefitPensionDependentNominees

BenefitContact

BenefitFuelReimbursementClaimDetail

BenefitPensionStatutoryMinimumLookup

BenefitInsuranceCoverageOptions

BenefitLeaveTravelReimbursementClaim

BenefitBalanceCarryForward

BenefitCompanyCarAllowedModels

BenefitsConfirmationStatementConfiguration

BenefitEnrollmentGroup

SavingsAccountTierConfiguration