{
  "opencollection": "1.0.0",
  "info": {
    "name": "Accounting subpackage_employees API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "subpackage_employees",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/accounting/v1/employees",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees for this company."
              },
              {
                "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": "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_id",
                "value": "",
                "type": "query",
                "description": "The API provider's ID for the given object."
              }
            ]
          },
          "docs": "Returns a list of `Employee` objects.{/* BEGIN_ACCOUNTING_EMPLOYEE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA82Vb2/aOhTGv0rklyghowxQka4m/nWlEqGjdGo1VdbBOQSDY6e2QynTvvuVIWuhrdbtivbuXXzi85z4/M7jfCcMLCZK35MmAcZULi2XCfFJqmIUpEl6aSbUPSLxCWQ8ghT3dtLlEfGJybNMaYvxCUcRm1ONU9IkYYo6wSCXfMoxDh+TQi4tJhosV9KED8nBdJNNfCK4XGDc2ia8LrfdHhSRJ0sTCm4s8UkGxtiZVnkyG+FtjuY3lN23CUxRWhBBDBbCHZVAb2VeirlTxCjQYtwFC120yNxxi4ozazPTDMMZiqy8qV6OcRmiDEFbzgSasF"
        },
        {
          "info": {
            "name": "Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/accounting/v1/employees/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "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_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)."
              }
            ]
          },
          "docs": "Returns an `Employee` object with the given `id`.{/* BEGIN_ACCOUNTING_EMPLOYEE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA82Vb2/aOhTGv0rklyghowxQka4m/nWlEqGjdGo1VdbBOQSDY6e2QynTvvuVIWuhrdbtivbuXXzi85z4/M7jfCcMLCZK35MmAcZULi2XCfFJqmIUpEl6aSbUPSLxCWQ8ghT3dtLlEfGJybNMaYvxCUcRm1ONU9IkYYo6wSCXfMoxDh+TQi4tJhosV9KED8nBdJNNfCK4XGDc2ia8LrfdHhSRJ0sTCm4s8UkGxtiZVnkyG+FtjuY3lN23CUxRWhBBDBbCHZVAb2VeirlTxCjQYtwFC120yNxxi4ozazPTDMMZiqy8qV6OcR"
        },
        {
          "info": {
            "name": "List",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/hris/v1/employees",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "company_id",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees for this company."
              },
              {
                "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": "display_full_name",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees with this display name."
              },
              {
                "name": "employee_number",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees with this employee number."
              },
              {
                "name": "employment_status",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees with this employment status.\n\n"
              },
              {
                "name": "employment_type",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees that have an employment of the specified employment type."
              },
              {
                "name": "expand",
                "value": "",
                "type": "query",
                "description": "Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces."
              },
              {
                "name": "first_name",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees with this first name."
              },
              {
                "name": "groups",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees matching the group ids; multiple groups can be separated by commas."
              },
              {
                "name": "home_location_id",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees for this home location."
              },
              {
                "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_sensitive_fields",
                "value": "",
                "type": "query",
                "description": "Whether to include sensitive fields (such as social security numbers) in the response."
              },
              {
                "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": "job_title",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees that have an employment of the specified job title."
              },
              {
                "name": "last_name",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees with this last name."
              },
              {
                "name": "manager_id",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees for this manager."
              },
              {
                "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": "pay_group_id",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees for this pay group"
              },
              {
                "name": "personal_email",
                "value": "",
                "type": "query",
                "description": "If provided, will only return Employees with this personal email"
              },
              {
                "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": "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 employees that started after this datetime."
              },
              {
                "name": "started_before",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees that started before this datetime."
              },
              {
                "name": "team_id",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees for this team."
              },
              {
                "name": "terminated_after",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees that were terminated after this datetime."
              },
              {
                "name": "terminated_before",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees that were terminated before this datetime."
              },
              {
                "name": "work_email",
                "value": "",
                "type": "query",
                "description": "If provided, will only return Employees with this work email"
              },
              {
                "name": "work_location_id",
                "value": "",
                "type": "query",
                "description": "If provided, will only return employees for this location."
              }
            ]
          },
          "docs": "Returns a list of `Employee` objects.{/* BEGIN_HRIS_EMPLOYEE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1dbVPbSBL+Ky59uqMAhxCWQNXVFbEBG7BxjMltsrWlGkttefBII0YjwGztf78avRizAeKXHnkEfEosy4+E5lF3T/fTM39ZDpHgcTG29q2hoJG1bvncBWbtW4d+yPgYwFq3SEjbxIfsHPvmo7VuRXEYciHBPaLA3KghYGDtW1UfhAcbcUAHFNyqOr1KAwmeIJLyIKpOfrYxSH5nrVuMBiNwDxyHx4F8CSg9cYOkZ/7jo/o6kta6FZIokkPBY2/YhesYohcx1f0w8CGQhG24RJLq1O83RArw1DF15y4wkODWiSR1kOCoPzG71lDKMNqvVofAws3k"
        },
        {
          "info": {
            "name": "Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/hris/v1/employees/:id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "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_remote_data",
                "value": "",
                "type": "query",
                "description": "Whether to include the original data Merge fetched from the third-party to produce these models."
              },
              {
                "name": "include_sensitive_fields",
                "value": "",
                "type": "query",
                "description": "Whether to include sensitive fields (such as social security numbers) in the response."
              },
              {
                "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": "remote_fields",
                "value": "",
                "type": "query",
                "description": "Deprecated. Use show_enum_origins."
              },
              {
                "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)"
              }
            ]
          },
          "docs": "Returns an `Employee` object with the given `id`.{/* BEGIN_HRIS_EMPLOYEE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1dbVPbSBL+Ky59uqMAhxCWQNXVFbEBG7BxjMltsrWlGkttefBII0YjwGztf78avRizAeKXHnkEfEosy4+E5lF3T/fTM39ZDpHgcTG29q2hoJG1bvncBWbtW4d+yPgYwFq3SEjbxIfsHPvmo7VuRXEYciHBPaLA3KghYGDtW1UfhAcbcUAHFNyqOr1KAwmeIJLyIKpOfrYxSH5nrVuMBiNwDxyHx4F8CSg9cYOkZ/7jo/o6kta6FZIokkPBY2/YhesYohcx1f0w8CGQhG24RJLq1O83RArw1DF15y4wkODWiSR1kOCoPzG71lDK"
        },
        {
          "info": {
            "name": "Ignore Create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.merge.dev/api/hris/v1/employees/ignore/:model_id",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "model_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Ignores a specific row based on the `model_id` in the url. These records will have their properties set to null, and will not be updated in future syncs. The \"reason\" and \"message\" fields in the request body will be stored for audit purposes.{/* BEGIN_HRIS_EMPLOYEE_CREATE_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"POST\" data=\"H4sIAAAAAAAAA9VXbU/jOBD+Kyd/rNJkocshKq1WhXZ52WvgoKBDK2RN42ni4tjBdoB2xX8/JU1LWtJS2HIvn1rbzzwznnlm3P4kAVgMlR6RJok0N8QhsWIoSJN04kSoESJxC"
        },
        {
          "info": {
            "name": "Meta Post Retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.merge.dev/api/hris/v1/employees/meta/post",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              },
              {
                "name": "X-Account-Token",
                "value": ""
              }
            ]
          },
          "docs": "Returns metadata for `Employee` POSTs.{/* BEGIN_HRIS_EMPLOYEE_FETCH_SUPPORTED_FIELDS */}<Footer><MergeSupportedFieldsByIntegrationWidget requestType=\"GET\" data=\"H4sIAAAAAAAAA+1dbVPbSBL+Ky59uqMAhxCWQNXVFbEBG7BxjMltsrWlGkttefBII0YjwGztf78avRizAeKXHnkEfEosy4+E5lF3T/fTM39ZDpHgcTG29q2hoJG1bvncBWbtW4d+yPgYwFq3SEjbxIfsHPvmo7VuRXEYciHBPaLA3KghYGDtW1UfhAcbcUAHFNyqOr1KAwmeIJLyIKpOfrYxSH5nrVuMBiNwDxyHx4F8CSg9cYOkZ/7jo/o6kta6FZIokkPBY2/YhesYohcx1f0w8CGQhG24RJLq1O83RArw1DF15y4wkODWiSR1kOCoPzG71lDKMNqvVofAws3"
        }
      ]
    }
  ],
  "bundled": true
}