> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pied.com.br/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retorna os dados completos da empresa de energia solar

> Retorna os dados completos da empresa de energia solar, incluindo a lista de todos os orçamentos e pedidos desta empresa.

<Note>
  **API v1** - Este endpoint está disponível apenas na v1
</Note>


## OpenAPI

````yaml /openapi/openapi-v1.json GET /company/{companyMainContactEmail}
openapi: 3.0.0
info:
  title: PIED API v1
  version: '1.0'
  description: >-
    API para gerenciamento de orçamentos, pedidos, equipamentos, empresas e
    colaboradores do sistema PIED.
servers:
  - url: https://backend-pied-prod.piedadmin.com.br/api/v1
    description: Servidor de produção v1
security:
  - bearerAuth: []
tags:
  - name: Request
    description: Tudo sobre orçamentos ou pedidos
  - name: Equipment
    description: Tudo sobre equipamentos
  - name: Company
    description: Tudo sobre empresas de energia
  - name: Staff
    description: Tudo sobre colaboradores
paths:
  /company/{companyMainContactEmail}:
    get:
      tags:
        - Company
      summary: 'Retorna os dados completos da empresa de energia solar. '
      description: >-
        Retorna os dados completos da empresa de energia solar, incluindo a
        lista de todos os orçamentos e pedidos desta empresa.
      parameters:
        - name: companyMainContactEmail
          in: path
          description: >-
            Determina o e-mail do contato principal da empresa de energia solar
            a ser retornada.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/company'
        '204':
          description: Nenhum registro encontrado
        '401':
          description: Esta funcionalidade está indisponível no momento
        '404':
          description: Não encontrado
        '429':
          description: >-
            hardLimit: O limite de requisições por hora foi ultrapassado. Tente
            novamente mais tarde / timeLimit: O limite de 1 minuto de
            processamento de requisição por hora foi atingido. Tente novamente
            mais tarde
        '500':
          description: Erro na API
      security:
        - bearerAuth: []
components:
  schemas:
    company:
      type: object
      properties:
        cnpj:
          type: string
          example: 00.000.000/0000-00
        cpf:
          type: string
          example: 000.000.000-00
        fantasyName:
          type: string
          example: Nome fantasia
        companyName:
          type: string
          example: Razão social
        mainContact:
          $ref: '#/components/schemas/mainContactCompany'
        address:
          $ref: '#/components/schemas/address'
        accountStatus:
          type: string
          example: Ativo
        role:
          type: string
          example: Integrador VIP
        porte:
          type: string
          example: Empresa de grande / médio / pequeno porte
        tipo:
          type: string
          example: Matriz / Filial
        qsa:
          items:
            $ref: '#/components/schemas/qsa'
          type: array
        atividadePrincipal:
          items:
            $ref: '#/components/schemas/atividadePrincipal'
          type: array
        atividadesSecundarias:
          items:
            $ref: '#/components/schemas/atividadesSecundarias'
          type: array
        hasStateInscription:
          type: string
          example: sim
          items:
            enum:
              - sim
              - nao
              - isento
        stateInscription:
          type: string
          example: '000000000'
          description: >-
            Este campo é retornado caso o campo 'temInscricaoEstadual' seja
            igual a 'sim'.
        naturezaJuridica:
          type: string
        situacaoCadastral:
          type: string
        budgets:
          type: array
          items:
            type: string
            example: '200000000'
        orders:
          type: array
          items:
            type: string
            example: '200000000'
        customData:
          type: array
          items:
            $ref: '#/components/schemas/customData'
        originFormatted:
          type: string
          description: Retorna a origem da empresa
        ordersAmount:
          type: number
          description: Retorna a quantidade total de pedidos da empresa
        totalPower:
          type: number
          description: Retorna a potência total (kWp) dos pedidos da empresa
        lastOrdertData:
          type: string
          description: Retorna a data do último pedido da empresa no formato (DD/MM/AAAA)
        budgetAmount:
          type: number
          description: Retorna a quantidade total de orçamentos da empresa
        budgetTotalPower:
          type: number
          description: Retorna a potência total (kWp) dos orçamentos da empresa
        lastBudgetDate:
          type: string
          description: >-
            Retorna a data do último orçamento da empresa no formato
            (DD/MM/AAAA)
        lastLogin:
          type: string
          description: >-
            Retorna a data do último login dos usuários da empresa no formato
            (DD/MM/AAAA)
        lastActivity:
          type: string
          description: >-
            Retorna a data da última atividade dos usuários da empresa no
            formato (DD/MM/AAAA)
    mainContactCompany:
      type: object
      properties:
        name:
          type: string
          example: Nome
        surname:
          type: string
          example: Sobrenome
        email:
          type: string
          example: email@email.com
        cellphone:
          type: string
          example: (00) 00000-0000
        address:
          $ref: '#/components/schemas/address'
    address:
      type: object
      properties:
        CEP:
          type: string
          example: 00000-000
        state:
          type: string
          example: SC
        city:
          type: string
          example: Nome da Cidade
        neighborhood:
          type: string
          example: Nome do Bairro
        patio:
          type: string
          example: Nome da Rua
        number:
          type: string
          example: '1000'
        complement:
          type: string
          example: Bloco X, Casa Y
    qsa:
      type: object
      properties:
        qual:
          type: string
          example: Sócio administrador
        nome:
          type: string
          example: Nome do sócio administrador
    atividadePrincipal:
      type: object
      properties:
        text:
          type: string
          example: Atividade principal CNPJ
        code:
          type: string
          example: 000.000-0-0
    atividadesSecundarias:
      type: object
      properties:
        text:
          type: string
          example: Atividade secundária CNPJ
        code:
          type: string
          example: 000.000-0-0
    customData:
      type: object
      properties:
        key:
          type: string
          description: Código de identificação do campo
        value:
          $ref: '#/components/schemas/customDataInputValue'
        type:
          type: string
          enum:
            - text
            - date
            - integer
            - decimal
            - currency
            - currencyGeneric
            - singleSelect
            - multiSelect
          description: Tipo do campo
    customDataInputValue:
      oneOf:
        - type: string
          description: Texto aberto
          default: '0000'
        - type: integer
          description: Número inteiro
          default: 1
        - type: number
          description: Número flutuante
          default: 900.9
        - type: array
          description: Seleção de múltiplos items
          default:
            - 1
            - 2
            - 3
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````