Get leave items
GET /api/bulk-ee-leave-details-balance
Gets the details for all leave items for multiple staff, using the user IDs in your system (external ID).
The leave details includes leave type, leave balance, effective date, and more, which will be displayed in your language of choice.
Request
Query parameters
lang string Required
The language settings, formatted as an uppercase ISO 639-1 code. The leave item information will be displayed in the selected language.
Valid values: EN, ZH
customer_id integer Required
The unique Marco identifier for your company.
customer_system_id string Required
The staff's unique identifier in your company's system.
Example: 50
Example Requests
Response (200)
A successful response will return an array of objects. Each object contains all the leave items for one staff.
leaves array[object]
An array of all active leave items for one staff.
leaves.id integer
The unique Marco identifier for the leave item.
leaves.user integer
The unique Marco identifier for the staff.
leaves.customer_id integer
The unique Marco identifier for the staff's company.
leaves.entitlement integer
The entitlement amount for the leave item.
leaves.effective_date string
The effective date for the leave item's entitlement, formatted as YYYY-MM-DD.
leaves.carried_expiry_date string
The expiry date for the leave item's carried balance, formatted as YYYY-MM-DD.
leaves.carried integer
The carried over amount for the leave item.
leaves.notes string
Company notes for the leave item.
leaves.created_at integer
Unix timestamp for the leave item's creation date.
leaves.updated_at integer
Unix timestamp for the leave item's update date.
leaves.deleted_at integer
Unix timestamp for the leave item's deletion date.
leaves.last_modified_by integer
The unique Marco identifier for the user who last modified the leave item details.
leaves.{leave_type} object
Leave type metadata.
{leave_type}.id integer
The unique Marco identifier for the leave type.
{leave_type}.country integer
The unique Marco identifier for the leave type's associated country.
{leave_type}.display_order integer
The display order for the leave type, when displayed in a list.
{leave_type}.iso_code string
The associated country for the leave type, formatted as an ISO Alpha-2 code.
Example: GB
{leave_type}.dictionary array[object]
Contains the leave type name and its corresponding notes.
dictionary.key string
The type of data.
Valid values: data, notes "data" stores the leave type name, while "notes" stores the leave type notes.
dictionary.value string
The field value for the data or notes.
Example: Sick Leave
leaves.{leaves} object
Leave item metadata, such as the leave balances and consumed leave days.
customer_system_id string
The staff's unique identifier in your company's system.
Example: 50