Get

GET

Get entity customization.

Path parameters

entityIdstringRequired

Entity ID or Entity ForeignID

Response

This endpoint returns an object.

metadatalist of objects

paymentSourcelist of objects

backupDisbursementlist of objects

paymentDestinationlist of objects

ocrobject

notificationsobject

workflowobject

GET

1 curl https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/customization \
2      -H "Authorization: Bearer <token>"

200Default

1 {
2   "metadata": [
3     {
4       "key": "my_custom_field",
5       "disabled": true
6     },
7     {
8       "key": "my_other_field",
9       "disabled": false
10     }
11   ],
12   "paymentSource": [
13     {
14       "type": "bankAccount",
15       "disabled": true
16     },
17     {
18       "type": "custom",
19       "disabled": true,
20       "schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
21     }
22   ],
23   "backupDisbursement": [
24     {
25       "type": "check",
26       "disabled": true
27     }
28   ],
29   "paymentDestination": [
30     {
31       "type": "bankAccount",
32       "disabled": true
33     },
34     {
35       "type": "check",
36       "disabled": true
37     }
38   ],
39   "ocr": {
40     "lineItems": true,
41     "invoiceMetadata": true,
42     "lineItemMetadata": true,
43     "lineItemGlAccountId": true,
44     "predictMetadata": true,
45     "taxAndShippingAsLineItems": true
46   },
47   "notifications": {
48     "assumeRole": "admin"
49   },
50   "workflow": {
51     "autoAdvanceInvoiceStatus": true
52   }
53 }

Update

Up Next

Built with

1	curl https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/customization \
2	-H "Authorization: Bearer <token>"

1	{
2	"metadata": [
3	{
4	"key": "my_custom_field",
5	"disabled": true
6	},
7	{
8	"key": "my_other_field",
9	"disabled": false
10	}
11	],
12	"paymentSource": [
13	{
14	"type": "bankAccount",
15	"disabled": true
16	},
17	{
18	"type": "custom",
19	"disabled": true,
20	"schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
21	}
22	],
23	"backupDisbursement": [
24	{
25	"type": "check",
26	"disabled": true
27	}
28	],
29	"paymentDestination": [
30	{
31	"type": "bankAccount",
32	"disabled": true
33	},
34	{
35	"type": "check",
36	"disabled": true
37	}
38	],
39	"ocr": {
40	"lineItems": true,
41	"invoiceMetadata": true,
42	"lineItemMetadata": true,
43	"lineItemGlAccountId": true,
44	"predictMetadata": true,
45	"taxAndShippingAsLineItems": true
46	},
47	"notifications": {
48	"assumeRole": "admin"
49	},
50	"workflow": {
51	"autoAdvanceInvoiceStatus": true
52	}
53	}