Skip to main content
GET
Retorna os dados completos da empresa de energia solar.
API v1 - Este endpoint está disponível apenas na v1

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

companyMainContactEmail
string
required

Determina o e-mail do contato principal da empresa de energia solar a ser retornada.

Response

OK

cnpj
string
Example:

"00.000.000/0000-00"

cpf
string
Example:

"000.000.000-00"

fantasyName
string
Example:

"Nome fantasia"

companyName
string
Example:

"Razão social"

mainContact
object
address
object
accountStatus
string
Example:

"Ativo"

role
string
Example:

"Integrador VIP"

porte
string
Example:

"Empresa de grande / médio / pequeno porte"

tipo
string
Example:

"Matriz / Filial"

qsa
object[]
atividadePrincipal
object[]
atividadesSecundarias
object[]
hasStateInscription
string
Example:

"sim"

stateInscription
string

Este campo é retornado caso o campo 'temInscricaoEstadual' seja igual a 'sim'.

Example:

"000000000"

naturezaJuridica
string
situacaoCadastral
string
budgets
string[]
orders
string[]
customData
object[]
originFormatted
string

Retorna a origem da empresa

ordersAmount
number

Retorna a quantidade total de pedidos da empresa

totalPower
number

Retorna a potência total (kWp) dos pedidos da empresa

lastOrdertData
string

Retorna a data do último pedido da empresa no formato (DD/MM/AAAA)

budgetAmount
number

Retorna a quantidade total de orçamentos da empresa

budgetTotalPower
number

Retorna a potência total (kWp) dos orçamentos da empresa

lastBudgetDate
string

Retorna a data do último orçamento da empresa no formato (DD/MM/AAAA)

lastLogin
string

Retorna a data do último login dos usuários da empresa no formato (DD/MM/AAAA)

lastActivity
string

Retorna a data da última atividade dos usuários da empresa no formato (DD/MM/AAAA)