Update

POST

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

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 }

Update entity customization. This lets you turn off metadata and payment methods for an entity.

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

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

feesobject

rolePermissionsmap from strings to lists of enums

Update

Path parameters

Headers

Request

Response

Errors