/target-fields

POST

/accounting/v1/target-fields

POST

/api/accounting/v1/target-fields

$ curl -X POST https://api.merge.dev/api/accounting/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   "Account": [
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   "AccountingAttachment": [
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   "BalanceSheet": [
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   "CashFlowStatement": [
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   "CompanyInfo": [
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   "Contact": [
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   "IncomeStatement": [
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   "CreditNote": [
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   "Item": [
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   "PurchaseOrder": [
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   "SalesOrder": [
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   "ItemFulfillment": [
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   "ExpenseReport": [
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   "TrackingCategory": [
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   "JournalEntry": [
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   "TaxRate": [
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   "Invoice": [
115     {
116       "name": "example_target_field_name",
117       "description": "this is a example description of a target field",
118       "is_mapped": "true"
119     }
120   ],
121   "Payment": [
122     {
123       "name": "example_target_field_name",
124       "description": "this is a example description of a target field",
125       "is_mapped": "true"
126     }
127   ],
128   "Expense": [
129     {
130       "name": "example_target_field_name",
131       "description": "this is a example description of a target field",
132       "is_mapped": "true"
133     }
134   ],
135   "VendorCredit": [
136     {
137       "name": "example_target_field_name",
138       "description": "this is a example description of a target field",
139       "is_mapped": "true"
140     }
141   ],
142   "Transaction": [
143     {
144       "name": "example_target_field_name",
145       "description": "this is a example description of a target field",
146       "is_mapped": "true"
147     }
148   ],
149   "AccountingPeriod": [
150     {
151       "name": "example_target_field_name",
152       "description": "this is a example description of a target field",
153       "is_mapped": "true"
154     }
155   ],
156   "GeneralLedgerTransaction": [
157     {
158       "name": "example_target_field_name",
159       "description": "this is a example description of a target field",
160       "is_mapped": "true"
161     }
162   ],
163   "BankFeedAccount": [
164     {
165       "name": "example_target_field_name",
166       "description": "this is a example description of a target field",
167       "is_mapped": "true"
168     }
169   ],
170   "Employee": [
171     {
172       "name": "example_target_field_name",
173       "description": "this is a example description of a target field",
174       "is_mapped": "true"
175     }
176   ],
177   "PaymentMethod": [
178     {
179       "name": "example_target_field_name",
180       "description": "this is a example description of a target field",
181       "is_mapped": "true"
182     }
183   ],
184   "Project": [
185     {
186       "name": "example_target_field_name",
187       "description": "this is a example description of a target field",
188       "is_mapped": "true"
189     }
190   ],
191   "PaymentTerm": [
192     {
193       "name": "example_target_field_name",
194       "description": "this is a example description of a target field",
195       "is_mapped": "true"
196     }
197   ]
198 }

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

Accountlist of objectsOptional

AccountingAttachmentlist of objectsOptional

BalanceSheetlist of objectsOptional

CashFlowStatementlist of objectsOptional

CompanyInfolist of objectsOptional

Contactlist of objectsOptional

IncomeStatementlist of objectsOptional

CreditNotelist of objectsOptional

Itemlist of objectsOptional

PurchaseOrderlist of objectsOptional

SalesOrderlist of objectsOptional

ItemFulfillmentlist of objectsOptional

ExpenseReportlist of objectsOptional

TrackingCategorylist of objectsOptional

JournalEntrylist of objectsOptional

TaxRatelist of objectsOptional

Invoicelist of objectsOptional

Paymentlist of objectsOptional

Expenselist of objectsOptional

VendorCreditlist of objectsOptional

Transactionlist of objectsOptional

AccountingPeriodlist of objectsOptional

GeneralLedgerTransactionlist of objectsOptional

BankFeedAccountlist of objectsOptional

Employeelist of objectsOptional

PaymentMethodlist of objectsOptional

Projectlist of objectsOptional

PaymentTermlist of objectsOptional

Authentication

Headers

Request

Response