{ "opencollection": "1.0.0", "info": { "name": "Accounting subpackage_timeOff API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_timeOff", "type": "folder" }, "items": [ { "info": { "name": "List", "type": "http" }, "http": { "method": "GET", "url": "https://api.merge.dev/api/hris/v1/time-off", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Account-Token", "value": "" } ], "params": [ { "name": "approver_id", "value": "", "type": "query", "description": "If provided, will only return time off for this approver." }, { "name": "created_after", "value": "", "type": "query", "description": "If provided, will only return objects created after this datetime." }, { "name": "created_before", "value": "", "type": "query", "description": "If provided, will only return objects created before this datetime." }, { "name": "cursor", "value": "", "type": "query", "description": "The pagination cursor value." }, { "name": "employee_id", "value": "", "type": "query", "description": "If provided, will only return time off for this employee." }, { "name": "ended_after", "value": "", "type": "query", "description": "If provided, will only return employees that ended after this datetime." }, { "name": "ended_before", "value": "", "type": "query", "description": "If provided, will only return time-offs that ended before this datetime." }, { "name": "expand", "value": "", "type": "query", "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces." }, { "name": "include_deleted_data", "value": "", "type": "query", "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)." }, { "name": "include_remote_data", "value": "", "type": "query", "description": "Whether to include the original data Merge fetched from the third-party to produce these models." }, { "name": "include_shell_data", "value": "", "type": "query", "description": "Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null)." }, { "name": "modified_after", "value": "", "type": "query", "description": "If provided, only objects synced by Merge after this date time will be returned." }, { "name": "modified_before", "value": "", "type": "query", "description": "If provided, only objects synced by Merge before this date time will be returned." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page. The maximum limit is 100." }, { "name": "remote_fields", "value": "", "type": "query", "description": "Deprecated. Use show_enum_origins." }, { "name": "remote_id", "value": "", "type": "query", "description": "The API provider's ID for the given object." }, { "name": "request_type", "value": "", "type": "query", "description": "If provided, will only return TimeOff with this request type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')\n\n" }, { "name": "show_enum_origins", "value": "", "type": "query", "description": "A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)" }, { "name": "started_after", "value": "", "type": "query", "description": "If provided, will only return time-offs that started after this datetime." }, { "name": "started_before", "value": "", "type": "query", "description": "If provided, will only return time-offs that started before this datetime." }, { "name": "status", "value": "", "type": "query", "description": "If provided, will only return TimeOff with this status. Options: ('REQUESTED', 'APPROVED', 'DECLINED', 'CANCELLED', 'DELETED')\n\n" } ] }, "docs": "Returns a list of `TimeOff` objects.{/* BEGIN_HRIS_TIMEOFF_FETCH_SUPPORTED_FIELDS */}