Skip to main content
GET
/
unidade-negocio
Lista todas as Unidades de Negócio
curl --request GET \
  --url https://api.example.com/unidade-negocio
{
  "maxUnidades": 0,
  "pagina": 0,
  "limite": 10,
  "total": 5,
  "unidades": [
    {
      "unidadeNegocioId": "1b88e4f3-04bf-4185-b782-9211e4b6bca4",
      "nome": "Pontua Matriz",
      "numeroCadastro": "12345678912",
      "logo": "//logo.png"
    }
  ],
  "cards": {
    "ativo": 15,
    "inativo": 4,
    "rascunho": 2
  }
}

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