Endpoint: Listagem de Unidades

Endpoint de listagem de unidades cadastradas na plataforma da SULTS.

URL: https://api.sults.com.br/v1/empresas

Método: GET

Observação

Somente unidades com a situação ativa são retornadas. As unidades são ordenadas pelo nome fantasia.

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>

Query parameters

Parâmetro	Valor
start	Início da paginação (número da página). Padrão 0
limit	Número de registros por página. Máximo 100. Padrão 100
ativo	Boolean relacionado ao estado da unidade true – busca apenas empresas ativas. false – busca apenas empresas inativas. Padrão true.

Exemplo

Exemplo de requisição, irá retornar os 100 primeiros registros:

fetch("https://api.sults.com.br/v1/empresas?start=0&limit=100&ativo=true", {
	method: "GET",
	headers: {
		"Authorization": "<token_de_acesso>"
	}
})

Resultado

[
	{
		"id": 1,
		"ativo": true,
		"razaoSocial": "Exemplo de Empresa",
		"nomeFantasia": "Exemplo",
		"cnpj": "00000000000000",
		"inscricaoEstadual": "Exemplo ",
		"dtCadastro": "2022-01-01T12:00:00Z",
		"dtCadastroSistema": "2022-01-01T12:00:00Z",
		"dtInicioImplantacao": "2021-01-01T12:00:00Z",
		"dtFimImplantacao": "2021-01-01T12:00:00Z",
		"dtUltimaAlteracao": "2022-01-01T12:00:00Z",
		"dtInauguracao": "2021-01-01T12:00:00Z",
		"situacaoId": 1,
		"dtInativacao": "2022-01-01T12:00:00Z",
		"dtInativacaoSistema": "2022-01-01T12:00:00Z",
		"anotacaoAtencao": "Nota de atenção da empresa",
		"inativacaoPessoa": {
			"id": 99,
			"nome": "Usuário Teste"
		},
		"endereco": {
			"uf": "MG",
			"cidade": "Uberaba",
			"complemento": "",
			"numero": 15,
			"bairro": "Bairro Exemplo",
			"latitude": "0",
			"cep": "38000000",
			"rua": "Rua Exemplo",
			"longitude": "0"
		},
		"email": [
			"exemplo@sults.com.br"
		],
		"telefone": [
			"3400000000"
		],
		"celular": [
			"34000000000"
		],
		"receitaFederal": {
			"dtAberturaRF": "2020-01-01T12:00:00Z",
			"naturezaJuridicaRF": "206-2 - Sociedade Empresária Limitada",
			"situacaoEspecialRF": "",
			"dtSituacaoEspecialRF": "2020-01-01T12:00:00Z",
			"capitalSocialRF": 100000000.00,
			"motivoSituacaoEspecialRF": "",
			"situacaoRF": "ATIVA"
		},
		"campoAdicional": [
			{
				"id": 1,
				"label": "exemplo 1",
				"valor": ""
			},
			{
				"id": 2,
				"label": "exemplo 2",
				"valor": ""
			},
			{
				"id": 3,
				"label": "exemplo 3",
				"valor": ""
			}
		],
		"grupo": [
			{
				"id": 1,
				"nome": "Exemplo de Grupo",
				"categoria": {
					"id": 2,
					"nome": "Exemplo de Tipo de Grupo"
				}
			}
		],
		"formulario": [
			{
				"id": 1,
				"nome": "Financeiro",
				"campoAdicional": [
					{
						"id": 98,
						"label": "valor minimo",
						"valor": "4500.45",
						"grupo": {
							"nome": "Cobrança",
							"id": 9
						}
					},
					{
						"id": 94,
						"label": "aaaa",
						"valor": "valor campo aaa"
					}
				]
			},
			{
				"id": 2,
				"nome": "CS",
				"campoAdicional": [
					{
						"id": 97,
						"label": "pessoa a frente da unidade",
						"valor": "Augusto"
					},
					{
						"id": 96,
						"label": "Ultimo contato",
						"valor": "sim"
					}
				]
			}
		]
	}
]

Campos da reposta

Campos principais

Nome Atributo	Tipo	Descrição
id	Integer	Código da unidade
razaoSocial	String	Razão Social da unidade
ativo	Boolean	true – unidade ativa. false – unidade inativa.
nomeFantasia	String	Nome Fantasia da unidade
cnpj	String	CNPJ da Unidade
inscricaoEstadual	String	Inscrição Estadual da unidade
dtCadastro	String	Data em que a unidade foi criada.
dtCadastroSistema	String	Data em que a unidade foi cadastrada no sistema
dtInicioImplantacao	String	Data em que a unidade iniciou a implantação.
dtFimImplantacao	String	Data em que a unidade finalizou a implantação.
dtUltimaAlteracao	String	Data da última atualização no cadastro da unidade.
dtInauguracao	String	Data em que a unidade foi inaugurada.
situacaoId	String
dtInativacao	String	Data em que a unidade foi inativada.
dtInativacaoSistema	String	Data em que a unidade foi inativada no sistema.
anotacaoAtencao	String	Nota de atenção da unidade
inativacaoPessoa	Objeto Pessoa: – id – nome	Pessoa que inativou a unidade no sistema
email	Lista de String	Lista de emails da unidade
telefone	Lista de String	Lista de telefones da unidade
celular	Lista de String	Lista de celulares da unidade

Campos endereço

Nome Atributo	Tipo	Descrição
uf	String	Estado da unidade
cidade	String	Cidade da unidade
rua	String	Rua da unidade
numero	String	Número da rua da unidade
complemento	String	Complemento do endereço da unidade
bairro	String	Bairro da unidade
cep	String	Cep da unidade
latitude	String	Latitude da unidade
longitude	String	Longitude da unidade

Campos receita federal

Nome Atributo	Tipo	Descrição
dtAberturaRF	String	Data de abertura da unidade na receita federal
naturezaJuridicaRF	String	Natureza Jurídica da unidade
capitalSocialRF	Decimal	Capital social da unidade na receita federal
situacaoRF	String	Situação na receita federal
situacaoEspecialRF	String	Situação especial da unidade na receita federal
motivoSituacaoEspecialRF	String	Motivo da situação especial na receita federal
dtSituacaoEspecialRF	String	Data de cadastro da situação especial na receita federal

Campos do grupo da unidade

Nome Atributo	Tipo	Descrição
id	Integer	Código do grupo ao qual a unidade pertence
nome	String	Nome do grupo
categoria	Objeto Categoria – id – nome	Categoria ao qual o grupo da unidade pertence.

Campos adicionais da unidade

Nome Atributo	Tipo	Descrição
id	Integer	Código do campo adicional na unidade
label	String	Nome do campo adicional
valor	Dinâmico Observação: Os valores podem variar o tipo.	Valor do campo adicional.
grupo	Objeto Grupo – id – nome Observação: Esse campo pode ser nulo.	Grupo ao qual o campo adicional pertence.

Campos do formulário personalizado da unidade

Nome Atributo	Tipo	Descrição
id	Integer	Código do formulário da unidade
nome	String	Nome do formulário
campoAdicional	Lista Objeto CampoAdicional referente a tabela anterior	Lista de campos adicionais do formulário personalizado