Actions

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

Available clients:

Client	Purpose
Client	Manages ecincometaxdeclaration objects: DeclarationType, FiscalYearVariant, FiscalYearToCountryMap, ItDeclarationTimeBound, ItDeclInvestmentType, ItDeclaration, over the SAP SuccessFactors OData v2 API.

---

Client

You can use these APIs to record income tax declaration and submit tax declarations actuals. You can also use these APIs to categorize or group investment types, and configure the window period that controls the creation of actuals and proposals.

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

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

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

Operations

DeclarationType

listDeclarationTypes

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

Returns: ListDeclarationTypesResponse|error

Sample code:

ListDeclarationTypesResponse result = check client->listDeclarationTypes();

Sample response:

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

getDeclarationType

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

Returns: DeclarationType|error

Sample code:

DeclarationType result = check client->getDeclarationType(externalCode);

Sample response:

{
  "externalCode": "1000"
}

FiscalYearVariant

listFiscalYearVariants

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

Returns: ListFiscalYearVariantsResponse|error

Sample code:

ListFiscalYearVariantsResponse result = check client->listFiscalYearVariants();

Sample response:

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

getFiscalYearVariant

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

Returns: FiscalYearVariant|error

Sample code:

FiscalYearVariant result = check client->getFiscalYearVariant(externalCode);

Sample response:

{
  "externalCode": "1000"
}

FiscalYearToCountryMap

listFiscalYearToCountryMaps

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

Returns: ListFiscalYearToCountryMapsResponse|error

Sample code:

ListFiscalYearToCountryMapsResponse result = check client->listFiscalYearToCountryMaps();

Sample response:

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

getFiscalYearToCountryMap

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

Returns: FiscalYearToCountryMap|error

Sample code:

FiscalYearToCountryMap result = check client->getFiscalYearToCountryMap(externalCode);

Sample response:

{
  "d": {}
}

ItDeclarationTimeBound

listItDeclarationTimeBounds

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

Returns: ListItDeclarationTimeBoundsResponse|error

Sample code:

ListItDeclarationTimeBoundsResponse result = check client->listItDeclarationTimeBounds();

Sample response:

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

getItDeclarationTimeBound

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

Returns: ItDeclarationTimeBound|error

Sample code:

ItDeclarationTimeBound result = check client->getItDeclarationTimeBound(externalCode);

Sample response:

{
  "externalCode": "1000"
}

ItDeclInvestmentType

listItDeclInvestmentTypes

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

Returns: ListItDeclInvestmentTypesResponse|error

Sample code:

ListItDeclInvestmentTypesResponse result = check client->listItDeclInvestmentTypes();

Sample response:

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

getItDeclInvestmentType

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

Returns: ItDeclInvestmentType|error

Sample code:

ItDeclInvestmentType result = check client->getItDeclInvestmentType(effectiveStartDate, externalCode);

Sample response:

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

ItDeclaration

listItDeclarations

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

Returns: ListItDeclarationsResponse|error

Sample code:

ListItDeclarationsResponse result = check client->listItDeclarations();

Sample response:

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

getItDeclaration

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

Returns: ItDeclaration|error

Sample code:

ItDeclaration result = check client->getItDeclaration(effectiveStartDate, externalCode);

Sample response:

{
  "effectiveStartDate": "2026-01-01",
  "externalCode": "1000",
  "itDeclInvestmentTypeNav": {
    "effectiveStartDate": "2026-01-01",
    "externalCode": "1000",
    "declarationTypeNav": {
      "externalCode": "1000"
    }
  },
  "typeNav": {
    "externalCode": "1000"
  }
}