--- title: "Get" method: GET path: "/organization" tags: ["organization"] --- # Get `GET /organization` ## Request - Base URL: `https://api.mercoa.com` - URL: `https://api.mercoa.com/organization` - Auth: HTTP bearer Get current organization information ## Query parameters - `paymentMethods` boolean - `emailProvider` boolean - `externalAccountingSystemProvider` boolean - `colorScheme` boolean - `payeeOnboardingOptions` boolean - `payorOnboardingOptions` boolean - `metadataSchema` boolean - `notificationEmailTemplate` boolean - `rolePermissions` boolean - `customDomains` boolean ## Response `200` Response with status 200 - OrganizationTypesOrganizationResponse - `id` string, required - `sandbox` boolean, required - `name` string, required - `logoUrl` string - `faviconUrl` string - `websiteUrl` string - `supportEmail` string - `paymentMethods` OrganizationTypesPaymentMethodsResponse - `payerPayments` OrganizationTypesPaymentRailResponse[], required: List of payment methods that can be used to pay invoices. - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `name` string, required: unused - `active` boolean, required - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[], required - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED', required - object - `type` 'card', required: Discriminator value: card - `name` string, required: unused - `active` boolean, required - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `name` string, required: unused - `active` boolean, required - object - `type` 'check', required: Discriminator value: check - `name` string, required: unused - `active` boolean, required - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[], required - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY', required - `printDescription` boolean, required - object - `type` 'custom', required: Discriminator value: custom - `name` string, required: unused - `active` boolean, required - `schemaId` string, required - object - `type` 'bnpl', required: Discriminator value: bnpl - `name` string, required: unused - `active` boolean, required - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `name` string, required: unused - `active` boolean, required - object - `type` 'utility', required: Discriminator value: utility - `name` string, required: unused - `active` boolean, required - object - `type` 'na', required: Discriminator value: na - `name` string, required: unused - `active` boolean, required - object - `type` 'wallet', required: Discriminator value: wallet - `name` string, required: unused - `active` boolean, required - `backupDisbursements` OrganizationTypesPaymentRailResponse[], required: List of payment methods that can be created by a payor to send disbursements. - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `name` string, required: unused - `active` boolean, required - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[], required - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED', required - object - `type` 'card', required: Discriminator value: card - `name` string, required: unused - `active` boolean, required - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `name` string, required: unused - `active` boolean, required - object - `type` 'check', required: Discriminator value: check - `name` string, required: unused - `active` boolean, required - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[], required - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY', required - `printDescription` boolean, required - object - `type` 'custom', required: Discriminator value: custom - `name` string, required: unused - `active` boolean, required - `schemaId` string, required - object - `type` 'bnpl', required: Discriminator value: bnpl - `name` string, required: unused - `active` boolean, required - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `name` string, required: unused - `active` boolean, required - object - `type` 'utility', required: Discriminator value: utility - `name` string, required: unused - `active` boolean, required - object - `type` 'na', required: Discriminator value: na - `name` string, required: unused - `active` boolean, required - object - `type` 'wallet', required: Discriminator value: wallet - `name` string, required: unused - `active` boolean, required - `vendorDisbursements` OrganizationTypesPaymentRailResponse[], required: List of payment methods that can be created by a payee to receive disbursements. - union - object - `type` 'bankAccount', required: Discriminator value: bankAccount - `name` string, required: unused - `active` boolean, required - `availableDeliveryMethods` InvoiceTypesBankDeliveryMethod[], required - `defaultDeliveryMethod` 'ACH_STANDARD' | 'ACH_SAME_DAY' | 'ACH_ACCELERATED', required - object - `type` 'card', required: Discriminator value: card - `name` string, required: unused - `active` boolean, required - object - `type` 'virtualCard', required: Discriminator value: virtualCard - `name` string, required: unused - `active` boolean, required - object - `type` 'check', required: Discriminator value: check - `name` string, required: unused - `active` boolean, required - `availableDeliveryMethods` InvoiceTypesCheckDeliveryMethod[], required - `defaultDeliveryMethod` 'PRINT' | 'MAIL' | 'MAIL_PRIORITY' | 'MAIL_UPS_NEXT_DAY', required - `printDescription` boolean, required - object - `type` 'custom', required: Discriminator value: custom - `name` string, required: unused - `active` boolean, required - `schemaId` string, required - object - `type` 'bnpl', required: Discriminator value: bnpl - `name` string, required: unused - `active` boolean, required - object - `type` 'offPlatform', required: Discriminator value: offPlatform - `name` string, required: unused - `active` boolean, required - object - `type` 'utility', required: Discriminator value: utility - `name` string, required: unused - `active` boolean, required - object - `type` 'na', required: Discriminator value: na - `name` string, required: unused - `active` boolean, required - object - `type` 'wallet', required: Discriminator value: wallet - `name` string, required: unused - `active` boolean, required - `emailProvider` OrganizationTypesEmailProviderResponse - `sender` OrganizationTypesEmailSenderResponse, required - `provider` 'none' | 'sendgrid' | 'ses' | 'resend' | 'cloudmailin', required - `fromEmail` string, required - `fromName` string, required - `hasApiKey` boolean, required - `useSmartReplyTo` boolean - `inboxDomain` string, required - `alternativeInboxDomains` string[], required - `externalAccountingSystemProvider` union - object - `type` 'none', required: Discriminator value: none - `hasApiKey` boolean, required - object - `type` 'codat', required: Discriminator value: codat - `hasApiKey` boolean, required - object - `type` 'rutter', required: Discriminator value: rutter - `hasClientId` boolean, required - `hasClientSecret` boolean, required - `colorScheme` OrganizationTypesColorSchemeResponse - `primaryColor` string - `secondaryColor` string - `logoBackgroundColor` string - `roundedCorners` integer - `fontFamily` string - `fontSize` string - `payeeOnboardingOptions` OrganizationTypesOnboardingOptionsResponse - `enableBusiness` boolean, required - `enableIndividual` boolean, required - `paymentMethod` boolean, required - `business` OrganizationTypesBusinessOnboardingOptionsResponse, required - `termsOfService` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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 - `address` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesIndividualOnboardingOptionsResponse, required - `termsOfService` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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 - `address` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionsResponse - `enableBusiness` boolean, required - `enableIndividual` boolean, required - `paymentMethod` boolean, required - `business` OrganizationTypesBusinessOnboardingOptionsResponse, required - `termsOfService` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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 - `address` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesIndividualOnboardingOptionsResponse, required - `termsOfService` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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 - `address` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesOnboardingOptionResponse, 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` OrganizationTypesMetadataSchema[] - `key` string, required - `displayName` string, required - `description` string - `lineItem` boolean: 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. - `type` 'STRING' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'KEY_VALUE', required - `allowMultiple` boolean: 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` OrganizationTypesMetadataValidationRule - `type` 'regex', required: Discriminator value: regex - `regex` string, required: A regular expression that the value must match. - `errorMessage` string, required: The error message to display if the value does not match the regular expression. - `showConditions` OrganizationTypesMetadataShowConditions - `alwaysHide` boolean: 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: Show this field only if the entity has values set for the metadata key. - `hasDocument` boolean: Show this field only if a document has been attached. - `hasNoLineItems` boolean: 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` PaymentMethodTypesPaymentMethodType[]: Show this field only if the payment source type is in this list. - `paymentSourceCustomSchemaIds` string[]: 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` PaymentMethodTypesPaymentMethodType[]: Show this field only if the payment destination type is in this list. - `paymentDestinationCustomSchemaIds` string[]: 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` OrganizationTypesMetadataOcrRules - `extractFromDocument` boolean: Attempt to extract this field from reading the document. Only applicable to line item metadata fields. Defaults to false. - `predictFromHistory` boolean: Attempt to predict this field from historical invoice metadata. Only applicable to line item metadata fields. Defaults to true. - `notificationEmailTemplate` OrganizationTypesNotificationEmailTemplateResponse - `backgroundStyle` string - `header` string - `body` string - `signature` string - `footer` string - `button` string - `customDomains` string[] - `organizationEntityId` string - `rolePermissions` OrganizationTypesRolePermissionResponse - `notificationsDisabled` boolean ## 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)