Actions

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

Available clients:

Client	Purpose
Client	Manages ecfoundationorganization objects: FOLegalEntityLocalUSA, FODepartment, FOJobClassLocalCAN, Territory, JobClassificationCountry, FOJobFunction, FODynamicRole, FOFrequency…, over the SAP SuccessFactors OData v2 API.

---

Client

You can use these APIs to access Foundation Objects that contain data on organization, job structure and pay.

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.ecfoundationorganization;

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

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

Operations

FOLegalEntityLocalUSA

listFOLegalEntityLocalUSAs

Queries the FOLegalEntityLocalUSA 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	ListFOLegalEntityLocalUSAsQueries	No	Queries to be sent with the request

Returns: ListFOLegalEntityLocalUSAsResponse|error

Sample code:

ListFOLegalEntityLocalUSAsResponse result = check client->listFOLegalEntityLocalUSAs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOLegalEntityLocalUSA

Retrieves a single FOLegalEntityLocalUSA entity identified by its key properties.

Parameters:

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

Returns: FOLegalEntityLocalUSA|error

Sample code:

FOLegalEntityLocalUSA result = check client->getFOLegalEntityLocalUSA(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

FODepartment

listFODepartments

Queries the FODepartment 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	ListFODepartmentsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFODepartments();

getFODepartment

Retrieves a single FODepartment entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFODepartment(externalCode, startDate);

deleteFODepartment

Deletes the FODepartment identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFODepartmentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFODepartment(externalCode, startDate);

FOJobClassLocalCAN

listFOJobClassLocalCANs

Queries the FOJobClassLocalCAN 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	ListFOJobClassLocalCANsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalCANsResponse|error

Sample code:

ListFOJobClassLocalCANsResponse result = check client->listFOJobClassLocalCANs();

Sample response:

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

getFOJobClassLocalCAN

Retrieves a single FOJobClassLocalCAN entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalCAN|error

Sample code:

FOJobClassLocalCAN result = check client->getFOJobClassLocalCAN(country, externalCode, startDate);

Sample response:

{
  "d": {}
}

Territory

listTerritorys

Queries the Territory 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	ListTerritorysQueries	No	Queries to be sent with the request

Returns: ListTerritorysResponse|error

Sample code:

ListTerritorysResponse result = check client->listTerritorys();

Sample response:

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

getTerritory

Retrieves a single Territory entity identified by its key property.

Parameters:

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

Returns: Territory|error

Sample code:

Territory result = check client->getTerritory(territoryCode);

Sample response:

{
  "territoryCode": "1000"
}

JobClassificationCountry

listJobClassificationCountrys

Queries the JobClassificationCountry 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	ListJobClassificationCountrysQueries	No	Queries to be sent with the request

Returns: ListJobClassificationCountrysResponse|error

Sample code:

ListJobClassificationCountrysResponse result = check client->listJobClassificationCountrys();

Sample response:

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

createJobClassificationCountry

Creates a new JobClassificationCountry entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationCountry|error

Sample code:

CreatedJobClassificationCountry result = check client->createJobClassificationCountry(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getJobClassificationCountry

Retrieves a single JobClassificationCountry entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
country	string	Yes	key: country
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationCountryQueries	No	Queries to be sent with the request

Returns: JobClassificationCountry|error

Sample code:

JobClassificationCountry result = check client->getJobClassificationCountry(JobClassification_effectiveStartDate, JobClassification_externalCode, country);

Sample response:

{
  "d": {}
}

updateJobClassificationCountry

Updates the JobClassificationCountry identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
country	string	Yes	key: country
payload	ModifiedJobClassificationCountry	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationCountry(JobClassification_effectiveStartDate, JobClassification_externalCode, country, payload);

deleteJobClassificationCountry

Deletes the JobClassificationCountry identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
country	string	Yes	key: country
headers	DeleteJobClassificationCountryHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationCountry(JobClassification_effectiveStartDate, JobClassification_externalCode, country);

FOJobFunction

listFOJobFunctions

Queries the FOJobFunction 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	ListFOJobFunctionsQueries	No	Queries to be sent with the request

Returns: ListFOJobFunctionsResponse|error

Sample code:

ListFOJobFunctionsResponse result = check client->listFOJobFunctions();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "descriptionTranslationNav": {},
        "nameTranslationNav": {},
        "parentFunctionCodeNav": {}
      }
    ]
  }
}

createFOJobFunction

Creates a new FOJobFunction entity from the supplied payload.

Parameters:

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

Returns: CreatedFOJobFunction|error

Sample code:

CreatedFOJobFunction result = check client->createFOJobFunction(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "startDate": "2026-01-01",
    "descriptionTranslationNav": {
      "externalCode": "1000"
    },
    "nameTranslationNav": {
      "externalCode": "1000"
    },
    "parentFunctionCodeNav": {}
  }
}

getFOJobFunction

Retrieves a single FOJobFunction entity identified by its key properties.

Parameters:

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

Returns: FOJobFunction|error

Sample code:

FOJobFunction result = check client->getFOJobFunction(externalCode, startDate);

Sample response:

{
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "descriptionTranslationNav": {
    "externalCode": "1000"
  },
  "nameTranslationNav": {
    "externalCode": "1000"
  },
  "parentFunctionCodeNav": {}
}

updateFOJobFunction

Updates the FOJobFunction identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
payload	ModifiedFOJobFunction	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateFOJobFunction(externalCode, startDate, payload);

deleteFOJobFunction

Deletes the FOJobFunction identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFOJobFunctionHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFOJobFunction(externalCode, startDate);

FODynamicRole

listFODynamicRoles

Queries the FODynamicRole 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	ListFODynamicRolesQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFODynamicRoles();

getFODynamicRole

Retrieves a single FODynamicRole entity identified by its key property.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFODynamicRole(dynamicRoleAssignmentId);

FOFrequency

listFOFrequencys

Queries the FOFrequency 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	ListFOFrequencysQueries	No	Queries to be sent with the request

Returns: ListFOFrequencysResponse|error

Sample code:

ListFOFrequencysResponse result = check client->listFOFrequencys();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "descriptionTranslationNav": {},
        "nameTranslationNav": {}
      }
    ]
  }
}

getFOFrequency

Retrieves a single FOFrequency 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	GetFOFrequencyQueries	No	Queries to be sent with the request

Returns: FOFrequency|error

Sample code:

FOFrequency result = check client->getFOFrequency(externalCode);

Sample response:

{
  "externalCode": "1000",
  "descriptionTranslationNav": {
    "externalCode": "1000"
  },
  "nameTranslationNav": {
    "externalCode": "1000"
  }
}

LegalEntityFRA

listLegalEntityFRAs

Queries the LegalEntityFRA 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	ListLegalEntityFRAsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityFRAsResponse|error

Sample code:

ListLegalEntityFRAsResponse result = check client->listLegalEntityFRAs();

Sample response:

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

createLegalEntityFRA

Creates a new LegalEntityFRA entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityFRA|error

Sample code:

CreatedLegalEntityFRA result = check client->createLegalEntityFRA(payload);

Sample response:

{
  "d": {
    "LegalEntity_effectiveStartDate": "2026-01-01",
    "LegalEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getLegalEntityFRA

Retrieves a single LegalEntityFRA entity identified by its key properties.

Parameters:

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

Returns: LegalEntityFRA|error

Sample code:

LegalEntityFRA result = check client->getLegalEntityFRA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "LegalEntity_effectiveStartDate": "2026-01-01",
  "LegalEntity_externalCode": "1000",
  "externalCode": "1000"
}

updateLegalEntityFRA

Updates the LegalEntityFRA identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityFRA	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityFRA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityFRA

Deletes the LegalEntityFRA identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityFRAHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityFRA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

FOPayGrade

listFOPayGrades

Queries the FOPayGrade 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	ListFOPayGradesQueries	No	Queries to be sent with the request

Returns: ListFOPayGradesResponse|error

Sample code:

ListFOPayGradesResponse result = check client->listFOPayGrades();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "descriptionTranslationNav": {},
        "nameTranslationNav": {}
      }
    ]
  }
}

getFOPayGrade

Retrieves a single FOPayGrade entity identified by its key properties.

Parameters:

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

Returns: FOPayGrade|error

Sample code:

FOPayGrade result = check client->getFOPayGrade(externalCode, startDate);

Sample response:

{
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "descriptionTranslationNav": {
    "externalCode": "1000"
  },
  "nameTranslationNav": {
    "externalCode": "1000"
  }
}

FOJobClassLocalAUS

listFOJobClassLocalAUSs

Queries the FOJobClassLocalAUS 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	ListFOJobClassLocalAUSsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalAUSsResponse|error

Sample code:

ListFOJobClassLocalAUSsResponse result = check client->listFOJobClassLocalAUSs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOJobClassLocalAUS

Retrieves a single FOJobClassLocalAUS entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalAUS|error

Sample code:

FOJobClassLocalAUS result = check client->getFOJobClassLocalAUS(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

FOPayRange

listFOPayRanges

Queries the FOPayRange 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	ListFOPayRangesQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOPayRanges();

getFOPayRange

Retrieves a single FOPayRange entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOPayRange(externalCode, startDate);

FOJobClassLocalITA

listFOJobClassLocalITAs

Queries the FOJobClassLocalITA 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	ListFOJobClassLocalITAsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalITAsResponse|error

Sample code:

ListFOJobClassLocalITAsResponse result = check client->listFOJobClassLocalITAs();

Sample response:

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

getFOJobClassLocalITA

Retrieves a single FOJobClassLocalITA entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalITA|error

Sample code:

FOJobClassLocalITA result = check client->getFOJobClassLocalITA(country, externalCode, startDate);

Sample response:

{
  "d": {}
}

JobClassificationBRA

listJobClassificationBRAs

Queries the JobClassificationBRA 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	ListJobClassificationBRAsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationBRAsResponse|error

Sample code:

ListJobClassificationBRAsResponse result = check client->listJobClassificationBRAs();

Sample response:

{
  "d": {
    "results": [
      {
        "JobClassificationCountry_country": "string",
        "JobClassification_effectiveStartDate": "2026-01-01",
        "JobClassification_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobClassificationBRA

Creates a new JobClassificationBRA entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationBRA|error

Sample code:

CreatedJobClassificationBRA result = check client->createJobClassificationBRA(payload);

Sample response:

{
  "d": {
    "JobClassificationCountry_country": "string",
    "JobClassification_effectiveStartDate": "2026-01-01",
    "JobClassification_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobClassificationBRA

Retrieves a single JobClassificationBRA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationBRAQueries	No	Queries to be sent with the request

Returns: JobClassificationBRA|error

Sample code:

JobClassificationBRA result = check client->getJobClassificationBRA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "JobClassificationCountry_country": "string",
  "JobClassification_effectiveStartDate": "2026-01-01",
  "JobClassification_externalCode": "1000",
  "externalCode": "1000"
}

updateJobClassificationBRA

Updates the JobClassificationBRA identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationBRA	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationBRA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationBRA

Deletes the JobClassificationBRA identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationBRAHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationBRA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

JobClassificationZAF

listJobClassificationZAFs

Queries the JobClassificationZAF 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	ListJobClassificationZAFsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationZAFsResponse|error

Sample code:

ListJobClassificationZAFsResponse result = check client->listJobClassificationZAFs();

Sample response:

{
  "d": {
    "results": [
      {
        "JobClassificationCountry_country": "string",
        "JobClassification_effectiveStartDate": "2026-01-01",
        "JobClassification_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobClassificationZAF

Creates a new JobClassificationZAF entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationZAF|error

Sample code:

CreatedJobClassificationZAF result = check client->createJobClassificationZAF(payload);

Sample response:

{
  "d": {
    "JobClassificationCountry_country": "string",
    "JobClassification_effectiveStartDate": "2026-01-01",
    "JobClassification_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobClassificationZAF

Retrieves a single JobClassificationZAF entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationZAFQueries	No	Queries to be sent with the request

Returns: JobClassificationZAF|error

Sample code:

JobClassificationZAF result = check client->getJobClassificationZAF(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "JobClassificationCountry_country": "string",
  "JobClassification_effectiveStartDate": "2026-01-01",
  "JobClassification_externalCode": "1000",
  "externalCode": "1000"
}

updateJobClassificationZAF

Updates the JobClassificationZAF identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationZAF	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationZAF(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationZAF

Deletes the JobClassificationZAF identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationZAFHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationZAF(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

LegalEntityDEU

listLegalEntityDEUs

Queries the LegalEntityDEU 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	ListLegalEntityDEUsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityDEUsResponse|error

Sample code:

ListLegalEntityDEUsResponse result = check client->listLegalEntityDEUs();

Sample response:

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

createLegalEntityDEU

Creates a new LegalEntityDEU entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityDEU|error

Sample code:

CreatedLegalEntityDEU result = check client->createLegalEntityDEU(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityDEU

Retrieves a single LegalEntityDEU entity identified by its key properties.

Parameters:

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

Returns: LegalEntityDEU|error

Sample code:

LegalEntityDEU result = check client->getLegalEntityDEU(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityDEU

Updates the LegalEntityDEU identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityDEU	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityDEU(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityDEU

Deletes the LegalEntityDEU identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityDEUHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityDEU(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

JobClassificationGBR

listJobClassificationGBRs

Queries the JobClassificationGBR 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	ListJobClassificationGBRsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationGBRsResponse|error

Sample code:

ListJobClassificationGBRsResponse result = check client->listJobClassificationGBRs();

Sample response:

{
  "d": {
    "results": [
      {
        "JobClassificationCountry_country": "string",
        "JobClassification_effectiveStartDate": "2026-01-01",
        "JobClassification_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobClassificationGBR

Creates a new JobClassificationGBR entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationGBR|error

Sample code:

CreatedJobClassificationGBR result = check client->createJobClassificationGBR(payload);

Sample response:

{
  "d": {
    "JobClassificationCountry_country": "string",
    "JobClassification_effectiveStartDate": "2026-01-01",
    "JobClassification_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobClassificationGBR

Retrieves a single JobClassificationGBR entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationGBRQueries	No	Queries to be sent with the request

Returns: JobClassificationGBR|error

Sample code:

JobClassificationGBR result = check client->getJobClassificationGBR(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "JobClassificationCountry_country": "string",
  "JobClassification_effectiveStartDate": "2026-01-01",
  "JobClassification_externalCode": "1000",
  "externalCode": "1000"
}

updateJobClassificationGBR

Updates the JobClassificationGBR identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationGBR	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationGBR(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationGBR

Deletes the JobClassificationGBR identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationGBRHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationGBR(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

JobClassificationFRA

listJobClassificationFRAs

Queries the JobClassificationFRA 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	ListJobClassificationFRAsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationFRAsResponse|error

Sample code:

ListJobClassificationFRAsResponse result = check client->listJobClassificationFRAs();

Sample response:

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

createJobClassificationFRA

Creates a new JobClassificationFRA entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationFRA|error

Sample code:

CreatedJobClassificationFRA result = check client->createJobClassificationFRA(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getJobClassificationFRA

Retrieves a single JobClassificationFRA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationFRAQueries	No	Queries to be sent with the request

Returns: JobClassificationFRA|error

Sample code:

JobClassificationFRA result = check client->getJobClassificationFRA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateJobClassificationFRA

Updates the JobClassificationFRA identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationFRA	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationFRA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationFRA

Deletes the JobClassificationFRA identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationFRAHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationFRA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Periods

listPeriodss

Queries the Periods 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	ListPeriodssQueries	No	Queries to be sent with the request

Returns: ListPeriodssResponse|error

Sample code:

ListPeriodssResponse result = check client->listPeriodss();

Sample response:

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

getPeriods

Retrieves a single Periods entity identified by its key properties.

Parameters:

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

Returns: Periods|error

Sample code:

Periods result = check client->getPeriods(FiscalYearVariant_externalCode, externalCode);

Sample response:

{
  "d": {}
}

BudgetGroup

listBudgetGroups

Queries the BudgetGroup 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	ListBudgetGroupsQueries	No	Queries to be sent with the request

Returns: ListBudgetGroupsResponse|error

Sample code:

ListBudgetGroupsResponse result = check client->listBudgetGroups();

Sample response:

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

createBudgetGroup

Creates a new BudgetGroup entity from the supplied payload.

Parameters:

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

Returns: CreatedBudgetGroup|error

Sample code:

CreatedBudgetGroup result = check client->createBudgetGroup(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getBudgetGroup

Retrieves a single BudgetGroup 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	GetBudgetGroupQueries	No	Queries to be sent with the request

Returns: BudgetGroup|error

Sample code:

BudgetGroup result = check client->getBudgetGroup(effectiveStartDate, externalCode);

Sample response:

{
  "d": {}
}

updateBudgetGroup

Updates the BudgetGroup identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
effectiveStartDate	string	Yes	key: effectiveStartDate
externalCode	string	Yes	key: externalCode
payload	ModifiedBudgetGroup	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateBudgetGroup(effectiveStartDate, externalCode, payload);

deleteBudgetGroup

Deletes the BudgetGroup identified by its key properties.

Parameters:

Name	Type	Required	Description
effectiveStartDate	string	Yes	key: effectiveStartDate
externalCode	string	Yes	key: externalCode
headers	DeleteBudgetGroupHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteBudgetGroup(effectiveStartDate, externalCode);

FOLocation

listFOLocations

Queries the FOLocation 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	ListFOLocationsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOLocations();

getFOLocation

Retrieves a single FOLocation entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOLocation(externalCode, startDate);

JobClassificationAUS

listJobClassificationAUSs

Queries the JobClassificationAUS 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	ListJobClassificationAUSsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationAUSsResponse|error

Sample code:

ListJobClassificationAUSsResponse result = check client->listJobClassificationAUSs();

Sample response:

{
  "d": {
    "results": [
      {
        "JobClassificationCountry_country": "string",
        "JobClassification_effectiveStartDate": "2026-01-01",
        "JobClassification_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobClassificationAUS

Creates a new JobClassificationAUS entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationAUS|error

Sample code:

CreatedJobClassificationAUS result = check client->createJobClassificationAUS(payload);

Sample response:

{
  "d": {
    "JobClassificationCountry_country": "string",
    "JobClassification_effectiveStartDate": "2026-01-01",
    "JobClassification_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobClassificationAUS

Retrieves a single JobClassificationAUS entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationAUSQueries	No	Queries to be sent with the request

Returns: JobClassificationAUS|error

Sample code:

JobClassificationAUS result = check client->getJobClassificationAUS(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "JobClassificationCountry_country": "string",
  "JobClassification_effectiveStartDate": "2026-01-01",
  "JobClassification_externalCode": "1000",
  "externalCode": "1000"
}

updateJobClassificationAUS

Updates the JobClassificationAUS identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationAUS	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationAUS(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationAUS

Deletes the JobClassificationAUS identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationAUSHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationAUS(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

PayScaleArea

listPayScaleAreas

Queries the PayScaleArea 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	ListPayScaleAreasQueries	No	Queries to be sent with the request

Returns: ListPayScaleAreasResponse|error

Sample code:

ListPayScaleAreasResponse result = check client->listPayScaleAreas();

Sample response:

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

createPayScaleArea

Creates a new PayScaleArea entity from the supplied payload.

Parameters:

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

Returns: CreatedPayScaleArea|error

Sample code:

CreatedPayScaleArea result = check client->createPayScaleArea(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getPayScaleArea

Retrieves a single PayScaleArea entity identified by its key property.

Parameters:

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

Returns: PayScaleArea|error

Sample code:

PayScaleArea result = check client->getPayScaleArea(code);

Sample response:

{
  "d": {}
}

updatePayScaleArea

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePayScaleArea(code, payload);

deletePayScaleArea

Deletes the PayScaleArea identified by its key property.

Parameters:

Name	Type	Required	Description
code	string	Yes	key: code
headers	DeletePayScaleAreaHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePayScaleArea(code);

FOJobClassLocalUSA

listFOJobClassLocalUSAs

Queries the FOJobClassLocalUSA 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	ListFOJobClassLocalUSAsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalUSAsResponse|error

Sample code:

ListFOJobClassLocalUSAsResponse result = check client->listFOJobClassLocalUSAs();

Sample response:

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

getFOJobClassLocalUSA

Retrieves a single FOJobClassLocalUSA entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalUSA|error

Sample code:

FOJobClassLocalUSA result = check client->getFOJobClassLocalUSA(country, externalCode, startDate);

Sample response:

{
  "d": {}
}

FOLegalEntityLocalFRA

listFOLegalEntityLocalFRAs

Queries the FOLegalEntityLocalFRA 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	ListFOLegalEntityLocalFRAsQueries	No	Queries to be sent with the request

Returns: ListFOLegalEntityLocalFRAsResponse|error

Sample code:

ListFOLegalEntityLocalFRAsResponse result = check client->listFOLegalEntityLocalFRAs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOLegalEntityLocalFRA

Retrieves a single FOLegalEntityLocalFRA entity identified by its key properties.

Parameters:

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

Returns: FOLegalEntityLocalFRA|error

Sample code:

FOLegalEntityLocalFRA result = check client->getFOLegalEntityLocalFRA(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

FOJobClassLocalFRA

listFOJobClassLocalFRAs

Queries the FOJobClassLocalFRA 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	ListFOJobClassLocalFRAsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalFRAsResponse|error

Sample code:

ListFOJobClassLocalFRAsResponse result = check client->listFOJobClassLocalFRAs();

Sample response:

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

getFOJobClassLocalFRA

Retrieves a single FOJobClassLocalFRA entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalFRA|error

Sample code:

FOJobClassLocalFRA result = check client->getFOJobClassLocalFRA(country, externalCode, startDate);

Sample response:

{
  "d": {}
}

FOLegalEntityLocalDEU

listFOLegalEntityLocalDEUs

Queries the FOLegalEntityLocalDEU 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	ListFOLegalEntityLocalDEUsQueries	No	Queries to be sent with the request

Returns: ListFOLegalEntityLocalDEUsResponse|error

Sample code:

ListFOLegalEntityLocalDEUsResponse result = check client->listFOLegalEntityLocalDEUs();

Sample response:

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

getFOLegalEntityLocalDEU

Retrieves a single FOLegalEntityLocalDEU entity identified by its key properties.

Parameters:

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

Returns: FOLegalEntityLocalDEU|error

Sample code:

FOLegalEntityLocalDEU result = check client->getFOLegalEntityLocalDEU(country, externalCode, startDate);

Sample response:

{
  "d": {}
}

JobClassificationITA

listJobClassificationITAs

Queries the JobClassificationITA 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	ListJobClassificationITAsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationITAsResponse|error

Sample code:

ListJobClassificationITAsResponse result = check client->listJobClassificationITAs();

Sample response:

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

createJobClassificationITA

Creates a new JobClassificationITA entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationITA|error

Sample code:

CreatedJobClassificationITA result = check client->createJobClassificationITA(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getJobClassificationITA

Retrieves a single JobClassificationITA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationITAQueries	No	Queries to be sent with the request

Returns: JobClassificationITA|error

Sample code:

JobClassificationITA result = check client->getJobClassificationITA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateJobClassificationITA

Updates the JobClassificationITA identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationITA	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationITA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationITA

Deletes the JobClassificationITA identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationITAHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationITA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

LegalEntityESP

listLegalEntityESPs

Queries the LegalEntityESP 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	ListLegalEntityESPsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityESPsResponse|error

Sample code:

ListLegalEntityESPsResponse result = check client->listLegalEntityESPs();

Sample response:

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

createLegalEntityESP

Creates a new LegalEntityESP entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityESP|error

Sample code:

CreatedLegalEntityESP result = check client->createLegalEntityESP(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityESP

Retrieves a single LegalEntityESP entity identified by its key properties.

Parameters:

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

Returns: LegalEntityESP|error

Sample code:

LegalEntityESP result = check client->getLegalEntityESP(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityESP

Updates the LegalEntityESP identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityESP	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityESP(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityESP

Deletes the LegalEntityESP identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityESPHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityESP(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

FOJobClassLocalGBR

listFOJobClassLocalGBRs

Queries the FOJobClassLocalGBR 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	ListFOJobClassLocalGBRsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalGBRsResponse|error

Sample code:

ListFOJobClassLocalGBRsResponse result = check client->listFOJobClassLocalGBRs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOJobClassLocalGBR

Retrieves a single FOJobClassLocalGBR entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalGBR|error

Sample code:

FOJobClassLocalGBR result = check client->getFOJobClassLocalGBR(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

FOCorporateAddressDEFLT

listFOCorporateAddressDEFLTs

Queries the FOCorporateAddressDEFLT 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	ListFOCorporateAddressDEFLTsQueries	No	Queries to be sent with the request

Returns: ListFOCorporateAddressDEFLTsResponse|error

Sample code:

ListFOCorporateAddressDEFLTsResponse result = check client->listFOCorporateAddressDEFLTs();

Sample response:

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

getFOCorporateAddressDEFLT

Retrieves a single FOCorporateAddressDEFLT entity identified by its key property.

Parameters:

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

Returns: FOCorporateAddressDEFLT|error

Sample code:

FOCorporateAddressDEFLT result = check client->getFOCorporateAddressDEFLT(addressId);

Sample response:

{
  "d": {}
}

FODivision

listFODivisions

Queries the FODivision 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	ListFODivisionsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFODivisions();

getFODivision

Retrieves a single FODivision entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFODivision(externalCode, startDate);

deleteFODivision

Deletes the FODivision identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFODivisionHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFODivision(externalCode, startDate);

JobClassificationUSA

listJobClassificationUSAs

Queries the JobClassificationUSA 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	ListJobClassificationUSAsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationUSAsResponse|error

Sample code:

ListJobClassificationUSAsResponse result = check client->listJobClassificationUSAs();

Sample response:

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

createJobClassificationUSA

Creates a new JobClassificationUSA entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationUSA|error

Sample code:

CreatedJobClassificationUSA result = check client->createJobClassificationUSA(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getJobClassificationUSA

Retrieves a single JobClassificationUSA entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationUSAQueries	No	Queries to be sent with the request

Returns: JobClassificationUSA|error

Sample code:

JobClassificationUSA result = check client->getJobClassificationUSA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateJobClassificationUSA

Updates the JobClassificationUSA identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationUSA	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationUSA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationUSA

Deletes the JobClassificationUSA identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationUSAHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationUSA(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

FOJobClassLocalDEFLT

listFOJobClassLocalDEFLTs

Queries the FOJobClassLocalDEFLT 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	ListFOJobClassLocalDEFLTsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalDEFLTsResponse|error

Sample code:

ListFOJobClassLocalDEFLTsResponse result = check client->listFOJobClassLocalDEFLTs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOJobClassLocalDEFLT

Retrieves a single FOJobClassLocalDEFLT entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalDEFLT|error

Sample code:

FOJobClassLocalDEFLT result = check client->getFOJobClassLocalDEFLT(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

FOEventReason

listFOEventReasons

Queries the FOEventReason 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	ListFOEventReasonsQueries	No	Queries to be sent with the request

Returns: ListFOEventReasonsResponse|error

Sample code:

ListFOEventReasonsResponse result = check client->listFOEventReasons();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "descriptionTranslationNav": {},
        "nameTranslationNav": {}
      }
    ]
  }
}

getFOEventReason

Retrieves a single FOEventReason entity identified by its key properties.

Parameters:

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

Returns: FOEventReason|error

Sample code:

FOEventReason result = check client->getFOEventReason(externalCode, startDate);

Sample response:

{
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "descriptionTranslationNav": {
    "externalCode": "1000"
  },
  "nameTranslationNav": {
    "externalCode": "1000"
  }
}

FOCostCenter

listFOCostCenters

Queries the FOCostCenter 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	ListFOCostCentersQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOCostCenters();

getFOCostCenter

Retrieves a single FOCostCenter entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOCostCenter(externalCode, startDate);

deleteFOCostCenter

Deletes the FOCostCenter identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFOCostCenterHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFOCostCenter(externalCode, startDate);

FOJobClassLocalBRA

listFOJobClassLocalBRAs

Queries the FOJobClassLocalBRA 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	ListFOJobClassLocalBRAsQueries	No	Queries to be sent with the request

Returns: ListFOJobClassLocalBRAsResponse|error

Sample code:

ListFOJobClassLocalBRAsResponse result = check client->listFOJobClassLocalBRAs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOJobClassLocalBRA

Retrieves a single FOJobClassLocalBRA entity identified by its key properties.

Parameters:

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

Returns: FOJobClassLocalBRA|error

Sample code:

FOJobClassLocalBRA result = check client->getFOJobClassLocalBRA(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

FOLocationGroup

listFOLocationGroups

Queries the FOLocationGroup 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	ListFOLocationGroupsQueries	No	Queries to be sent with the request

Returns: ListFOLocationGroupsResponse|error

Sample code:

ListFOLocationGroupsResponse result = check client->listFOLocationGroups();

Sample response:

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

getFOLocationGroup

Retrieves a single FOLocationGroup entity identified by its key properties.

Parameters:

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

Returns: FOLocationGroup|error

Sample code:

FOLocationGroup result = check client->getFOLocationGroup(externalCode, startDate);

Sample response:

{
  "d": {}
}

FOLegalEntityLocalESP

listFOLegalEntityLocalESPs

Queries the FOLegalEntityLocalESP 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	ListFOLegalEntityLocalESPsQueries	No	Queries to be sent with the request

Returns: ListFOLegalEntityLocalESPsResponse|error

Sample code:

ListFOLegalEntityLocalESPsResponse result = check client->listFOLegalEntityLocalESPs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOLegalEntityLocalESP

Retrieves a single FOLegalEntityLocalESP entity identified by its key properties.

Parameters:

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

Returns: FOLegalEntityLocalESP|error

Sample code:

FOLegalEntityLocalESP result = check client->getFOLegalEntityLocalESP(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

PayScaleType

listPayScaleTypes

Queries the PayScaleType 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	ListPayScaleTypesQueries	No	Queries to be sent with the request

Returns: ListPayScaleTypesResponse|error

Sample code:

ListPayScaleTypesResponse result = check client->listPayScaleTypes();

Sample response:

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

createPayScaleType

Creates a new PayScaleType entity from the supplied payload.

Parameters:

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

Returns: CreatedPayScaleType|error

Sample code:

CreatedPayScaleType result = check client->createPayScaleType(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getPayScaleType

Retrieves a single PayScaleType entity identified by its key property.

Parameters:

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

Returns: PayScaleType|error

Sample code:

PayScaleType result = check client->getPayScaleType(code);

Sample response:

{
  "d": {}
}

updatePayScaleType

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePayScaleType(code, payload);

deletePayScaleType

Deletes the PayScaleType identified by its key property.

Parameters:

Name	Type	Required	Description
code	string	Yes	key: code
headers	DeletePayScaleTypeHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePayScaleType(code);

FOLegalEntityLocalDEFLT

listFOLegalEntityLocalDEFLTs

Queries the FOLegalEntityLocalDEFLT 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	ListFOLegalEntityLocalDEFLTsQueries	No	Queries to be sent with the request

Returns: ListFOLegalEntityLocalDEFLTsResponse|error

Sample code:

ListFOLegalEntityLocalDEFLTsResponse result = check client->listFOLegalEntityLocalDEFLTs();

Sample response:

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

getFOLegalEntityLocalDEFLT

Retrieves a single FOLegalEntityLocalDEFLT entity identified by its key properties.

Parameters:

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

Returns: FOLegalEntityLocalDEFLT|error

Sample code:

FOLegalEntityLocalDEFLT result = check client->getFOLegalEntityLocalDEFLT(country, externalCode, startDate);

Sample response:

{
  "d": {}
}

LegalEntityRUS

listLegalEntityRUSs

Queries the LegalEntityRUS 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	ListLegalEntityRUSsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityRUSsResponse|error

Sample code:

ListLegalEntityRUSsResponse result = check client->listLegalEntityRUSs();

Sample response:

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

createLegalEntityRUS

Creates a new LegalEntityRUS entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityRUS|error

Sample code:

CreatedLegalEntityRUS result = check client->createLegalEntityRUS(payload);

Sample response:

{
  "d": {
    "LegalEntity_effectiveStartDate": "2026-01-01",
    "LegalEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getLegalEntityRUS

Retrieves a single LegalEntityRUS entity identified by its key properties.

Parameters:

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

Returns: LegalEntityRUS|error

Sample code:

LegalEntityRUS result = check client->getLegalEntityRUS(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "LegalEntity_effectiveStartDate": "2026-01-01",
  "LegalEntity_externalCode": "1000",
  "externalCode": "1000"
}

updateLegalEntityRUS

Updates the LegalEntityRUS identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityRUS	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityRUS(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityRUS

Deletes the LegalEntityRUS identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityRUSHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityRUS(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

JobClassificationCAN

listJobClassificationCANs

Queries the JobClassificationCAN 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	ListJobClassificationCANsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationCANsResponse|error

Sample code:

ListJobClassificationCANsResponse result = check client->listJobClassificationCANs();

Sample response:

{
  "d": {
    "results": [
      {
        "JobClassificationCountry_country": "string",
        "JobClassification_effectiveStartDate": "2026-01-01",
        "JobClassification_externalCode": "1000",
        "externalCode": "1000"
      }
    ]
  }
}

createJobClassificationCAN

Creates a new JobClassificationCAN entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationCAN|error

Sample code:

CreatedJobClassificationCAN result = check client->createJobClassificationCAN(payload);

Sample response:

{
  "d": {
    "JobClassificationCountry_country": "string",
    "JobClassification_effectiveStartDate": "2026-01-01",
    "JobClassification_externalCode": "1000",
    "externalCode": "1000"
  }
}

getJobClassificationCAN

Retrieves a single JobClassificationCAN entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationCANQueries	No	Queries to be sent with the request

Returns: JobClassificationCAN|error

Sample code:

JobClassificationCAN result = check client->getJobClassificationCAN(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "JobClassificationCountry_country": "string",
  "JobClassification_effectiveStartDate": "2026-01-01",
  "JobClassification_externalCode": "1000",
  "externalCode": "1000"
}

updateJobClassificationCAN

Updates the JobClassificationCAN identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationCAN	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationCAN(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationCAN

Deletes the JobClassificationCAN identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationCANHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationCAN(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

PayScalePayComponent

listPayScalePayComponents

Queries the PayScalePayComponent 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	ListPayScalePayComponentsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listPayScalePayComponents();

getPayScalePayComponent

Retrieves a single PayScalePayComponent entity identified by its key properties.

Parameters:

Name	Type	Required	Description
PayScaleLevel_code	string	Yes	key: PayScaleLevel_code
PayScaleLevel_effectiveStartDate	string	Yes	key: PayScaleLevel_effectiveStartDate
code	string	Yes	key: code
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetPayScalePayComponentQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->getPayScalePayComponent(PayScaleLevel_code, PayScaleLevel_effectiveStartDate, code);

deletePayScalePayComponent

Deletes the PayScalePayComponent identified by its key properties.

Parameters:

Name	Type	Required	Description
PayScaleLevel_code	string	Yes	key: PayScaleLevel_code
PayScaleLevel_effectiveStartDate	string	Yes	key: PayScaleLevel_effectiveStartDate
code	string	Yes	key: code
headers	DeletePayScalePayComponentHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePayScalePayComponent(PayScaleLevel_code, PayScaleLevel_effectiveStartDate, code);

LegalEntitySVN

listLegalEntitySVNs

Queries the LegalEntitySVN 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	ListLegalEntitySVNsQueries	No	Queries to be sent with the request

Returns: ListLegalEntitySVNsResponse|error

Sample code:

ListLegalEntitySVNsResponse result = check client->listLegalEntitySVNs();

Sample response:

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

createLegalEntitySVN

Creates a new LegalEntitySVN entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntitySVN|error

Sample code:

CreatedLegalEntitySVN result = check client->createLegalEntitySVN(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntitySVN

Retrieves a single LegalEntitySVN entity identified by its key properties.

Parameters:

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

Returns: LegalEntitySVN|error

Sample code:

LegalEntitySVN result = check client->getLegalEntitySVN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntitySVN

Updates the LegalEntitySVN identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntitySVN	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntitySVN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntitySVN

Deletes the LegalEntitySVN identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntitySVNHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntitySVN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntitySAU

listLegalEntitySAUs

Queries the LegalEntitySAU 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	ListLegalEntitySAUsQueries	No	Queries to be sent with the request

Returns: ListLegalEntitySAUsResponse|error

Sample code:

ListLegalEntitySAUsResponse result = check client->listLegalEntitySAUs();

Sample response:

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

createLegalEntitySAU

Creates a new LegalEntitySAU entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntitySAU|error

Sample code:

CreatedLegalEntitySAU result = check client->createLegalEntitySAU(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntitySAU

Retrieves a single LegalEntitySAU entity identified by its key properties.

Parameters:

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

Returns: LegalEntitySAU|error

Sample code:

LegalEntitySAU result = check client->getLegalEntitySAU(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntitySAU

Updates the LegalEntitySAU identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntitySAU	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntitySAU(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntitySAU

Deletes the LegalEntitySAU identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntitySAUHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntitySAU(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntityPRY

listLegalEntityPRYs

Queries the LegalEntityPRY 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	ListLegalEntityPRYsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityPRYsResponse|error

Sample code:

ListLegalEntityPRYsResponse result = check client->listLegalEntityPRYs();

Sample response:

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

createLegalEntityPRY

Creates a new LegalEntityPRY entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityPRY|error

Sample code:

CreatedLegalEntityPRY result = check client->createLegalEntityPRY(payload);

Sample response:

{
  "d": {
    "LegalEntity_effectiveStartDate": "2026-01-01",
    "LegalEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getLegalEntityPRY

Retrieves a single LegalEntityPRY entity identified by its key properties.

Parameters:

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

Returns: LegalEntityPRY|error

Sample code:

LegalEntityPRY result = check client->getLegalEntityPRY(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "LegalEntity_effectiveStartDate": "2026-01-01",
  "LegalEntity_externalCode": "1000",
  "externalCode": "1000"
}

updateLegalEntityPRY

Updates the LegalEntityPRY identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityPRY	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityPRY(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityPRY

Deletes the LegalEntityPRY identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityPRYHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityPRY(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntityCAN

listLegalEntityCANs

Queries the LegalEntityCAN 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	ListLegalEntityCANsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityCANsResponse|error

Sample code:

ListLegalEntityCANsResponse result = check client->listLegalEntityCANs();

Sample response:

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

createLegalEntityCAN

Creates a new LegalEntityCAN entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityCAN|error

Sample code:

CreatedLegalEntityCAN result = check client->createLegalEntityCAN(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityCAN

Retrieves a single LegalEntityCAN entity identified by its key properties.

Parameters:

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

Returns: LegalEntityCAN|error

Sample code:

LegalEntityCAN result = check client->getLegalEntityCAN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityCAN

Updates the LegalEntityCAN identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityCAN	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityCAN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityCAN

Deletes the LegalEntityCAN identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityCANHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityCAN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntityBOL

listLegalEntityBOLs

Queries the LegalEntityBOL 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	ListLegalEntityBOLsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityBOLsResponse|error

Sample code:

ListLegalEntityBOLsResponse result = check client->listLegalEntityBOLs();

Sample response:

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

createLegalEntityBOL

Creates a new LegalEntityBOL entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityBOL|error

Sample code:

CreatedLegalEntityBOL result = check client->createLegalEntityBOL(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityBOL

Retrieves a single LegalEntityBOL entity identified by its key properties.

Parameters:

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

Returns: LegalEntityBOL|error

Sample code:

LegalEntityBOL result = check client->getLegalEntityBOL(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityBOL

Updates the LegalEntityBOL identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityBOL	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityBOL(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityBOL

Deletes the LegalEntityBOL identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityBOLHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityBOL(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntityTHA

listLegalEntityTHAs

Queries the LegalEntityTHA 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	ListLegalEntityTHAsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityTHAsResponse|error

Sample code:

ListLegalEntityTHAsResponse result = check client->listLegalEntityTHAs();

Sample response:

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

createLegalEntityTHA

Creates a new LegalEntityTHA entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityTHA|error

Sample code:

CreatedLegalEntityTHA result = check client->createLegalEntityTHA(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityTHA

Retrieves a single LegalEntityTHA entity identified by its key properties.

Parameters:

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

Returns: LegalEntityTHA|error

Sample code:

LegalEntityTHA result = check client->getLegalEntityTHA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityTHA

Updates the LegalEntityTHA identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityTHA	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityTHA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityTHA

Deletes the LegalEntityTHA identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityTHAHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityTHA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

FOPayComponentGroup

listFOPayComponentGroups

Queries the FOPayComponentGroup 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	ListFOPayComponentGroupsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOPayComponentGroups();

getFOPayComponentGroup

Retrieves a single FOPayComponentGroup entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOPayComponentGroup(externalCode, startDate);

FOWfConfigStepApprover

listFOWfConfigStepApprovers

Queries the FOWfConfigStepApprover 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	ListFOWfConfigStepApproversQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOWfConfigStepApprovers();

getFOWfConfigStepApprover

Retrieves a single FOWfConfigStepApprover entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOWfConfigStepApprover(externalCode, stepNum);

LegalEntityBLR

listLegalEntityBLRs

Queries the LegalEntityBLR 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	ListLegalEntityBLRsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityBLRsResponse|error

Sample code:

ListLegalEntityBLRsResponse result = check client->listLegalEntityBLRs();

Sample response:

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

createLegalEntityBLR

Creates a new LegalEntityBLR entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityBLR|error

Sample code:

CreatedLegalEntityBLR result = check client->createLegalEntityBLR(payload);

Sample response:

{
  "d": {
    "LegalEntity_effectiveStartDate": "2026-01-01",
    "LegalEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getLegalEntityBLR

Retrieves a single LegalEntityBLR entity identified by its key properties.

Parameters:

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

Returns: LegalEntityBLR|error

Sample code:

LegalEntityBLR result = check client->getLegalEntityBLR(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "LegalEntity_effectiveStartDate": "2026-01-01",
  "LegalEntity_externalCode": "1000",
  "externalCode": "1000"
}

updateLegalEntityBLR

Updates the LegalEntityBLR identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityBLR	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityBLR(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityBLR

Deletes the LegalEntityBLR identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityBLRHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityBLR(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntityTUN

listLegalEntityTUNs

Queries the LegalEntityTUN 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	ListLegalEntityTUNsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityTUNsResponse|error

Sample code:

ListLegalEntityTUNsResponse result = check client->listLegalEntityTUNs();

Sample response:

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

createLegalEntityTUN

Creates a new LegalEntityTUN entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityTUN|error

Sample code:

CreatedLegalEntityTUN result = check client->createLegalEntityTUN(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityTUN

Retrieves a single LegalEntityTUN entity identified by its key properties.

Parameters:

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

Returns: LegalEntityTUN|error

Sample code:

LegalEntityTUN result = check client->getLegalEntityTUN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityTUN

Updates the LegalEntityTUN identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityTUN	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityTUN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityTUN

Deletes the LegalEntityTUN identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityTUNHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityTUN(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntitySGP

listLegalEntitySGPs

Queries the LegalEntitySGP 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	ListLegalEntitySGPsQueries	No	Queries to be sent with the request

Returns: ListLegalEntitySGPsResponse|error

Sample code:

ListLegalEntitySGPsResponse result = check client->listLegalEntitySGPs();

Sample response:

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

createLegalEntitySGP

Creates a new LegalEntitySGP entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntitySGP|error

Sample code:

CreatedLegalEntitySGP result = check client->createLegalEntitySGP(payload);

Sample response:

{
  "d": {
    "LegalEntity_effectiveStartDate": "2026-01-01",
    "LegalEntity_externalCode": "1000",
    "externalCode": "1000"
  }
}

getLegalEntitySGP

Retrieves a single LegalEntitySGP entity identified by its key properties.

Parameters:

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

Returns: LegalEntitySGP|error

Sample code:

LegalEntitySGP result = check client->getLegalEntitySGP(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "LegalEntity_effectiveStartDate": "2026-01-01",
  "LegalEntity_externalCode": "1000",
  "externalCode": "1000"
}

updateLegalEntitySGP

Updates the LegalEntitySGP identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntitySGP	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntitySGP(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntitySGP

Deletes the LegalEntitySGP identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntitySGPHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntitySGP(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

LegalEntityUSA

listLegalEntityUSAs

Queries the LegalEntityUSA 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	ListLegalEntityUSAsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityUSAsResponse|error

Sample code:

ListLegalEntityUSAsResponse result = check client->listLegalEntityUSAs();

Sample response:

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

createLegalEntityUSA

Creates a new LegalEntityUSA entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityUSA|error

Sample code:

CreatedLegalEntityUSA result = check client->createLegalEntityUSA(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityUSA

Retrieves a single LegalEntityUSA entity identified by its key properties.

Parameters:

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

Returns: LegalEntityUSA|error

Sample code:

LegalEntityUSA result = check client->getLegalEntityUSA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityUSA

Updates the LegalEntityUSA identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityUSA	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityUSA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityUSA

Deletes the LegalEntityUSA identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityUSAHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityUSA(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

PayPeriod

listPayPeriods

Queries the PayPeriod 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	ListPayPeriodsQueries	No	Queries to be sent with the request

Returns: ListPayPeriodsResponse|error

Sample code:

ListPayPeriodsResponse result = check client->listPayPeriods();

Sample response:

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

createPayPeriod

Creates a new PayPeriod entity from the supplied payload.

Parameters:

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

Returns: CreatedPayPeriod|error

Sample code:

CreatedPayPeriod result = check client->createPayPeriod(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getPayPeriod

Retrieves a single PayPeriod entity identified by its key properties.

Parameters:

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

Returns: PayPeriod|error

Sample code:

PayPeriod result = check client->getPayPeriod(PayCalendar_payGroup, externalCode);

Sample response:

{
  "d": {}
}

updatePayPeriod

Updates the PayPeriod identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
PayCalendar_payGroup	string	Yes	key: PayCalendar_payGroup
externalCode	int	Yes	key: externalCode
payload	ModifiedPayPeriod	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updatePayPeriod(PayCalendar_payGroup, externalCode, payload);

deletePayPeriod

Deletes the PayPeriod identified by its key properties.

Parameters:

Name	Type	Required	Description
PayCalendar_payGroup	string	Yes	key: PayCalendar_payGroup
externalCode	int	Yes	key: externalCode
headers	DeletePayPeriodHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePayPeriod(PayCalendar_payGroup, externalCode);

FOPayComponent

listFOPayComponents

Queries the FOPayComponent 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	ListFOPayComponentsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOPayComponents();

getFOPayComponent

Retrieves a single FOPayComponent entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOPayComponent(externalCode, startDate);

FOLegalEntityLocalARG

listFOLegalEntityLocalARGs

Queries the FOLegalEntityLocalARG 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	ListFOLegalEntityLocalARGsQueries	No	Queries to be sent with the request

Returns: ListFOLegalEntityLocalARGsResponse|error

Sample code:

ListFOLegalEntityLocalARGsResponse result = check client->listFOLegalEntityLocalARGs();

Sample response:

{
  "d": {
    "results": [
      {
        "country": "string",
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "countryNav": {}
      }
    ]
  }
}

getFOLegalEntityLocalARG

Retrieves a single FOLegalEntityLocalARG entity identified by its key properties.

Parameters:

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

Returns: FOLegalEntityLocalARG|error

Sample code:

FOLegalEntityLocalARG result = check client->getFOLegalEntityLocalARG(country, externalCode, startDate);

Sample response:

{
  "country": "string",
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "countryNav": {
    "territoryCode": "1000"
  }
}

FOGeozone

listFOGeozones

Queries the FOGeozone 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	ListFOGeozonesQueries	No	Queries to be sent with the request

Returns: ListFOGeozonesResponse|error

Sample code:

ListFOGeozonesResponse result = check client->listFOGeozones();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "descriptionTranslationNav": {},
        "nameTranslationNav": {}
      }
    ]
  }
}

getFOGeozone

Retrieves a single FOGeozone entity identified by its key properties.

Parameters:

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

Returns: FOGeozone|error

Sample code:

FOGeozone result = check client->getFOGeozone(externalCode, startDate);

Sample response:

{
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "descriptionTranslationNav": {
    "externalCode": "1000"
  },
  "nameTranslationNav": {
    "externalCode": "1000"
  }
}

LegalEntityARG

listLegalEntityARGs

Queries the LegalEntityARG 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	ListLegalEntityARGsQueries	No	Queries to be sent with the request

Returns: ListLegalEntityARGsResponse|error

Sample code:

ListLegalEntityARGsResponse result = check client->listLegalEntityARGs();

Sample response:

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

createLegalEntityARG

Creates a new LegalEntityARG entity from the supplied payload.

Parameters:

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

Returns: CreatedLegalEntityARG|error

Sample code:

CreatedLegalEntityARG result = check client->createLegalEntityARG(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getLegalEntityARG

Retrieves a single LegalEntityARG entity identified by its key properties.

Parameters:

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

Returns: LegalEntityARG|error

Sample code:

LegalEntityARG result = check client->getLegalEntityARG(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateLegalEntityARG

Updates the LegalEntityARG identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedLegalEntityARG	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateLegalEntityARG(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode, payload);

deleteLegalEntityARG

Deletes the LegalEntityARG identified by its key properties.

Parameters:

Name	Type	Required	Description
LegalEntity_effectiveStartDate	string	Yes	key: LegalEntity_effectiveStartDate
LegalEntity_externalCode	string	Yes	key: LegalEntity_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteLegalEntityARGHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteLegalEntityARG(LegalEntity_effectiveStartDate, LegalEntity_externalCode, externalCode);

FOBusinessUnit

listFOBusinessUnits

Queries the FOBusinessUnit 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	ListFOBusinessUnitsQueries	No	Queries to be sent with the request

Returns: ListFOBusinessUnitsResponse|error

Sample code:

ListFOBusinessUnitsResponse result = check client->listFOBusinessUnits();

Sample response:

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

createFOBusinessUnit

Creates a new FOBusinessUnit entity from the supplied payload.

Parameters:

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

Returns: CreatedFOBusinessUnit|error

Sample code:

CreatedFOBusinessUnit result = check client->createFOBusinessUnit(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getFOBusinessUnit

Retrieves a single FOBusinessUnit entity identified by its key properties.

Parameters:

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

Returns: FOBusinessUnit|error

Sample code:

FOBusinessUnit result = check client->getFOBusinessUnit(externalCode, startDate);

Sample response:

{
  "d": {}
}

updateFOBusinessUnit

Updates the FOBusinessUnit identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
payload	ModifiedFOBusinessUnit	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateFOBusinessUnit(externalCode, startDate, payload);

deleteFOBusinessUnit

Deletes the FOBusinessUnit identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFOBusinessUnitHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFOBusinessUnit(externalCode, startDate);

FOCompany

listFOCompanys

Queries the FOCompany 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	ListFOCompanysQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOCompanys();

getFOCompany

Retrieves a single FOCompany entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOCompany(externalCode, startDate);

deleteFOCompany

Deletes the FOCompany identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFOCompanyHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFOCompany(externalCode, startDate);

FOPayGroup

listFOPayGroups

Queries the FOPayGroup 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	ListFOPayGroupsQueries	No	Queries to be sent with the request

Returns: ListFOPayGroupsResponse|error

Sample code:

ListFOPayGroupsResponse result = check client->listFOPayGroups();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "startDate": "2026-01-01",
        "descriptionTranslationNav": {},
        "nameTranslationNav": {}
      }
    ]
  }
}

createFOPayGroup

Creates a new FOPayGroup entity from the supplied payload.

Parameters:

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

Returns: CreatedFOPayGroup|error

Sample code:

CreatedFOPayGroup result = check client->createFOPayGroup(payload);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "startDate": "2026-01-01",
    "descriptionTranslationNav": {
      "externalCode": "1000"
    },
    "nameTranslationNav": {
      "externalCode": "1000"
    }
  }
}

getFOPayGroup

Retrieves a single FOPayGroup entity identified by its key properties.

Parameters:

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

Returns: FOPayGroup|error

Sample code:

FOPayGroup result = check client->getFOPayGroup(externalCode, startDate);

Sample response:

{
  "externalCode": "1000",
  "startDate": "2026-01-01",
  "descriptionTranslationNav": {
    "externalCode": "1000"
  },
  "nameTranslationNav": {
    "externalCode": "1000"
  }
}

updateFOPayGroup

Updates the FOPayGroup identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
payload	ModifiedFOPayGroup	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateFOPayGroup(externalCode, startDate, payload);

deleteFOPayGroup

Deletes the FOPayGroup identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFOPayGroupHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFOPayGroup(externalCode, startDate);

LocalizedData

listLocalizedDatas

Queries the LocalizedData 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	ListLocalizedDatasQueries	No	Queries to be sent with the request

Returns: ListLocalizedDatasResponse|error

Sample code:

ListLocalizedDatasResponse result = check client->listLocalizedDatas();

Sample response:

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

getLocalizedData

Retrieves a single LocalizedData entity identified by its key properties.

Parameters:

Name	Type	Required	Description
localizedDataCode	string	Yes	key: localizedDataCode
localizedDataLocale	string	Yes	key: localizedDataLocale
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetLocalizedDataQueries	No	Queries to be sent with the request

Returns: LocalizedData|error

Sample code:

LocalizedData result = check client->getLocalizedData(localizedDataCode, localizedDataLocale);

Sample response:

{
  "d": {}
}

FoTranslation

listFoTranslations

Queries the FoTranslation 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	ListFoTranslationsQueries	No	Queries to be sent with the request

Returns: ListFoTranslationsResponse|error

Sample code:

ListFoTranslationsResponse result = check client->listFoTranslations();

Sample response:

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

getFoTranslation

Retrieves a single FoTranslation 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	GetFoTranslationQueries	No	Queries to be sent with the request

Returns: FoTranslation|error

Sample code:

FoTranslation result = check client->getFoTranslation(externalCode);

Sample response:

{
  "externalCode": "1000"
}

PayScaleGroup

listPayScaleGroups

Queries the PayScaleGroup 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	ListPayScaleGroupsQueries	No	Queries to be sent with the request

Returns: ListPayScaleGroupsResponse|error

Sample code:

ListPayScaleGroupsResponse result = check client->listPayScaleGroups();

Sample response:

{
  "d": {
    "results": [
      {
        "code": "1000",
        "payScaleAreaNav": {},
        "payScaleTypeNav": {}
      }
    ]
  }
}

createPayScaleGroup

Creates a new PayScaleGroup entity from the supplied payload.

Parameters:

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

Returns: CreatedPayScaleGroup|error

Sample code:

CreatedPayScaleGroup result = check client->createPayScaleGroup(payload);

Sample response:

{
  "d": {
    "code": "1000",
    "payScaleAreaNav": {
      "d": {}
    },
    "payScaleTypeNav": {
      "d": {}
    }
  }
}

getPayScaleGroup

Retrieves a single PayScaleGroup entity identified by its key property.

Parameters:

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

Returns: PayScaleGroup|error

Sample code:

PayScaleGroup result = check client->getPayScaleGroup(code);

Sample response:

{
  "code": "1000",
  "payScaleAreaNav": {
    "d": {}
  },
  "payScaleTypeNav": {
    "d": {}
  }
}

updatePayScaleGroup

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

Parameters:

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

Returns: error?

Sample code:

check client->updatePayScaleGroup(code, payload);

deletePayScaleGroup

Deletes the PayScaleGroup identified by its key property.

Parameters:

Name	Type	Required	Description
code	string	Yes	key: code
headers	DeletePayScaleGroupHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePayScaleGroup(code);

PayCalendar

listPayCalendars

Queries the PayCalendar 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	ListPayCalendarsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listPayCalendars();

getPayCalendar

Retrieves a single PayCalendar entity identified by its key property.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getPayCalendar(payGroup);

deletePayCalendar

Deletes the PayCalendar identified by its key property.

Parameters:

Name	Type	Required	Description
payGroup	string	Yes	key: payGroup
headers	DeletePayCalendarHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePayCalendar(payGroup);

FOWfConfig

listFOWfConfigs

Queries the FOWfConfig 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	ListFOWfConfigsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOWfConfigs();

getFOWfConfig

Retrieves a single FOWfConfig 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	GetFOWfConfigQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

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

FOJobCode

listFOJobCodes

Queries the FOJobCode 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	ListFOJobCodesQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listFOJobCodes();

getFOJobCode

Retrieves a single FOJobCode entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getFOJobCode(externalCode, startDate);

deleteFOJobCode

Deletes the FOJobCode identified by its key properties.

Parameters:

Name	Type	Required	Description
externalCode	string	Yes	key: externalCode
startDate	string	Yes	key: startDate
headers	DeleteFOJobCodeHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteFOJobCode(externalCode, startDate);

PayScaleLevel

listPayScaleLevels

Queries the PayScaleLevel 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	ListPayScaleLevelsQueries	No	Queries to be sent with the request

Returns: json|error

Sample code:

json result = check client->listPayScaleLevels();

getPayScaleLevel

Retrieves a single PayScaleLevel entity identified by its key properties.

Parameters:

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

Returns: json|error

Sample code:

json result = check client->getPayScaleLevel(code, effectiveStartDate);

deletePayScaleLevel

Deletes the PayScaleLevel identified by its key properties.

Parameters:

Name	Type	Required	Description
code	string	Yes	key: code
effectiveStartDate	string	Yes	key: effectiveStartDate
headers	DeletePayScaleLevelHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deletePayScaleLevel(code, effectiveStartDate);

JobClassificationBGR

listJobClassificationBGRs

Queries the JobClassificationBGR 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	ListJobClassificationBGRsQueries	No	Queries to be sent with the request

Returns: ListJobClassificationBGRsResponse|error

Sample code:

ListJobClassificationBGRsResponse result = check client->listJobClassificationBGRs();

Sample response:

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

createJobClassificationBGR

Creates a new JobClassificationBGR entity from the supplied payload.

Parameters:

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

Returns: CreatedJobClassificationBGR|error

Sample code:

CreatedJobClassificationBGR result = check client->createJobClassificationBGR(payload);

Sample response:

{
  "d": {
    "d": {}
  }
}

getJobClassificationBGR

Retrieves a single JobClassificationBGR entity identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	map<string|string[]>	No	Headers to be sent with the request
queries	GetJobClassificationBGRQueries	No	Queries to be sent with the request

Returns: JobClassificationBGR|error

Sample code:

JobClassificationBGR result = check client->getJobClassificationBGR(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);

Sample response:

{
  "d": {}
}

updateJobClassificationBGR

Updates the JobClassificationBGR identified by its key properties with the supplied payload.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
payload	ModifiedJobClassificationBGR	Yes	New property values
headers	map<string|string[]>	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->updateJobClassificationBGR(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode, payload);

deleteJobClassificationBGR

Deletes the JobClassificationBGR identified by its key properties.

Parameters:

Name	Type	Required	Description
JobClassificationCountry_country	string	Yes	key: JobClassificationCountry_country
JobClassification_effectiveStartDate	string	Yes	key: JobClassification_effectiveStartDate
JobClassification_externalCode	string	Yes	key: JobClassification_externalCode
externalCode	int	Yes	key: externalCode
headers	DeleteJobClassificationBGRHeaders	No	Headers to be sent with the request

Returns: error?

Sample code:

check client->deleteJobClassificationBGR(JobClassificationCountry_country, JobClassification_effectiveStartDate, JobClassification_externalCode, externalCode);