Mercoa Entity Group API

openapi: 3.2.0
info:
  title: Reference Entity Group API
  version: 1.0.0
servers:
- url: https://api.mercoa.com
  description: Production
tags:
- name: entity-group
paths:
  /entityGroup/{entityGroupId}/removeEntities:
    post:
      operationId: entityGroup_removeEntities
      summary: Remove Entities
      description: Remove entities from an entity group
      tags:
      - entity-group
      parameters:
      - name: entityGroupId
        in: path
        description: Entity Group ID or Entity Group ForeignID
        required: true
        schema:
          $ref: '#/components/schemas/entityGroupTypes_EntityGroupId'
      responses:
        '200':
          description: Response with status 200
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/entityGroupTypes_EntityGroupResponse'
        '400':
          description: Error response with status 400
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - BadRequest
                  content:
                    type: string
                required:
                - errorName
                - content
        '401':
          description: Error response with status 401
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - Unauthorized
                  content:
                    type: string
                required:
                - errorName
                - content
        '403':
          description: Error response with status 403
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - Forbidden
                  content:
                    type: string
                required:
                - errorName
                - content
        '404':
          description: Error response with status 404
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - NotFound
                  content:
                    type: string
                required:
                - errorName
                - content
        '409':
          description: Error response with status 409
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - Conflict
                  content:
                    type: string
                required:
                - errorName
                - content
        '500':
          description: Error response with status 500
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - InternalServerError
                  content:
                    type: string
                required:
                - errorName
                - content
        '501':
          description: Error response with status 501
          content:
            application/json:
              schema:
                type: object
                properties:
                  errorName:
                    type: string
                    enum:
                    - Unimplemented
                  content:
                    type: string
                required:
                - errorName
                - content
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/entityGroupTypes_EntityGroupRemoveEntitiesRequest'
      security:
      - default: []
components:
  schemas:
    entityTypes_EntityStatus:
      type: string
      enum:
      - unverified
      - pending
      - resubmit
      - review
      - verified
      - failed
      title: EntityStatus
    entityTypes_Ein:
      type: object
      properties:
        number:
          type: string
          description: Must be in the format XX-XXXXXXX.
      required:
      - number
      title: Ein
    entityTypes_EntityResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/entityTypes_EntityId'
        name:
          type: string
        email:
          type: string
        foreignId:
          type: string
          description: The ID used to identify this entity in your system
        emailTo:
          type: string
          description: Local-part/username of the email address to which to send invoices to be added to the Invoice Inbox.
        emailToAlias:
          type: array
          items:
            type: string
          description: Email inbox alias addresses. Used when forwarding emails to the emailTo address from an alias.
        isCustomer:
          type: boolean
          description: True if this entity has a direct relationship with your organization.
        accountType:
          $ref: '#/components/schemas/entityTypes_AccountType'
        profile:
          $ref: '#/components/schemas/entityTypes_ProfileResponse'
        logo:
          type: string
          description: URL for the entity logo
        status:
          $ref: '#/components/schemas/entityTypes_EntityStatus'
        oatfiStatus:
          type: string
          description: The OatFi status of this entity
        oatfiUnderwritingResponse:
          type: object
          additionalProperties:
            type: string
          description: The OatFi underwriting response of this entity
        acceptedTos:
          type: boolean
          description: True if this entity has accepted the terms of service.
        isPayor:
          type: boolean
          description: True if this entity can pay invoices.
        isPayee:
          type: boolean
          description: True if this entity can receive payments.
        isNetworkPayor:
          type: boolean
          description: True if this entity is available as a payor to any entity on your platform. Otherwise this entity will only be available as a payor to entities that have a direct relationship with this entity.
        isNetworkPayee:
          type: boolean
          description: True if this entity is available as a payee to any entity on your platform. Otherwise this entity will only be available as a payee to entities that have a direct relationship with this entity.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: Simple key/value metadata associated with this entity. For more complex metadata, use the Metadata API.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
      - id
      - name
      - email
      - isCustomer
      - accountType
      - profile
      - status
      - acceptedTos
      - isPayor
      - isPayee
      - isNetworkPayor
      - isNetworkPayee
      - createdAt
      - updatedAt
      title: EntityResponse
    entityTypes_IndustryCodes:
      type: object
      properties:
        mcc:
          type: string
      title: IndustryCodes
    entityGroupTypes_EntityGroupId:
      type: string
      title: EntityGroupId
    entityTypes_BusinessProfileResponse:
      type: object
      properties:
        email:
          type: string
        legalBusinessName:
          type: string
        businessType:
          $ref: '#/components/schemas/entityTypes_BusinessType'
        phone:
          $ref: '#/components/schemas/commons_PhoneNumber'
        doingBusinessAs:
          type: string
        website:
          type: string
        description:
          type: string
        address:
          $ref: '#/components/schemas/commons_Address'
        ownersProvided:
          type: boolean
          description: True if all representatives have been provided for this business.
        taxIDProvided:
          type: boolean
        taxId:
          $ref: '#/components/schemas/entityTypes_TaxID'
        formationDate:
          type: string
          format: date-time
        industryCodes:
          $ref: '#/components/schemas/entityTypes_IndustryCodes'
        averageMonthlyTransactionVolume:
          type: number
          format: double
        averageTransactionSize:
          type: number
          format: double
        maxTransactionSize:
          type: number
          format: double
      required:
      - legalBusinessName
      - taxIDProvided
      title: BusinessProfileResponse
    commons_PhoneNumber:
      type: object
      properties:
        countryCode:
          type: string
        number:
          type: string
      required:
      - countryCode
      - number
      title: PhoneNumber
    entityTypes_IndividualProfileResponse:
      type: object
      properties:
        email:
          type: string
        name:
          $ref: '#/components/schemas/commons_FullName'
        phone:
          $ref: '#/components/schemas/commons_PhoneNumber'
        address:
          $ref: '#/components/schemas/commons_Address'
        birthDateProvided:
          type: boolean
        governmentIDProvided:
          type: boolean
      required:
      - name
      - birthDateProvided
      - governmentIDProvided
      title: IndividualProfileResponse
    entityGroupTypes_EntityGroupRemoveEntitiesRequest:
      type: object
      properties:
        entityIds:
          type: array
          items:
            $ref: '#/components/schemas/entityTypes_EntityId'
          description: List of entity IDs or foreign IDs to remove from the group
      required:
      - entityIds
      title: EntityGroupRemoveEntitiesRequest
    entityTypes_ProfileResponse:
      type: object
      properties:
        business:
          $ref: '#/components/schemas/entityTypes_BusinessProfileResponse'
          description: Will be set if the entity is a business
        individual:
          $ref: '#/components/schemas/entityTypes_IndividualProfileResponse'
          description: Will be set if the entity is a individual
      title: ProfileResponse
    commons_Address:
      type: object
      properties:
        addressLine1:
          type: string
        addressLine2:
          type: string
        city:
          type: string
        stateOrProvince:
          type: string
          description: State or province code. Must be in the format XX.
        postalCode:
          type: string
          description: Postal code. Must be in the format XXXXX or XXXXX-XXXX.
        country:
          type: string
      required:
      - addressLine1
      - city
      - stateOrProvince
      - postalCode
      title: Address
    entityGroupTypes_EntityGroupResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/entityGroupTypes_EntityGroupId'
        foreignId:
          type: string
        name:
          type: string
        emailToName:
          type: string
        entities:
          type: array
          items:
            $ref: '#/components/schemas/entityTypes_EntityResponse'
        metadata:
          type: object
          additionalProperties:
            type: string
      required:
      - id
      - entities
      - metadata
      title: EntityGroupResponse
    entityTypes_EntityId:
      type: string
      title: EntityId
    commons_FullName:
      type: object
      properties:
        firstName:
          type: string
        middleName:
          type: string
        lastName:
          type: string
        suffix:
          type: string
      required:
      - firstName
      - lastName
      title: FullName
    entityTypes_AccountType:
      type: string
      enum:
      - business
      - individual
      title: AccountType
    entityTypes_BusinessType:
      type: string
      enum:
      - soleProprietorship
      - unincorporatedAssociation
      - trust
      - publicCorporation
      - privateCorporation
      - llc
      - partnership
      - unincorporatedNonProfit
      - incorporatedNonProfit
      title: BusinessType
    entityTypes_TaxID:
      type: object
      properties:
        ein:
          $ref: '#/components/schemas/entityTypes_Ein'
      required:
      - ein
      title: TaxID
  securitySchemes:
    default:
      type: http
      scheme: bearer