--- title: "Update" method: POST path: "/entity/{entityId}/customization" tags: ["entity > customization"] --- # Update `POST /entity/{entityId}/customization` ## Request - Base URL: `https://api.mercoa.com` - URL: `https://api.mercoa.com/entity/{entityId}/customization` - Auth: HTTP bearer Update entity customization. This lets you turn off metadata and payment methods for an entity. ## Path parameters - `entityId` string, required ## Request body - EntityTypesEntityCustomizationRequest - `metadata` CustomizationTypesMetadataCustomizationRequest[] - `key` string, required: The key of the metadata field. This must be defined at the organization level, otherwise an error will be returned. - `disabled` boolean, required: If true, this field will not be available to the entity. - `paymentSource` CustomizationTypesPaymentMethodCustomizationRequest[] - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED' - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[]: The delivery methods that are available for this payment method. - `originatingCompanyName` 'ENTITY_NAME' | 'BANK_NAME' - object - `type` 'card', required: Discriminator value: card - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'check', required: Discriminator value: check - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY' - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[]: The delivery methods that are available for this payment method. - `printDescription` boolean: If true, the check will be printed with the description. - object - `type` 'custom', required: Discriminator value: custom - `disabled` boolean, required: If true, this method will will not be available to the entity. - `schemaId` string, required: The ID of the schema to use for this payment method. - object - `type` 'bnpl', required: Discriminator value: bnpl - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'utility', required: Discriminator value: utility - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'na', required: Discriminator value: na - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'wallet', required: Discriminator value: wallet - `disabled` boolean, required: If true, this method will will not be available to the entity. - `backupDisbursement` CustomizationTypesPaymentMethodCustomizationRequest[] - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED' - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[]: The delivery methods that are available for this payment method. - `originatingCompanyName` 'ENTITY_NAME' | 'BANK_NAME' - object - `type` 'card', required: Discriminator value: card - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'check', required: Discriminator value: check - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY' - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[]: The delivery methods that are available for this payment method. - `printDescription` boolean: If true, the check will be printed with the description. - object - `type` 'custom', required: Discriminator value: custom - `disabled` boolean, required: If true, this method will will not be available to the entity. - `schemaId` string, required: The ID of the schema to use for this payment method. - object - `type` 'bnpl', required: Discriminator value: bnpl - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'utility', required: Discriminator value: utility - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'na', required: Discriminator value: na - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'wallet', required: Discriminator value: wallet - `disabled` boolean, required: If true, this method will will not be available to the entity. - `paymentDestination` CustomizationTypesPaymentMethodCustomizationRequest[] - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED' - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[]: The delivery methods that are available for this payment method. - `originatingCompanyName` 'ENTITY_NAME' | 'BANK_NAME' - object - `type` 'card', required: Discriminator value: card - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'check', required: Discriminator value: check - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY' - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[]: The delivery methods that are available for this payment method. - `printDescription` boolean: If true, the check will be printed with the description. - object - `type` 'custom', required: Discriminator value: custom - `disabled` boolean, required: If true, this method will will not be available to the entity. - `schemaId` string, required: The ID of the schema to use for this payment method. - object - `type` 'bnpl', required: Discriminator value: bnpl - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'utility', required: Discriminator value: utility - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'na', required: Discriminator value: na - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'wallet', required: Discriminator value: wallet - `disabled` boolean, required: If true, this method will will not be available to the entity. - `ocr` CustomizationTypesOcrCustomizationRequest - `lineItems` boolean: Extract line items from the invoice. Defaults to true. - `collapseLineItems` boolean: If true, the line items will be collapsed into a single line item. Defaults to false. - `invoiceMetadata` boolean: Pull custom metadata at the invoice level. Defaults to true. - `lineItemMetadata` boolean: Pull custom metadata at the line item level. Defaults to true. - `lineItemGlAccountId` boolean: Pull GL Account ID at the line item level. Defaults to true. - `predictMetadata` boolean: Use AI to predict metadata from historical data. Defaults to true. - `taxAndShippingAsLineItems` boolean: Pull tax and shipping information as line items. Defaults to true. If false, tax and shipping will extracted as invoice level fields. - `splitDocuments` boolean: Use AI to intelligently split documents into multiple subdocuments. Defaults to false. - `notifications` CustomizationTypesNotificationCustomizationRequest - `assumeRole` string: If set, notifications to this role will be sent to the email address of the entity. Set as empty string to disable. - `workflow` CustomizationTypesWorkflowCustomizationRequest - `autoAdvanceInvoiceStatus` boolean: If true, the invoice will be automatically advanced to the furthest stage in the payment workflow. For example, if the invoice is APPROVED, but has all necessary data to move to SCHEDULED, it will be advanced to SCHEDULED. - `invoice` CustomizationTypesInvoiceCustomizationRequest - `hideAddress` boolean: If true, the address information will be hidden from generated invoice PDFs. Defaults to false. - `hideQrCode` boolean: If true, the QR code will be hidden from generated invoice PDFs. Defaults to false. - `hideBankDetails` boolean: If true, the bank account details will be hidden from generated invoice PDFs. Defaults to false. - `hidePaymentLink` boolean: If true, the payment link will be hidden from generated invoice PDFs. Defaults to false. - `fees` CustomizationTypesFeeCustomizationRequest - `payable` CustomizationTypesFeeCustomizationDetailRequest - `source` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `destination` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `receivable` CustomizationTypesFeeCustomizationDetailRequest - `source` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `destination` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `rolePermissions` OrganizationTypesRolePermissionRequest ## Response `200` Response with status 200 - EntityTypesEntityCustomizationResponse - `metadata` CustomizationTypesMetadataCustomizationRequest[], required - `key` string, required: The key of the metadata field. This must be defined at the organization level, otherwise an error will be returned. - `disabled` boolean, required: If true, this field will not be available to the entity. - `paymentSource` CustomizationTypesPaymentMethodCustomizationRequest[], required - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED' - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[]: The delivery methods that are available for this payment method. - `originatingCompanyName` 'ENTITY_NAME' | 'BANK_NAME' - object - `type` 'card', required: Discriminator value: card - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'check', required: Discriminator value: check - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY' - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[]: The delivery methods that are available for this payment method. - `printDescription` boolean: If true, the check will be printed with the description. - object - `type` 'custom', required: Discriminator value: custom - `disabled` boolean, required: If true, this method will will not be available to the entity. - `schemaId` string, required: The ID of the schema to use for this payment method. - object - `type` 'bnpl', required: Discriminator value: bnpl - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'utility', required: Discriminator value: utility - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'na', required: Discriminator value: na - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'wallet', required: Discriminator value: wallet - `disabled` boolean, required: If true, this method will will not be available to the entity. - `backupDisbursement` CustomizationTypesPaymentMethodCustomizationRequest[], required - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED' - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[]: The delivery methods that are available for this payment method. - `originatingCompanyName` 'ENTITY_NAME' | 'BANK_NAME' - object - `type` 'card', required: Discriminator value: card - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'check', required: Discriminator value: check - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY' - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[]: The delivery methods that are available for this payment method. - `printDescription` boolean: If true, the check will be printed with the description. - object - `type` 'custom', required: Discriminator value: custom - `disabled` boolean, required: If true, this method will will not be available to the entity. - `schemaId` string, required: The ID of the schema to use for this payment method. - object - `type` 'bnpl', required: Discriminator value: bnpl - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'utility', required: Discriminator value: utility - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'na', required: Discriminator value: na - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'wallet', required: Discriminator value: wallet - `disabled` boolean, required: If true, this method will will not be available to the entity. - `paymentDestination` CustomizationTypesPaymentMethodCustomizationRequest[], required - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED' - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[]: The delivery methods that are available for this payment method. - `originatingCompanyName` 'ENTITY_NAME' | 'BANK_NAME' - object - `type` 'card', required: Discriminator value: card - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'check', required: Discriminator value: check - `disabled` boolean, required: If true, this method will will not be available to the entity. - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY' - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[]: The delivery methods that are available for this payment method. - `printDescription` boolean: If true, the check will be printed with the description. - object - `type` 'custom', required: Discriminator value: custom - `disabled` boolean, required: If true, this method will will not be available to the entity. - `schemaId` string, required: The ID of the schema to use for this payment method. - object - `type` 'bnpl', required: Discriminator value: bnpl - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'utility', required: Discriminator value: utility - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'na', required: Discriminator value: na - `disabled` boolean, required: If true, this method will will not be available to the entity. - object - `type` 'wallet', required: Discriminator value: wallet - `disabled` boolean, required: If true, this method will will not be available to the entity. - `ocr` CustomizationTypesOcrCustomizationResponse, required - `lineItems` boolean, required: Extract line items from the invoice. Defaults to true. - `collapseLineItems` boolean, required: If true, the line items will be collapsed into a single line item. Defaults to false. - `invoiceMetadata` boolean, required: Pull custom metadata at the invoice level. Defaults to true. - `lineItemMetadata` boolean, required: Pull custom metadata at the line item level. Defaults to true. - `lineItemGlAccountId` boolean, required: Pull GL Account ID at the line item level. Defaults to true. - `predictMetadata` boolean, required: Use AI to predict metadata from historical data. Defaults to true. - `taxAndShippingAsLineItems` boolean, required: Pull tax and shipping information as line items. Defaults to true. If false, tax and shipping will extracted as invoice level fields. - `splitDocuments` boolean, required: Use AI to intelligently split documents into multiple subdocuments. Defaults to false. - `notifications` CustomizationTypesNotificationCustomizationRequest, required - `assumeRole` string: If set, notifications to this role will be sent to the email address of the entity. Set as empty string to disable. - `workflow` CustomizationTypesWorkflowCustomizationRequest, required - `autoAdvanceInvoiceStatus` boolean: If true, the invoice will be automatically advanced to the furthest stage in the payment workflow. For example, if the invoice is APPROVED, but has all necessary data to move to SCHEDULED, it will be advanced to SCHEDULED. - `invoice` CustomizationTypesInvoiceCustomizationResponse, required - `hideAddress` boolean, required: If true, the address information will be hidden from generated invoice PDFs. Defaults to false. - `hideQrCode` boolean, required: If true, the QR code will be hidden from generated invoice PDFs. Defaults to false. - `hideBankDetails` boolean, required: If true, the bank account details will be hidden from generated invoice PDFs. Defaults to false. - `hidePaymentLink` boolean, required: If true, the payment link will be hidden from generated invoice PDFs. Defaults to false. - `fees` CustomizationTypesFeeCustomizationRequest, required - `payable` CustomizationTypesFeeCustomizationDetailRequest - `source` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `destination` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `receivable` CustomizationTypesFeeCustomizationDetailRequest - `source` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `destination` CustomizationTypesFeeCustomizationRailRequest - `ACH_STANDARD` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `ACH_SAME_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_PRINT` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_PRIORITY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `CHECK_MAIL_UPS_NEXT_DAY` union - object - `type` 'percentage', required: Discriminator value: percentage - `amount` number, double, required: The percentage of the payment amount that will be charged as a fee. For example, if the fee is 2.5%, set this to 2.5. - object - `type` 'flat', required: Discriminator value: flat - `amount` number, double, required: The flat amount that will be charged as a fee. For example, if the fee is $2.50, set this to 2.5. - object: The default fee for the payment method based on your organization's default fee. - `type` 'default', required: Discriminator value: default - `rolePermissions` OrganizationTypesRolePermissionRequest, required ## Other responses - `400`: Error response with status 400 - `401`: Error response with status 401 - `403`: Error response with status 403 - `404`: Error response with status 404 - `409`: Error response with status 409 - `500`: Error response with status 500 - `501`: Error response with status 501 --- [API](https://skmtc.dev/mercoa/apis/mercoa-2.md) - [All operations](https://skmtc.dev/mercoa/apis/mercoa-2/llms.txt) - [OpenAPI document](https://skmtc.dev/mercoa/apis/mercoa-2/revisions/00a8e403ae18?raw)