Get

GET

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.entity.customization.get(
7     entity_id="ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
8 )

Play

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       "defaultDeliveryMethod": "ACH_SAME_DAY"
17     },
18     {
19       "type": "custom",
20       "disabled": true,
21       "schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
22     }
23   ],
24   "backupDisbursement": [
25     {
26       "type": "check",
27       "disabled": true,
28       "defaultDeliveryMethod": "MAIL",
29       "printDescription": true
30     }
31   ],
32   "paymentDestination": [
33     {
34       "type": "bankAccount",
35       "disabled": true,
36       "defaultDeliveryMethod": "ACH_SAME_DAY"
37     },
38     {
39       "type": "check",
40       "disabled": true,
41       "defaultDeliveryMethod": "MAIL",
42       "printDescription": true
43     }
44   ],
45   "ocr": {
46     "lineItems": true,
47     "collapseLineItems": true,
48     "invoiceMetadata": true,
49     "lineItemMetadata": true,
50     "lineItemGlAccountId": true,
51     "predictMetadata": true,
52     "taxAndShippingAsLineItems": true
53   },
54   "notifications": {
55     "assumeRole": "admin"
56   },
57   "workflow": {
58     "autoAdvanceInvoiceStatus": true
59   },
60   "fees": {
61     "payable": {
62       "source": {
63         "ACH_STANDARD": {
64           "type": "flat",
65           "amount": 2.5
66         },
67         "ACH_SAME_DAY": {
68           "type": "percentage",
69           "amount": 2.5
70         },
71         "CHECK_PRINT": {
72           "type": "flat",
73           "amount": 2.5
74         },
75         "CHECK_MAIL": {
76           "type": "flat",
77           "amount": 2.5
78         }
79       },
80       "destination": {
81         "ACH_STANDARD": {
82           "type": "flat",
83           "amount": 2.5
84         },
85         "ACH_SAME_DAY": {
86           "type": "percentage",
87           "amount": 2.5
88         },
89         "CHECK_PRINT": {
90           "type": "flat",
91           "amount": 2.5
92         },
93         "CHECK_MAIL": {
94           "type": "flat",
95           "amount": 2.5
96         }
97       }
98     },
99     "receivable": {
100       "source": {
101         "ACH_STANDARD": {
102           "type": "flat",
103           "amount": 2.5
104         },
105         "ACH_SAME_DAY": {
106           "type": "percentage",
107           "amount": 2.5
108         },
109         "CHECK_PRINT": {
110           "type": "flat",
111           "amount": 2.5
112         },
113         "CHECK_MAIL": {
114           "type": "flat",
115           "amount": 2.5
116         }
117       },
118       "destination": {
119         "ACH_STANDARD": {
120           "type": "flat",
121           "amount": 2.5
122         },
123         "ACH_SAME_DAY": {
124           "type": "percentage",
125           "amount": 2.5
126         },
127         "CHECK_PRINT": {
128           "type": "flat",
129           "amount": 2.5
130         },
131         "CHECK_MAIL": {
132           "type": "flat",
133           "amount": 2.5
134         }
135       }
136     }
137   },
138   "rolePermissions": {
139     "admin": [
140       "invoice.all",
141       "paymentMethod.all"
142     ]
143   }
144 }

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

feesobject

rolePermissionsmap from strings to lists of enums

Get

Path parameters

Headers

Response

Errors