Actions

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

Available clients:

Client	Purpose
Client	Manages ecpayrolltimesheets objects: EmployeeTimeSheet, ExternalAllowance, TimeCollector, ExternalTimeRecord, ExternalTimeData, DataReplicationProxy, EmployeeTimeSheetEntry, EmployeeTimeValuationResult…, over the SAP SuccessFactors OData v2 API.

---

Client

API to record employee attendances, overtime, on-call times, and allowances

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

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

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

Operations

EmployeeTimeSheet

listEmployeeTimeSheets

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

Returns: ListEmployeeTimeSheetsResponse|error

Sample code:

ListEmployeeTimeSheetsResponse result = check client->listEmployeeTimeSheets();

Sample response:

{
  "d": {
    "results": [
      {
        "externalCode": "1000",
        "allowance": {},
        "employeeTimeSheetEntry": {},
        "employeeTimeValuationResult": {},
        "replacedByNav": {},
        "replacesNav": {}
      }
    ]
  }
}

getEmployeeTimeSheet

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

Returns: EmployeeTimeSheet_1|error

Sample code:

EmployeeTimeSheet_1 result = check client->getEmployeeTimeSheet(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "allowance": {
      "results": []
    },
    "employeeTimeSheetEntry": {
      "results": []
    },
    "employeeTimeValuationResult": {
      "results": []
    },
    "replacedByNav": {},
    "replacesNav": {}
  }
}

ExternalAllowance

listExternalAllowances

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

Returns: ListExternalAllowancesResponse|error

Sample code:

ListExternalAllowancesResponse result = check client->listExternalAllowances();

Sample response:

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

createExternalAllowance

Creates a new ExternalAllowance entity from the supplied payload.

Parameters:

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

Returns: CreatedExternalAllowance|error

Sample code:

CreatedExternalAllowance result = check client->createExternalAllowance(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getExternalAllowance

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

Returns: ExternalAllowance_1|error

Sample code:

ExternalAllowance_1 result = check client->getExternalAllowance(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateExternalAllowance

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

Parameters:

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

Returns: error?

Sample code:

check client->updateExternalAllowance(externalCode, payload);

deleteExternalAllowance

Deletes the ExternalAllowance identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteExternalAllowance(externalCode);

TimeCollector

listTimeCollectors

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

Returns: ListTimeCollectorsResponse|error

Sample code:

ListTimeCollectorsResponse result = check client->listTimeCollectors();

Sample response:

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

getTimeCollector

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

Returns: TimeCollector_1|error

Sample code:

TimeCollector_1 result = check client->getTimeCollector(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

ExternalTimeRecord

listExternalTimeRecords

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

Returns: ListExternalTimeRecordsResponse|error

Sample code:

ListExternalTimeRecordsResponse result = check client->listExternalTimeRecords();

Sample response:

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

createExternalTimeRecord

Creates a new ExternalTimeRecord entity from the supplied payload.

Parameters:

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

Returns: CreatedExternalTimeRecord|error

Sample code:

CreatedExternalTimeRecord result = check client->createExternalTimeRecord(payload);

Sample response:

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

getExternalTimeRecord

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

Returns: ExternalTimeRecord_1|error

Sample code:

ExternalTimeRecord_1 result = check client->getExternalTimeRecord(externalCode);

Sample response:

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

updateExternalTimeRecord

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

Parameters:

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

Returns: error?

Sample code:

check client->updateExternalTimeRecord(externalCode, payload);

deleteExternalTimeRecord

Deletes the ExternalTimeRecord identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteExternalTimeRecord(externalCode);

ExternalTimeData

listExternalTimeData

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

Returns: ListExternalTimeDataResponse|error

Sample code:

ListExternalTimeDataResponse result = check client->listExternalTimeData();

Sample response:

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

createExternalTimeData

Creates a new ExternalTimeData entity from the supplied payload.

Parameters:

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

Returns: CreatedExternalTimeData|error

Sample code:

CreatedExternalTimeData result = check client->createExternalTimeData(payload);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

getExternalTimeData

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

Returns: ExternalTimeData_1|error

Sample code:

ExternalTimeData_1 result = check client->getExternalTimeData(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

updateExternalTimeData

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

Parameters:

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

Returns: error?

Sample code:

check client->updateExternalTimeData(externalCode, payload);

deleteExternalTimeData

Deletes the ExternalTimeData identified by its key property.

Parameters:

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

Returns: error?

Sample code:

check client->deleteExternalTimeData(externalCode);

DataReplicationProxy

listDataReplicationProxies

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

Returns: ListDataReplicationProxiesResponse|error

Sample code:

ListDataReplicationProxiesResponse result = check client->listDataReplicationProxies();

Sample response:

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

getDataReplicationProxy

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

Returns: DataReplicationProxy_1|error

Sample code:

DataReplicationProxy_1 result = check client->getDataReplicationProxy(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000",
    "employeeTimeValuationResultNav": {
      "EmployeeTimeSheet_externalCode": "1000",
      "externalCode": "1000"
    }
  }
}

EmployeeTimeSheetEntry

listEmployeeTimeSheetEntries

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

Returns: ListEmployeeTimeSheetEntriesResponse|error

Sample code:

ListEmployeeTimeSheetEntriesResponse result = check client->listEmployeeTimeSheetEntries();

Sample response:

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

getEmployeeTimeSheetEntry

Retrieves a single EmployeeTimeSheetEntry entity identified by its key properties.

Parameters:

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

Returns: EmployeeTimeSheetEntry_1|error

Sample code:

EmployeeTimeSheetEntry_1 result = check client->getEmployeeTimeSheetEntry(EmployeeTimeSheet_externalCode, externalCode);

Sample response:

{
  "d": {
    "EmployeeTimeSheet_externalCode": "1000",
    "externalCode": "1000"
  }
}

EmployeeTimeValuationResult

listEmployeeTimeValuationResults

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

Returns: ListEmployeeTimeValuationResultsResponse|error

Sample code:

ListEmployeeTimeValuationResultsResponse result = check client->listEmployeeTimeValuationResults();

Sample response:

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

getEmployeeTimeValuationResult

Retrieves a single EmployeeTimeValuationResult entity identified by its key properties.

Parameters:

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

Returns: EmployeeTimeValuationResult_1|error

Sample code:

EmployeeTimeValuationResult_1 result = check client->getEmployeeTimeValuationResult(EmployeeTimeSheet_externalCode, externalCode);

Sample response:

{
  "d": {
    "EmployeeTimeSheet_externalCode": "1000",
    "externalCode": "1000"
  }
}

AllowanceRecording

listAllowanceRecordings

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

Returns: ListAllowanceRecordingsResponse|error

Sample code:

ListAllowanceRecordingsResponse result = check client->listAllowanceRecordings();

Sample response:

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

getAllowanceRecording

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

Returns: AllowanceRecording_1|error

Sample code:

AllowanceRecording_1 result = check client->getAllowanceRecording(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

AvailableAllowanceType

listAvailableAllowanceTypes

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

Returns: ListAvailableAllowanceTypesResponse|error

Sample code:

ListAvailableAllowanceTypesResponse result = check client->listAvailableAllowanceTypes();

Sample response:

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

getAvailableAllowanceType

Retrieves a single AvailableAllowanceType entity identified by its key properties.

Parameters:

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

Returns: AvailableAllowanceType|error

Sample code:

AvailableAllowanceType result = check client->getAvailableAllowanceType(TimeTypeProfile_externalCode, TimeTypeProfile_mdfSystemEffectiveStartDate, externalCode);

Sample response:

{
  "d": {
    "TimeTypeProfile_externalCode": "1000",
    "TimeTypeProfile_mdfSystemEffectiveStartDate": "2026-01-01",
    "externalCode": "1000"
  }
}

ExternalTimeSegment

listExternalTimeSegments

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

Returns: ListExternalTimeSegmentsResponse|error

Sample code:

ListExternalTimeSegmentsResponse result = check client->listExternalTimeSegments();

Sample response:

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

createExternalTimeSegment

Creates a new ExternalTimeSegment entity from the supplied payload.

Parameters:

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

Returns: CreatedExternalTimeSegment|error

Sample code:

CreatedExternalTimeSegment result = check client->createExternalTimeSegment(payload);

Sample response:

{
  "d": {
    "ExternalTimeRecord_externalCode": "1000",
    "externalCode": "1000"
  }
}

getExternalTimeSegment

Retrieves a single ExternalTimeSegment entity identified by its key properties.

Parameters:

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

Returns: ExternalTimeSegment_1|error

Sample code:

ExternalTimeSegment_1 result = check client->getExternalTimeSegment(ExternalTimeRecord_externalCode, externalCode);

Sample response:

{
  "d": {
    "ExternalTimeRecord_externalCode": "1000",
    "externalCode": "1000"
  }
}

updateExternalTimeSegment

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

Parameters:

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

Returns: error?

Sample code:

check client->updateExternalTimeSegment(ExternalTimeRecord_externalCode, externalCode, payload);

deleteExternalTimeSegment

Deletes the ExternalTimeSegment identified by its key properties.

Parameters:

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

Returns: error?

Sample code:

check client->deleteExternalTimeSegment(ExternalTimeRecord_externalCode, externalCode);

TimeRecording

listTimeRecordings

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

Returns: ListTimeRecordingsResponse|error

Sample code:

ListTimeRecordingsResponse result = check client->listTimeRecordings();

Sample response:

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

getTimeRecording

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

Returns: TimeRecording_1|error

Sample code:

TimeRecording_1 result = check client->getTimeRecording(externalCode);

Sample response:

{
  "d": {
    "externalCode": "1000"
  }
}

Allowance

listAllowances

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

Returns: ListAllowancesResponse|error

Sample code:

ListAllowancesResponse result = check client->listAllowances();

Sample response:

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

getAllowance

Retrieves a single Allowance entity identified by its key properties.

Parameters:

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

Returns: Allowance_1|error

Sample code:

Allowance_1 result = check client->getAllowance(EmployeeTimeSheet_externalCode, externalCode);

Sample response:

{
  "d": {
    "EmployeeTimeSheet_externalCode": "1000",
    "externalCode": "1000"
  }
}