Skip to main content
GET
Lista todas as Unidades de Negócio

Query Parameters

searchText
string

Texto pesquisado para filtrar consulta

pagina
number

Página que deseja retornar os resultados

Example:

0

limite
number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

100

situacao
enum<string>[]

Campo para filtrar unidade de negocio por sua Situação

Available options:
ATIVO,
INATIVO,
RASCUNHO
regimeTributario
enum<string>[]

Campo para filtrar unidade de negocio por seu remime tributario

Available options:
LUCRO_PRESUMIDO,
SIMPLES_NACIONAL,
LUCRO_REAL,
IMUNE,
ISENTO,
MEI,
PRODUTOR_RURAL,
EMPREGADOR_DOMESTICO,
LUCRO_ARBITRADO,
OUTROS
estado
string[]

Campo para filtrar unidade de negocio por seu estado

cidade
string[]

Campo para filtrar unidade de negocio por sua cidade

minDataCriacao
string<date-time>

Campo para filtrar apenas unidade de negocio criadas após a data

maxDataCriacao
string<date-time>

Campo para filtrar apenas unidade de negocio criadas antes da data

Response

Unidades de Negócio

maxUnidades
number
required

Quantidade de unidades permitidas

Example:

0

pagina
number
required

Pagina retornada dos dados

Example:

0

limite
number
required

Quantidade de itens retornados na consulta

Example:

10

total
number
required

Quantidade total de unidades para consultar

Example:

5

unidades
object[]
required

Resultado da consulta

cards
object
required

Quantidades de unidades agrupado por tipo