Alleva

Alleva Referral Companies API

The ReferralCompanies API from Alleva — 14 operation(s) for referralcompanies.

GitHub OpenAPI

Operations 24

POST /referral-companies
GET /referral-companies
POST /v{version}/referral-companies
GET /v{version}/referral-companies
PATCH /referral-companies/{id}
GET /referral-companies/{id}
PATCH /v{version}/referral-companies/{id}
GET /v{version}/referral-companies/{id}
GET /referral-companies/{companyId}/notes/{noteId}
PUT /referral-companies/{companyId}/notes/{noteId}
PATCH /referral-companies/{companyId}/notes/{noteId}
GET /v{version}/referral-companies/{companyId}/notes/{noteId}
PUT /v{version}/referral-companies/{companyId}/notes/{noteId}
PATCH /v{version}/referral-companies/{companyId}/notes/{noteId}
GET /referral-companies/{companyId}/notes
POST /referral-companies/{companyId}/notes
GET /v{version}/referral-companies/{companyId}/notes
POST /v{version}/referral-companies/{companyId}/notes
GET /referral-companies/notes
GET /v{version}/referral-companies/notes
POST /referral-companies/{id}/logo
POST /v{version}/referral-companies/{id}/logo
POST /referral-companies/bulk
POST /v{version}/referral-companies/bulk

Documentation

📖
Documentation
https://api.helloalleva.com/swagger/index.html
📖
APIReference
https://api.helloalleva.com/swagger/index.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/alleva/refs/heads/main/openapi/alleva-referralcompanies-api-openapi.yml

Other Resources

🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/alleva/refs/heads/main/mcp/alleva-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/alleva-referralcompanies-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

alleva-referralcompanies-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Alleva Referral Companies API
  version: '1.0'
  description: 'Operations tagged ReferralCompanies across 2 of this provider''s published API definitions: alleva-referralcompanies-api-openapi.yml, alleva-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.helloalleva.com
  description: Base URL reconciled from apis.yml
security:
- Bearer: []
tags:
- name: ReferralCompanies
paths:
  /referral-companies:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: Limit
        in: query
        schema:
          type: integer
          format: int64
      - name: Cursor
        in: query
        schema:
          type: integer
          format: int32
      - name: StartDate
        in: query
        schema:
          type: string
          format: date-time
      - name: EndDate
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        in: query
        schema:
          type: array
          items:
            type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
  /v{version}/referral-companies:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralCompany'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: Limit
        in: query
        schema:
          type: integer
          format: int64
      - name: Cursor
        in: query
        schema:
          type: integer
          format: int32
      - name: StartDate
        in: query
        schema:
          type: string
          format: date-time
      - name: EndDate
        in: query
        schema:
          type: string
          format: date-time
      - name: fields
        in: query
        schema:
          type: array
          items:
            type: string
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
  /referral-companies/{id}:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    patch:
      tags:
      - ReferralCompanies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
          application/json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
          text/json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
          application/*+json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
  /v{version}/referral-companies/{id}:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    patch:
      tags:
      - ReferralCompanies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
          application/json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
          text/json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
          application/*+json; ver=1.0:
            schema:
              type: object
              additionalProperties:
                $ref: '#/components/schemas/JToken'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/ReferralCompany'
  /referral-companies/{companyId}/notes/{noteId}:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
    put:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
      responses:
        '200':
          description: Success
    patch:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
      responses:
        '200':
          description: Success
  /v{version}/referral-companies/{companyId}/notes/{noteId}:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
    put:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
      responses:
        '200':
          description: Success
    patch:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: noteId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
      responses:
        '200':
          description: Success
  /referral-companies/{companyId}/notes:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
      responses:
        '200':
          description: Success
  /v{version}/referral-companies/{companyId}/notes:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: companyId
        in: path
        required: true
        schema:
          type: integer
          format: int64
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralNoteCreationApiStruct'
      responses:
        '200':
          description: Success
  /referral-companies/notes:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
  /v{version}/referral-companies/notes:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    get:
      tags:
      - ReferralCompanies
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      responses:
        '200':
          description: Success
  /referral-companies/{id}/logo:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/UpdateResult'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/UpdateResult'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/UpdateResult'
  /v{version}/referral-companies/{id}/logo:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
          application/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
          text/json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
          application/*+json; ver=1.0:
            schema:
              $ref: '#/components/schemas/ReferralLogoData'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                $ref: '#/components/schemas/UpdateResult'
            application/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/UpdateResult'
            text/json; ver=1.0:
              schema:
                $ref: '#/components/schemas/UpdateResult'
  /referral-companies/bulk:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
          application/json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
          text/json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
          application/*+json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
  /v{version}/referral-companies/bulk:
    servers:
    - url: https://api.helloalleva.com
      description: Base URL reconciled from apis.yml
    post:
      tags:
      - ReferralCompanies
      parameters:
      - name: version
        in: path
        required: true
        schema:
          type: string
      - name: api-version
        in: query
        schema:
          type: string
      - name: X-Version
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json-patch+json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
          application/json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
          text/json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
          application/*+json; ver=1.0:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/ReferralCompany'
      responses:
        '200':
          description: Success
          content:
            text/plain; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            application/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
            text/json; ver=1.0:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReferralCompany'
components:
  schemas:
    ReferralLogoData:
      type: object
      properties:
        fileName:
          type:
          - string
          - 'null'
        base64String:
          type:
          - string
          - 'null'
      additionalProperties: false
    ReferralCompany:
      type: object
      properties:
        id:
          type: integer
          format: int32
        href:
          type:
          - string
          - 'null'
          readOnly: true
        name:
          type:
          - string
          - 'null'
        website:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        email:
          type:
          - string
          - 'null'
        phone:
          $ref: '#/components/schemas/Phone'
        address:
          $ref: '#/components/schemas/Address'
        createdById:
          type: integer
          format: int32
          writeOnly: true
        externalId:
          $ref: '#/components/schemas/ExternalData'
      additionalProperties: false
    UpdateResult:
      type: object
      properties:
        operationResult:
          $ref: '#/components/schemas/UpdateOperationResult'
        success:
          type: boolean
        id:
          type: integer
          format: int64
        messages:
          type:
          - array
          - 'null'
          items:
            type: string
        reason:
          type:
          - string
          - 'null'
      additionalProperties: false
    ReferralNoteCreationApiStruct:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        level:
          type:
          - string
          - 'null'
        content:
          type:
          - string
          - 'null'
        noteDate:
          type: string
          format: date-time
        authorId:
          type: integer
          format: int32
        creatorId:
          type: integer
          format: int32
          writeOnly: true
        modifierId:
          type: integer
          format: int32
          writeOnly: true
      additionalProperties: false
    ExternalData:
      type: object
      properties:
        externalId:
          type:
          - string
          - 'null'
        externalIdType:
          type:
          - string
          - 'null'
        serviceIdentifier:
          type:
          - string
          - 'null'
        serviceId:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    JToken:
      type: array
      items:
        $ref: '#/components/schemas/JToken'
    UpdateOperationResult:
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
      format: int32
    Phone:
      type: object
      properties:
        home:
          type:
          - string
          - 'null'
        office:
          type:
          - string
          - 'null'
        other:
          type:
          - string
          - 'null'
        number:
          type:
          - string
          - 'null'
        fax:
          type:
          - string
          - 'null'
      additionalProperties: false
    Address:
      type: object
      properties:
        line1:
          type:
          - string
          - 'null'
        line2:
          type:
          - string
          - 'null'
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        stateAbbr:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
        zipCode:
          type:
          - string
          - 'null'
      additionalProperties: false
  securitySchemes:
    Bearer:
      type: apiKey
      description: "JWT Authorization header using the Bearer scheme. \n\n Enter Bearer [space] and then your token in the text input below.\n\nExample: Bearer 12345abcdef"
      name: Authorization
      in: header
x-refined-from:
- alleva-referralcompanies-api-openapi.yml
- alleva-rest-api-openapi.yml