/target-fields

POST

/hris/v1/target-fields

POST

/api/hris/v1/target-fields

$ curl -X POST https://api.merge.dev/api/hris/v1/target-fields \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "employee_favorite_team",
>   "common_model": "Employee"
> }'

200Successful

1 {
2   "Benefit": [
3     {
4       "name": "example_target_field_name",
5       "description": "this is a example description of a target field",
6       "is_mapped": "true"
7     }
8   ],
9   "EmployerBenefit": [
10     {
11       "name": "example_target_field_name",
12       "description": "this is a example description of a target field",
13       "is_mapped": "true"
14     }
15   ],
16   "Company": [
17     {
18       "name": "example_target_field_name",
19       "description": "this is a example description of a target field",
20       "is_mapped": "true"
21     }
22   ],
23   "EmployeePayrollRun": [
24     {
25       "name": "example_target_field_name",
26       "description": "this is a example description of a target field",
27       "is_mapped": "true"
28     }
29   ],
30   "Employee": [
31     {
32       "name": "example_target_field_name",
33       "description": "this is a example description of a target field",
34       "is_mapped": "true"
35     }
36   ],
37   "Employment": [
38     {
39       "name": "example_target_field_name",
40       "description": "this is a example description of a target field",
41       "is_mapped": "true"
42     }
43   ],
44   "Location": [
45     {
46       "name": "example_target_field_name",
47       "description": "this is a example description of a target field",
48       "is_mapped": "true"
49     }
50   ],
51   "PayrollRun": [
52     {
53       "name": "example_target_field_name",
54       "description": "this is a example description of a target field",
55       "is_mapped": "true"
56     }
57   ],
58   "Team": [
59     {
60       "name": "example_target_field_name",
61       "description": "this is a example description of a target field",
62       "is_mapped": "true"
63     }
64   ],
65   "TimeOff": [
66     {
67       "name": "example_target_field_name",
68       "description": "this is a example description of a target field",
69       "is_mapped": "true"
70     }
71   ],
72   "TimeOffBalance": [
73     {
74       "name": "example_target_field_name",
75       "description": "this is a example description of a target field",
76       "is_mapped": "true"
77     }
78   ],
79   "BankInfo": [
80     {
81       "name": "example_target_field_name",
82       "description": "this is a example description of a target field",
83       "is_mapped": "true"
84     }
85   ],
86   "PayGroup": [
87     {
88       "name": "example_target_field_name",
89       "description": "this is a example description of a target field",
90       "is_mapped": "true"
91     }
92   ],
93   "Group": [
94     {
95       "name": "example_target_field_name",
96       "description": "this is a example description of a target field",
97       "is_mapped": "true"
98     }
99   ],
100   "Dependent": [
101     {
102       "name": "example_target_field_name",
103       "description": "this is a example description of a target field",
104       "is_mapped": "true"
105     }
106   ],
107   "TimesheetEntry": [
108     {
109       "name": "example_target_field_name",
110       "description": "this is a example description of a target field",
111       "is_mapped": "true"
112     }
113   ]
114 }

Create a new organization-wide Target Field. Target Fields are custom fields that your organization defines to collect supplemental data from integrations. Learn more.

Create a new organization-wide Target Field. Target Fields are custom fields that your organization defines to collect supplemental data from integrations. [Learn more](https://docs.merge.dev/supplemental-data/field-mappings/target-fields/).

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Request

This endpoint expects an object.

namestringRequired>=1 character

The name of the target field.

common_modelstringRequired>=1 character

The name of the Common Model to associate the target field with.

descriptionstringOptional>=1 characterDefaults to

The description of the target field.

Response

Benefitlist of objectsOptional

EmployerBenefitlist of objectsOptional

Companylist of objectsOptional

EmployeePayrollRunlist of objectsOptional

Employeelist of objectsOptional

Employmentlist of objectsOptional

Locationlist of objectsOptional

PayrollRunlist of objectsOptional

Teamlist of objectsOptional

TimeOfflist of objectsOptional

TimeOffBalancelist of objectsOptional

BankInfolist of objectsOptional

PayGrouplist of objectsOptional

Grouplist of objectsOptional

Dependentlist of objectsOptional

TimesheetEntrylist of objectsOptional

Authentication

Headers

Request

Response