sap-successfactors-compensation

SAP SuccessFactors Compensation

Server path: /sap-successfactors-compensation | Type: Application | PCID required: Yes

Tools

Tool	Description
sap_successfactors_compensation_get_emp_compensation	Get entity from EmpCompensation by key
sap_successfactors_compensation_get_emp_pay_comp_non_recurring	Get entity from EmpPayCompNonRecurring by key
sap_successfactors_compensation_get_emp_pay_comp_recurring	Get entity from EmpPayCompRecurring by key
sap_successfactors_compensation_list_emp_compensation	Get entities from EmpCompensation
sap_successfactors_compensation_list_emp_pay_comp_non_recurring	Get entities from EmpPayCompNonRecurring
sap_successfactors_compensation_list_emp_pay_comp_recurring	Get entities from EmpPayCompRecurring

---

sap_successfactors_compensation_get_emp_compensation

Get entity from EmpCompensation by key

Parameters:

Parameter	Type	Required	Default	Description
startDate	string	Yes	—	key: startDate
userId	string	Yes	—	key: userId
$select	string[]	No	—	Select properties to be returned, see OData Select
$expand	string[]	No	—	Expand related entities, see OData Expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "startDate": {
      "type": "string",
      "description": "key: startDate"
    },
    "userId": {
      "type": "string",
      "description": "key: userId"
    },
    "$select": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "benefitsRate",
          "bonusTarget",
          "createdBy",
          "createdDateTime",
          "createdOn",
          "customDouble5",
          "customDouble6",
          "customDouble7",
          "customString20",
          "endDate",
          "event",
          "eventReason",
          "isEligibleForBenefits",
          "isEligibleForCar",
          "isHighlyCompensatedEmployee",
          "isInsider",
          "lastModifiedBy",
          "lastModifiedDateTime",
          "lastModifiedOn",
          "payGrade",
          "payGroup",
          "payrollSystemId",
          "startDate",
          "userId"
        ]
      },
      "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "*",
          "empCompensationCalculatedNav",
          "empCompensationGroupSumCalculatedNav",
          "empPayCompRecurringNav"
        ]
      },
      "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    }
  },
  "required": [
    "PCID",
    "startDate",
    "userId"
  ]
}

---

sap_successfactors_compensation_get_emp_pay_comp_non_recurring

Get entity from EmpPayCompNonRecurring by key

Parameters:

Parameter	Type	Required	Default	Description
payComponentCode	string	Yes	—	key: payComponentCode
payDate	string	Yes	—	key: payDate
userId	string	Yes	—	key: userId
$select	string[]	No	—	Select properties to be returned, see OData Select

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "payComponentCode": {
      "type": "string",
      "description": "key: payComponentCode"
    },
    "payDate": {
      "type": "string",
      "description": "key: payDate"
    },
    "userId": {
      "type": "string",
      "description": "key: userId"
    },
    "$select": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "alternativeCostCenter",
          "createdBy",
          "createdDateTime",
          "createdOn",
          "currencyCode",
          "lastModifiedBy",
          "lastModifiedDateTime",
          "lastModifiedOn",
          "notes",
          "operation",
          "payComponentCode",
          "payDate",
          "userId",
          "value"
        ]
      },
      "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    }
  },
  "required": [
    "PCID",
    "payComponentCode",
    "payDate",
    "userId"
  ]
}

---

sap_successfactors_compensation_get_emp_pay_comp_recurring

Get entity from EmpPayCompRecurring by key

Parameters:

Parameter	Type	Required	Default	Description
payComponent	string	Yes	—	key: payComponent
seqNumber	integer	Yes	—	key: seqNumber
startDate	string	Yes	—	key: startDate
userId	string	Yes	—	key: userId
$select	string[]	No	—	Select properties to be returned, see OData Select
$expand	string[]	No	—	Expand related entities, see OData Expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "payComponent": {
      "type": "string",
      "description": "key: payComponent"
    },
    "seqNumber": {
      "type": "integer",
      "description": "key: seqNumber"
    },
    "startDate": {
      "type": "string",
      "description": "key: startDate"
    },
    "userId": {
      "type": "string",
      "description": "key: userId"
    },
    "$select": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "createdBy",
          "createdDateTime",
          "createdOn",
          "currencyCode",
          "endDate",
          "frequency",
          "lastModifiedBy",
          "lastModifiedDateTime",
          "lastModifiedOn",
          "notes",
          "operation",
          "payComponent",
          "paycompvalue",
          "seqNumber",
          "startDate",
          "userId"
        ]
      },
      "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "*",
          "compensationNav"
        ]
      },
      "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    }
  },
  "required": [
    "PCID",
    "payComponent",
    "seqNumber",
    "startDate",
    "userId"
  ]
}

---

sap_successfactors_compensation_list_emp_compensation

Get entities from EmpCompensation

Parameters:

Parameter	Type	Required	Default	Description
$top	integer	No	—	Show only the first n items, see OData Paging - Top
$skip	integer	No	—	Skip the first n items, see OData Paging - Skip
$search	string	No	—	Search items by search phrases, see OData Searching
$filter	string	No	—	Filter items by property values, see OData Filtering
$count	boolean	No	—	Include count of items, see OData Count
$orderby	string[]	No	—	Order items by property values, see OData Sorting
$select	string[]	No	—	Select properties to be returned, see OData Select
$expand	string[]	No	—	Expand related entities, see OData Expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "$top": {
      "type": "integer",
      "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$skip": {
      "type": "integer",
      "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$search": {
      "type": "string",
      "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$filter": {
      "type": "string",
      "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$count": {
      "type": "boolean",
      "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$orderby": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "benefitsRate",
          "benefitsRate desc",
          "bonusTarget",
          "bonusTarget desc",
          "createdBy",
          "createdBy desc",
          "createdDateTime",
          "createdDateTime desc",
          "createdOn",
          "createdOn desc",
          "customDouble5",
          "customDouble5 desc",
          "customDouble6",
          "customDouble6 desc",
          "customDouble7",
          "customDouble7 desc",
          "customString20",
          "customString20 desc",
          "endDate",
          "endDate desc",
          "event",
          "event desc",
          "eventReason",
          "eventReason desc",
          "isEligibleForBenefits",
          "isEligibleForBenefits desc",
          "isEligibleForCar",
          "isEligibleForCar desc",
          "isHighlyCompensatedEmployee",
          "isHighlyCompensatedEmployee desc",
          "isInsider",
          "isInsider desc",
          "lastModifiedBy",
          "lastModifiedBy desc",
          "lastModifiedDateTime",
          "lastModifiedDateTime desc",
          "lastModifiedOn",
          "lastModifiedOn desc",
          "payGrade",
          "payGrade desc",
          "payGroup",
          "payGroup desc",
          "payrollSystemId",
          "payrollSystemId desc",
          "startDate",
          "startDate desc",
          "userId",
          "userId desc"
        ]
      },
      "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$select": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "benefitsRate",
          "bonusTarget",
          "createdBy",
          "createdDateTime",
          "createdOn",
          "customDouble5",
          "customDouble6",
          "customDouble7",
          "customString20",
          "endDate",
          "event",
          "eventReason",
          "isEligibleForBenefits",
          "isEligibleForCar",
          "isHighlyCompensatedEmployee",
          "isInsider",
          "lastModifiedBy",
          "lastModifiedDateTime",
          "lastModifiedOn",
          "payGrade",
          "payGroup",
          "payrollSystemId",
          "startDate",
          "userId"
        ]
      },
      "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "*",
          "empCompensationCalculatedNav",
          "empCompensationGroupSumCalculatedNav",
          "empPayCompRecurringNav"
        ]
      },
      "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    }
  },
  "required": [
    "PCID"
  ]
}

---

sap_successfactors_compensation_list_emp_pay_comp_non_recurring

Get entities from EmpPayCompNonRecurring

Parameters:

Parameter	Type	Required	Default	Description
$top	integer	No	—	Show only the first n items, see OData Paging - Top
$skip	integer	No	—	Skip the first n items, see OData Paging - Skip
$search	string	No	—	Search items by search phrases, see OData Searching
$filter	string	No	—	Filter items by property values, see OData Filtering
$count	boolean	No	—	Include count of items, see OData Count
$orderby	string[]	No	—	Order items by property values, see OData Sorting
$select	string[]	No	—	Select properties to be returned, see OData Select

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "$top": {
      "type": "integer",
      "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$skip": {
      "type": "integer",
      "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$search": {
      "type": "string",
      "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$filter": {
      "type": "string",
      "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$count": {
      "type": "boolean",
      "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$orderby": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "alternativeCostCenter",
          "alternativeCostCenter desc",
          "createdBy",
          "createdBy desc",
          "createdDateTime",
          "createdDateTime desc",
          "createdOn",
          "createdOn desc",
          "currencyCode",
          "currencyCode desc",
          "lastModifiedBy",
          "lastModifiedBy desc",
          "lastModifiedDateTime",
          "lastModifiedDateTime desc",
          "lastModifiedOn",
          "lastModifiedOn desc",
          "notes",
          "notes desc",
          "operation",
          "operation desc",
          "payComponentCode",
          "payComponentCode desc",
          "payDate",
          "payDate desc",
          "userId",
          "userId desc",
          "value",
          "value desc"
        ]
      },
      "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$select": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "alternativeCostCenter",
          "createdBy",
          "createdDateTime",
          "createdOn",
          "currencyCode",
          "lastModifiedBy",
          "lastModifiedDateTime",
          "lastModifiedOn",
          "notes",
          "operation",
          "payComponentCode",
          "payDate",
          "userId",
          "value"
        ]
      },
      "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    }
  },
  "required": [
    "PCID"
  ]
}

---

sap_successfactors_compensation_list_emp_pay_comp_recurring

Get entities from EmpPayCompRecurring

Parameters:

Parameter	Type	Required	Default	Description
$top	integer	No	—	Show only the first n items, see OData Paging - Top
$skip	integer	No	—	Skip the first n items, see OData Paging - Skip
$search	string	No	—	Search items by search phrases, see OData Searching
$filter	string	No	—	Filter items by property values, see OData Filtering
$count	boolean	No	—	Include count of items, see OData Count
$orderby	string[]	No	—	Order items by property values, see OData Sorting
$select	string[]	No	—	Select properties to be returned, see OData Select
$expand	string[]	No	—	Expand related entities, see OData Expand

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "$top": {
      "type": "integer",
      "description": "Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$skip": {
      "type": "integer",
      "description": "Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$search": {
      "type": "string",
      "description": "Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$filter": {
      "type": "string",
      "description": "Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$count": {
      "type": "boolean",
      "description": "Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$orderby": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "createdBy",
          "createdBy desc",
          "createdDateTime",
          "createdDateTime desc",
          "createdOn",
          "createdOn desc",
          "currencyCode",
          "currencyCode desc",
          "endDate",
          "endDate desc",
          "frequency",
          "frequency desc",
          "lastModifiedBy",
          "lastModifiedBy desc",
          "lastModifiedDateTime",
          "lastModifiedDateTime desc",
          "lastModifiedOn",
          "lastModifiedOn desc",
          "notes",
          "notes desc",
          "operation",
          "operation desc",
          "payComponent",
          "payComponent desc",
          "paycompvalue",
          "paycompvalue desc",
          "seqNumber",
          "seqNumber desc",
          "startDate",
          "startDate desc",
          "userId",
          "userId desc"
        ]
      },
      "description": "Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$select": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "createdBy",
          "createdDateTime",
          "createdOn",
          "currencyCode",
          "endDate",
          "frequency",
          "lastModifiedBy",
          "lastModifiedDateTime",
          "lastModifiedOn",
          "notes",
          "operation",
          "payComponent",
          "paycompvalue",
          "seqNumber",
          "startDate",
          "userId"
        ]
      },
      "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    },
    "$expand": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "*",
          "compensationNav"
        ]
      },
      "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
    }
  },
  "required": [
    "PCID"
  ]
}