/remote-fields

GET

/accounting/v1/remote-fields

GET

/api/accounting/v1/remote-fields

$ curl https://api.merge.dev/api/accounting/v1/remote-fields \
>      -H "X-Account-Token: X-Account-Token" \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "Account": [
3     {
4       "schema": {
5         "type": "string"
6       },
7       "remote_key_name": "example_remote_key_name",
8       "remote_endpoint_info": {
9         "method": "GET",
10         "url_path": "/example-url-path",
11         "field_traversal_path": [
12           "example_key_name"
13         ]
14       },
15       "advanced_metadata": {
16         "id": "string",
17         "display_name": "string",
18         "description": "string",
19         "is_required": true,
20         "is_custom": true,
21         "field_choices": [
22           null
23         ]
24       },
25       "example_values": [
26         "example"
27       ],
28       "coverage": 0.33
29     }
30   ],
31   "AccountingAttachment": [
32     {
33       "schema": {
34         "type": "string"
35       },
36       "remote_key_name": "example_remote_key_name",
37       "remote_endpoint_info": {
38         "method": "GET",
39         "url_path": "/example-url-path",
40         "field_traversal_path": [
41           "example_key_name"
42         ]
43       },
44       "advanced_metadata": {
45         "id": "string",
46         "display_name": "string",
47         "description": "string",
48         "is_required": true,
49         "is_custom": true,
50         "field_choices": [
51           null
52         ]
53       },
54       "example_values": [
55         "example"
56       ],
57       "coverage": 0.33
58     }
59   ],
60   "BalanceSheet": [
61     {
62       "schema": {
63         "type": "string"
64       },
65       "remote_key_name": "example_remote_key_name",
66       "remote_endpoint_info": {
67         "method": "GET",
68         "url_path": "/example-url-path",
69         "field_traversal_path": [
70           "example_key_name"
71         ]
72       },
73       "advanced_metadata": {
74         "id": "string",
75         "display_name": "string",
76         "description": "string",
77         "is_required": true,
78         "is_custom": true,
79         "field_choices": [
80           null
81         ]
82       },
83       "example_values": [
84         "example"
85       ],
86       "coverage": 0.33
87     }
88   ],
89   "CashFlowStatement": [
90     {
91       "schema": {
92         "type": "string"
93       },
94       "remote_key_name": "example_remote_key_name",
95       "remote_endpoint_info": {
96         "method": "GET",
97         "url_path": "/example-url-path",
98         "field_traversal_path": [
99           "example_key_name"
100         ]
101       },
102       "advanced_metadata": {
103         "id": "string",
104         "display_name": "string",
105         "description": "string",
106         "is_required": true,
107         "is_custom": true,
108         "field_choices": [
109           null
110         ]
111       },
112       "example_values": [
113         "example"
114       ],
115       "coverage": 0.33
116     }
117   ],
118   "CompanyInfo": [
119     {
120       "schema": {
121         "type": "string"
122       },
123       "remote_key_name": "example_remote_key_name",
124       "remote_endpoint_info": {
125         "method": "GET",
126         "url_path": "/example-url-path",
127         "field_traversal_path": [
128           "example_key_name"
129         ]
130       },
131       "advanced_metadata": {
132         "id": "string",
133         "display_name": "string",
134         "description": "string",
135         "is_required": true,
136         "is_custom": true,
137         "field_choices": [
138           null
139         ]
140       },
141       "example_values": [
142         "example"
143       ],
144       "coverage": 0.33
145     }
146   ],
147   "Contact": [
148     {
149       "schema": {
150         "type": "string"
151       },
152       "remote_key_name": "example_remote_key_name",
153       "remote_endpoint_info": {
154         "method": "GET",
155         "url_path": "/example-url-path",
156         "field_traversal_path": [
157           "example_key_name"
158         ]
159       },
160       "advanced_metadata": {
161         "id": "string",
162         "display_name": "string",
163         "description": "string",
164         "is_required": true,
165         "is_custom": true,
166         "field_choices": [
167           null
168         ]
169       },
170       "example_values": [
171         "example"
172       ],
173       "coverage": 0.33
174     }
175   ],
176   "IncomeStatement": [
177     {
178       "schema": {
179         "type": "string"
180       },
181       "remote_key_name": "example_remote_key_name",
182       "remote_endpoint_info": {
183         "method": "GET",
184         "url_path": "/example-url-path",
185         "field_traversal_path": [
186           "example_key_name"
187         ]
188       },
189       "advanced_metadata": {
190         "id": "string",
191         "display_name": "string",
192         "description": "string",
193         "is_required": true,
194         "is_custom": true,
195         "field_choices": [
196           null
197         ]
198       },
199       "example_values": [
200         "example"
201       ],
202       "coverage": 0.33
203     }
204   ],
205   "CreditNote": [
206     {
207       "schema": {
208         "type": "string"
209       },
210       "remote_key_name": "example_remote_key_name",
211       "remote_endpoint_info": {
212         "method": "GET",
213         "url_path": "/example-url-path",
214         "field_traversal_path": [
215           "example_key_name"
216         ]
217       },
218       "advanced_metadata": {
219         "id": "string",
220         "display_name": "string",
221         "description": "string",
222         "is_required": true,
223         "is_custom": true,
224         "field_choices": [
225           null
226         ]
227       },
228       "example_values": [
229         "example"
230       ],
231       "coverage": 0.33
232     }
233   ],
234   "Item": [
235     {
236       "schema": {
237         "type": "string"
238       },
239       "remote_key_name": "example_remote_key_name",
240       "remote_endpoint_info": {
241         "method": "GET",
242         "url_path": "/example-url-path",
243         "field_traversal_path": [
244           "example_key_name"
245         ]
246       },
247       "advanced_metadata": {
248         "id": "string",
249         "display_name": "string",
250         "description": "string",
251         "is_required": true,
252         "is_custom": true,
253         "field_choices": [
254           null
255         ]
256       },
257       "example_values": [
258         "example"
259       ],
260       "coverage": 0.33
261     }
262   ],
263   "PurchaseOrder": [
264     {
265       "schema": {
266         "type": "string"
267       },
268       "remote_key_name": "example_remote_key_name",
269       "remote_endpoint_info": {
270         "method": "GET",
271         "url_path": "/example-url-path",
272         "field_traversal_path": [
273           "example_key_name"
274         ]
275       },
276       "advanced_metadata": {
277         "id": "string",
278         "display_name": "string",
279         "description": "string",
280         "is_required": true,
281         "is_custom": true,
282         "field_choices": [
283           null
284         ]
285       },
286       "example_values": [
287         "example"
288       ],
289       "coverage": 0.33
290     }
291   ],
292   "SalesOrder": [
293     {
294       "schema": {
295         "type": "string"
296       },
297       "remote_key_name": "example_remote_key_name",
298       "remote_endpoint_info": {
299         "method": "GET",
300         "url_path": "/example-url-path",
301         "field_traversal_path": [
302           "example_key_name"
303         ]
304       },
305       "advanced_metadata": {
306         "id": "string",
307         "display_name": "string",
308         "description": "string",
309         "is_required": true,
310         "is_custom": true,
311         "field_choices": [
312           null
313         ]
314       },
315       "example_values": [
316         "example"
317       ],
318       "coverage": 0.33
319     }
320   ],
321   "ItemFulfillment": [
322     {
323       "schema": {
324         "type": "string"
325       },
326       "remote_key_name": "example_remote_key_name",
327       "remote_endpoint_info": {
328         "method": "GET",
329         "url_path": "/example-url-path",
330         "field_traversal_path": [
331           "example_key_name"
332         ]
333       },
334       "advanced_metadata": {
335         "id": "string",
336         "display_name": "string",
337         "description": "string",
338         "is_required": true,
339         "is_custom": true,
340         "field_choices": [
341           null
342         ]
343       },
344       "example_values": [
345         "example"
346       ],
347       "coverage": 0.33
348     }
349   ],
350   "ExpenseReport": [
351     {
352       "schema": {
353         "type": "string"
354       },
355       "remote_key_name": "example_remote_key_name",
356       "remote_endpoint_info": {
357         "method": "GET",
358         "url_path": "/example-url-path",
359         "field_traversal_path": [
360           "example_key_name"
361         ]
362       },
363       "advanced_metadata": {
364         "id": "string",
365         "display_name": "string",
366         "description": "string",
367         "is_required": true,
368         "is_custom": true,
369         "field_choices": [
370           null
371         ]
372       },
373       "example_values": [
374         "example"
375       ],
376       "coverage": 0.33
377     }
378   ],
379   "TrackingCategory": [
380     {
381       "schema": {
382         "type": "string"
383       },
384       "remote_key_name": "example_remote_key_name",
385       "remote_endpoint_info": {
386         "method": "GET",
387         "url_path": "/example-url-path",
388         "field_traversal_path": [
389           "example_key_name"
390         ]
391       },
392       "advanced_metadata": {
393         "id": "string",
394         "display_name": "string",
395         "description": "string",
396         "is_required": true,
397         "is_custom": true,
398         "field_choices": [
399           null
400         ]
401       },
402       "example_values": [
403         "example"
404       ],
405       "coverage": 0.33
406     }
407   ],
408   "JournalEntry": [
409     {
410       "schema": {
411         "type": "string"
412       },
413       "remote_key_name": "example_remote_key_name",
414       "remote_endpoint_info": {
415         "method": "GET",
416         "url_path": "/example-url-path",
417         "field_traversal_path": [
418           "example_key_name"
419         ]
420       },
421       "advanced_metadata": {
422         "id": "string",
423         "display_name": "string",
424         "description": "string",
425         "is_required": true,
426         "is_custom": true,
427         "field_choices": [
428           null
429         ]
430       },
431       "example_values": [
432         "example"
433       ],
434       "coverage": 0.33
435     }
436   ],
437   "TaxRate": [
438     {
439       "schema": {
440         "type": "string"
441       },
442       "remote_key_name": "example_remote_key_name",
443       "remote_endpoint_info": {
444         "method": "GET",
445         "url_path": "/example-url-path",
446         "field_traversal_path": [
447           "example_key_name"
448         ]
449       },
450       "advanced_metadata": {
451         "id": "string",
452         "display_name": "string",
453         "description": "string",
454         "is_required": true,
455         "is_custom": true,
456         "field_choices": [
457           null
458         ]
459       },
460       "example_values": [
461         "example"
462       ],
463       "coverage": 0.33
464     }
465   ],
466   "Invoice": [
467     {
468       "schema": {
469         "type": "string"
470       },
471       "remote_key_name": "example_remote_key_name",
472       "remote_endpoint_info": {
473         "method": "GET",
474         "url_path": "/example-url-path",
475         "field_traversal_path": [
476           "example_key_name"
477         ]
478       },
479       "advanced_metadata": {
480         "id": "string",
481         "display_name": "string",
482         "description": "string",
483         "is_required": true,
484         "is_custom": true,
485         "field_choices": [
486           null
487         ]
488       },
489       "example_values": [
490         "example"
491       ],
492       "coverage": 0.33
493     }
494   ],
495   "Payment": [
496     {
497       "schema": {
498         "type": "string"
499       },
500       "remote_key_name": "example_remote_key_name",
501       "remote_endpoint_info": {
502         "method": "GET",
503         "url_path": "/example-url-path",
504         "field_traversal_path": [
505           "example_key_name"
506         ]
507       },
508       "advanced_metadata": {
509         "id": "string",
510         "display_name": "string",
511         "description": "string",
512         "is_required": true,
513         "is_custom": true,
514         "field_choices": [
515           null
516         ]
517       },
518       "example_values": [
519         "example"
520       ],
521       "coverage": 0.33
522     }
523   ],
524   "Expense": [
525     {
526       "schema": {
527         "type": "string"
528       },
529       "remote_key_name": "example_remote_key_name",
530       "remote_endpoint_info": {
531         "method": "GET",
532         "url_path": "/example-url-path",
533         "field_traversal_path": [
534           "example_key_name"
535         ]
536       },
537       "advanced_metadata": {
538         "id": "string",
539         "display_name": "string",
540         "description": "string",
541         "is_required": true,
542         "is_custom": true,
543         "field_choices": [
544           null
545         ]
546       },
547       "example_values": [
548         "example"
549       ],
550       "coverage": 0.33
551     }
552   ],
553   "VendorCredit": [
554     {
555       "schema": {
556         "type": "string"
557       },
558       "remote_key_name": "example_remote_key_name",
559       "remote_endpoint_info": {
560         "method": "GET",
561         "url_path": "/example-url-path",
562         "field_traversal_path": [
563           "example_key_name"
564         ]
565       },
566       "advanced_metadata": {
567         "id": "string",
568         "display_name": "string",
569         "description": "string",
570         "is_required": true,
571         "is_custom": true,
572         "field_choices": [
573           null
574         ]
575       },
576       "example_values": [
577         "example"
578       ],
579       "coverage": 0.33
580     }
581   ],
582   "Transaction": [
583     {
584       "schema": {
585         "type": "string"
586       },
587       "remote_key_name": "example_remote_key_name",
588       "remote_endpoint_info": {
589         "method": "GET",
590         "url_path": "/example-url-path",
591         "field_traversal_path": [
592           "example_key_name"
593         ]
594       },
595       "advanced_metadata": {
596         "id": "string",
597         "display_name": "string",
598         "description": "string",
599         "is_required": true,
600         "is_custom": true,
601         "field_choices": [
602           null
603         ]
604       },
605       "example_values": [
606         "example"
607       ],
608       "coverage": 0.33
609     }
610   ],
611   "AccountingPeriod": [
612     {
613       "schema": {
614         "type": "string"
615       },
616       "remote_key_name": "example_remote_key_name",
617       "remote_endpoint_info": {
618         "method": "GET",
619         "url_path": "/example-url-path",
620         "field_traversal_path": [
621           "example_key_name"
622         ]
623       },
624       "advanced_metadata": {
625         "id": "string",
626         "display_name": "string",
627         "description": "string",
628         "is_required": true,
629         "is_custom": true,
630         "field_choices": [
631           null
632         ]
633       },
634       "example_values": [
635         "example"
636       ],
637       "coverage": 0.33
638     }
639   ],
640   "GeneralLedgerTransaction": [
641     {
642       "schema": {
643         "type": "string"
644       },
645       "remote_key_name": "example_remote_key_name",
646       "remote_endpoint_info": {
647         "method": "GET",
648         "url_path": "/example-url-path",
649         "field_traversal_path": [
650           "example_key_name"
651         ]
652       },
653       "advanced_metadata": {
654         "id": "string",
655         "display_name": "string",
656         "description": "string",
657         "is_required": true,
658         "is_custom": true,
659         "field_choices": [
660           null
661         ]
662       },
663       "example_values": [
664         "example"
665       ],
666       "coverage": 0.33
667     }
668   ],
669   "BankFeedAccount": [
670     {
671       "schema": {
672         "type": "string"
673       },
674       "remote_key_name": "example_remote_key_name",
675       "remote_endpoint_info": {
676         "method": "GET",
677         "url_path": "/example-url-path",
678         "field_traversal_path": [
679           "example_key_name"
680         ]
681       },
682       "advanced_metadata": {
683         "id": "string",
684         "display_name": "string",
685         "description": "string",
686         "is_required": true,
687         "is_custom": true,
688         "field_choices": [
689           null
690         ]
691       },
692       "example_values": [
693         "example"
694       ],
695       "coverage": 0.33
696     }
697   ],
698   "Employee": [
699     {
700       "schema": {
701         "type": "string"
702       },
703       "remote_key_name": "example_remote_key_name",
704       "remote_endpoint_info": {
705         "method": "GET",
706         "url_path": "/example-url-path",
707         "field_traversal_path": [
708           "example_key_name"
709         ]
710       },
711       "advanced_metadata": {
712         "id": "string",
713         "display_name": "string",
714         "description": "string",
715         "is_required": true,
716         "is_custom": true,
717         "field_choices": [
718           null
719         ]
720       },
721       "example_values": [
722         "example"
723       ],
724       "coverage": 0.33
725     }
726   ],
727   "PaymentMethod": [
728     {
729       "schema": {
730         "type": "string"
731       },
732       "remote_key_name": "example_remote_key_name",
733       "remote_endpoint_info": {
734         "method": "GET",
735         "url_path": "/example-url-path",
736         "field_traversal_path": [
737           "example_key_name"
738         ]
739       },
740       "advanced_metadata": {
741         "id": "string",
742         "display_name": "string",
743         "description": "string",
744         "is_required": true,
745         "is_custom": true,
746         "field_choices": [
747           null
748         ]
749       },
750       "example_values": [
751         "example"
752       ],
753       "coverage": 0.33
754     }
755   ],
756   "Project": [
757     {
758       "schema": {
759         "type": "string"
760       },
761       "remote_key_name": "example_remote_key_name",
762       "remote_endpoint_info": {
763         "method": "GET",
764         "url_path": "/example-url-path",
765         "field_traversal_path": [
766           "example_key_name"
767         ]
768       },
769       "advanced_metadata": {
770         "id": "string",
771         "display_name": "string",
772         "description": "string",
773         "is_required": true,
774         "is_custom": true,
775         "field_choices": [
776           null
777         ]
778       },
779       "example_values": [
780         "example"
781       ],
782       "coverage": 0.33
783     }
784   ],
785   "PaymentTerm": [
786     {
787       "schema": {
788         "type": "string"
789       },
790       "remote_key_name": "example_remote_key_name",
791       "remote_endpoint_info": {
792         "method": "GET",
793         "url_path": "/example-url-path",
794         "field_traversal_path": [
795           "example_key_name"
796         ]
797       },
798       "advanced_metadata": {
799         "id": "string",
800         "display_name": "string",
801         "description": "string",
802         "is_required": true,
803         "is_custom": true,
804         "field_choices": [
805           null
806         ]
807       },
808       "example_values": [
809         "example"
810       ],
811       "coverage": 0.33
812     }
813   ]
814 }

Get all remote fields for a Linked Account. Remote fields are third-party fields that are accessible after initial sync if remote_data is enabled. You can use remote fields to override existing Merge fields or map a new Merge field. Learn more.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

common_modelsstringOptional

A comma seperated list of Common Model names. If included, will only return Remote Fields for those Common Models.

include_example_valuesstringOptional

If true, will include example values, where available, for remote fields in the 3rd party platform. These examples come from active data from your customers.

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

Query parameters

Response