Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Logo
Sign inBook a demo
API ReferenceEntityCustomization

Update

POST
https://api.mercoa.com/entity/:entityId/customization
POST
/entity/:entityId/customization
1curl -X POST https://api.mercoa.com/entity/ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced/customization \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "metadata": [
6    {
7      "key": "my_custom_field",
8      "disabled": true
9    },
10    {
11      "key": "my_other_field",
12      "disabled": false
13    }
14  ],
15  "paymentSource": [
16    {
17      "type": "bankAccount",
18      "disabled": true,
19      "defaultDeliveryMethod": "ACH_SAME_DAY"
20    },
21    {
22      "type": "custom",
23      "disabled": true,
24      "schemaId": "cpms_7df2974a-4069-454c-912f-7e58ebe030fb"
25    }
26  ],
27  "backupDisbursement": [
28    {
29      "type": "check",
30      "disabled": true,
31      "defaultDeliveryMethod": "MAIL",
32      "printDescription": true
33    }
34  ],
35  "paymentDestination": [
36    {
37      "type": "bankAccount",
38      "disabled": true,
39      "defaultDeliveryMethod": "ACH_SAME_DAY"
40    },
41    {
42      "type": "check",
43      "disabled": true,
44      "defaultDeliveryMethod": "MAIL",
45      "printDescription": true
46    }
47  ],
48  "ocr": {
49    "lineItems": true,
50    "collapseLineItems": true,
51    "invoiceMetadata": true,
52    "lineItemMetadata": true,
53    "lineItemGlAccountId": true,
54    "predictMetadata": true,
55    "taxAndShippingAsLineItems": true,
56    "splitDocuments": true
57  },
58  "notifications": {
59    "assumeRole": "admin"
60  },
61  "workflow": {
62    "autoAdvanceInvoiceStatus": true
63  },
64  "invoice": {
65    "hideAddress": false,
66    "hideQrCode": false,
67    "hideBankDetails": false,
68    "hidePaymentLink": false
69  },
70  "fees": {
71    "payable": {
72      "source": {
73        "ACH_STANDARD": {
74          "type": "flat",
75          "amount": 2.5
76        },
77        "ACH_SAME_DAY": {
78          "type": "percentage",
79          "amount": 2.5
80        },
81        "CHECK_PRINT": {
82          "type": "flat",
83          "amount": 2.5
84        },
85        "CHECK_MAIL": {
86          "type": "flat",
87          "amount": 2.5
88        },
89        "CHECK_MAIL_PRIORITY": {
90          "type": "flat",
91          "amount": 2.5
92        },
93        "CHECK_MAIL_UPS_NEXT_DAY": {
94          "type": "flat",
95          "amount": 2.5
96        }
97      },
98      "destination": {
99        "ACH_STANDARD": {
100          "type": "flat",
101          "amount": 2.5
102        },
103        "ACH_SAME_DAY": {
104          "type": "percentage",
105          "amount": 2.5
106        },
107        "CHECK_PRINT": {
108          "type": "flat",
109          "amount": 2.5
110        },
111        "CHECK_MAIL": {
112          "type": "flat",
113          "amount": 2.5
114        },
115        "CHECK_MAIL_PRIORITY": {
116          "type": "flat",
117          "amount": 2.5
118        },
119        "CHECK_MAIL_UPS_NEXT_DAY": {
120          "type": "flat",
121          "amount": 2.5
122        }
123      }
124    },
125    "receivable": {
126      "source": {
127        "ACH_STANDARD": {
128          "type": "flat",
129          "amount": 2.5
130        },
131        "ACH_SAME_DAY": {
132          "type": "percentage",
133          "amount": 2.5
134        },
135        "CHECK_PRINT": {
136          "type": "flat",
137          "amount": 2.5
138        },
139        "CHECK_MAIL": {
140          "type": "flat",
141          "amount": 2.5
142        },
143        "CHECK_MAIL_PRIORITY": {
144          "type": "flat",
145          "amount": 2.5
146        },
147        "CHECK_MAIL_UPS_NEXT_DAY": {
148          "type": "flat",
149          "amount": 2.5
150        }
151      },
152      "destination": {
153        "ACH_STANDARD": {
154          "type": "flat",
155          "amount": 2.5
156        },
157        "ACH_SAME_DAY": {
158          "type": "percentage",
159          "amount": 2.5
160        },
161        "CHECK_PRINT": {
162          "type": "flat",
163          "amount": 2.5
164        },
165        "CHECK_MAIL": {
166          "type": "flat",
167          "amount": 2.5
168        },
169        "CHECK_MAIL_PRIORITY": {
170          "type": "flat",
171          "amount": 2.5
172        },
173        "CHECK_MAIL_UPS_NEXT_DAY": {
174          "type": "flat",
175          "amount": 2.5
176        }
177      }
178    }
179  },
180  "rolePermissions": {
181    "admin": [
182      "invoice.all",
183      "paymentMethod.all"
184    ]
185  }
186}'
Try it
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    "splitDocuments": true
54  },
55  "notifications": {
56    "assumeRole": "admin"
57  },
58  "workflow": {
59    "autoAdvanceInvoiceStatus": true
60  },
61  "invoice": {
62    "hideAddress": false,
63    "hideQrCode": false,
64    "hideBankDetails": false,
65    "hidePaymentLink": false
66  },
67  "fees": {
68    "payable": {
69      "source": {
70        "ACH_STANDARD": {
71          "type": "flat",
72          "amount": 2.5
73        },
74        "ACH_SAME_DAY": {
75          "type": "percentage",
76          "amount": 2.5
77        },
78        "CHECK_PRINT": {
79          "type": "flat",
80          "amount": 2.5
81        },
82        "CHECK_MAIL": {
83          "type": "flat",
84          "amount": 2.5
85        },
86        "CHECK_MAIL_PRIORITY": {
87          "type": "flat",
88          "amount": 2.5
89        },
90        "CHECK_MAIL_UPS_NEXT_DAY": {
91          "type": "flat",
92          "amount": 2.5
93        }
94      },
95      "destination": {
96        "ACH_STANDARD": {
97          "type": "flat",
98          "amount": 2.5
99        },
100        "ACH_SAME_DAY": {
101          "type": "percentage",
102          "amount": 2.5
103        },
104        "CHECK_PRINT": {
105          "type": "flat",
106          "amount": 2.5
107        },
108        "CHECK_MAIL": {
109          "type": "flat",
110          "amount": 2.5
111        },
112        "CHECK_MAIL_PRIORITY": {
113          "type": "flat",
114          "amount": 2.5
115        },
116        "CHECK_MAIL_UPS_NEXT_DAY": {
117          "type": "flat",
118          "amount": 2.5
119        }
120      }
121    },
122    "receivable": {
123      "source": {
124        "ACH_STANDARD": {
125          "type": "flat",
126          "amount": 2.5
127        },
128        "ACH_SAME_DAY": {
129          "type": "percentage",
130          "amount": 2.5
131        },
132        "CHECK_PRINT": {
133          "type": "flat",
134          "amount": 2.5
135        },
136        "CHECK_MAIL": {
137          "type": "flat",
138          "amount": 2.5
139        },
140        "CHECK_MAIL_PRIORITY": {
141          "type": "flat",
142          "amount": 2.5
143        },
144        "CHECK_MAIL_UPS_NEXT_DAY": {
145          "type": "flat",
146          "amount": 2.5
147        }
148      },
149      "destination": {
150        "ACH_STANDARD": {
151          "type": "flat",
152          "amount": 2.5
153        },
154        "ACH_SAME_DAY": {
155          "type": "percentage",
156          "amount": 2.5
157        },
158        "CHECK_PRINT": {
159          "type": "flat",
160          "amount": 2.5
161        },
162        "CHECK_MAIL": {
163          "type": "flat",
164          "amount": 2.5
165        },
166        "CHECK_MAIL_PRIORITY": {
167          "type": "flat",
168          "amount": 2.5
169        },
170        "CHECK_MAIL_UPS_NEXT_DAY": {
171          "type": "flat",
172          "amount": 2.5
173        }
174      }
175    }
176  },
177  "rolePermissions": {
178    "admin": [
179      "invoice.all",
180      "paymentMethod.all"
181    ]
182  }
183}
Update entity customization. This lets you turn off metadata and payment methods for an entity.
Was this page helpful?
Previous

Get Documents

Next
Built with
Get Documents
Update entity customization. This lets you turn off metadata and payment methods for an entity.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityIdstringRequired
Entity ID or Entity ForeignID

Request

This endpoint expects an object.
metadatalist of objectsOptional
paymentSourcelist of objectsOptional
backupDisbursementlist of objectsOptional
paymentDestinationlist of objectsOptional
ocrobjectOptional
notificationsobjectOptional
workflowobjectOptional
invoiceobjectOptional
feesobjectOptional
rolePermissionsmap from strings to lists of enumsOptional

Response

This endpoint returns an object.
metadatalist of objects
paymentSourcelist of objects
backupDisbursementlist of objects
paymentDestinationlist of objects
ocrobject
notificationsobject
workflowobject
invoiceobject
feesobject
rolePermissionsmap from strings to lists of enums

Errors