Update

POST

https://api.mercoa.com/entity/:entityId/customization

POST

/entity/:entityId/customization

1 from mercoa import Mercoa
2 from mercoa.customization_types import (
3     FeeCustomizationDetailRequest,
4     FeeCustomizationRailRequest,
5     FeeCustomizationRequest,
6     InvoiceCustomizationRequest,
7     MetadataCustomizationRequest,
8     NotificationCustomizationRequest,
9     OcrCustomizationRequest,
10     PaymentMethodCustomizationRequest_BankAccount,
11     PaymentMethodCustomizationRequest_Check,
12     PaymentMethodCustomizationRequest_Custom,
13     PaymentMethodFee_Flat,
14     PaymentMethodFee_Percentage,
15     WorkflowCustomizationRequest,
16 )
17 from mercoa.entity_types import EntityCustomizationRequest
18 
19 client = Mercoa(
20     token="YOUR_TOKEN",
21 )
22 client.entity.customization.update(
23     entity_id="ent_a0f6ea94-0761-4a5e-a416-3c453cb7eced",
24     request=EntityCustomizationRequest(
25         metadata=[
26             MetadataCustomizationRequest(
27                 key="my_custom_field",
28                 disabled=True,
29             ),
30             MetadataCustomizationRequest(
31                 key="my_other_field",
32                 disabled=False,
33             ),
34         ],
35         payment_source=[
36             PaymentMethodCustomizationRequest_BankAccount(
37                 disabled=True,
38                 default_delivery_method="ACH_SAME_DAY",
39             ),
40             PaymentMethodCustomizationRequest_Custom(
41                 schema_id="cpms_7df2974a-4069-454c-912f-7e58ebe030fb",
42                 disabled=True,
43             ),
44         ],
45         backup_disbursement=[
46             PaymentMethodCustomizationRequest_Check(
47                 disabled=True,
48                 default_delivery_method="MAIL",
49                 print_description=True,
50             )
51         ],
52         payment_destination=[
53             PaymentMethodCustomizationRequest_BankAccount(
54                 disabled=True,
55                 default_delivery_method="ACH_SAME_DAY",
56             ),
57             PaymentMethodCustomizationRequest_Check(
58                 disabled=True,
59                 default_delivery_method="MAIL",
60                 print_description=True,
61             ),
62         ],
63         ocr=OcrCustomizationRequest(
64             line_items=True,
65             collapse_line_items=True,
66             invoice_metadata=True,
67             line_item_metadata=True,
68             line_item_gl_account_id=True,
69             predict_metadata=True,
70             tax_and_shipping_as_line_items=True,
71             split_documents=True,
72         ),
73         notifications=NotificationCustomizationRequest(
74             assume_role="admin",
75         ),
76         workflow=WorkflowCustomizationRequest(
77             auto_advance_invoice_status=True,
78         ),
79         invoice=InvoiceCustomizationRequest(
80             hide_address=False,
81             hide_qr_code=False,
82             hide_bank_details=False,
83             hide_payment_link=False,
84         ),
85         role_permissions={"admin": ["invoice.all", "paymentMethod.all"]},
86         fees=FeeCustomizationRequest(
87             payable=FeeCustomizationDetailRequest(
88                 source=FeeCustomizationRailRequest(
89                     ach_standard=PaymentMethodFee_Flat(
90                         amount=2.5,
91                     ),
92                     ach_same_day=PaymentMethodFee_Percentage(
93                         amount=2.5,
94                     ),
95                     check_print=PaymentMethodFee_Flat(
96                         amount=2.5,
97                     ),
98                     check_mail=PaymentMethodFee_Flat(
99                         amount=2.5,
100                     ),
101                     check_mail_priority=PaymentMethodFee_Flat(
102                         amount=2.5,
103                     ),
104                     check_mail_ups_next_day=PaymentMethodFee_Flat(
105                         amount=2.5,
106                     ),
107                 ),
108                 destination=FeeCustomizationRailRequest(
109                     ach_standard=PaymentMethodFee_Flat(
110                         amount=2.5,
111                     ),
112                     ach_same_day=PaymentMethodFee_Percentage(
113                         amount=2.5,
114                     ),
115                     check_print=PaymentMethodFee_Flat(
116                         amount=2.5,
117                     ),
118                     check_mail=PaymentMethodFee_Flat(
119                         amount=2.5,
120                     ),
121                     check_mail_priority=PaymentMethodFee_Flat(
122                         amount=2.5,
123                     ),
124                     check_mail_ups_next_day=PaymentMethodFee_Flat(
125                         amount=2.5,
126                     ),
127                 ),
128             ),
129             receivable=FeeCustomizationDetailRequest(
130                 source=FeeCustomizationRailRequest(
131                     ach_standard=PaymentMethodFee_Flat(
132                         amount=2.5,
133                     ),
134                     ach_same_day=PaymentMethodFee_Percentage(
135                         amount=2.5,
136                     ),
137                     check_print=PaymentMethodFee_Flat(
138                         amount=2.5,
139                     ),
140                     check_mail=PaymentMethodFee_Flat(
141                         amount=2.5,
142                     ),
143                     check_mail_priority=PaymentMethodFee_Flat(
144                         amount=2.5,
145                     ),
146                     check_mail_ups_next_day=PaymentMethodFee_Flat(
147                         amount=2.5,
148                     ),
149                 ),
150                 destination=FeeCustomizationRailRequest(
151                     ach_standard=PaymentMethodFee_Flat(
152                         amount=2.5,
153                     ),
154                     ach_same_day=PaymentMethodFee_Percentage(
155                         amount=2.5,
156                     ),
157                     check_print=PaymentMethodFee_Flat(
158                         amount=2.5,
159                     ),
160                     check_mail=PaymentMethodFee_Flat(
161                         amount=2.5,
162                     ),
163                     check_mail_priority=PaymentMethodFee_Flat(
164                         amount=2.5,
165                     ),
166                     check_mail_ups_next_day=PaymentMethodFee_Flat(
167                         amount=2.5,
168                     ),
169                 ),
170             ),
171         ),
172     ),
173 )

Try it

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.

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

Authentication

Path parameters

Request

Response

Errors