SAP IC – Xceed365 HCM Integration

Documentation
Sub Info

Duke Obasi 9/25/24 Integration

Integration Architecture and Business Process Orchestration

Example Business Process orchestration:

When a new Hire is entered into SAP SuccessFactors.

1. SAP SF User has entered transaction into SAP SuccessFactors.

2. SAP Integration Centre will run on a schedule
3. SAP Integration Centre will pick up the “new hire(s)” only that have been established
since the last run.
4. SAP Integration Centre will call the “Middleware URL” for the trigger to send JSON
payload. The Middleware proxies the call and passes the payload.
5. Middleware Transforms the payload, adds authentication information and calls the
downstream Xceed365 HCM API to deliver the payload.
6. Xceed365 HCM Processes the payload into the required transaction.
Employee Data JSON Payload Documentation
This JSON payload contains detailed information about an employee. Below is a description of
each field in the payload:

Payload Structure

"api_session_id": "92BEA689-36E7-4041-AEDD-3CD75BF69F2F",
"api_session_record_id": "",
"employee_number": "1234T01",
"staff_category_code": "FTE",
"title": "Mr",
"employee_surname": "Bloom",
"employee_midname": "",
"employee_firstname": "Orlandoa",
"gender": "Male",
"date_of_birth": "1985-07-20T08:53:05.933Z",
"rec_category": 0,
"user_on_ad": "false",
"sync_firstname": "",
"sync_surname": "",
"username": "[email protected]",
"designation_code": "",
"position_code": "",
"reports_to_number": "",
"employment_date": "2024-07-20T08:53:05.933Z",
"a_confirm_date": "",
"backup_officer_number": "",
"is_permanent_staff": "true",
"emp_duration_from": "",
"emp_duration_to": "",
"ent_struc_type_code": "",
"ent_struc_details_code": "",
"on_payroll": "true",
"paygroup_code": "",
"grade_code": "",
"compute_pension": "true",
"compute_nhf": "true",
"compute_tax": "true",
"pay_newstaff_arrears": "true",
"api_json_data":
"{\"basepay_code\":\"BASIC\",\"base_pay\":\"23000000\",\"account_no\":\"0009007654\",\"bank_co
de\":\"X365-
GTB\",\"rsa_number\":\"PEN0000988372\",\"pfa_code\":\"ARM\",\"tax_idn\":\"234564555\"}",
"file_number": ""
}

Field Descriptions

1. api_session_id:
• A value must be passed.
• Unique identifier for the API session.
• You can pass a GUID for this field
• Example: "92BEA689-36E7-4041-AEDD-3CD75BF69F2F"

2. api_session_record_id:
 • An empty string can be passed.
• The Middleware will create a GUID and pass to the downstream API.
• If passed, it should be a Unique identifier for the API Record.
• You can pass a GUID for this field
• Example: ""

3. employee_number:
• A value must be passed.
• This represents the employee number and should be unique to that employee.
• Example: "SEP2021/01"

4. staff_category_code:
• Code representing the category of the staff (e.g., Full-Time Employee).
• A value must be passed.
• Example: "FTE"

5. title:
• Employee's title of courtesy (e.g., Mr, Mrs, Ms).
• A value must be passed.
• Example: "Mr"

6. employee_surname:
• Last name of the employee.
• A value must be passed.
• Example: "Bloom"

7. employee_midname:
• Middle name of the employee (optional).
• Example: ""

8. employee_firstname:
• First name of the employee.
• A value must be passed.
• Example: "Orlandoa"

9. gender:
• Gender of the employee.
• A value must be passed. (Male/Female)
• Example: "Male"

10. date_of_birth:
• Date of birth of the employee (in ISO 8601 format).
• A value must be passed.
• Example: "1985-07-20T08:53:05.933Z"

11. rec_category:
• Numeric category for the record.
• A value must be passed. (0=Employee Only, 1=Employee and User)
• Example: 0

12. user_on_ad:
• Boolean string indicating if the employee should be synced with Active Directory.
• A value must be passed.
• Example: "false"
13. sync_firstname:
• Active Directory Sync first name (if applicable).
• Example: ""

14. sync_surname:
• Active Directory Sync last name (if applicable).
• Example: ""

15. username:
• The employee's login username or email.
• A value must be passed.
• Must be in the format of an email address
• Example: "[email protected]"

16. designation_code:
• Code representing the employee's designation (optional).
• If passed, this must match a designation code on Xceed365 HCM.
• Example: ""

17. position_code:
• Code representing the employee's position (optional).
• If passed, this must match a position code on Xceed365 HCM.
• Example: ""

18. reports_to_number:
• The employee number of the person to whom this employee reports (optional).
• If passed, this must match the staff number of an employee provisioned on Xceed365 HCM.
• Example: ""

19. employment_date:
• Employee’s date of employment (in ISO 8601 format).
• A value must be passed.
• Example: "2024-07-20T08:53:05.933Z"

20. a_confirm_date:
• Date of employee's confirmation (optional).
• If passed, this should be in ISO 8601 format.
• Example: ""

21. backup_officer_number:
• Employee number of a backup officer (optional).
• If passed, this must match the staff number of an employee provisioned on Xceed365
HCM.
• Example: ""

22. is_permanent_staff:
• Boolean string indicating if the employee is permanent staff.
• A value must be passed.
• Example: "true"

23. emp_duration_from:
• Start date of the employee's contract or employment duration (optional).
• If passed, this should be in ISO 8601 format.
• Example: ""

24. emp_duration_to:
 • End date of the employee's contract or employment duration (optional).
• If passed, this should be in ISO 8601 format.
• Example: ""

25. ent_struc_type_code:
• Code for the enterprise structure type (optional).
• If passed, this must match an enterprise structure type definition on Xceed365 HCM.
• Example: ""

26. ent_struc_details_code:
• Code for the specific enterprise structure details/business unit to place this
employee into (optional).
• If passed, this must match an enterprise business unit definition on Xceed365 HCM.
• Example: ""

27. on_payroll:
• Boolean string indicating if the employee is on payroll.
• A value must be passed.
• Example: "true"

28. paygroup_code:
• Code representing the payment group of the employee. (optional).
• If passed, this must match a payment group definition on Xceed365 HCM.
• Failure to pass this information will result in the employee being excluded from
payroll.
• Example: ""

29. grade_code:
• Code representing the employee's grade (optional).
• If passed, this must match a job grade definition on Xceed365 HCM.
• Failure to pass this information will result in the employee being excluded from
payroll.
• Example: ""

30. compute_pension:
• Boolean string indicating if pension computation is enabled.
• A value must be passed.
• Example: "true"

31. compute_nhf:
• Boolean string indicating if NHF (National Housing Fund) computation is enabled.
• A value must be passed.
• Example: "true"

32. compute_tax:
• Boolean string indicating if tax computation is enabled.
• A value must be passed.
• Example: "true"

33. pay_newstaff_arrears:
• Boolean string indicating if arrears for new staff are paid.
• A value must be passed.
• Example: "true"

34. api_json_data:
 • An escaped JSON string containing additional financial details such as base pay,
account number, bank code, and pension details (Optional)
• If this value is not passed, the information will not be maintained for the employee
and may result in no payroll value for the employee.
• If passed, the string must be escaped as represented below or the above payload.
• Example:
"{\"basepay_code\":\"BASIC\",\"base_pay\":\"23000000\",\"account_no\":\"0009007654\",\"
bank_code\":\"X365-
GTB\",\"rsa_number\":\"PEN0000988372\",\"pfa_code\":\"ARM\",\"tax_idn\":\"234564555\"}"

NOTES
• "basepay_code"-This must match the code of the base pay item definition on Xceed365 HCM
• "base_pay": - The value of the employee’s base pay.
• "account_no": - The account number of the employee.
• "bank_code": - The Bank code of the employee. This must match the bank codes defined on
the Xceed365 HCM to be processed.
• "rsa_number": - The RSA number of the employee.
• "pfa_code": - The code of the PFA for the employee. The code must match the code of the
PFA as defined within Xceed365 HCM.
• "tax_idn": - The TAX ID of the employee.

35. file_number:
• Employee's file number (optional).
• Example: ""

Additional Notes:

- All date fields follow the ISO 8601 format (`YYYY-MM-DDTHH:mm:ss.sssZ`).

- Boolean fields are represented as strings ("true"/"false").
- Optional fields are part of the model however may have empty strings.
Update Employee Information
https://earthapi.xceed365.com/app-process/api/recordmodify/bulk-create?uuk={uuk}
[
{
"api_session_id": "92BEA689-36E7-4041-AEDD-3CD75BF69F2F",
"api_session_record_id": "2EC10668-29AF-409C-9E75-8AF83ED71DD9",
"employee_number": "1234T01",
"staff_category_code": "FT",
"title": "Mr",
"employee_surname": "Bloom",
"employee_midname": "",
"employee_firstname": "Orlandoa",
"gender": "Male"
"date_of_birth": "1985-07-20T08:53:05.933Z",
"rec_category": 0,
"user_on_ad": false,
"sync_firstname": "Orlandoa",
"sync_surname": "Bloom",
"username": "[email protected]",
"designation_code": "FIN_AACT",
"position_code": "FA",
"reports_to_number": "X365-V2_01",
"employment_date": "2024-07-20T08:53:05.933Z",
"a_confirm_date": "",
"backup_officer_number": "",
"is_permanent_staff": true,
"emp_duration_from": "2024-07-20T08:53:05.933Z",
"emp_duration_to": "",
"on_payroll": true,
"paygroup_code": "PG003",
"grade_code": "GRD002-3",
"compute_pension": false,
"compute_nhf": false,
"compute_tax": false,
"pay_newstaff_arrears": false,
"api_json_data":
"{\"basepay_code\":\"BASIC\",\"base_pay\":\"23000000\",\"account_no\":\"0009007654\",\"bank_co
de\":\"X365-
GTB\",\"rsa_number\":\"PEN0000988372\",\"pfa_code\":\"ARM\",\"tax_idn\":\"234564555\"}",
"file_number": "1234T01"
}
]
Field Descriptions

1. api_session_id:
• A value must be passed.
• Unique identifier for the API session.
• You can pass a GUID for this field
• Example: "92BEA689-36E7-4041-AEDD-3CD75BF69F2F"

2. api_session_record_id:
• An empty string can be passed.
• The Middleware will create a GUID and pass to the downstream API.
• If passed, it should be a Unique identifier for the API Record.
• You can pass a GUID for this field
• Example: ""
3. employee_number:
• A value must be passed.
• This represents the employee number and should be unique to that employee. You
cannot use this property to change employee number.
• Example: "SEP2021/01"

4. staff_category_code:
• Code representing the category of the staff (e.g., Full-Time Employee).
• A value must be passed.
• Example: "FTE"

5. title:
• Employee's title of courtesy (e.g., Mr, Mrs, Ms).
• A value must be passed.
• Example: "Mr"

6. employee_surname:
• Last name of the employee.
• A value must be passed.
• Example: "Bloom"

7. employee_midname:
• Middle name of the employee (optional).
• Example: ""

8. employee_firstname:
• First name of the employee.
• A value must be passed.
• Example: "Orlandoa"

9. gender:
• Gender of the employee.
• A value must be passed. (Male/Female)
• Example: "Male"

10. date_of_birth:
• Date of birth of the employee (in ISO 8601 format).
• A value must be passed.
• Example: "1985-07-20T08:53:05.933Z"

11. rec_category:
• Numeric category for the record.
• A value must be passed. (0=Employee Only, 1=Employee and User)
• Example: 0

12. user_on_ad:
• Boolean string indicating if the employee should be synced with Active Directory.
• A value must be passed.
• Example: "false"

13. sync_firstname:
• Active Directory Sync first name (if applicable).
• Example: ""

14. sync_surname:
 • Active Directory Sync last name (if applicable).
• Example: ""

15. username:
• The employee's login username or email.
• A value must be passed.
• Must be in the format of an email address
• Example: "[email protected]"

16. designation_code:
• Code representing the employee's designation (optional).
• If passed, this must match a designation code on Xceed365 HCM.
• Example: ""

17. position_code:
• Code representing the employee's position (optional).
• If passed, this must match a position code on Xceed365 HCM.
• Example: ""

18. reports_to_number:
• The employee number of the person to whom this employee reports (optional).
• If passed, this must match the staff number of an employee provisioned on Xceed365 HCM.
• Example: ""

19. employment_date:
• Employee’s date of employment (in ISO 8601 format).
• A value must be passed.
• Example: "2024-07-20T08:53:05.933Z"

20. a_confirm_date:
• Date of employee's confirmation (optional).
• If passed, this should be in ISO 8601 format.
• Example: ""

21. backup_officer_number:
• Employee number of a backup officer (optional).
• If passed, this must match the staff number of an employee provisioned on Xceed365
HCM.
• Example: ""

22. is_permanent_staff:
• Boolean string indicating if the employee is permanent staff.
• A value must be passed.
• Example: "true"

23. emp_duration_from:
• Start date of the employee's contract or employment duration (optional).
• If passed, this should be in ISO 8601 format.
• Example: ""

24. emp_duration_to:
• End date of the employee's contract or employment duration (optional).
• If passed, this should be in ISO 8601 format.
• Example: ""

27. on_payroll:
 • Boolean string indicating if the employee is on payroll.
• A value must be passed.
• Example: "true"

28. paygroup_code:
• Code representing the payment group of the employee. (optional).
• If passed, this must match a payment group definition on Xceed365 HCM.
• Failure to pass this information will result in the employee being excluded from
payroll.
• Example: ""

29. grade_code:
• Code representing the employee's grade (optional).
• If passed, this must match a job grade definition on Xceed365 HCM.
• Failure to pass this information will result in the employee being excluded from
payroll.
• Example: ""

30. compute_pension:
• Boolean string indicating if pension computation is enabled.
• A value must be passed.
• Example: "true"

31. compute_nhf:
• Boolean string indicating if NHF (National Housing Fund) computation is enabled.
• A value must be passed.
• Example: "true"

32. compute_tax:
• Boolean string indicating if tax computation is enabled.
• A value must be passed.
• Example: "true"

33. pay_newstaff_arrears:
• Boolean string indicating if arrears for new staff are paid.
• A value must be passed.
• Example: "true"

34. api_json_data:
• An escaped JSON string containing additional financial details such as base pay,
account number, bank code, and pension details (Optional)
• If this value is not passed, the information will not be maintained for the employee
and may result in no payroll value for the employee.
• If passed, the string must be escaped as represented below or the above payload.
• Example:
"{\"basepay_code\":\"BASIC\",\"base_pay\":\"23000000\",\"account_no\":\"0009007654\",\"
bank_code\":\"X365-
GTB\",\"rsa_number\":\"PEN0000988372\",\"pfa_code\":\"ARM\",\"tax_idn\":\"234564555\"}"

NOTES
• "basepay_code"-This must match the code of the base pay item definition on Xceed365 HCM
• "base_pay": - The value of the employee’s base pay.
• "account_no": - The account number of the employee.
• "bank_code": - The Bank code of the employee. This must match the bank codes defined on
the Xceed365 HCM to be processed.
• "rsa_number": - The RSA number of the employee.
 • "pfa_code": - The code of the PFA for the employee. The code must match the code of the
PFA as defined within Xceed365 HCM.
• "tax_idn": - The TAX ID of the employee.

35. file_number:
• Employee's file number (optional).
• Example: ""

Additional Notes:

- All date fields follow the ISO 8601 format (`YYYY-MM-DDTHH:mm:ss.sssZ`).

- Boolean fields are represented as strings ("true"/"false").
- Optional fields are part of the model however may have empty strings.
Transfer an employee into a business unit
https://earthapi.xceed365.com/app-process/api/transfer/bulk-create?uuk={uuk}
{
"api_session_id": "string",
"api_session_record_id": "string",
"employee_number": "string",
"to_location_code": "string",
"to_new_designation": "string",
"to_position_code": "string",
"reports_to": "string",
"eff_period_start": "2023-07-20T08:53:06.045Z",
"is_temporary": true,
"eff_period_end": "2023-07-20T08:53:06.045Z"
}

1. api_session_id:
• A value must be passed.
• Unique identifier for the API session.
• You can pass a GUID for this field
• Example: "92BEA689-36E7-4041-AEDD-3CD75BF69F2F"

2. api_session_record_id:
• An empty string can be passed.
• The Middleware will create a GUID and pass to the downstream API.
• If passed, it should be a Unique identifier for the API Record.
• You can pass a GUID for this field
• Example: ""

3. employee_number:
• A value must be passed.
• This represents the employee number and should be unique to that employee.
• Example: "SEP2021/01"

4. to_location_code:
• Code for the specific enterprise structure details/business unit to place this
employee into (optional).
• If passed, this must match an enterprise business unit definition on Xceed365 HCM.
• Example: ""
• One, more or all of to_location_code,to_new_designation,to_position_code must be
passed at the least.

5. to_new_designation:
• Code for the specific designation to place this employee into (optional).
• If passed, this must match a designation code definition on Xceed365 HCM.
• Example: ""
• One, more or all of to_location_code, to_new_designation,to_position_code must be
passed at the least.

6. to_position_code:
• Code for the specific position to place this employee into (optional).
• If passed, this must match a position code definition on Xceed365 HCM.
• Example: ""
• One, more or all of to_location_code, to_new_designation,to_position_code must be
passed at the least.
7. reports_to:
• The employee number of the person to whom this employee reports (optional).
• If passed, this must match the staff number of an employee provisioned on
Xceed365 HCM.
• Example: ""

8. eff_period_start:
• Effective date of the employee's transfer (required).
• This should be in ISO 8601 format.
• Example: "2023-07-20T08:53:06.045Z"

9. is_temporary:
• Boolean string indicating if the transfer is temporary and should be reverted on
the end date.
• A value must be passed.
• Example: "true"

10. eff_period_end:
• Effective date on which the employee’s transfer will be auto reverted (optional).
• If passed, this should be in ISO 8601 format.
• Example: "2023-07-20T08:53:06.045Z"
Exclusion/Suspension

https://earthapi.xceed365.com/app-process/api/exclusion/bulk-create?uuk={uuk}

{
"api_session_id": "string",
"api_session_record_id": "string",
"suspension_type": 0,
"item_type": 0,
"item_code": "string",
"employee_number": "string",
"suspend_by_percent": true,
"percent_value": 0,
"amount_value": 0,
"is_temp": true,
"eff_period_start": "2023-07-20T08:53:06.071Z",
"eff_period_end": "2023-07-20T08:53:06.071Z",
"notes": "string",
"api_json_data": "string"
}

Field Descriptions

1. api_session_id (string):
A unique identifier for the API session. This is used to track the current API call
across systems.
2. api_session_record_id (string):
A unique identifier for the API session record. This differentiates individual records
or transactions within a session.
3. suspension_type (integer):
Specifies the type of suspension to be applied. The available options are:
o 0: All Items
o 1: All Allowances
o 2: All Deductions
o 3: All Loans
o 4: Tax
o 5: Specific Item(s)
4. item_type (integer):
Indicates the type of payroll item to be suspended. The possible values are:
o 0: Fixed Allowance
o 1: Fixed Deduction
o 2: Variable Allowance
o 3: Variable Deduction
5. item_code (string):
The code for the specific item (e.g., allowance or deduction) that is being suspended.
This code uniquely identifies the payroll item.
6. employee_number (string):
The unique identifier for the employee affected by the suspension.
7. suspend_by_percent (boolean):
A flag that determines if the suspension is based on a percentage.
o true: Suspension is applied as a percentage of the total item value.
o false: Suspension is applied as a fixed amount.
8. percent_value (decimal):
The percentage value to be applied if suspend_by_percent is true.
Example: 50 means 50% of the value is suspended.
9. amount_value (decimal):
The fixed amount to be suspended if suspend_by_percent is false.
10. is_temp (boolean):
A flag indicating if the suspension is temporary.
 o true: The suspension is temporary.
o false: The suspension is permanent.
11. eff_period_start (datetime):
The start date and time when the suspension takes effect. This should follow ISO 8601
format (e.g., 2023-07-20T08:53:06.071Z).
12. eff_period_end (datetime):
The end date and time when the suspension expires. If left null or empty, the
suspension is assumed to be ongoing unless is_temp is false.
13. notes (string):
Optional field for additional notes or comments related to the suspension.
14. api_json_data (string):
Any additional API-related data in JSON format, typically used for storing extended
metadata or extra configurations required by the API.
Separation

https://earthapi.xceed365.com/app-process/api/separation/bulk-create?uuk={uuk}

{
"api_session_id": "string",
"api_session_record_id": "string",
"employee_number": "string",
"separation_code" : "string",
"notice_date": "2023-07-20T08:53:06.094Z",
"effective_date": "2023-07-20T08:53:06.094Z",
"api_json_data": "string",
}

Field Descriptions
1. api_session_id (string):
A unique identifier for the API session. This tracks the current session of the API
interaction, ensuring it is linked to the correct process flow.
2. api_session_record_id (string):
A unique identifier for the specific record within the API session. It differentiates
the particular employee separation event from other records in the session.
3. employee_number (string):
A unique identifier for the employee undergoing separation. This is typically an
employee ID or similar reference number within the organization.
4. separation_code (string):
A code representing the type or reason for the separation. This can be a resignation,
retirement, termination, or other forms of employee departure. This is based on your
definition within Xceed365 HCM.
5. notice_date (datetime):
The date when the employee officially submitted their notice of separation or when the
company issued the separation notice. The date follows the ISO 8601 format (e.g., 2023-
07-20T08:53:06.094Z).
6. effective_date (datetime):
The official date when the separation takes effect. This represents the date the
employee wont be at work or the date from which the separation is legally valid. This
field also uses the ISO 8601 format.
7. api_json_data (string):
Additional data related to the API in JSON format. This can contain extended metadata
or any other optional information needed for the API’s operation.
Employee Specific Allowances

https://earthapi.xceed365.com/app-process/api/empspec-allowance/bulk-create?uuk={uuk}
{
"api_session_id": "string",
"api_session_record_id": "string",
"employee_number": "string",
"fixed_allowance_code": "string",
"direct_value": 0,
"formula_code": "string",
"eff_period_start": "2023-07-20T08:53:06.004Z",
"eff_period_end": "2023-07-20T08:53:06.004Z",
"api_json_data": "string"
}

Field Descriptions
1. api_session_id (string):
A unique identifier for the API session. This ensures the correct tracking of requests
made during this session.
2. api_session_record_id (string):
A unique identifier for the specific record within the session, ensuring each fixed
allowance transaction is distinctly identifiable.
3. employee_number (string):
The unique identifier for the employee to whom the fixed allowance is being applied.
This could be the employee ID or payroll number.
4. fixed_allowance_code (string):
A code that uniquely identifies the specific fixed allowance being applied to the
employee. This should correspond to the codes defined in the organization's payroll
system for allowances (e.g., HOUSING_ALLOW, TRANSPORT_ALLOW).
5. direct_value (decimal):
The monetary value of the fixed allowance to be applied directly. If the allowance is
not calculated based on a formula, this value will define the allowance amount.
6. formula_code (string):
An optional field specifying a formula code that defines how the allowance is
calculated. If the fixed allowance is determined by a formula (rather than a direct
value), this field is used to reference that formula. Example values might include
predefined codes such as FORMULA1, HOUSINGFORMULA, etc.
7. eff_period_start (datetime):
The start date and time when the fixed allowance becomes effective. This field follows
the ISO 8601 format (e.g., 2023-07-20T08:53:06.004Z).
8. eff_period_end (datetime):
The end date and time when the fixed allowance expires. If the allowance is ongoing
without an expiration date, this field may be left null or blank. This field also
follows the ISO 8601 format.
9. api_json_data (string):
Additional API-specific data or metadata in JSON format. This can be used to store
extra details or configurations necessary for the API operation.
Paygroup Specific Allowance

https://earthapi.xceed365.com/app-process/api/pgspec-allowance/bulk-create?uuk={uuk}
{
"api_session_id": "string",
"api_session_record_id": "string",
"paygroup_code": "string",
"fixed_allowance_code": "string",
"direct_value": 0,
"formula_code": "string",
"eff_period_start": "2023-07-20T08:53:06.004Z",
"eff_period_end": "2023-07-20T08:53:06.004Z",
"api_json_data": "string"
}

Field Descriptions
1. api_session_id (string):
A unique identifier for the API session. This ensures the correct tracking of requests
made during this session.
2. api_session_record_id (string):
A unique identifier for the specific record within the session, ensuring each fixed
allowance transaction is distinctly identifiable.
3. paygroup_code (string):
The unique identifier for the payment group to which the fixed allowance is being
applied. This should be a code predefined within Xceed HCM.
4. fixed_allowance_code (string):
A code that uniquely identifies the specific fixed allowance being applied to the
employee. This should correspond to the codes defined in the organization's payroll
system for allowances (e.g., HOUSING_ALLOW, TRANSPORT_ALLOW).
5. direct_value (decimal):
The monetary value of the fixed allowance to be applied directly. If the allowance is
not calculated based on a formula, this value will define the allowance amount.
6. formula_code (string):
An optional field specifying a formula code that defines how the allowance is
calculated. If the fixed allowance is determined by a formula (rather than a direct
value), this field is used to reference that formula. Example values might include
predefined codes such as FORMULA1, HOUSINGFORMULA, etc.
7. eff_period_start (datetime):
The start date and time when the fixed allowance becomes effective. This field follows
the ISO 8601 format (e.g., 2023-07-20T08:53:06.004Z).
8. eff_period_end (datetime):
The end date and time when the fixed allowance expires. If the allowance is ongoing
without an expiration date, this field may be left null or blank. This field also
follows the ISO 8601 format.
9. api_json_data (string):
Additional API-specific data or metadata in JSON format. This can be used to store
extra details or configurations necessary for the API operation.
Employee Specific Deduction

https://earthapi.xceed365.com/app-process/api/empspec-deduction/bulk-create?uuk={uuk}
{
"api_session_id": "string",
"api_session_record_id": "string",
"employee_number": "string",
"fixed_deduction_code": "string",
"direct_value": 0,
"formula_code": "string",
"eff_period_start": "2023-07-20T08:53:06.004Z",
"eff_period_end": "2023-07-20T08:53:06.004Z",
"api_json_data": "string"
}

Field Descriptions
1. api_session_id (string):
A unique identifier for the API session. This ensures the correct tracking of requests
made during this session.
2. api_session_record_id (string):
A unique identifier for the specific record within the session, ensuring each fixed
deduction transaction is distinctly identifiable.
3. employee_number (string):
The unique identifier for the employee to whom the fixed deduction is being applied.
This could be the employee ID or payroll number.
4. fixed_deduction_code (string):
A code that uniquely identifies the specific fixed deduction being applied to the
employee. This should correspond to the codes defined in the organization's payroll
system for deductions.
5. direct_value (decimal):
The monetary value of the fixed deduction to be applied directly. If the deduction is
not calculated based on a formula, this value will define the deduction amount.
6. formula_code (string):
An optional field specifying a formula code that defines how the deduction is
calculated. If the fixed deduction is determined by a formula (rather than a direct
value), this field is used to reference that formula. Example values might include
predefined codes such as FORMULA1, HOUSINGFORMULA, etc.
7. eff_period_start (datetime):
The start date and time when the fixed deduction becomes effective. This field follows
the ISO 8601 format (e.g., 2023-07-20T08:53:06.004Z).
8. eff_period_end (datetime):
The end date and time when the fixed deduction expires. If the deduction is ongoing
without an expiration date, this field may be left null or blank. This field also
follows the ISO 8601 format.
9. api_json_data (string):
Additional API-specific data or metadata in JSON format. This can be used to store
extra details or configurations necessary for the API operation.
Paygroup Specific Deductions

https://earthapi.xceed365.com/app-process/api/pgspec-deduction/bulk-create?uuk={uuk}
{
"api_session_id": "string",
"api_session_record_id": "string",
"paygroup_code": "string",
"fixed_deduction_code": "string",
"direct_value": 0,
"formula_code": "string",
"eff_period_start": "2023-07-20T08:53:06.004Z",
"eff_period_end": "2023-07-20T08:53:06.004Z",
"api_json_data": "string"
}

Field Descriptions
1. api_session_id (string):
A unique identifier for the API session. This ensures the correct tracking of requests
made during this session.
2. api_session_record_id (string):
A unique identifier for the specific record within the session, ensuring each fixed
deduction transaction is distinctly identifiable.
3. paygroup_code (string):
The unique identifier for the payment group to which the fixed deduction is being
applied. This should be a value within the Xceed365 HCM solution.
4. fixed_deduction_code (string):
A code that uniquely identifies the specific fixed deduction being applied to the
employee. This should correspond to the codes defined in the organization's payroll
system for deductions.
5. direct_value (decimal):
The monetary value of the fixed deduction to be applied directly. If the deduction is
not calculated based on a formula, this value will define the deduction amount.
6. formula_code (string):
An optional field specifying a formula code that defines how the deduction is
calculated. If the fixed deduction is determined by a formula (rather than a direct
value), this field is used to reference that formula. Example values might include
predefined codes such as FORMULA1, HOUSINGFORMULA, etc.
7. eff_period_start (datetime):
The start date and time when the fixed deduction becomes effective. This field follows
the ISO 8601 format (e.g., 2023-07-20T08:53:06.004Z).
8. eff_period_end (datetime):
The end date and time when the fixed deduction expires. If the deduction is ongoing
without an expiration date, this field may be left null or blank. This field also
follows the ISO 8601 format.
9. api_json_data (string):
Additional API-specific data or metadata in JSON format. This can be used to store
extra details or configurations necessary for the API operation.
Variable Allowance Entry for an employee

https://earthapi.xceed365.com/app-process/api/variable-allowance-transaction/bulk-
create?uuk={uuk}

{
"api_session_id": "string",
"api_session_record_id": "string",
"employee_number": "string",
"v_allowance_code": "string",
"transaction_date": "2023-07-20T08:53:05.962Z",
"no_of_units": 0,
"amount": 0,
"api_json_data": "string"
}

Field Descriptions
1. api_session_id (string):
A unique identifier for the current API session. This ensures the transaction is
tracked across related API calls.
2. api_session_record_id (string):
A unique identifier for the specific record within the session, which differentiates
this particular variable allowance transaction from other records.
3. employee_number (string):
The unique identifier for the employee receiving the variable allowance. This is
typically an employee ID or payroll number within the system.
4. v_allowance_code (string):
The code representing the specific variable allowance being applied. This code must
align with the organization’s payroll system for tracking different types of variable
allowances (e.g., BONUS, OT for overtime).
5. transaction_date (datetime):
The date and time the variable allowance transaction occurs or is recorded. It follows
the ISO 8601 format (e.g., 2023-07-20T08:53:05.962Z).
6. no_of_units (decimal):
The number of units applicable for this variable allowance. This field is useful for
allowances that depend on units such as hours worked, days, or other measurable
factors.
7. amount (decimal):
The total monetary value of the variable allowance. This is the computed amount based
on the number of units and the allowance rate.
8. api_json_data (string):
Additional API-related data in JSON format, which can store extra metadata or optional
configurations necessary for the API transaction.
Employee Variable Deduction Entries

https://earthapi.xceed365.com/app-process/api/variable-deduction-transaction/bulk-
create?uuk={uuk}
{
"api_session_id": "string",
"api_session_record_id": "string",
"employee_number": "string",
"v_deduction_code": "string",
"transaction_date": "2023-07-20T08:53:05.962Z",
"no_of_units": 0,
"amount": 0,
"api_json_data": "string"
}

Field Descriptions
1. api_session_id (string):
A unique identifier for the current API session. This ensures the transaction is
tracked across related API calls.
2. api_session_record_id (string):
A unique identifier for the specific record within the session, which differentiates
this particular variable deduction transaction from other records.
3. employee_number (string):
The unique identifier for the employee receiving the variable deduction. This is
typically an employee ID or payroll number within the system.
4. v_deduction_code (string):
The code representing the specific variable deduction being applied. This code must
align with the organization’s payroll system for tracking different types of variable
deductions (e.g., BONUS, OT for overtime).
5. transaction_date (datetime):
The date and time the variable deduction transaction occurs or is recorded. It follows
the ISO 8601 format (e.g., 2023-07-20T08:53:05.962Z).
6. no_of_units (decimal):
The number of units applicable for this variable deduction. This field is useful for
deductions that depend on units such as hours worked, days, or other measurable
factors.
7. amount (decimal):
The total monetary value of the variable deduction. This is the computed amount based
on the number of units and the deduction rate.
8. api_json_data (string):
Additional API-related data in JSON format, which can store extra metadata or optional
configurations necessary for the API transaction.