> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# sap-successfactors-onboarding

> SAP SuccessFactors Onboarding

**Server path:** `/sap-successfactors-onboarding` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                                      | Description                                                                                                                                                                                                                                                                                                                                                                     |
| ----------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [`sap_successfactors_onboarding_create_create_onboardee`](#sap_successfactors_onboarding_create_create_onboardee)                         | This function import enables you to create an onboarding external user record in the system with information collected from your external Applicant Tracking System (ATS). It also enables you to perform preliminary checks to understand if the onboardee is a new hire or a rehire and take actions as necessary.                                                            |
| [`sap_successfactors_onboarding_create_initiate_onboarding_for_user`](#sap_successfactors_onboarding_create_initiate_onboarding_for_user) | After an external user record is created and Employee Central data is added to the record, you can use this funtion import to initiate onboarding process from an external Application Tracking System. It modifies the ONB2Process and ONB2ProcessTrigger MDF objects. All Employee Central entities (PerPerson, EmpJob, EmpEmployment) should be upserted prior to this call. |
| [`sap_successfactors_onboarding_get_assigned_compliance_form`](#sap_successfactors_onboarding_get_assigned_compliance_form)               | Get entity from AssignedComplianceForm by key                                                                                                                                                                                                                                                                                                                                   |
| [`sap_successfactors_onboarding_get_compliance_document_flow`](#sap_successfactors_onboarding_get_compliance_document_flow)               | Get entity from ComplianceDocumentFlow by key                                                                                                                                                                                                                                                                                                                                   |
| [`sap_successfactors_onboarding_get_compliance_form_data`](#sap_successfactors_onboarding_get_compliance_form_data)                       | Get entity from ComplianceFormData by key                                                                                                                                                                                                                                                                                                                                       |
| [`sap_successfactors_onboarding_get_compliance_form_signature`](#sap_successfactors_onboarding_get_compliance_form_signature)             | Get entity from ComplianceFormSignature by key                                                                                                                                                                                                                                                                                                                                  |
| [`sap_successfactors_onboarding_get_compliance_process`](#sap_successfactors_onboarding_get_compliance_process)                           | Get entity from ComplianceProcess by key                                                                                                                                                                                                                                                                                                                                        |
| [`sap_successfactors_onboarding_get_compliance_process_task`](#sap_successfactors_onboarding_get_compliance_process_task)                 | Get entity from ComplianceProcessTask by key                                                                                                                                                                                                                                                                                                                                    |
| [`sap_successfactors_onboarding_list_assigned_compliance_form`](#sap_successfactors_onboarding_list_assigned_compliance_form)             | This entity contains the compliance forms assigned to new hires.                                                                                                                                                                                                                                                                                                                |
| [`sap_successfactors_onboarding_list_compliance_document_flow`](#sap_successfactors_onboarding_list_compliance_document_flow)             | This entity stores the Compliance document flow assigned to the new hire.                                                                                                                                                                                                                                                                                                       |
| [`sap_successfactors_onboarding_list_compliance_form_data`](#sap_successfactors_onboarding_list_compliance_form_data)                     | This entity stores the compliance form data for the new hire.                                                                                                                                                                                                                                                                                                                   |
| [`sap_successfactors_onboarding_list_compliance_form_signature`](#sap_successfactors_onboarding_list_compliance_form_signature)           | This entity stores the Compliance form signature assigned to the new hire.                                                                                                                                                                                                                                                                                                      |
| [`sap_successfactors_onboarding_list_compliance_process`](#sap_successfactors_onboarding_list_compliance_process)                         | This entity represents the compliance workflow assigned to a new hire.                                                                                                                                                                                                                                                                                                          |
| [`sap_successfactors_onboarding_list_compliance_process_task`](#sap_successfactors_onboarding_list_compliance_process_task)               | This entity allows you to store the start time, end time, and the status of a particular compliance task.                                                                                                                                                                                                                                                                       |

***

## sap\_successfactors\_onboarding\_create\_create\_onboardee

This function import enables you to create an onboarding external user record in the system with information collected from your external Applicant Tracking System (ATS). It also enables you to perform preliminary checks to understand if the onboardee is a new hire or a rehire and take actions as necessary.

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_create\_initiate\_onboarding\_for\_user

After an external user record is created and Employee Central data is added to the record, you can use this funtion import to initiate onboarding process from an external Application Tracking System. It modifies the ONB2Process and ONB2ProcessTrigger MDF objects. All Employee Central entities (PerPerson, EmpJob, EmpEmployment) should be upserted prior to this call.

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_get\_assigned\_compliance\_form

Get entity from AssignedComplianceForm by key

**Parameters:**

| Parameter | Type      | Required | Default | Description                                                                                                                  |
| --------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `id`      | string    | Yes      | —       | key: id                                                                                                                      |
| `$select` | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$expand` | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "key: id"
      },
      "$select": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "bpeUserTaskId",
            "complianceFormName",
            "createdBy",
            "createdDateTime",
            "dueDate",
            "form",
            "id",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "order",
            "participantType",
            "preRequisiteFormNames",
            "process",
            "rank",
            "responsibleUser",
            "status",
            "subjectUser"
          ]
        },
        "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": [
            "*",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_get\_compliance\_document\_flow

Get entity from ComplianceDocumentFlow by key

**Parameters:**

| Parameter          | Type      | Required | Default | Description                                                                                                                  |
| ------------------ | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `documentFlowCode` | string    | Yes      | —       | key: documentFlowCode                                                                                                        |
| `$select`          | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$expand`          | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "documentFlowCode": {
        "type": "string",
        "description": "key: documentFlowCode"
      },
      "$select": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "createdBy",
            "createdDateTime",
            "declinedBy",
            "declinedDocuments",
            "declinedReason",
            "docFlowBpeUserTaskId",
            "documentFlowCode",
            "documentFlowStatus",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "process",
            "subjectUser"
          ]
        },
        "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": [
            "*",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID",
      "documentFlowCode"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_get\_compliance\_form\_data

Get entity from ComplianceFormData by key

**Parameters:**

| Parameter      | Type      | Required | Default | Description                                                                                                                  |
| -------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `externalCode` | string    | Yes      | —       | key: externalCode                                                                                                            |
| `$select`      | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$expand`      | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "externalCode": {
        "type": "string",
        "description": "key: externalCode"
      },
      "$select": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "createdBy",
            "createdDateTime",
            "documentAttachmentId",
            "documentFlow",
            "envelopeId",
            "externalCode",
            "form",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "pdfId",
            "pdfLocaleMetadata",
            "process",
            "sensitiveDataIncluded",
            "subjectUser"
          ]
        },
        "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": [
            "*",
            "documentFlowNav",
            "formSignatures",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID",
      "externalCode"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_get\_compliance\_form\_signature

Get entity from ComplianceFormSignature by key

**Parameters:**

| Parameter                         | Type      | Required | Default | Description                                                                                                                  |
| --------------------------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `ComplianceFormData_externalCode` | string    | Yes      | —       | key: ComplianceFormData\_externalCode                                                                                        |
| `externalCode`                    | string    | Yes      | —       | key: externalCode                                                                                                            |
| `$select`                         | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "ComplianceFormData_externalCode": {
        "type": "string",
        "description": "key: ComplianceFormData_externalCode"
      },
      "externalCode": {
        "type": "string",
        "description": "key: externalCode"
      },
      "$select": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "ComplianceFormData_externalCode",
            "createdBy",
            "createdDateTime",
            "externalCode",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "signatureStatus",
            "signatureUser",
            "signatureUserFullName",
            "signatureUserRole"
          ]
        },
        "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID",
      "ComplianceFormData_externalCode",
      "externalCode"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_get\_compliance\_process

Get entity from ComplianceProcess by key

**Parameters:**

| Parameter   | Type      | Required | Default | Description                                                                                                                  |
| ----------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `processId` | string    | Yes      | —       | key: processId                                                                                                               |
| `$select`   | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$expand`   | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "processId": {
        "type": "string",
        "description": "key: processId"
      },
      "$select": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "complianceMasterId",
            "correctDataTriggered",
            "createdBy",
            "createdDateTime",
            "eVerifyData",
            "i9UserData",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "onboardingProcess",
            "processId",
            "processInitiatorId",
            "processInitiatorType",
            "processStatus",
            "processType",
            "startDate",
            "user"
          ]
        },
        "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": [
            "*",
            "onboardingProcessNav",
            "processTasks",
            "toDocumentFlow",
            "toFormData"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID",
      "processId"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_get\_compliance\_process\_task

Get entity from ComplianceProcessTask by key

**Parameters:**

| Parameter | Type      | Required | Default | Description                                                                                                                  |
| --------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `taskId`  | string    | Yes      | —       | key: taskId                                                                                                                  |
| `$select` | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$expand` | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "taskId": {
        "type": "string",
        "description": "key: taskId"
      },
      "$select": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "category",
            "completedBy",
            "createdBy",
            "createdDateTime",
            "dueDate",
            "endDate",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "process",
            "startDate",
            "status",
            "subjectUser",
            "taskId",
            "type"
          ]
        },
        "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": [
            "*",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID",
      "taskId"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_list\_assigned\_compliance\_form

This entity contains the compliance forms assigned to new hires.

**Parameters:**

| Parameter  | Type      | Required | Default | Description                                                                                                                    |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `$top`     | integer   | No       | —       | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$skip`    | integer   | No       | —       | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)      |
| `$search`  | string    | No       | —       | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$filter`  | string    | No       | —       | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$count`   | boolean   | No       | —       | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)              |
| `$orderby` | string\[] | No       | —       | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)    |
| `$select`  | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)   |
| `$expand`  | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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": [
            "bpeUserTaskId",
            "bpeUserTaskId desc",
            "complianceFormName",
            "complianceFormName desc",
            "createdBy",
            "createdBy desc",
            "createdDateTime",
            "createdDateTime desc",
            "dueDate",
            "dueDate desc",
            "form",
            "form desc",
            "id",
            "id desc",
            "lastModifiedBy",
            "lastModifiedBy desc",
            "lastModifiedDateTime",
            "lastModifiedDateTime desc",
            "mdfSystemRecordStatus",
            "mdfSystemRecordStatus desc",
            "order",
            "order desc",
            "participantType",
            "participantType desc",
            "preRequisiteFormNames",
            "preRequisiteFormNames desc",
            "process",
            "process desc",
            "rank",
            "rank desc",
            "responsibleUser",
            "responsibleUser desc",
            "status",
            "status desc",
            "subjectUser",
            "subjectUser 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": [
            "bpeUserTaskId",
            "complianceFormName",
            "createdBy",
            "createdDateTime",
            "dueDate",
            "form",
            "id",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "order",
            "participantType",
            "preRequisiteFormNames",
            "process",
            "rank",
            "responsibleUser",
            "status",
            "subjectUser"
          ]
        },
        "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": [
            "*",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_list\_compliance\_document\_flow

This entity stores the Compliance document flow assigned to the new hire.

**Parameters:**

| Parameter  | Type      | Required | Default | Description                                                                                                                    |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `$top`     | integer   | No       | —       | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$skip`    | integer   | No       | —       | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)      |
| `$search`  | string    | No       | —       | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$filter`  | string    | No       | —       | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$count`   | boolean   | No       | —       | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)              |
| `$orderby` | string\[] | No       | —       | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)    |
| `$select`  | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)   |
| `$expand`  | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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",
            "declinedBy",
            "declinedBy desc",
            "declinedDocuments",
            "declinedDocuments desc",
            "declinedReason",
            "declinedReason desc",
            "docFlowBpeUserTaskId",
            "docFlowBpeUserTaskId desc",
            "documentFlowCode",
            "documentFlowCode desc",
            "documentFlowStatus",
            "documentFlowStatus desc",
            "lastModifiedBy",
            "lastModifiedBy desc",
            "lastModifiedDateTime",
            "lastModifiedDateTime desc",
            "mdfSystemRecordStatus",
            "mdfSystemRecordStatus desc",
            "process",
            "process desc",
            "subjectUser",
            "subjectUser 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",
            "declinedBy",
            "declinedDocuments",
            "declinedReason",
            "docFlowBpeUserTaskId",
            "documentFlowCode",
            "documentFlowStatus",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "process",
            "subjectUser"
          ]
        },
        "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": [
            "*",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_list\_compliance\_form\_data

This entity stores the compliance form data for the new hire.

**Parameters:**

| Parameter  | Type      | Required | Default | Description                                                                                                                    |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `$top`     | integer   | No       | —       | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$skip`    | integer   | No       | —       | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)      |
| `$search`  | string    | No       | —       | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$filter`  | string    | No       | —       | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$count`   | boolean   | No       | —       | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)              |
| `$orderby` | string\[] | No       | —       | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)    |
| `$select`  | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)   |
| `$expand`  | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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",
            "documentAttachmentId",
            "documentAttachmentId desc",
            "documentFlow",
            "documentFlow desc",
            "envelopeId",
            "envelopeId desc",
            "externalCode",
            "externalCode desc",
            "form",
            "form desc",
            "lastModifiedBy",
            "lastModifiedBy desc",
            "lastModifiedDateTime",
            "lastModifiedDateTime desc",
            "mdfSystemRecordStatus",
            "mdfSystemRecordStatus desc",
            "pdfId",
            "pdfId desc",
            "pdfLocaleMetadata",
            "pdfLocaleMetadata desc",
            "process",
            "process desc",
            "sensitiveDataIncluded",
            "sensitiveDataIncluded desc",
            "subjectUser",
            "subjectUser 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",
            "documentAttachmentId",
            "documentFlow",
            "envelopeId",
            "externalCode",
            "form",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "pdfId",
            "pdfLocaleMetadata",
            "process",
            "sensitiveDataIncluded",
            "subjectUser"
          ]
        },
        "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": [
            "*",
            "documentFlowNav",
            "formSignatures",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_list\_compliance\_form\_signature

This entity stores the Compliance form signature assigned to the new hire.

**Parameters:**

| Parameter  | Type      | Required | Default | Description                                                                                                                    |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `$top`     | integer   | No       | —       | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$skip`    | integer   | No       | —       | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)      |
| `$search`  | string    | No       | —       | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$filter`  | string    | No       | —       | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$count`   | boolean   | No       | —       | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)              |
| `$orderby` | string\[] | No       | —       | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)    |
| `$select`  | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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": [
            "ComplianceFormData_externalCode",
            "ComplianceFormData_externalCode desc",
            "createdBy",
            "createdBy desc",
            "createdDateTime",
            "createdDateTime desc",
            "externalCode",
            "externalCode desc",
            "lastModifiedBy",
            "lastModifiedBy desc",
            "lastModifiedDateTime",
            "lastModifiedDateTime desc",
            "mdfSystemRecordStatus",
            "mdfSystemRecordStatus desc",
            "signatureStatus",
            "signatureStatus desc",
            "signatureUser",
            "signatureUser desc",
            "signatureUserFullName",
            "signatureUserFullName desc",
            "signatureUserRole",
            "signatureUserRole 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": [
            "ComplianceFormData_externalCode",
            "createdBy",
            "createdDateTime",
            "externalCode",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "signatureStatus",
            "signatureUser",
            "signatureUserFullName",
            "signatureUserRole"
          ]
        },
        "description": "Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_list\_compliance\_process

This entity represents the compliance workflow assigned to a new hire.

**Parameters:**

| Parameter  | Type      | Required | Default | Description                                                                                                                    |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `$top`     | integer   | No       | —       | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$skip`    | integer   | No       | —       | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)      |
| `$search`  | string    | No       | —       | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$filter`  | string    | No       | —       | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$count`   | boolean   | No       | —       | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)              |
| `$orderby` | string\[] | No       | —       | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)    |
| `$select`  | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)   |
| `$expand`  | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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": [
            "complianceMasterId",
            "complianceMasterId desc",
            "correctDataTriggered",
            "correctDataTriggered desc",
            "createdBy",
            "createdBy desc",
            "createdDateTime",
            "createdDateTime desc",
            "eVerifyData",
            "eVerifyData desc",
            "i9UserData",
            "i9UserData desc",
            "lastModifiedBy",
            "lastModifiedBy desc",
            "lastModifiedDateTime",
            "lastModifiedDateTime desc",
            "mdfSystemRecordStatus",
            "mdfSystemRecordStatus desc",
            "onboardingProcess",
            "onboardingProcess desc",
            "processId",
            "processId desc",
            "processInitiatorId",
            "processInitiatorId desc",
            "processInitiatorType",
            "processInitiatorType desc",
            "processStatus",
            "processStatus desc",
            "processType",
            "processType desc",
            "startDate",
            "startDate desc",
            "user",
            "user 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": [
            "complianceMasterId",
            "correctDataTriggered",
            "createdBy",
            "createdDateTime",
            "eVerifyData",
            "i9UserData",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "onboardingProcess",
            "processId",
            "processInitiatorId",
            "processInitiatorType",
            "processStatus",
            "processType",
            "startDate",
            "user"
          ]
        },
        "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": [
            "*",
            "onboardingProcessNav",
            "processTasks",
            "toDocumentFlow",
            "toFormData"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## sap\_successfactors\_onboarding\_list\_compliance\_process\_task

This entity allows you to store the start time, end time, and the status of a particular compliance task.

**Parameters:**

| Parameter  | Type      | Required | Default | Description                                                                                                                    |
| ---------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `$top`     | integer   | No       | —       | Show only the first n items, see [OData Paging - Top](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$skip`    | integer   | No       | —       | Skip the first n items, see [OData Paging - Skip](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)      |
| `$search`  | string    | No       | —       | Search items by search phrases, see [OData Searching](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)  |
| `$filter`  | string    | No       | —       | Filter items by property values, see [OData Filtering](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) |
| `$count`   | boolean   | No       | —       | Include count of items, see [OData Count](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)              |
| `$orderby` | string\[] | No       | —       | Order items by property values, see [OData Sorting](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)    |
| `$select`  | string\[] | No       | —       | Select properties to be returned, see [OData Select](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)   |
| `$expand`  | string\[] | No       | —       | Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "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": [
            "category",
            "category desc",
            "completedBy",
            "completedBy desc",
            "createdBy",
            "createdBy desc",
            "createdDateTime",
            "createdDateTime desc",
            "dueDate",
            "dueDate desc",
            "endDate",
            "endDate desc",
            "lastModifiedBy",
            "lastModifiedBy desc",
            "lastModifiedDateTime",
            "lastModifiedDateTime desc",
            "mdfSystemRecordStatus",
            "mdfSystemRecordStatus desc",
            "process",
            "process desc",
            "startDate",
            "startDate desc",
            "status",
            "status desc",
            "subjectUser",
            "subjectUser desc",
            "taskId",
            "taskId desc",
            "type",
            "type 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": [
            "category",
            "completedBy",
            "createdBy",
            "createdDateTime",
            "dueDate",
            "endDate",
            "lastModifiedBy",
            "lastModifiedDateTime",
            "mdfSystemRecordStatus",
            "process",
            "startDate",
            "status",
            "subjectUser",
            "taskId",
            "type"
          ]
        },
        "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": [
            "*",
            "processNav"
          ]
        },
        "description": "Expand related entities, see [OData Expand](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>