How to add Additional Fields

The Sage People API allows you to add Additional Fields to the API response. Additional Fields enables the API user to access custom and non-standard fields associated with the corresponding object specific to the organization, which are not provided by default in the API response. For more information regarding the API field sets and the objects they belong to, see the table below

The example below shows how to add additional fields to the fieldset on the Team Member object:

  1. In your Salesforce org, navigate to Setup.
  2. Select the Object Manager tab.
  3. In the Quick Find box, search for Team Member.
  4. Select Team Member.

    Team Member search

  5. Select the Field Sets tab on the left hand side.
  6. Select the Employee API Additional Fields field set.

    fieldSetsSearch.png

  7. Drag and drop the fields of your choice in to the In the Field Set box.

    Additional fields page

  8. Select Save.

The process is identical for each of the supported objects (api endpoints), simply select the corresponding object’s API additional fields field set and add the desired fields.

You can now see the chosen fields in the Additional Details section of the API response. If a chosen field has no value it will be returned with a null value per the example below.

Additional fields null value

API Field Set Object Mapping

API Endpoint Name Field Set Name Object Name
/employee Employee_API_Additional_Fields fHCM2__Team_Member__c
/salaries Salary_API_Additional_Fields fHCM2__Salary__c
/bonuses Bonus_API_Additional_Fields fHCM2__Bonus__c
/absences Absence_API_Additional_Fields fHCM2__Absence__c
/absenceBalances Absence_Balance_API_Additional_Fields fta__Accrual_Balance__c