> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.mercoa.com/embedded-ap-ar/api-reference/organization/update/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.mercoa.com/_mcp/server. # Update POST https://api.mercoa.com/organization Content-Type: application/json Update current organization Reference: https://docs.mercoa.com/embedded-ap-ar/api-reference/organization/update ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Body (application/json) This endpoint expects an object. - `name` (string, optional) - `logo` (string, optional) — Base64 encoded logo image. - `favicon` (string, optional) — Base64 encoded favicon image. - `websiteUrl` (string, optional) - `supportEmail` (string, optional) - `paymentMethods` (object, optional) - `payerPayments` (list of object, required) — List of payment methods that can be used to pay invoices. - `type`: `bankAccount` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, optional) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `defaultDeliveryMethod` (enum, optional) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `name` (string, optional, deprecated) - `type`: `card` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `virtualCard` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `check` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, optional) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `defaultDeliveryMethod` (enum, optional) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `printDescription` (boolean, optional) — If true, invoices default to printing the invoice description (noteToSelf) on the check note. - `name` (string, optional, deprecated) - `type`: `custom` - `active` (boolean, required) - `schemaId` (string, required) - `name` (string, optional, deprecated) - `type`: `bnpl` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `offPlatform` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `utility` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `na` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `wallet` - `active` (boolean, required) - `name` (string, optional, deprecated) - `backupDisbursements` (list of object, required) — List of payment methods that can be created by a payor to send disbursements. - `type`: `bankAccount` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, optional) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `defaultDeliveryMethod` (enum, optional) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `name` (string, optional, deprecated) - `type`: `card` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `virtualCard` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `check` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, optional) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `defaultDeliveryMethod` (enum, optional) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `printDescription` (boolean, optional) — If true, invoices default to printing the invoice description (noteToSelf) on the check note. - `name` (string, optional, deprecated) - `type`: `custom` - `active` (boolean, required) - `schemaId` (string, required) - `name` (string, optional, deprecated) - `type`: `bnpl` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `offPlatform` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `utility` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `na` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `wallet` - `active` (boolean, required) - `name` (string, optional, deprecated) - `vendorDisbursements` (list of object, required) — List of payment methods that can be created by a payee to receive disbursements. - `type`: `bankAccount` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, optional) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `defaultDeliveryMethod` (enum, optional) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `name` (string, optional, deprecated) - `type`: `card` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `virtualCard` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `check` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, optional) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `defaultDeliveryMethod` (enum, optional) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `printDescription` (boolean, optional) — If true, invoices default to printing the invoice description (noteToSelf) on the check note. - `name` (string, optional, deprecated) - `type`: `custom` - `active` (boolean, required) - `schemaId` (string, required) - `name` (string, optional, deprecated) - `type`: `bnpl` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `offPlatform` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `utility` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `na` - `active` (boolean, required) - `name` (string, optional, deprecated) - `type`: `wallet` - `active` (boolean, required) - `name` (string, optional, deprecated) - `emailProvider` (object, optional) - `sender` (object, required) - `provider` (enum, required) - Allowed values: `none`, `sendgrid`, `ses`, `resend`, `cloudmailin` - `fromEmail` (string, required) - `fromName` (string, required) - `apiKey` (string, optional) - `useSmartReplyTo` (boolean, optional) - `inboxDomain` (string, required) - `alternativeInboxDomains` (list of string, optional) - `externalAccountingSystemProvider` (object, optional) - `type`: `none` - `apiKey` (string, required) - `type`: `codat` - `apiKey` (string, required) - `type`: `rutter` - `clientId` (string, required) - `clientSecret` (string, required) - `colorScheme` (object, optional) - `primaryColor` (string, optional) - `secondaryColor` (string, optional) - `logoBackgroundColor` (string, optional) - `roundedCorners` (integer, optional) - `fontFamily` (string, optional) - `fontSize` (string, optional) - `payeeOnboardingOptions` (object, optional) - `enableBusiness` (boolean, optional) - `enableIndividual` (boolean, optional) - `paymentMethod` (boolean, optional) - `business` (object, optional) - `address` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `averageMonthlyTransactionVolume` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `averageTransactionSize` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `bankStatement` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `description` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `doingBusinessAs` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `ein` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `email` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `formationDate` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `logo` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `maxTransactionSize` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `mcc` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `name` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `phone` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `representatives` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `tenNinetyNine` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `termsOfService` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `type` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `w9` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `website` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `individual` (object, optional) - `address` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `bankStatement` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `dateOfBirth` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `email` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `name` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `phone` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `ssn` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `tenNinetyNine` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `termsOfService` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `w9` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `payorOnboardingOptions` (object, optional) - `enableBusiness` (boolean, optional) - `enableIndividual` (boolean, optional) - `paymentMethod` (boolean, optional) - `business` (object, optional) - `address` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `averageMonthlyTransactionVolume` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `averageTransactionSize` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `bankStatement` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `description` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `doingBusinessAs` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `ein` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `email` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `formationDate` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `logo` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `maxTransactionSize` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `mcc` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `name` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `phone` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `representatives` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `tenNinetyNine` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `termsOfService` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `type` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `w9` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `website` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `individual` (object, optional) - `address` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `bankStatement` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `dateOfBirth` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `email` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `name` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `phone` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `ssn` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `tenNinetyNine` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `termsOfService` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `w9` (object, optional) — How this field will be shown on the onboarding page. If `show`, `edit`, or `required` are not specified, they will default to `false`. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, optional) - `edit` (boolean, optional) - `required` (boolean, optional) - `metadataSchema` (list of object, optional) - `key` (string, required) - `displayName` (string, required) - `type` (enum, required) - Allowed values: `STRING`, `NUMBER`, `DATE`, `BOOLEAN`, `KEY_VALUE` - `description` (string, optional) - `lineItem` (boolean, optional) — Whether or not this field should be shown on line items. If true, this field will be shown on each line item. If false, the field will be shown on the invoice level. Defaults to false. - `allowMultiple` (boolean, optional) — Whether or not multiple values are allowed for this field. Defaults to false. If true, the value will be a list of the specified type. - `validationRules` (object, optional) — Validation rules are currently only supported for STRING types. - `type`: `regex` - `errorMessage` (string, required) — The error message to display if the value does not match the regular expression. - `regex` (string, required) — A regular expression that the value must match. - `showConditions` (object, optional) — A list of conditional rules that determine whether or not this field should be shown. The field will only be shown if all of the conditions are met. If no conditions are specified, the field will always be shown. - `alwaysHide` (boolean, optional) — Always hide this field. Useful for getting data from OCR and AI predictions that you don't want to show in the UI. - `hasOptions` (boolean, optional) — Show this field only if the entity has values set for the metadata key. - `hasDocument` (boolean, optional) — Show this field only if a document has been attached. - `hasNoLineItems` (boolean, optional) — Show this field only if the invoice has no line items. Useful for showing a field that applies to the entire invoice but overridden by line items if present. - `paymentSourceTypes` (list of enum, optional) — Show this field only if the payment source type is in this list. - Allowed values: `custom`, `check`, `bankAccount`, `na`, `card`, `bnpl`, `virtualCard`, `offPlatform`, `utility`, `wallet` - `paymentSourceCustomSchemaIds` (list of string, optional) — Show this field only if the payment source schema ID is in this list of payment source schema IDs. This is only applicable if paymentSourceTypes contains CUSTOM. - `paymentDestinationTypes` (list of enum, optional) — Show this field only if the payment destination type is in this list. - Allowed values: `custom`, `check`, `bankAccount`, `na`, `card`, `bnpl`, `virtualCard`, `offPlatform`, `utility`, `wallet` - `paymentDestinationCustomSchemaIds` (list of string, optional) — Show this field only if the payment destination schema ID is in this list of payment destination schema IDs. This is only applicable if paymentDestinationTypes contains CUSTOM. - `ocrRules` (object, optional) — A collection of rules that determine how this field is populated during OCR. - `extractFromDocument` (boolean, optional) — Attempt to extract this field from reading the document. Only applicable to line item metadata fields. Defaults to false. - `predictFromHistory` (boolean, optional) — Attempt to predict this field from historical invoice metadata. Only applicable to line item metadata fields. Defaults to true. - `notificationEmailTemplate` (object, optional) - `backgroundStyle` (string, optional) - `header` (string, optional) - `body` (string, optional) - `signature` (string, optional) - `footer` (string, optional) - `button` (string, optional) - `customDomains` (list of string, optional) - `rolePermissions` (map from string to list of enum, optional) - Allowed values: `invoice.all`, `invoice.view.all`, `invoice.view.draft`, `invoice.view.new`, `invoice.view.approved`, `invoice.view.scheduled`, `invoice.view.pending`, `invoice.view.paid`, `invoice.view.archived`, `invoice.view.refused`, `invoice.view.canceled`, `invoice.view.failed`, `invoice.create.all`, `invoice.create.draft`, `invoice.create.new`, `invoice.create.approved`, `invoice.create.scheduled`, `invoice.create.archived`, `invoice.create.cancel`, `invoice.update.all`, `invoice.update.draft`, `invoice.update.new`, `invoice.update.approved`, `invoice.update.scheduled`, `invoice.update.archived`, `invoice.update.cancel`, `invoice.delete`, `invoice.comment.view`, `invoice.comment.create`, `invoice.approver.override`, `invoice.check.print`, `paymentMethod.all`, `paymentMethod.view`, `paymentMethod.create`, `paymentMethod.update`, `paymentMethod.delete` - `notificationsDisabled` (boolean, optional) — If true, all notifications for this organization will be disabled. ## Response ### 200 - `id` (string, required) - `sandbox` (boolean, required) - `name` (string, required) - `logoUrl` (string, optional) - `faviconUrl` (string, optional) - `websiteUrl` (string, optional) - `supportEmail` (string, optional) - `paymentMethods` (object, optional) - `payerPayments` (list of object, required) — List of payment methods that can be used to pay invoices. - `type`: `bankAccount` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, required) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `defaultDeliveryMethod` (enum, required) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `name` (string, required, deprecated) — unused - `type`: `card` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `virtualCard` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `check` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, required) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `defaultDeliveryMethod` (enum, required) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `printDescription` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `custom` - `active` (boolean, required) - `schemaId` (string, required) - `name` (string, required, deprecated) — unused - `type`: `bnpl` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `offPlatform` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `utility` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `na` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `wallet` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `backupDisbursements` (list of object, required) — List of payment methods that can be created by a payor to send disbursements. - `type`: `bankAccount` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, required) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `defaultDeliveryMethod` (enum, required) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `name` (string, required, deprecated) — unused - `type`: `card` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `virtualCard` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `check` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, required) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `defaultDeliveryMethod` (enum, required) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `printDescription` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `custom` - `active` (boolean, required) - `schemaId` (string, required) - `name` (string, required, deprecated) — unused - `type`: `bnpl` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `offPlatform` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `utility` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `na` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `wallet` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `vendorDisbursements` (list of object, required) — List of payment methods that can be created by a payee to receive disbursements. - `type`: `bankAccount` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, required) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `defaultDeliveryMethod` (enum, required) - Allowed values: `ACH_STANDARD`, `ACH_SAME_DAY`, `ACH_ACCELERATED` - `name` (string, required, deprecated) — unused - `type`: `card` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `virtualCard` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `check` - `active` (boolean, required) - `availableDeliveryMethods` (list of enum, required) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `defaultDeliveryMethod` (enum, required) - Allowed values: `PRINT`, `MAIL`, `MAIL_PRIORITY`, `MAIL_UPS_NEXT_DAY` - `printDescription` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `custom` - `active` (boolean, required) - `schemaId` (string, required) - `name` (string, required, deprecated) — unused - `type`: `bnpl` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `offPlatform` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `utility` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `na` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `type`: `wallet` - `active` (boolean, required) - `name` (string, required, deprecated) — unused - `emailProvider` (object, optional) - `sender` (object, required) - `provider` (enum, required) - Allowed values: `none`, `sendgrid`, `ses`, `resend`, `cloudmailin` - `fromEmail` (string, required) - `fromName` (string, required) - `hasApiKey` (boolean, required) - `useSmartReplyTo` (boolean, optional) - `inboxDomain` (string, required) - `alternativeInboxDomains` (list of string, required) - `externalAccountingSystemProvider` (object, optional) - `type`: `none` - `hasApiKey` (boolean, required) - `type`: `codat` - `hasApiKey` (boolean, required) - `type`: `rutter` - `hasClientId` (boolean, required) - `hasClientSecret` (boolean, required) - `colorScheme` (object, optional) - `primaryColor` (string, optional) - `secondaryColor` (string, optional) - `logoBackgroundColor` (string, optional) - `roundedCorners` (integer, optional) - `fontFamily` (string, optional) - `fontSize` (string, optional) - `payeeOnboardingOptions` (object, optional) - `enableBusiness` (boolean, required) - `enableIndividual` (boolean, required) - `paymentMethod` (boolean, required) - `business` (object, required) - `address` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `averageMonthlyTransactionVolume` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `averageTransactionSize` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `bankStatement` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `description` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `doingBusinessAs` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `ein` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `email` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `formationDate` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `logo` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `maxTransactionSize` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `mcc` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `name` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `phone` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `representatives` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `tenNinetyNine` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `termsOfService` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `type` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `w9` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `website` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `individual` (object, required) - `address` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `bankStatement` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `dateOfBirth` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `email` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `name` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `phone` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `ssn` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `tenNinetyNine` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `termsOfService` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `w9` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `payorOnboardingOptions` (object, optional) - `enableBusiness` (boolean, required) - `enableIndividual` (boolean, required) - `paymentMethod` (boolean, required) - `business` (object, required) - `address` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `averageMonthlyTransactionVolume` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `averageTransactionSize` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `bankStatement` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `description` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `doingBusinessAs` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `ein` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `email` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `formationDate` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `logo` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `maxTransactionSize` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `mcc` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `name` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `phone` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `representatives` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `tenNinetyNine` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `termsOfService` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `type` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `w9` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `website` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `individual` (object, required) - `address` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `bankStatement` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `dateOfBirth` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `email` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `name` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `phone` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `ssn` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `tenNinetyNine` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `termsOfService` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `w9` (object, required) — How this field will be shown on the onboarding page. Note that `required` implies `edit`, and `edit` implies `show`. - `show` (boolean, required) - `edit` (boolean, required) - `required` (boolean, required) - `metadataSchema` (list of object, optional) - `key` (string, required) - `displayName` (string, required) - `type` (enum, required) - Allowed values: `STRING`, `NUMBER`, `DATE`, `BOOLEAN`, `KEY_VALUE` - `description` (string, optional) - `lineItem` (boolean, optional) — Whether or not this field should be shown on line items. If true, this field will be shown on each line item. If false, the field will be shown on the invoice level. Defaults to false. - `allowMultiple` (boolean, optional) — Whether or not multiple values are allowed for this field. Defaults to false. If true, the value will be a list of the specified type. - `validationRules` (object, optional) — Validation rules are currently only supported for STRING types. - `type`: `regex` - `errorMessage` (string, required) — The error message to display if the value does not match the regular expression. - `regex` (string, required) — A regular expression that the value must match. - `showConditions` (object, optional) — A list of conditional rules that determine whether or not this field should be shown. The field will only be shown if all of the conditions are met. If no conditions are specified, the field will always be shown. - `alwaysHide` (boolean, optional) — Always hide this field. Useful for getting data from OCR and AI predictions that you don't want to show in the UI. - `hasOptions` (boolean, optional) — Show this field only if the entity has values set for the metadata key. - `hasDocument` (boolean, optional) — Show this field only if a document has been attached. - `hasNoLineItems` (boolean, optional) — Show this field only if the invoice has no line items. Useful for showing a field that applies to the entire invoice but overridden by line items if present. - `paymentSourceTypes` (list of enum, optional) — Show this field only if the payment source type is in this list. - Allowed values: `custom`, `check`, `bankAccount`, `na`, `card`, `bnpl`, `virtualCard`, `offPlatform`, `utility`, `wallet` - `paymentSourceCustomSchemaIds` (list of string, optional) — Show this field only if the payment source schema ID is in this list of payment source schema IDs. This is only applicable if paymentSourceTypes contains CUSTOM. - `paymentDestinationTypes` (list of enum, optional) — Show this field only if the payment destination type is in this list. - Allowed values: `custom`, `check`, `bankAccount`, `na`, `card`, `bnpl`, `virtualCard`, `offPlatform`, `utility`, `wallet` - `paymentDestinationCustomSchemaIds` (list of string, optional) — Show this field only if the payment destination schema ID is in this list of payment destination schema IDs. This is only applicable if paymentDestinationTypes contains CUSTOM. - `ocrRules` (object, optional) — A collection of rules that determine how this field is populated during OCR. - `extractFromDocument` (boolean, optional) — Attempt to extract this field from reading the document. Only applicable to line item metadata fields. Defaults to false. - `predictFromHistory` (boolean, optional) — Attempt to predict this field from historical invoice metadata. Only applicable to line item metadata fields. Defaults to true. - `notificationEmailTemplate` (object, optional) - `backgroundStyle` (string, optional) - `header` (string, optional) - `body` (string, optional) - `signature` (string, optional) - `footer` (string, optional) - `button` (string, optional) - `customDomains` (list of string, optional) - `organizationEntityId` (string, optional) - `rolePermissions` (map from string to list of enum, optional) - Allowed values: `invoice.all`, `invoice.view.all`, `invoice.view.draft`, `invoice.view.new`, `invoice.view.approved`, `invoice.view.scheduled`, `invoice.view.pending`, `invoice.view.paid`, `invoice.view.archived`, `invoice.view.refused`, `invoice.view.canceled`, `invoice.view.failed`, `invoice.create.all`, `invoice.create.draft`, `invoice.create.new`, `invoice.create.approved`, `invoice.create.scheduled`, `invoice.create.archived`, `invoice.create.cancel`, `invoice.update.all`, `invoice.update.draft`, `invoice.update.new`, `invoice.update.approved`, `invoice.update.scheduled`, `invoice.update.archived`, `invoice.update.cancel`, `invoice.delete`, `invoice.comment.view`, `invoice.comment.create`, `invoice.approver.override`, `invoice.check.print`, `paymentMethod.all`, `paymentMethod.view`, `paymentMethod.create`, `paymentMethod.update`, `paymentMethod.delete` - `notificationsDisabled` (boolean, optional) ## Errors ### 400 Bad Request - `errorName` ("BadRequest", required) - `content` (string, required) ### 401 Unauthorized - `errorName` ("Unauthorized", required) - `content` (string, required) ### 403 Forbidden - `errorName` ("Forbidden", required) - `content` (string, required) ### 404 Not Found - `errorName` ("NotFound", required) - `content` (string, required) ### 409 Conflict - `errorName` ("Conflict", required) - `content` (string, required) ### 500 Internal Server Error - `errorName` ("InternalServerError", required) - `content` (string, required) ### 501 Unimplemented - `errorName` ("Unimplemented", required) - `content` (string, required) ## Examples **Request** ```json {} ``` **Response** ```json { "id": "id", "sandbox": true, "name": "name", "logoUrl": "logoUrl", "faviconUrl": "faviconUrl", "websiteUrl": "websiteUrl", "supportEmail": "supportEmail", "paymentMethods": { "payerPayments": [ { "type": "bankAccount", "active": true, "availableDeliveryMethods": [ "ACH_STANDARD", "ACH_STANDARD" ], "defaultDeliveryMethod": "ACH_STANDARD", "name": "name" }, { "type": "bankAccount", "active": true, "availableDeliveryMethods": [ "ACH_STANDARD", "ACH_STANDARD" ], "defaultDeliveryMethod": "ACH_STANDARD", "name": "name" } ], "backupDisbursements": [ { "type": "bankAccount", "active": true, "availableDeliveryMethods": [ "ACH_STANDARD", "ACH_STANDARD" ], "defaultDeliveryMethod": "ACH_STANDARD", "name": "name" }, { "type": "bankAccount", "active": true, "availableDeliveryMethods": [ "ACH_STANDARD", "ACH_STANDARD" ], "defaultDeliveryMethod": "ACH_STANDARD", "name": "name" } ], "vendorDisbursements": [ { "type": "bankAccount", "active": true, "availableDeliveryMethods": [ "ACH_STANDARD", "ACH_STANDARD" ], "defaultDeliveryMethod": "ACH_STANDARD", "name": "name" }, { "type": "bankAccount", "active": true, "availableDeliveryMethods": [ "ACH_STANDARD", "ACH_STANDARD" ], "defaultDeliveryMethod": "ACH_STANDARD", "name": "name" } ] }, "emailProvider": { "sender": { "provider": "none", "fromEmail": "fromEmail", "fromName": "fromName", "hasApiKey": true, "useSmartReplyTo": true }, "inboxDomain": "inboxDomain", "alternativeInboxDomains": [ "alternativeInboxDomains", "alternativeInboxDomains" ] }, "externalAccountingSystemProvider": { "type": "none", "hasApiKey": true }, "colorScheme": { "primaryColor": "primaryColor", "secondaryColor": "secondaryColor", "logoBackgroundColor": "logoBackgroundColor", "roundedCorners": 1, "fontFamily": "fontFamily", "fontSize": "fontSize" }, "payeeOnboardingOptions": { "enableBusiness": true, "enableIndividual": true, "paymentMethod": true, "business": { "address": { "show": true, "edit": true, "required": true }, "averageMonthlyTransactionVolume": { "show": true, "edit": true, "required": true }, "averageTransactionSize": { "show": true, "edit": true, "required": true }, "bankStatement": { "show": true, "edit": true, "required": true }, "description": { "show": true, "edit": true, "required": true }, "doingBusinessAs": { "show": true, "edit": true, "required": true }, "ein": { "show": true, "edit": true, "required": true }, "email": { "show": true, "edit": true, "required": true }, "formationDate": { "show": true, "edit": true, "required": true }, "logo": { "show": true, "edit": true, "required": true }, "maxTransactionSize": { "show": true, "edit": true, "required": true }, "mcc": { "show": true, "edit": true, "required": true }, "name": { "show": true, "edit": true, "required": true }, "phone": { "show": true, "edit": true, "required": true }, "representatives": { "show": true, "edit": true, "required": true }, "tenNinetyNine": { "show": true, "edit": true, "required": true }, "termsOfService": { "show": true, "edit": true, "required": true }, "type": { "show": true, "edit": true, "required": true }, "w9": { "show": true, "edit": true, "required": true }, "website": { "show": true, "edit": true, "required": true } }, "individual": { "address": { "show": true, "edit": true, "required": true }, "bankStatement": { "show": true, "edit": true, "required": true }, "dateOfBirth": { "show": true, "edit": true, "required": true }, "email": { "show": true, "edit": true, "required": true }, "name": { "show": true, "edit": true, "required": true }, "phone": { "show": true, "edit": true, "required": true }, "ssn": { "show": true, "edit": true, "required": true }, "tenNinetyNine": { "show": true, "edit": true, "required": true }, "termsOfService": { "show": true, "edit": true, "required": true }, "w9": { "show": true, "edit": true, "required": true } } }, "payorOnboardingOptions": { "enableBusiness": true, "enableIndividual": true, "paymentMethod": true, "business": { "address": { "show": true, "edit": true, "required": true }, "averageMonthlyTransactionVolume": { "show": true, "edit": true, "required": true }, "averageTransactionSize": { "show": true, "edit": true, "required": true }, "bankStatement": { "show": true, "edit": true, "required": true }, "description": { "show": true, "edit": true, "required": true }, "doingBusinessAs": { "show": true, "edit": true, "required": true }, "ein": { "show": true, "edit": true, "required": true }, "email": { "show": true, "edit": true, "required": true }, "formationDate": { "show": true, "edit": true, "required": true }, "logo": { "show": true, "edit": true, "required": true }, "maxTransactionSize": { "show": true, "edit": true, "required": true }, "mcc": { "show": true, "edit": true, "required": true }, "name": { "show": true, "edit": true, "required": true }, "phone": { "show": true, "edit": true, "required": true }, "representatives": { "show": true, "edit": true, "required": true }, "tenNinetyNine": { "show": true, "edit": true, "required": true }, "termsOfService": { "show": true, "edit": true, "required": true }, "type": { "show": true, "edit": true, "required": true }, "w9": { "show": true, "edit": true, "required": true }, "website": { "show": true, "edit": true, "required": true } }, "individual": { "address": { "show": true, "edit": true, "required": true }, "bankStatement": { "show": true, "edit": true, "required": true }, "dateOfBirth": { "show": true, "edit": true, "required": true }, "email": { "show": true, "edit": true, "required": true }, "name": { "show": true, "edit": true, "required": true }, "phone": { "show": true, "edit": true, "required": true }, "ssn": { "show": true, "edit": true, "required": true }, "tenNinetyNine": { "show": true, "edit": true, "required": true }, "termsOfService": { "show": true, "edit": true, "required": true }, "w9": { "show": true, "edit": true, "required": true } } }, "metadataSchema": [ { "key": "key", "displayName": "displayName", "type": "STRING", "description": "description", "lineItem": true, "allowMultiple": true, "validationRules": { "type": "regex", "errorMessage": "errorMessage", "regex": "regex" }, "showConditions": { "alwaysHide": true, "hasOptions": true, "hasDocument": true, "hasNoLineItems": true, "paymentSourceTypes": [ "custom", "custom" ], "paymentSourceCustomSchemaIds": [ "paymentSourceCustomSchemaIds", "paymentSourceCustomSchemaIds" ], "paymentDestinationTypes": [ "custom", "custom" ], "paymentDestinationCustomSchemaIds": [ "paymentDestinationCustomSchemaIds", "paymentDestinationCustomSchemaIds" ] }, "ocrRules": { "extractFromDocument": true, "predictFromHistory": true } }, { "key": "key", "displayName": "displayName", "type": "STRING", "description": "description", "lineItem": true, "allowMultiple": true, "validationRules": { "type": "regex", "errorMessage": "errorMessage", "regex": "regex" }, "showConditions": { "alwaysHide": true, "hasOptions": true, "hasDocument": true, "hasNoLineItems": true, "paymentSourceTypes": [ "custom", "custom" ], "paymentSourceCustomSchemaIds": [ "paymentSourceCustomSchemaIds", "paymentSourceCustomSchemaIds" ], "paymentDestinationTypes": [ "custom", "custom" ], "paymentDestinationCustomSchemaIds": [ "paymentDestinationCustomSchemaIds", "paymentDestinationCustomSchemaIds" ] }, "ocrRules": { "extractFromDocument": true, "predictFromHistory": true } } ], "notificationEmailTemplate": { "backgroundStyle": "backgroundStyle", "header": "header", "body": "body", "signature": "signature", "footer": "footer", "button": "button" }, "customDomains": [ "customDomains", "customDomains" ], "organizationEntityId": "organizationEntityId", "rolePermissions": { "rolePermissions": [ "invoice.all", "invoice.all" ] }, "notificationsDisabled": true } ``` **SDK Code** ```python import requests url = "https://api.mercoa.com/organization" payload = {} headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```typescript import { MercoaClient, Mercoa } from "@mercoa/javascript"; const client = new MercoaClient({ token: "YOUR_TOKEN" }); await client.organization.update({}); ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.mercoa.com/organization" payload := strings.NewReader("{}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.mercoa.com/organization") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.mercoa.com/organization") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('POST', 'https://api.mercoa.com/organization', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.mercoa.com/organization"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.mercoa.com/organization")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```