Skip to main content
GET
Retorna os dados das empresas de energia.
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

pageNumber
integer
required

Determina o número da página a ser retornada.

pageLimit
integer
required

Limita a quantidade de registros retornados por página.

Query Parameters

createdBefore
string

A pesquisa retorna registros criados até esta data passada no parâmetro. Formato (AAAA-MM-DD).

createdAfter
string

A pesquisa retorna registros criados a partir desta data passada no parâmetro. Formato (AAAA-MM-DD).

companyCNPJ
string

A pesquisa retorna registros nos quais o CNPJ da empresa de energia solar ou parte deste CNPJ é igual ao passado no parâmetro. Formato (00.000.000/000-00).

Exemplo: Para a pesquisa retornar registros com o CNPJ 01.234.567/0001-89, pode-se passar tanto o parâmetro 01.234.567/0001-89, quanto os parâmetros 0, 1, 2, 3, 4, 01, 56, 0001, 567/0001…

companyCPF
string

A pesquisa retorna registros nos quais o CPF da empresa de energia solar ou parte deste CPF é igual ao passado no parâmetro. Formato (000.000.000-00).

Exemplo: Para a pesquisa retornar registros com o CNPJ 012.345.678-90, pode-se passar tanto o parâmetro 012.345.678-90, quanto os parâmetros 0, 1, 2, 3, 4, 01, 67, 678, 678-90…

mainContactName
string

A pesquisa retorna registros nos quais o nome do contato principal da empresa de energia solar ou parte deste nome é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o nome ABCDE, pode-se passar tanto o parâmetro ABCDE, quanto os parâmetros A, B, C, D, E, AB, BC, ABC, CDE…

mainContactEmail
string

A pesquisa retorna registros nos quais o e-mail do contato principal da empresa de energia solar ou parte deste e-mail é igual ao passado no parâmetro.

Exemplo: Para a pesquisa retornar registros com o e-mail email@email.com, pode-se passar tanto o parâmetro email@email.com, quanto os parâmetros e, m, a, @, ail, .com, email, @email.com…

Response

OK

id
string

Retorna o identificador (ID) da empresa

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"

hasStateInscription
string
Example:

"sim"

stateInscription
string

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

Example:

"000000000"

naturezaJuridica
string
situacaoCadastral
string
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)

mainContact
object
address
object
customData
object[]