{"openapi":"3.0.0","paths":{"/zip/{code}":{"get":{"description":"Adquire os dados de um código de endereçamento postal, incluindo município IBGE.\n\n**Fontes de Dados**  \n- [Correios 🡭](https://buscacepinter.correios.com.br/app/endereco/index.php)\n\n**Frequência de Atualizações**  \n- Os dados são previamente armazenados em cache.  \n- Atualizações globais a cada 15 dias.\n\n**Custo**  \n- **0 ₪** por consulta.","operationId":"Consulta CEP","parameters":[{"name":"code","required":true,"in":"path","description":"Código de Endereçamento Postal.","schema":{"minLength":8,"maxLength":8,"format":"numeric","example":"01452922","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ZipDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta CEP","tags":["Códigos Postais"]}},"/suframa":{"get":{"description":"Adquire junto à SUFRAMA os dados cadastrais do estabelecimento, situação do projeto, atividades econômicas, e incentivos fiscais.\n\n**Fontes de Dados**  \n- [SUFRAMA 🡭](https://www4.suframa.gov.br/cadsuf/#/menu-externo)\n\n**Frequência de Atualizações**  \n- Os dados podem ser obtidos online em tempo real, ou previamente armazenados em cache.  \n- O modo de resolução irá respeitar a defasagem máxima fornecida em `maxAge`.  \n- Atualizações individuais sob demanda.\n\n**Custo**  \n- **1 ₪** por consulta online.  \n- **0 ₪** por consulta em cache.","operationId":"Consulta Suframa","parameters":[{"name":"taxId","required":true,"in":"query","description":"Número do CNPJ ou CPF sem pontuação.","schema":{"format":"cnpj|cpf","example":"37335118000180","type":"string"}},{"name":"strategy","required":false,"in":"query","description":"Estratégia de cache utilizada na aquisição dos dados:  \n- `CACHE`: Entrega os dados do cache, evitando cobranças de créditos, se os dados não estiverem disponíveis resultará em um erro 404.  \n- `CACHE_IF_FRESH`: Retorna os dados do cache respeitando o limite em `maxAge`, se os dados estiverem desatualizados será consultado online.  \n- `CACHE_IF_ERROR`: Idem ao `CACHE_IF_FRESH`, mas se a consulta online falhar retorna os dados do cache respeitando o limite em `maxStale`.  \n- `ONLINE`: Consulta diretamente online, não recomendado pois ignora qualquer cache, sugerimos configurar `maxAge=1` como alternativa.","schema":{"default":"CACHE_IF_ERROR","type":"string","enum":["ONLINE","CACHE_IF_FRESH","CACHE_IF_ERROR","CACHE"]}},{"name":"maxAge","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite, relevante para as estratégias `CACHE_IF_FRESH` e `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":45,"type":"number"}},{"name":"maxStale","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite em caso de erro na busca online, relevante apenas para a estratégia `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":365,"type":"number"}},{"name":"sync","required":false,"in":"query","description":"Aguarda a compensação dos créditos de forma síncrona, retornando o cabeçalho `cnpja-request-cost`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuframaDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Suframa","tags":["Suframa"]}},"/suframa/certificate":{"get":{"description":"Emite o comprovante em PDF do registro na Suframa.\n\n**Fontes de Dados**  \n- [SUFRAMA 🡭](https://www4.suframa.gov.br/cadsuf/#/menu-externo)\n\n**Frequência de Atualizações**  \n- Os dados são obtidos online em tempo real.\n\n**Custo**  \n- **1 ₪** por consulta.\n\n**Exemplos**  \n- [Estabelecimento Ativo](/proxy/api/assets/docs/suframa_certificate_01.pdf).  \n- [Estabelecimento Bloqueado](/proxy/api/assets/docs/suframa_certificate_02.pdf).  \n- [Estabelecimento com Múltiplos Incentivos](/proxy/api/assets/docs/suframa_certificate_03.pdf).","operationId":"Comprovante Suframa","parameters":[{"name":"taxId","required":true,"in":"query","description":"Número do CNPJ ou CPF sem pontuação.","schema":{"format":"cnpj|cpf","example":"37335118000180","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Buffer"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Comprovante Suframa","tags":["Suframa"]}},"/simples":{"get":{"description":"Adquire junto ao Simples Nacional a opção pelo regime, enquadramento no MEI, datas de inclusão, histórico de períodos, e eventos do regime regular do IBS e da CBS.\n\n**Fontes de Dados**  \n- [Simples Nacional 🡭](https://www8.receita.fazenda.gov.br/SimplesNacional/aplicacoes.aspx?id=21)\n\n**Frequência de Atualizações**  \n- Os dados podem ser obtidos online em tempo real, ou previamente armazenados em cache.  \n- O modo de resolução irá respeitar a defasagem máxima fornecida em `maxAge`.  \n- Atualizações individuais sob demanda.  \n- Atualizações globais a cada 30 dias.\n\n**Custo**  \n- **1 ₪** por consulta online.  \n- **0 ₪** por consulta em cache.  \n- Sujeito a adicionais conforme escolhas de parâmetros.","operationId":"Consulta Simples e MEI","parameters":[{"name":"taxId","required":true,"in":"query","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}},{"name":"history","required":false,"in":"query","description":"+**1 ₪** Adiciona o histórico de períodos\nanteriores do Simples e MEI, e os eventos do regime regular do IBS e da CBS.","schema":{"default":false,"type":"boolean"}},{"name":"strategy","required":false,"in":"query","description":"Estratégia de cache utilizada na aquisição dos dados:  \n- `CACHE`: Entrega os dados do cache, evitando cobranças de créditos, se os dados não estiverem disponíveis resultará em um erro 404.  \n- `CACHE_IF_FRESH`: Retorna os dados do cache respeitando o limite em `maxAge`, se os dados estiverem desatualizados será consultado online.  \n- `CACHE_IF_ERROR`: Idem ao `CACHE_IF_FRESH`, mas se a consulta online falhar retorna os dados do cache respeitando o limite em `maxStale`.  \n- `ONLINE`: Consulta diretamente online, não recomendado pois ignora qualquer cache, sugerimos configurar `maxAge=1` como alternativa.","schema":{"default":"CACHE_IF_ERROR","type":"string","enum":["ONLINE","CACHE_IF_FRESH","CACHE_IF_ERROR","CACHE"]}},{"name":"maxAge","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite, relevante para as estratégias `CACHE_IF_FRESH` e `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":45,"type":"number"}},{"name":"maxStale","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite em caso de erro na busca online, relevante apenas para a estratégia `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":365,"type":"number"}},{"name":"sync","required":false,"in":"query","description":"Aguarda a compensação dos créditos de forma síncrona, retornando o cabeçalho `cnpja-request-cost`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimplesDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Simples e MEI","tags":["Simples Nacional"]}},"/simples/certificate":{"get":{"description":"Emite o comprovante em PDF do registro no Simples Nacional.\n\n**Fontes de Dados**  \n- [Simples Nacional 🡭](https://www8.receita.fazenda.gov.br/SimplesNacional/aplicacoes.aspx?id=21)\n\n**Frequência de Atualizações**  \n- Os dados são obtidos online em tempo real.\n\n**Custo**  \n- **1 ₪** por consulta.\n\n**Exemplos**  \n- [Empresa Optante Simples Nacional](/proxy/api/assets/docs/simples_certificate_01.pdf).  \n- [Empresa Enquadrada no MEI](/proxy/api/assets/docs/simples_certificate_02.pdf).  \n- [Empresa Desenquadrada](/proxy/api/assets/docs/simples_certificate_03.pdf).","operationId":"Comprovante Simples e MEI","parameters":[{"name":"taxId","required":true,"in":"query","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Buffer"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Comprovante Simples e MEI","tags":["Simples Nacional"]}},"/rfb":{"get":{"description":"Adquire junto à Receita Federal os dados cadastrais do estabelecimento, atividades econômicas, e quadro de sócios e administradores.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)\n\n**Frequência de Atualizações**  \n- Os dados podem ser obtidos online em tempo real, ou previamente armazenados em cache.  \n- O modo de resolução irá respeitar a defasagem máxima fornecida em `maxAge`.  \n- Atualizações individuais sob demanda.  \n- Atualizações globais a cada 30 dias.\n\n**Custo**  \n- **1 ₪** por consulta online.  \n- **0 ₪** por consulta em cache.","operationId":"Consulta Receita Federal","parameters":[{"name":"taxId","required":true,"in":"query","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}},{"name":"strategy","required":false,"in":"query","description":"Estratégia de cache utilizada na aquisição dos dados:  \n- `CACHE`: Entrega os dados do cache, evitando cobranças de créditos, se os dados não estiverem disponíveis resultará em um erro 404.  \n- `CACHE_IF_FRESH`: Retorna os dados do cache respeitando o limite em `maxAge`, se os dados estiverem desatualizados será consultado online.  \n- `CACHE_IF_ERROR`: Idem ao `CACHE_IF_FRESH`, mas se a consulta online falhar retorna os dados do cache respeitando o limite em `maxStale`.  \n- `ONLINE`: Consulta diretamente online, não recomendado pois ignora qualquer cache, sugerimos configurar `maxAge=1` como alternativa.","schema":{"default":"CACHE_IF_ERROR","type":"string","enum":["ONLINE","CACHE_IF_FRESH","CACHE_IF_ERROR","CACHE"]}},{"name":"maxAge","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite, relevante para as estratégias `CACHE_IF_FRESH` e `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":45,"type":"number"}},{"name":"maxStale","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite em caso de erro na busca online, relevante apenas para a estratégia `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":365,"type":"number"}},{"name":"sync","required":false,"in":"query","description":"Aguarda a compensação dos créditos de forma síncrona, retornando o cabeçalho `cnpja-request-cost`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RfbDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Receita Federal","tags":["Receita Federal"]}},"/rfb/certificate":{"get":{"description":"Emite o comprovante em PDF do registro na Receita Federal.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)\n\n**Frequência de Atualizações**  \n- Os dados são obtidos online em tempo real.\n\n**Custo**  \n- **1 ₪** por consulta.\n\n**Exemplos**  \n- [Estabelecimento Ativo](/proxy/api/assets/docs/rfb_certificate_01.pdf).  \n- [Estabelecimento Baixado](/proxy/api/assets/docs/rfb_certificate_02.pdf).  \n- [Estabelecimento com Múltiplos CNAEs e Sócios](/proxy/api/assets/docs/rfb_certificate_03.pdf).  \n- [Estabelecimento Domiciliado no Exterior](/proxy/api/assets/docs/rfb_certificate_04.pdf).","operationId":"Comprovante RFB","parameters":[{"name":"taxId","required":true,"in":"query","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}},{"name":"pages","required":false,"in":"query","description":"Páginas a incluir no comprovante separadas por vírgula.","schema":{"default":"REGISTRATION,MEMBERS","type":"array","items":{"type":"string","enum":["REGISTRATION","MEMBERS"]}}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Buffer"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Comprovante RFB","tags":["Receita Federal"]}},"/person/{personId}":{"get":{"description":"Adquire os dados de uma pessoa, incluindo todos os quadros societários dos quais faz parte.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)\n\n**Frequência de Atualizações**  \n- Os dados são previamente armazenados em cache.  \n- Atualizações individuais sob demanda.  \n- Atualizações globais a cada 30 dias.\n\n**Custo**  \n- **0 ₪** por consulta.","operationId":"Consulta Pessoa","parameters":[{"name":"personId","required":true,"in":"path","description":"Código da pessoa.","schema":{"format":"uuid","example":"1e5ed433-0f39-4309-8e85-8d21a571b212","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Pessoa","tags":["Pessoas"]}},"/person":{"get":{"description":"Lista todas as pessoas que correspondem aos filtros configurados.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)\n\n**Frequência de Atualizações**  \n- Os dados são previamente armazenados em cache.  \n- Atualizações individuais sob demanda.  \n- Atualizações globais a cada 30 dias.\n\n**Custo**  \n- **1 ₪** por cada 10 registros.","operationId":"Pesquisa Pessoas","parameters":[{"name":"token","required":false,"in":"query","description":"Token de paginação, mutualmente exclusivo com as demais propriedades.","schema":{"minLength":32,"maxLength":32,"format":"not empty","example":"8d47bdcbde4a7a2d4a98d5f555a19701","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Quantidade de registros a serem lidos por página.","schema":{"minimum":1,"maximum":1000,"format":"integer","default":10,"type":"number"}},{"name":"type.in","required":false,"in":"query","description":"Tipos das pessoas serem incluídos, separados por vírgula:  \n- `NATURAL`: Pessoa física.  \n- `LEGAL`: Pessoa jurídica.  \n- `FOREIGN`: Pessoa residente no exterior.  \n- `UNKNOWN`: Pessoa desconhecida.","schema":{"example":"NATURAL,LEGAL","type":"array","items":{"type":"string","enum":["LEGAL","NATURAL","FOREIGN","UNKNOWN"]}}},{"name":"name.in","required":false,"in":"query","description":"Nomes a serem incluídos, separados por espaço para correspondência na mesma pessoa,\nou separados por vírgula para correspondência em diferentes.","schema":{"example":"Maria Oliveira,Ana Martins,João","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"name.nin","required":false,"in":"query","description":"Nomes a serem excluídos, separados por espaço para correspondência na mesma pessoa,\nou separados por vírgula para correspondência em diferentes.","schema":{"example":"Maria Oliveira,Ana Martins,João","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"taxId.in","required":false,"in":"query","description":"CPFs ou CNPJs a serem incluídos, separados por vírgula. A correspondência por CPF será feita pelos\ndígitos entre o quarto e nono, uma vez que não armazenamos CPFs completos em nossa plataforma.","schema":{"example":"78326957062,92854908082,07526557000100","type":"array","items":{"type":"string","format":"cnpj|cpf"}}},{"name":"age.in","required":false,"in":"query","description":"Faixas etárias a serem incluídas, separadas por vírgula.","schema":{"example":"21-30,31-40","type":"array","items":{"type":"string","enum":["0-12","13-20","21-30","31-40","41-50","51-60","61-70","71-80","81+"]}}},{"name":"country.id.in","required":false,"in":"query","description":"Códigos dos países a serem incluídos, separados por vírgula, conforme\n[M49 🡭](https://unstats.un.org/unsd/methodology/m49/).","schema":{"example":"32,152,600","type":"array","items":{"type":"number","format":"integer"}}},{"name":"country.id.nin","required":false,"in":"query","description":"Códigos dos países a serem excluídos, separados por vírgula, conforme\n[M49 🡭](https://unstats.un.org/unsd/methodology/m49/).","schema":{"example":"32,152,600","type":"array","items":{"type":"number","format":"integer"}}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonPageDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Pesquisa Pessoas","tags":["Pessoas"]}},"/office/{taxId}":{"get":{"description":"Adquire de forma centralizada múltiplas informações de um estabelecimento, incluindo acesso a diversos portais públicos e enriquecimentos externos.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)  \n- [Simples Nacional 🡭](https://www8.receita.fazenda.gov.br/SimplesNacional/aplicacoes.aspx?id=21)  \n- [Cadastro de Contribuintes 🡭](https://dfe-portal.svrs.rs.gov.br/NFE/CCC)  \n- [SUFRAMA 🡭](https://www4.suframa.gov.br/cadsuf/#/menu-externo)\n\n**Frequência de Atualizações**  \n- Os dados podem ser obtidos online em tempo real, ou previamente armazenados em cache.  \n- O modo de resolução irá respeitar a defasagem máxima fornecida em `maxAge`.  \n- Atualizações individuais sob demanda.\n\n**Custo**  \n- **1 ₪** por consulta online.  \n- **0 ₪** por consulta em cache.  \n- Sujeito a adicionais conforme escolhas de parâmetros.","operationId":"Consulta CNPJ","parameters":[{"name":"taxId","required":true,"in":"path","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}},{"name":"simples","required":false,"in":"query","description":"+**1 ₪** Adiciona as informações de opção pelo\nSimples e enquadramento no MEI.","schema":{"default":false,"type":"boolean"}},{"name":"simplesHistory","required":false,"in":"query","description":"+**1 ₪** Adiciona o histórico de períodos\nanteriores do Simples e MEI.","schema":{"default":false,"type":"boolean"}},{"name":"registrations","required":false,"in":"query","description":"+**1 ₪** quando `registrationsSource` for `CCC`, \n+**1 ₪** por UF quando `registrationsSource` for `SINTEGRA`.\nAdiciona as Inscrições Estaduais para as selecionadas Unidades Federativas separadas por vírgula.\nAceita os termos especiais `ORIGIN` (mesma UF do endereço do estabelecimento) e `ALL` (todas).","schema":{"minItems":1,"example":"PR,RS,SC","type":"array","items":{"type":"string","enum":["ORIGIN","ALL","AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]}}},{"name":"registrationsSource","required":false,"in":"query","description":"Fonte de dados para obtenção das Inscrições Estaduais:  \n- `AUTO`: Idem a utilizar `CCC`, sujeito a alterações no futuro caso credenciais sejam necessárias.  \n- `CCC`: Utiliza o Cadastro Centralizado de Contribuintes para leitura de todas as inscrições.  \n- `SINTEGRA`: Utiliza individualmente cada SINTEGRA estadual para leitura das inscrições.","schema":{"default":"AUTO","type":"string","enum":["AUTO","CCC","SINTEGRA"]}},{"name":"suframa","required":false,"in":"query","description":"+**1 ₪** Adiciona a inscrição na SUFRAMA.","schema":{"default":false,"type":"boolean"}},{"name":"geocoding","required":false,"in":"query","description":"+**1 ₪** Adiciona a latitude e longitude do endereço.","schema":{"default":false,"type":"boolean"}},{"name":"links","required":false,"in":"query","description":"Adiciona links públicos para visualização dos arquivos selecionados separados por vírgula.","schema":{"example":"RFB_CERTIFICATE,SIMPLES_CERTIFICATE","type":"array","items":{"type":"string","enum":["RFB_CERTIFICATE","SIMPLES_CERTIFICATE","CCC_CERTIFICATE","SUFRAMA_CERTIFICATE","OFFICE_MAP","OFFICE_STREET"]}}},{"name":"strategy","required":false,"in":"query","description":"Estratégia de cache utilizada na aquisição dos dados:  \n- `CACHE`: Entrega os dados do cache, evitando cobranças de créditos, se os dados não estiverem disponíveis resultará em um erro 404.  \n- `CACHE_IF_FRESH`: Retorna os dados do cache respeitando o limite em `maxAge`, se os dados estiverem desatualizados será consultado online.  \n- `CACHE_IF_ERROR`: Idem ao `CACHE_IF_FRESH`, mas se a consulta online falhar retorna os dados do cache respeitando o limite em `maxStale`.  \n- `ONLINE`: Consulta diretamente online, não recomendado pois ignora qualquer cache, sugerimos configurar `maxAge=1` como alternativa.","schema":{"default":"CACHE_IF_ERROR","type":"string","enum":["ONLINE","CACHE_IF_FRESH","CACHE_IF_ERROR","CACHE"]}},{"name":"maxAge","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite, relevante para as estratégias `CACHE_IF_FRESH` e `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":45,"type":"number"}},{"name":"maxStale","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite em caso de erro na busca online, relevante apenas para a estratégia `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":365,"type":"number"}},{"name":"sync","required":false,"in":"query","description":"Aguarda a compensação dos créditos de forma síncrona, retornando o cabeçalho `cnpja-request-cost`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficeDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta CNPJ","tags":["Estabelecimentos"]}},"/office":{"get":{"description":"Lista todos os estabelecimentos que correspondem aos filtros configurados.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)\n\n**Frequência de Atualizações**  \n- Os dados são previamente armazenados em cache.  \n- Atualizações individuais sob demanda.  \n- Atualizações globais a cada 30 dias.\n\n**Custo**  \n- **1 ₪** por cada 10 registros.","operationId":"Pesquisa CNPJ","parameters":[{"name":"token","required":false,"in":"query","description":"Token de paginação, mutualmente exclusivo com as demais propriedades.","schema":{"minLength":32,"maxLength":32,"format":"not empty","example":"8d47bdcbde4a7a2d4a98d5f555a19701","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Quantidade de registros a serem lidos por página.","schema":{"minimum":1,"maximum":1000,"format":"integer","default":10,"type":"number"}},{"name":"names.in","required":false,"in":"query","description":"Termos a serem incluídos na razão social ou nome fantasia, separados por espaço para correspondência\nno mesmo estabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"CNPJá,Banco do Brasil,AMBEV S/A","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"names.nin","required":false,"in":"query","description":"Termos a serem excluídos na razão social ou nome fantasia, separados por espaço para correspondência\nno mesmo estabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"EI,Eireli,LTDA","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"company.name.in","required":false,"in":"query","description":"Termos a serem incluídos na razão social, separados por espaço para correspondência na mesma empresa,\nou separados por vírgula para correspondência em diferentes.","schema":{"example":"CNPJá,Banco do Brasil,AMBEV S/A","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"company.name.nin","required":false,"in":"query","description":"Termos a serem excluídos na razão social, separados por espaço para correspondência na mesma empresa,\nou separados por vírgula para correspondência em diferentes.","schema":{"example":"EI,Eireli,LTDA","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"company.equity.gte","required":false,"in":"query","description":"Capital social maior ou igual ao valor especificado.","schema":{"minimum":0,"format":"float","example":12345.67,"type":"number"}},{"name":"company.equity.lte","required":false,"in":"query","description":"Capital social menor ou igual ao valor especificado.","schema":{"minimum":0,"format":"float","example":98765.43,"type":"number"}},{"name":"company.nature.id.in","required":false,"in":"query","description":"Códigos das naturezas jurídicas a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/estrutura/natjur-estrutura/natureza-juridica-2021).","schema":{"example":"1015,2011,3034","type":"array","items":{"type":"number","format":"integer"}}},{"name":"company.nature.id.nin","required":false,"in":"query","description":"Códigos das naturezas jurídicas a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/estrutura/natjur-estrutura/natureza-juridica-2021).","schema":{"example":"1015,2011,3034","type":"array","items":{"type":"number","format":"integer"}}},{"name":"company.size.id.in","required":false,"in":"query","description":"Códigos dos portes a serem incluídos, separados por vírgula:  \n- `1`: Microempresa (ME).  \n- `3`: Empresa de Pequeno Porte (EPP).  \n- `5`: Demais.","schema":{"example":"1,3","type":"array","items":{"type":"number","format":"integer"}}},{"name":"company.simples.optant.eq","required":false,"in":"query","description":"Indicador de opção pelo Simples Nacional:  \n- `true`: Apenas empresas optantes.  \n- `false`: Apenas empresas não optantes.","schema":{"example":true,"type":"boolean"}},{"name":"company.simples.since.gte","required":false,"in":"query","description":"Data de opção pelo Simples Nacional maior ou igual a especificada.","schema":{"format":"iso8601","example":"2018-01-01","type":"string"}},{"name":"company.simples.since.lte","required":false,"in":"query","description":"Data de opção pelo Simples Nacional menor ou igual a especificada.","schema":{"format":"iso8601","example":"2020-12-31","type":"string"}},{"name":"company.simei.optant.eq","required":false,"in":"query","description":"Indicador de enquadramento no MEI:  \n- `true`: Apenas empresas enquadradas.  \n- `false`: Apenas empresas não enquadradas.","schema":{"example":true,"type":"boolean"}},{"name":"company.simei.since.gte","required":false,"in":"query","description":"Data de enquadramento no MEI maior ou igual a especificada.","schema":{"format":"iso8601","example":"2018-01-01","type":"string"}},{"name":"company.simei.since.lte","required":false,"in":"query","description":"Data de enquadramento no MEI menor ou igual a especificada.","schema":{"format":"iso8601","example":"2020-12-31","type":"string"}},{"name":"taxId.nin","required":false,"in":"query","description":"Identificadores de listas de CNPJs a serem excluídos, separados por vírgula.","schema":{"example":"37505509-b2a5-42c2-94f4-aa99d2033bf5","type":"array","items":{"type":"string","format":"uuid"}}},{"name":"alias.in","required":false,"in":"query","description":"Termos a serem incluídos no nome fantasia, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"CNPJá,Banco do Brasil,AMBEV S/A","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"alias.nin","required":false,"in":"query","description":"Termos a serem excluídos no nome fantasia, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"Eireli,LTDA","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"founded.gte","required":false,"in":"query","description":"Data de abertura maior ou igual a especificada.","schema":{"format":"iso8601","example":"2018-01-01","type":"string"}},{"name":"founded.lte","required":false,"in":"query","description":"Data de abertura menor ou igual a especificada.","schema":{"format":"iso8601","example":"2020-12-31","type":"string"}},{"name":"head.eq","required":false,"in":"query","description":"Indicador de estabelecimento matriz:  \n- `true`: Apenas matrizes.  \n- `false`: Apenas filiais.","schema":{"example":true,"type":"boolean"}},{"name":"statusDate.gte","required":false,"in":"query","description":"Data da situação cadastral maior ou igual a especificada.","schema":{"format":"iso8601","example":"2018-01-01","type":"string"}},{"name":"statusDate.lte","required":false,"in":"query","description":"Data da situação cadastral menor ou igual a especificada.","schema":{"format":"iso8601","example":"2020-12-31","type":"string"}},{"name":"status.id.in","required":false,"in":"query","description":"Códigos das situações cadastrais a serem incluídos, separados por vírgula:  \n- `1`: Nula.  \n- `2`: Ativa.  \n- `3`: Suspensa.  \n- `4`: Inapta.  \n- `8`: Baixada.","schema":{"example":"3,4,8","type":"array","items":{"type":"number","format":"integer"}}},{"name":"reason.id.in","required":false,"in":"query","description":"Códigos dos motivos das situações cadastrais a serem incluídos, separados por vírgula, conforme\n[Receita Federal 🡭](http://www.consultas.cge.rj.gov.br/scadastral.pdf).","schema":{"example":"1,3,5","type":"array","items":{"type":"number","format":"integer"}}},{"name":"specialDate.gte","required":false,"in":"query","description":"Data da situação especial maior ou igual a especificada.","schema":{"format":"iso8601","example":"2018-01-01","type":"string"}},{"name":"specialDate.lte","required":false,"in":"query","description":"Data da situação especial menor ou igual a especificada.","schema":{"format":"iso8601","example":"2020-12-31","type":"string"}},{"name":"special.id.in","required":false,"in":"query","description":"Códigos das situações especiais a serem incluídos, separados por vírgula, conforme\n[Receita Federal 🡭](http://www38.receita.fazenda.gov.br/cadsincnac/jsp/coleta/ajuda/topicos/Eventos_de_Alteracao.htm).","schema":{"example":"405,410,417","type":"array","items":{"type":"number","format":"integer"}}},{"name":"address.municipality.in","required":false,"in":"query","description":"Códigos dos municípios a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://www.ibge.gov.br/explica/codigos-dos-municipios.php).","schema":{"example":"4106902,4205407,4314902","type":"array","items":{"type":"number","format":"integer"}}},{"name":"address.municipality.nin","required":false,"in":"query","description":"Códigos dos municípios a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://www.ibge.gov.br/explica/codigos-dos-municipios.php).","schema":{"example":"4106902,4205407,4314902","type":"array","items":{"type":"number","format":"integer"}}},{"name":"address.street.in","required":false,"in":"query","description":"Termos a serem incluídos no logradouro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"Avenida Copacabana,Rua das Pedras,Rua Oscar Freire","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.street.nin","required":false,"in":"query","description":"Termos a serem excluídos no logradouro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"Avenida Copacabana,Rua das Pedras,Rua Oscar Freire","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.number.in","required":false,"in":"query","description":"Números do logradouro a serem incluídos, separados por vírgula.","schema":{"example":"10,435,10387","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.number.nin","required":false,"in":"query","description":"Números do logradouro a serem excluídos, separados por vírgula.","schema":{"example":"10,435,10387","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.details.in","required":false,"in":"query","description":"Termos a serem incluídos no complemento, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"Cj 1403,Andar 4,Bloco C","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.details.nin","required":false,"in":"query","description":"Termos a serem excluídos no complemento, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"Cj 1403,Andar 4,Bloco C","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.district.in","required":false,"in":"query","description":"Termos a serem incluídos no bairro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"Leblon,Vila Olímpia,Belvedere","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.district.nin","required":false,"in":"query","description":"Termos a serem excluídos no bairro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","schema":{"example":"Leblon,Vila Olímpia,Belvedere","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"address.state.in","required":false,"in":"query","description":"Unidades federativas a serem incluídas, separadas por vírgula.","schema":{"example":"ES,RJ,SP","type":"array","items":{"type":"string","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]}}},{"name":"address.zip.in","required":false,"in":"query","description":"Códigos de endereçamento postal a serem incluídos, separados por vírgula.","schema":{"minLength":8,"maxLength":8,"example":"01430000,01452922,01310100","type":"array","items":{"type":"string","format":"numeric"}}},{"name":"address.zip.gte","required":false,"in":"query","description":"Código de endereçamento postal maior ou igual ao especificado.","schema":{"minLength":8,"maxLength":8,"format":"numeric","example":"01452922","type":"string"}},{"name":"address.zip.lte","required":false,"in":"query","description":"Código de endereçamento postal menor ou igual ao especificado.","schema":{"minLength":8,"maxLength":8,"format":"numeric","example":"01452922","type":"string"}},{"name":"address.country.id.in","required":false,"in":"query","description":"Códigos dos países a serem incluídos, separados por vírgula, conforme\n[M49 🡭](https://unstats.un.org/unsd/methodology/m49/).","schema":{"example":"32,152,600","type":"array","items":{"type":"number","format":"integer"}}},{"name":"address.country.id.nin","required":false,"in":"query","description":"Códigos dos países a serem excluídos, separados por vírgula, conforme\n[M49 🡭](https://unstats.un.org/unsd/methodology/m49/).","schema":{"example":"32,152,600","type":"array","items":{"type":"number","format":"integer"}}},{"name":"phones.ex","required":false,"in":"query","description":"Indicador de existência de telefone:  \n- `true`: Apenas estabelecimentos com telefone.  \n- `false`: Apenas estabelecimentos sem telefone.","schema":{"example":true,"type":"boolean"}},{"name":"phones.type.in","required":false,"in":"query","description":"Tipos de telefone a serem incluídos, separados por vírgula.","schema":{"example":"LANDLINE,MOBILE","type":"array","items":{"type":"string","enum":["LANDLINE","MOBILE"]}}},{"name":"phones.area.in","required":false,"in":"query","description":"Códigos de DDD a serem incluídos, separados por vírgula.","schema":{"minLength":2,"maxLength":2,"example":"11,13,15","type":"array","items":{"type":"string","format":"numeric"}}},{"name":"phones.area.nin","required":false,"in":"query","description":"Códigos de DDD a serem excluídos, separados por vírgula.","schema":{"minLength":2,"maxLength":2,"example":"11,13,15","type":"array","items":{"type":"string","format":"numeric"}}},{"name":"phones.area.gte","required":false,"in":"query","description":"Códigos de DDD maior ou igual ao especificado.","schema":{"minLength":2,"maxLength":2,"format":"numeric","example":"11","type":"string"}},{"name":"phones.area.lte","required":false,"in":"query","description":"Códigos de DDD menor ou igual ao especificado.","schema":{"minLength":2,"maxLength":2,"format":"numeric","example":"11","type":"string"}},{"name":"phones.number.in","required":false,"in":"query","description":"Números de telefone a serem incluídos, separados por vírgula.","schema":{"minLength":8,"maxLength":8,"example":"92635835,44594576,36285962","type":"array","items":{"type":"string","format":"numeric"}}},{"name":"phones.number.nin","required":false,"in":"query","description":"Números de telefone a serem excluídos, separados por vírgula.","schema":{"minLength":8,"maxLength":8,"example":"92635835,44594576,36285962","type":"array","items":{"type":"string","format":"numeric"}}},{"name":"emails.ex","required":false,"in":"query","description":"Indicador de existência de e-mail:  \n- `true`: Apenas estabelecimentos com e-mail.  \n- `false`: Apenas estabelecimentos sem e-mail.","schema":{"example":true,"type":"boolean"}},{"name":"emails.ownership.in","required":false,"in":"query","description":"Tipos de propriedade de e-mail a serem incluídos, separados por vírgula.","schema":{"example":"CORPORATE,ACCOUNTING","type":"array","items":{"type":"string","enum":["ACCOUNTING","CORPORATE","PERSONAL"]}}},{"name":"emails.address.in","required":false,"in":"query","description":"Endereços de e-mail a serem incluídos, separados por vírgula.","schema":{"example":"alex.costa@company.com,jane.doe@gmail.com,support@domain.com","type":"array","items":{"type":"string","format":"e-mail"}}},{"name":"emails.address.nin","required":false,"in":"query","description":"Endereços de e-mail a serem excluídos, separados por vírgula.","schema":{"example":"alex.costa@company.com,jane.doe@gmail.com,support@domain.com","type":"array","items":{"type":"string","format":"e-mail"}}},{"name":"emails.domain.in","required":false,"in":"query","description":"Domínios de e-mail a serem incluídos, separados por vírgula.","schema":{"example":"cnpja.com,bb.com.br,ambev.com.br","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"emails.domain.nin","required":false,"in":"query","description":"Domínios de e-mail a serem excluídos, separados por vírgula.","schema":{"example":"gmail.com,hotmail.com,yahoo.com","type":"array","items":{"type":"string","format":"not empty"}}},{"name":"activities.id.in","required":false,"in":"query","description":"Códigos das atividades econômicas principais ou secundárias a serem incluídos, separados por vírgula,\nconforme [IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","schema":{"example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}}},{"name":"activities.id.nin","required":false,"in":"query","description":"Códigos das atividades econômicas principais ou secundárias a serem excluídos, separados por vírgula,\nconforme [IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","schema":{"example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}}},{"name":"mainActivity.id.in","required":false,"in":"query","description":"Códigos das atividades econômicas principais a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","schema":{"example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}}},{"name":"mainActivity.id.nin","required":false,"in":"query","description":"Códigos das atividades econômicas principais a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","schema":{"example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}}},{"name":"sideActivities.id.in","required":false,"in":"query","description":"Códigos das atividades econômicas secundárias a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","schema":{"example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}}},{"name":"sideActivities.id.nin","required":false,"in":"query","description":"Códigos das atividades econômicas secundárias a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","schema":{"example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfficePageDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Pesquisa CNPJ","tags":["Estabelecimentos"]}},"/office/{taxId}/map":{"get":{"description":"Gera o mapa aéreo referente ao endereço do estabelecimento.\n\n**Fontes de Dados**  \n- [Google Maps 🡭](https://developers.google.com/maps)\n\n**Frequência de Atualizações**  \n- Os dados são obtidos online em tempo real.\n\n**Custo**  \n- **3 ₪** por consulta.\n\n**Exemplos**  \n- Tamanho: [640x640](/proxy/api/assets/docs/map_size_640x640.png), [320x320](/proxy/api/assets/docs/map_size_320x320.png), [160x160](/proxy/api/assets/docs/map_size_160x160.png).  \n- Densidade: [1](/proxy/api/assets/docs/map_size_640x640.png), [2](/proxy/api/assets/docs/map_size_640x640x2.png).  \n- Zoom: [2](/proxy/api/assets/docs/map_zoom_02.png), [5](/proxy/api/assets/docs/map_zoom_05.png), [8](/proxy/api/assets/docs/map_zoom_08.png), [11](/proxy/api/assets/docs/map_zoom_11.png), [14](/proxy/api/assets/docs/map_zoom_14.png), [17](/proxy/api/assets/docs/map_zoom_17.png), [20](/proxy/api/assets/docs/map_zoom_20.png).  \n- Tipo: [roadmap](/proxy/api/assets/docs/map_type_roadmap.png), [terrain](/proxy/api/assets/docs/map_type_terrain.png), [satellite](/proxy/api/assets/docs/map_type_satellite.png), [hybrid](/proxy/api/assets/docs/map_type_hybrid.png).","operationId":"Mapa Aéreo","parameters":[{"name":"taxId","required":true,"in":"path","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}},{"name":"width","required":false,"in":"query","description":"Largura em pixels.","schema":{"minimum":80,"maximum":640,"format":"integer","default":640,"type":"number"}},{"name":"height","required":false,"in":"query","description":"Altura em pixels.","schema":{"minimum":80,"maximum":640,"format":"integer","default":640,"type":"number"}},{"name":"scale","required":false,"in":"query","description":"Multiplicador de densidade de pixels.","schema":{"minimum":1,"maximum":2,"format":"integer","default":1,"type":"number"}},{"name":"zoom","required":false,"in":"query","description":"Nível de ampliação.","schema":{"minimum":1,"maximum":20,"format":"integer","default":17,"type":"number"}},{"name":"type","required":false,"in":"query","description":"Tipo do mapa:  \n- `roadmap`: Rodovias.  \n- `terrain`: Elevação.  \n- `satellite`: Satélite.  \n- `hybrid`: Rodovias e satélite.","schema":{"default":"roadmap","type":"string","enum":["roadmap","terrain","satellite","hybrid"]}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"image/png":{"schema":{"$ref":"#/components/schemas/Buffer"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Mapa Aéreo","tags":["Estabelecimentos"]}},"/office/{taxId}/street":{"get":{"description":"Gera a visão da rua referente ao endereço do estabelecimento.\n\n**Fontes de Dados**  \n- [Google Maps 🡭](https://developers.google.com/maps)\n\n**Frequência de Atualizações**  \n- Os dados são obtidos online em tempo real.\n\n**Custo**  \n- **10 ₪** por consulta.\n\n**Exemplos**  \n- Tamanho: [640x640](/proxy/api/assets/docs/street_size_640x640.png), [640x400](/proxy/api/assets/docs/street_size_640x400.png), [320x320](/proxy/api/assets/docs/street_size_320x320.png), [320x200](/proxy/api/assets/docs/street_size_320x200.png).  \n- Campo de visão: [120](/proxy/api/assets/docs/street_fov_120.png), [90](/proxy/api/assets/docs/street_fov_90.png), [60](/proxy/api/assets/docs/street_fov_60.png).","operationId":"Visão da Rua","parameters":[{"name":"taxId","required":true,"in":"path","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}},{"name":"width","required":false,"in":"query","description":"Largura em pixels.","schema":{"minimum":80,"maximum":640,"format":"integer","default":640,"type":"number"}},{"name":"height","required":false,"in":"query","description":"Altura em pixels.","schema":{"minimum":80,"maximum":640,"format":"integer","default":640,"type":"number"}},{"name":"fov","required":false,"in":"query","description":"Campo de visão em graus.","schema":{"minimum":60,"maximum":120,"format":"integer","default":90,"type":"number"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"image/png":{"schema":{"$ref":"#/components/schemas/Buffer"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Visão da Rua","tags":["Estabelecimentos"]}},"/list":{"post":{"description":"Adiciona uma nova lista em sua conta, é possível criar até mil listas.","operationId":"Cria Lista","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCreateDto"}}}},"responses":{"201":{"description":"Criação bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Cria Lista","tags":["Listas de CNPJ"]},"get":{"description":"Encontra as listas que correspondem aos filtros configurados.","operationId":"Pesquisa Listas","parameters":[{"name":"token","required":false,"in":"query","description":"Token de paginação, mutualmente exclusivo com as demais propriedades.","schema":{"minLength":32,"maxLength":32,"format":"not empty","example":"8d47bdcbde4a7a2d4a98d5f555a19701","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Quantidade de registros a serem lidos por página.","schema":{"minimum":1,"maximum":1000,"format":"integer","default":10,"type":"number"}},{"name":"search","required":false,"in":"query","description":"Termo a ser pesquisado no título ou descrição.","schema":{"minLength":1,"format":"not empty","example":"Clientes","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPageDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Pesquisa Listas","tags":["Listas de CNPJ"]}},"/list/{listId}":{"get":{"description":"Adquire informações de uma lista através de seu identificador único.","operationId":"Consulta Lista","parameters":[{"name":"listId","required":true,"in":"path","description":"Código da lista.","schema":{"format":"uuid","example":"97d34b55-ecba-4e22-bd05-9e27ff24632b","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Lista","tags":["Listas de CNPJ"]},"patch":{"description":"Modifica as informações de uma lista através de seu identificador único.","operationId":"Atualiza Lista","parameters":[{"name":"listId","required":true,"in":"path","description":"Código da lista.","schema":{"format":"uuid","example":"97d34b55-ecba-4e22-bd05-9e27ff24632b","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUpdateDto"}}}},"responses":{"200":{"description":"Atualização bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Atualiza Lista","tags":["Listas de CNPJ"]},"delete":{"description":"Apaga uma lista através de seu identificador único.","operationId":"Remove Lista","parameters":[{"name":"listId","required":true,"in":"path","description":"Código da lista.","schema":{"format":"uuid","example":"97d34b55-ecba-4e22-bd05-9e27ff24632b","type":"string"}}],"responses":{"204":{"description":"Remoção bem sucedida."},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Remove Lista","tags":["Listas de CNPJ"]}},"/list/{listId}/export":{"post":{"description":"Cria uma tarefa de exportação da lista em formatos Excel e JSON, obedecendo as opções de consulta CNPJ.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)  \n- [Simples Nacional 🡭](https://www8.receita.fazenda.gov.br/SimplesNacional/aplicacoes.aspx?id=21)  \n- [Cadastro de Contribuintes 🡭](https://dfe-portal.svrs.rs.gov.br/NFE/CCC)  \n- [SUFRAMA 🡭](https://www4.suframa.gov.br/cadsuf/#/menu-externo)\n\n**Frequência de Atualizações**  \n- Os dados podem ser obtidos online em tempo real, ou previamente armazenados em cache.  \n- O modo de resolução irá respeitar a defasagem máxima fornecida em `maxAge`.  \n- Atualizações individuais sob demanda.\n\n**Custo**  \n- **1 ₪** por cada 100 registros.  \n- Sujeito a adicionais conforme escolhas de parâmetros.","operationId":"Exporta Lista","parameters":[{"name":"listId","required":true,"in":"path","description":"Código da lista.","schema":{"format":"uuid","example":"97d34b55-ecba-4e22-bd05-9e27ff24632b","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExportCreateDto"}}}},"responses":{"201":{"description":"Criação bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExportIdDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Exporta Lista","tags":["Listas de CNPJ"]},"get":{"description":"Encontra as exportações de uma lista através de seu identificador único.","operationId":"Pesquisa Exportações","parameters":[{"name":"listId","required":true,"in":"path","description":"Código da lista.","schema":{"format":"uuid","example":"97d34b55-ecba-4e22-bd05-9e27ff24632b","type":"string"}},{"name":"token","required":false,"in":"query","description":"Token de paginação, mutualmente exclusivo com as demais propriedades.","schema":{"minLength":32,"maxLength":32,"format":"not empty","example":"8d47bdcbde4a7a2d4a98d5f555a19701","type":"string"}},{"name":"limit","required":false,"in":"query","description":"Quantidade de registros a serem lidos por página.","schema":{"minimum":1,"maximum":1000,"format":"integer","default":10,"type":"number"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExportPageDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Pesquisa Exportações","tags":["Listas de CNPJ"]}},"/list/{listId}/export/{exportId}":{"get":{"description":"Adquire as informações da exportação de uma lista através de seus identificadores únicos.","operationId":"Consulta Exportação","parameters":[{"name":"listId","required":true,"in":"path","description":"Código da lista.","schema":{"format":"uuid","example":"97d34b55-ecba-4e22-bd05-9e27ff24632b","type":"string"}},{"name":"exportId","required":true,"in":"path","description":"Código da exportação.","schema":{"format":"uuid","example":"c81fd826-7e72-49c0-b0c5-e0f0982c58d3","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListExportDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Exportação","tags":["Listas de CNPJ"]}},"/companies/{taxId}":{"get":{"description":"Adquire de forma centralizada múltiplas informações de um estabelecimento, incluindo acesso a diversos portais públicos.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)  \n- [Simples Nacional 🡭](https://www8.receita.fazenda.gov.br/SimplesNacional/aplicacoes.aspx?id=21)  \n- [Cadastro de Contribuintes 🡭](https://dfe-portal.svrs.rs.gov.br/NFE/CCC)\n\n**Frequência de Atualizações**  \n- Os dados podem ser obtidos online em tempo real, ou previamente armazenados em cache.  \n- O modo de resolução irá respeitar a defasagem máxima fornecida em `maxAge`.  \n- Atualizações individuais sob demanda.\n\n**Custo**  \n- **1 ₪** por consulta online.  \n- **0 ₪** por consulta em cache.  \n- Sujeito a adicionais conforme escolhas de parâmetros.","operationId":"⚠️ Consulta CNPJ","parameters":[{"name":"taxId","required":true,"in":"path","description":"Número do CNPJ sem pontuação.","schema":{"format":"cnpj","example":"37335118000180","type":"string"}},{"name":"enable_cache_fallback","required":false,"in":"query","description":"Habilita retornar dados em cache caso a busca em tempo real falhe.","schema":{"default":true,"type":"boolean"}},{"name":"company_max_age","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite.","schema":{"minimum":0,"format":"integer","default":45,"type":"number"}},{"name":"simples_max_age","required":false,"in":"query","description":"+**1 ₪** Adiciona as informações de opção pelo Simples e\nenquadramento no MEI.","schema":{"minimum":0,"format":"integer","example":1,"type":"number"}},{"name":"sintegra_max_age","required":false,"in":"query","description":"+**1 ₪** Adiciona a lista de Inscrições Estaduais.","schema":{"minimum":0,"format":"integer","example":1,"type":"number"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LegacyCompanyDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"⚠️ Consulta CNPJ","tags":["Descontinuados"]}},"/credit":{"get":{"description":"Adquire a quantidade de créditos restantes em sua conta.","operationId":"Consulta Saldo","parameters":[],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditoDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Saldo","tags":["Créditos Restantes"]}},"/company/{companyId}":{"get":{"description":"Adquire os dados de uma empresa incluindo todos os sócios e estabelecimentos.\n\n**Fontes de Dados**  \n- [Receita Federal 🡭](https://solucoes.receita.fazenda.gov.br/Servicos/cnpjreva/cnpjreva_solicitacao.asp)  \n- [Simples Nacional 🡭](https://www8.receita.fazenda.gov.br/SimplesNacional/aplicacoes.aspx?id=21)\n\n**Frequência de Atualizações**  \n- Os dados são previamente armazenados em cache.  \n- Atualizações individuais sob demanda.  \n- Atualizações globais a cada 30 dias.\n\n**Custo**  \n- **0 ₪** por consulta.","operationId":"Consulta Empresa","parameters":[{"name":"companyId","required":true,"in":"path","description":"Código da empresa, idem aos oito primeiros caracteres do CNPJ.","schema":{"format":"not empty","example":"37335118","type":"string"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta Empresa","tags":["Empresas"]}},"/ccc":{"get":{"description":"Adquire junto ao Cadastro Centralizado de Contribuintes os números das inscrições estaduais e situações cadastrais. É possível informar o CNPJ de um estabelecimento, ou o CPF de um produtor rural.\n\n**Fontes de Dados**  \n- [Cadastro de Contribuintes 🡭](https://dfe-portal.svrs.rs.gov.br/NFE/CCC)\n\n**Frequência de Atualizações**  \n- Os dados podem ser obtidos online em tempo real, ou previamente armazenados em cache.  \n- O modo de resolução irá respeitar a defasagem máxima fornecida em `maxAge`.  \n- Atualizações individuais sob demanda.\n\n**Custo**  \n- **1 ₪** por consulta online.  \n- **0 ₪** por consulta em cache.","operationId":"Consulta CCC","parameters":[{"name":"taxId","required":true,"in":"query","description":"CNPJ ou CPF de produtor rural","schema":{"format":"cnpj|cpf","example":"37335118000180","type":"string"}},{"name":"states","required":true,"in":"query","description":"Unidades Federativas separadas por vírgula. Aceita os termos especiais `ORIGIN` \n(mesma UF do endereço do estabelecimento) e `ALL` (todas). Consultas de CPF de produtor rural exigem \ninformar a UF exata.","schema":{"example":"PR,RS,SC","type":"array","items":{"type":"string","enum":["ORIGIN","ALL","AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]}}},{"name":"source","required":false,"in":"query","description":"Fonte de dados para obtenção das Inscrições Estaduais:  \n- `AUTO`: Idem a utilizar `CCC`, sujeito a alterações no futuro caso credenciais sejam necessárias.  \n- `CCC`: Utiliza o Cadastro Centralizado de Contribuintes para leitura de todas as inscrições.  \n- `SINTEGRA`: Utiliza individualmente cada SINTEGRA estadual para leitura das inscrições.","schema":{"default":"AUTO","type":"string","enum":["AUTO","CCC","SINTEGRA"]}},{"name":"strategy","required":false,"in":"query","description":"Estratégia de cache utilizada na aquisição dos dados:  \n- `CACHE`: Entrega os dados do cache, evitando cobranças de créditos, se os dados não estiverem disponíveis resultará em um erro 404.  \n- `CACHE_IF_FRESH`: Retorna os dados do cache respeitando o limite em `maxAge`, se os dados estiverem desatualizados será consultado online.  \n- `CACHE_IF_ERROR`: Idem ao `CACHE_IF_FRESH`, mas se a consulta online falhar retorna os dados do cache respeitando o limite em `maxStale`.  \n- `ONLINE`: Consulta diretamente online, não recomendado pois ignora qualquer cache, sugerimos configurar `maxAge=1` como alternativa.","schema":{"default":"CACHE_IF_ERROR","type":"string","enum":["ONLINE","CACHE_IF_FRESH","CACHE_IF_ERROR","CACHE"]}},{"name":"maxAge","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite, relevante para as estratégias `CACHE_IF_FRESH` e `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":45,"type":"number"}},{"name":"maxStale","required":false,"in":"query","description":"Idade máxima, em dias, que um dado em cache é aceite em caso de erro na busca online, relevante apenas para a estratégia `CACHE_IF_ERROR`.","schema":{"minimum":1,"maximum":3650,"format":"integer","default":365,"type":"number"}},{"name":"sync","required":false,"in":"query","description":"Aguarda a compensação dos créditos de forma síncrona, retornando o cabeçalho `cnpja-request-cost`.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CccDto"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Consulta CCC","tags":["Cadastro de Contribuintes"]}},"/ccc/certificate":{"get":{"description":"Emite o comprovante em PDF do registro no Cadastro Centralizado de Contribuintes.\n\n**Fontes de Dados**  \n- [Cadastro de Contribuintes 🡭](https://dfe-portal.svrs.rs.gov.br/NFE/CCC)\n\n**Frequência de Atualizações**  \n- Os dados são obtidos online em tempo real.\n\n**Custo**  \n- **1 ₪** por consulta.\n\n**Exemplos**  \n- [Estabelecimento Sem Restrição](/proxy/api/assets/docs/ccc_certificate_01.pdf).  \n- [Estabelecimento Bloqueado](/proxy/api/assets/docs/ccc_certificate_02.pdf).  \n- [Estabelecimento com Múltiplas Inscrições](/proxy/api/assets/docs/ccc_certificate_03.pdf).  \n- [Produtor Rural](/proxy/api/assets/docs/ccc_certificate_04.pdf).","operationId":"Comprovante CCC","parameters":[{"name":"taxId","required":true,"in":"query","description":"Número do CNPJ ou CPF sem pontuação.","schema":{"format":"cnpj|cpf","example":"37335118000180","type":"string"}},{"name":"state","required":false,"in":"query","description":"Unidade Federativa de origem. Consultas de CPF de produtor rural exigem informar a UF exata.","schema":{"example":"SP","type":"string","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]}}],"responses":{"200":{"description":"Consulta bem sucedida.","content":{"application/pdf":{"schema":{"$ref":"#/components/schemas/Buffer"}}}},"400":{"description":"Parâmetro de consulta mal formatado ou faltante.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorBadRequestDto"}}}},"401":{"description":"Chave de API ausente ou incorreta.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorUnauthorizedDto"}}}},"404":{"description":"Entidade pesquisada não registrada no órgão.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorNotFoundDto"}}}},"429":{"description":"Créditos esgotados ou limite por minuto excedido.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorTooManyRequestsDto"}}}},"500":{"description":"Erro interno ou falha inesperada.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorInternalServerErrorDto"}}}},"503":{"description":"Consulta online temporariamente indisponível.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorServiceUnavailableDto"}}}}},"security":[{"Chave de API":[]}],"summary":"Comprovante CCC","tags":["Cadastro de Contribuintes"]}}},"info":{"title":"Referência da API","description":"","version":"Comercial","contact":{}},"tags":[{"name":"Cadastro de Contribuintes","description":"O Cadastro Centralizado de Contribuintes (CCC) é uma base unificada que consolida os dados provenientes dos sistemas estaduais de cadastro de contribuintes, como o SINTEGRA.\n\nEle reúne informações detalhadas sobre empresas inscritas em todos os estados brasileiros, permitindo a consulta integrada de dados como inscrição estadual, atividade econômica e situação cadastral.\n\nEsse cadastro centralizado facilita a análise e cruzamento de informações tributárias em âmbito nacional, otimizando processos de controle e fiscalização.\n"},{"name":"Empresas","description":"Uma empresa é uma entidade jurídica criada com o objetivo de exercer atividades econômicas organizadas, como produção, comercialização de bens ou prestação de serviços.\n\nEla é identificada pelos oito primeiros dígitos do CNPJ, chamados de \"raiz\", que correspondem ao número base da empresa.\n\nA empresa pode possuir um ou mais estabelecimentos, que podem estar localizados em diferentes lugares, mas são subordinados à sua estrutura administrativa e jurídica.\n"},{"name":"Créditos Restantes","description":"A funcionalidade de consulta de saldo permite que os usuários verifiquem a quantidade de créditos disponíveis em sua conta, facilitando o acompanhamento e o planejamento do uso da API.\n\nEste recurso é essencial para monitorar de forma automatizada tanto os créditos acumulados de períodos anteriores quanto os disponíveis no mês atual.\n"},{"name":"Descontinuados","description":"As consultas listadas nesta seção referem-se a funcionalidades que foram descontinuadas e, por isso, não recebem mais atualizações ou suporte técnico ativo.\n\nApesar disso, elas permanecem acessíveis para garantir a continuidade de uso e minimizar impactos para usuários que já integraram suas soluções com a plataforma.\n\nRecomendamos, sempre que possível, a transição para alternativas mais atualizadas e alinhadas aos padrões atuais da API, visando maior eficiência e suporte contínuo.\n"},{"name":"Listas de CNPJ","description":"As listas permitem centralizar múltiplos CNPJs em uma única estrutura, viabilizando consultas em lote a portais públicos e facilitando o download de dados em formatos como Excel ou JSON.\n\nApós sua criação, as listas podem ser reprocessadas quantas vezes forem necessárias, garantindo que os dados estejam sempre atualizados e refletindo as informações mais recentes disponíveis nos sistemas de origem.\n\nEssa funcionalidade é ideal para gerenciar e monitorar grandes volumes de dados de empresas de forma eficiente e integrada.\n"},{"name":"Estabelecimentos","description":"O estabelecimento é uma unidade operacional ou filial de uma empresa, funcionando em um local específico e desempenhando atividades próprias.\n\nCada estabelecimento é identificado por um CNPJ completo, composto pela raiz de 8 dígitos da empresa, seguida por 4 números que o diferenciam dos demais estabelecimentos, e 2 dígitos verificadores finais.\n\nApesar de vinculado à empresa matriz, o estabelecimento pode operar de forma independente no aspecto operacional e fiscal, sendo fundamental para a descentralização e organização das atividades empresariais.\n"},{"name":"Pessoas","description":"Uma pessoa é um sócio ou representante legal mapeado em nossa infraestrutura, ela é identificada por um código único gerado pela plataforma.\n\nO sócio é uma pessoa física, jurídica, ou estrangeira, que detém parte do capital de uma empresa e participa de suas decisões estratégicas, conforme o contrato social ou estatuto.\n\nOs representantes legais participam dos quadros societários como agentes de outras instituições, ou assistindo sócios que ainda não podem exercer decisões, como menores de idade.\n"},{"name":"Receita Federal","description":"A Receita Federal é o órgão responsável pela administração tributária federal no Brasil, desempenhando um papel fundamental no registro e fiscalização de empresas por meio do Cadastro Nacional da Pessoa Jurídica (CNPJ).\n\nEste sistema armazena informações sobre a constituição, atividade econômica, situação cadastral e outras características relevantes de empresas e entidades no país.\n\nO órgão é essencial para validação e consulta de dados oficiais de empresas, garantindo a transparência e conformidade com as normas tributárias.\n"},{"name":"Simples Nacional","description":"O Simples Nacional é um regime tributário diferenciado destinado a micro e pequenas empresas. Ele unifica o recolhimento de impostos federais, estaduais e municipais, simplificando o processo de arrecadação.\n\nEste sistema permite verificar informações sobre empresas optantes, como data de adesão, atividade econômica e situação fiscal no regime.\n\nEle promove agilidade e transparência ao consolidar as obrigações tributárias em uma única plataforma, sendo uma fonte essencial para análise de regularidade e enquadramento.\n"},{"name":"Suframa","description":"A SUFRAMA (Superintendência da Zona Franca de Manaus) é uma autarquia federal responsável pela administração dos incentivos fiscais e pelo desenvolvimento econômico da região amazônica.\n\nEla gerencia cadastros de empresas beneficiárias dos incentivos fiscais da Zona Franca de Manaus e de Áreas de Livre Comércio.\n\nA consulta de dados da SUFRAMA permite acesso a informações como número de inscrição, validade de benefícios e regularidade de empresas cadastradas, sendo crucial para operações fiscais na região.\n"},{"name":"Códigos Postais","description":"O Código de Endereçamento Postal (CEP) é um sistema numérico usado para identificar e organizar endereços em uma região geográfica.\n\nCriado pelos Correios do Brasil, o CEP facilita a triagem, envio e entrega de correspondências e encomendas.\n\nComposto por oito dígitos, ele pode identificar municípios, bairros, ruas e até mesmo estabelecimentos específicos.\n"}],"servers":[{"url":"https://api.cnpja.com","description":"Produção"}],"components":{"securitySchemes":{"Chave de API":{"type":"apiKey","in":"header","name":"Authorization"}},"schemas":{"ErrorBadRequestDto":{"type":"object","properties":{"code":{"type":"number","description":"Código do status HTTP.","format":"integer","example":400},"message":{"type":"string","description":"Mensagem de erro.","format":"not empty","example":"request validation failed"},"constraints":{"description":"Lista com as falhas de validação.","example":["taxId must be a string that obeys cnpj verification algorithm"],"type":"array","items":{"type":"string","format":"not empty"}}},"required":["code","message","constraints"],"title":"ErrorBadRequestDto"},"ErrorUnauthorizedDto":{"type":"object","properties":{"code":{"type":"number","description":"Código do status HTTP.","format":"integer","example":401},"message":{"type":"string","description":"Mensagem de erro.","format":"not empty","example":"invalid authentication"}},"required":["code","message"],"title":"ErrorUnauthorizedDto"},"ErrorNotFoundDto":{"type":"object","properties":{"code":{"type":"number","description":"Código do status HTTP.","format":"integer","example":404},"message":{"type":"string","description":"Mensagem de erro.","format":"not empty","example":"tax id not registered at revenue service"}},"required":["code","message"],"title":"ErrorNotFoundDto"},"ErrorTooManyRequestsDto":{"type":"object","properties":{"code":{"type":"number","description":"Código do status HTTP.","format":"integer","example":429},"message":{"type":"string","description":"Mensagem de erro.","format":"not empty","example":"not enough credits"},"required":{"type":"number","description":"Créditos necessários para completar a consulta.","example":3,"format":"integer"},"remaining":{"type":"number","description":"Créditos restantes em sua conta.","example":1,"format":"integer"}},"required":["code","message","required","remaining"],"title":"ErrorTooManyRequestsDto"},"ErrorInternalServerErrorDto":{"type":"object","properties":{"code":{"type":"number","description":"Código do status HTTP.","format":"integer","example":500},"message":{"type":"string","description":"Mensagem de erro.","format":"not empty","example":"unexpected error"}},"required":["code","message"],"title":"ErrorInternalServerErrorDto"},"ErrorServiceUnavailableDto":{"type":"object","properties":{"code":{"type":"number","description":"Código do status HTTP.","format":"integer","example":503},"message":{"type":"string","description":"Mensagem de erro.","format":"not empty","example":"revenue service is offline"}},"required":["code","message"],"title":"ErrorServiceUnavailableDto"},"ZipDto":{"type":"object","properties":{"updated":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"municipality":{"type":"number","description":"Código do município conforme\n[IBGE 🡭](https://www.ibge.gov.br/explica/codigos-dos-municipios.php).","example":3550308,"format":"integer"},"code":{"type":"string","description":"Código de Endereçamento Postal.","example":"01452922","minLength":8,"maxLength":8,"format":"numeric"},"street":{"type":"string","description":"Logradouro.","example":"Avenida Brigadeiro Faria Lima","format":"not empty"},"number":{"type":"string","description":"Número.","example":"2369","format":"not empty"},"district":{"type":"string","description":"Bairro ou distrito.","example":"Jardim Paulistano","format":"not empty"},"city":{"type":"string","description":"Município.","example":"São Paulo","format":"not empty"},"state":{"type":"string","description":"Sigla da Unidade Federativa.","example":"SP","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]}},"required":["updated","municipality","code","street","number","district","city","state"],"title":"ZipDto"},"SuframaStatusDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da situação cadastral:  \n- `1`: Ativa.  \n- `2`: Inativa.  \n- `3`: Bloqueada.  \n- `4`: Cancelada.  \n- `5`: Cancelada Ag. Rec.","example":1,"format":"integer"},"text":{"type":"string","description":"Descrição da situação cadastral.","example":"Ativa","format":"not empty"}},"required":["id","text"],"title":"SuframaStatusDto"},"NatureDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da natureza jurídica conforme\n[IBGE 🡭](https://concla.ibge.gov.br/estrutura/natjur-estrutura/natureza-juridica-2021).","example":2062,"format":"integer"},"text":{"type":"string","description":"Descrição da natureza jurídica.","example":"Sociedade Empresária Limitada","format":"not empty"}},"required":["id","text"],"title":"NatureDto"},"CountryDto":{"type":"object","properties":{"id":{"type":"number","description":"Código do país conforme [M49 🡭](https://unstats.un.org/unsd/methodology/m49/).","example":76,"format":"integer"},"name":{"type":"string","description":"Nome do país.","example":"Brasil","format":"not empty"}},"required":["id","name"],"title":"CountryDto"},"AddressDto":{"type":"object","properties":{"municipality":{"type":"number","description":"Código do município conforme\n[IBGE 🡭](https://www.ibge.gov.br/explica/codigos-dos-municipios.php).","example":3550308,"format":"integer"},"street":{"type":"string","description":"Logradouro.","example":"Avenida Brigadeiro Faria Lima","format":"not empty"},"number":{"type":"string","description":"Número.","example":"2369","format":"not empty"},"district":{"type":"string","description":"Bairro ou distrito.","example":"Jardim Paulistano","format":"not empty"},"city":{"type":"string","description":"Município.","example":"São Paulo","format":"not empty"},"state":{"type":"string","description":"Sigla da Unidade Federativa.","example":"SP","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]},"details":{"type":"string","description":"Complemento.","example":"Conj 1102","format":"not empty"},"zip":{"type":"string","description":"Código de Endereçamento Postal.","example":"01452922","minLength":8,"maxLength":8,"format":"numeric"},"latitude":{"type":"number","description":"Latitude.","example":-23.5774994,"format":"float"},"longitude":{"type":"number","description":"Longitude.","example":-46.6864608,"format":"float"},"country":{"description":"Informações do país.","allOf":[{"$ref":"#/components/schemas/CountryDto"}]}},"required":["municipality","street","number","district","city","state","details","zip","country"],"title":"AddressDto"},"PhoneDto":{"type":"object","properties":{"type":{"type":"string","description":"Tipo do telefone:  \n- `LANDLINE`: Linha terrestre, telefone fixo.  \n- `MOBILE`: Linha móvel, telefone celular.","example":"LANDLINE","enum":["LANDLINE","MOBILE"]},"area":{"type":"string","description":"Código de DDD.","example":"11","minLength":2,"maxLength":2,"format":"numeric"},"number":{"type":"string","description":"Número.","example":"971564144","minLength":8,"maxLength":9,"format":"numeric"}},"required":["type","area","number"],"title":"PhoneDto"},"EmailDto":{"type":"object","properties":{"ownership":{"type":"string","description":"Tipo de propriedade do e-mail:  \n- `PERSONAL`: Pessoal, registrado em provedor gratuito.  \n- `CORPORATE`: Corporativo, registrado em provedor privado.  \n- `ACCOUNTING`: Contabilidade, domínio remete a empresas de contadores.","example":"ACCOUNTING","enum":["ACCOUNTING","CORPORATE","PERSONAL"]},"address":{"type":"string","description":"Endereço de e-mail.","example":"contato@cnpja.com","format":"e-mail"},"domain":{"type":"string","description":"Domínio de registro.","example":"cnpja.com","format":"not empty"}},"required":["ownership","address","domain"],"title":"EmailDto"},"SuframaActivityDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da atividade econômica conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":6311900,"format":"integer"},"text":{"type":"string","description":"Descrição da atividade econômica.","example":"Tratamento de dados, provedores de serviços de aplicação e serviços de hospedagem na internet","format":"not empty"},"performed":{"type":"boolean","description":"Indica se a atividade econômica é exercida.","example":true}},"required":["id","text","performed"],"title":"SuframaActivityDto"},"SuframaIncentiveDto":{"type":"object","properties":{"tribute":{"type":"string","description":"Nome do tributo incentivado.","example":"IPI","enum":["ICMS","IPI"]},"benefit":{"type":"string","description":"Benefício aplicado ao incentivo.","example":"Isenção","format":"not empty"},"purpose":{"type":"string","description":"Finalidade do incentivo.","example":"Consumo Interno, Industrialização e Utilização","format":"not empty"},"basis":{"type":"string","description":"Base legal do incentivo.","example":"Decreto 7.212 de 2010 (Art. 81)","format":"not empty"}},"required":["tribute","benefit","purpose","basis"],"title":"SuframaIncentiveDto"},"SuframaDto":{"type":"object","properties":{"taxId":{"type":"string","description":"Número do CNPJ ou CPF sem pontuação.","example":"37335118000180","format":"cnpj|cpf"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"number":{"type":"string","description":"Número da inscrição SUFRAMA.","example":"200400029","format":"numeric"},"name":{"type":"string","description":"Razão social.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"since":{"type":"string","description":"Data de inscrição na SUFRAMA.","example":"2020-01-01","format":"iso8601"},"head":{"type":"boolean","description":"Indica se o estabelecimento é a Matriz.","example":true},"approved":{"type":"boolean","description":"Indica se o projeto está aprovado.","example":true},"approvalDate":{"type":"string","description":"Data de aprovação do projeto.","example":"2021-01-01","format":"iso8601"},"status":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/SuframaStatusDto"}]},"nature":{"description":"Informações da natureza jurídica.","allOf":[{"$ref":"#/components/schemas/NatureDto"}]},"address":{"description":"Informações do endereço.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"phones":{"description":"Lista de telefones.","type":"array","items":{"$ref":"#/components/schemas/PhoneDto"}},"emails":{"description":"Lista de e-mails.","type":"array","items":{"$ref":"#/components/schemas/EmailDto"}},"mainActivity":{"description":"Informações da atividade econômica principal.","allOf":[{"$ref":"#/components/schemas/SuframaActivityDto"}]},"sideActivities":{"description":"Lista de atividades econômicas secundárias.","type":"array","items":{"$ref":"#/components/schemas/SuframaActivityDto"}},"incentives":{"description":"Lista de incentivos fiscais.","type":"array","items":{"$ref":"#/components/schemas/SuframaIncentiveDto"}}},"required":["taxId","updated","number","name","since","head","approved","approvalDate","status","nature","address","phones","emails","mainActivity","sideActivities","incentives"],"title":"SuframaDto"},"Buffer":{"type":"object","properties":{},"title":"Buffer"},"SimplesSimeiHistoryDto":{"type":"object","properties":{"from":{"type":"string","description":"Data de início do período.","example":"2012-12-26","format":"iso8601"},"until":{"type":"string","description":"Data de término do período.","example":"2013-12-31","format":"iso8601"},"text":{"type":"string","description":"Motivo de encerramento.","example":"Excluída por Ato Administrativo praticado pela Receita Federal do Brasil","format":"not empty"}},"required":["from","until","text"],"title":"SimplesSimeiHistoryDto"},"SimplesEventDto":{"type":"object","properties":{"regime":{"type":"string","description":"Tributo do regime regular.","example":"IBS","enum":["IBS","CBS"]},"from":{"type":"string","description":"Data de efeito do evento.","example":"2027-01-01","format":"iso8601"},"text":{"type":"string","description":"Descrição do evento.","example":"Opção pelo Regime Regular","format":"not empty"}},"required":["regime","from","text"],"title":"SimplesEventDto"},"SimplesNacionalDto":{"type":"object","properties":{"optant":{"type":"boolean","description":"Indica se optante ou enquadrado.","example":true},"since":{"type":"string","description":"Data de inclusão no período vigente.","example":"2020-06-05","format":"iso8601"},"history":{"description":"Histórico de períodos anteriores.","type":"array","items":{"$ref":"#/components/schemas/SimplesSimeiHistoryDto"}},"events":{"description":"Eventos futuros do regime regular do IBS e da CBS.","type":"array","items":{"$ref":"#/components/schemas/SimplesEventDto"}}},"required":["optant","since"],"title":"SimplesNacionalDto"},"SimplesSimeiDto":{"type":"object","properties":{"optant":{"type":"boolean","description":"Indica se optante ou enquadrado.","example":true},"since":{"type":"string","description":"Data de inclusão no período vigente.","example":"2020-06-05","format":"iso8601"},"history":{"description":"Histórico de períodos anteriores.","type":"array","items":{"$ref":"#/components/schemas/SimplesSimeiHistoryDto"}}},"required":["optant","since"],"title":"SimplesSimeiDto"},"SimplesDto":{"type":"object","properties":{"taxId":{"type":"string","description":"Número do CNPJ sem pontuação.","example":"37335118000180","format":"cnpj"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"simples":{"description":"Informações da opção pelo Simples Nacional.","allOf":[{"$ref":"#/components/schemas/SimplesNacionalDto"}]},"simei":{"description":"Informações do enquadramento no MEI.","allOf":[{"$ref":"#/components/schemas/SimplesSimeiDto"}]}},"required":["taxId","updated","simples","simei"],"title":"SimplesDto"},"CompanySizeDto":{"type":"object","properties":{"id":{"type":"number","description":"Código do porte:  \n- `1`: Microempresa (ME).  \n- `3`: Empresa de Pequeno Porte (EPP).  \n- `5`: Demais.","example":1,"format":"integer"},"acronym":{"type":"string","description":"Sigla do porte.","example":"ME","format":"not empty"},"text":{"type":"string","description":"Descrição do porte.","example":"Microempresa","format":"not empty"}},"required":["id","acronym","text"],"title":"CompanySizeDto"},"OfficeStatusDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da situação cadastral:  \n- `1`: Nula.  \n- `2`: Ativa.  \n- `3`: Suspensa.  \n- `4`: Inapta.  \n- `8`: Baixada.","example":2,"format":"integer"},"text":{"type":"string","description":"Descrição da situação cadastral.","example":"Ativa","format":"not empty"}},"required":["id","text"],"title":"OfficeStatusDto"},"OfficeReasonDto":{"type":"object","properties":{"id":{"type":"number","description":"Código do motivo da situação cadastral conforme\n[Receita Federal 🡭](http://www.consultas.cge.rj.gov.br/scadastral.pdf).","example":1,"format":"integer"},"text":{"type":"string","description":"Descrição do motivo da situação cadastral.","example":"Extinção Por Encerramento Liquidação Voluntária","format":"not empty"}},"required":["id","text"],"title":"OfficeReasonDto"},"OfficeSpecialDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da situação especial conforme\n[Receita Federal 🡭](http://www38.receita.fazenda.gov.br/cadsincnac/jsp/coleta/ajuda/topicos/Eventos_de_Alteracao.htm).","example":416,"format":"integer"},"text":{"type":"string","description":"Descrição da situação especial.","example":"Início de Liquidação Judicial","format":"not empty"}},"required":["id","text"],"title":"OfficeSpecialDto"},"ActivityDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da atividade econômica conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":6311900,"format":"integer"},"text":{"type":"string","description":"Descrição da atividade econômica.","example":"Tratamento de dados, provedores de serviços de aplicação e serviços de hospedagem na internet","format":"not empty"}},"required":["id","text"],"title":"ActivityDto"},"RoleDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da qualificação conforme\n[Receita Federal 🡭](http://www.consultas.cge.rj.gov.br/codsocio.pdf).","example":49,"format":"integer"},"text":{"type":"string","description":"Descrição da qualificação.","example":"Sócio-Administrador","format":"not empty"}},"required":["id","text"],"title":"RoleDto"},"PersonBaseDto":{"type":"object","properties":{"id":{"type":"string","description":"Código da pessoa.","example":"1e5ed433-0f39-4309-8e85-8d21a571b212","format":"uuid"},"type":{"type":"string","description":"Tipo da pessoa:  \n- `NATURAL`: Pessoa física.  \n- `LEGAL`: Pessoa jurídica.  \n- `FOREIGN`: Pessoa residente no exterior.  \n- `UNKNOWN`: Pessoa desconhecida.","example":"NATURAL","enum":["LEGAL","NATURAL","FOREIGN","UNKNOWN"]},"name":{"type":"string","description":"Nome ou razão social.","example":"João Silva","format":"not empty"},"taxId":{"type":"string","description":"CPF ou CNPJ, presente quando `type == 'NATURAL' | 'LEGAL'`.","example":"***123456**","format":"not empty"},"age":{"type":"string","description":"Faixa etária, presente quando `type == 'NATURAL'`.","example":"31-40","enum":["0-12","13-20","21-30","31-40","41-50","51-60","61-70","71-80","81+"]},"country":{"description":"País de origem, presente quando `type == 'FOREIGN'`.","allOf":[{"$ref":"#/components/schemas/CountryDto"}]}},"required":["id","type","name"],"title":"PersonBaseDto"},"MemberAgentDto":{"type":"object","properties":{"person":{"description":"Informações da pessoa representante legal.","allOf":[{"$ref":"#/components/schemas/PersonBaseDto"}]},"role":{"description":"Informações da qualificação do representante legal.","allOf":[{"$ref":"#/components/schemas/RoleDto"}]}},"required":["person","role"],"title":"MemberAgentDto"},"RfbMemberDto":{"type":"object","properties":{"since":{"type":"string","description":"Data de entrada na sociedade.","example":"2020-06-05","format":"iso8601"},"role":{"description":"Informações da qualificação.","allOf":[{"$ref":"#/components/schemas/RoleDto"}]},"person":{"description":"Informações do sócio ou administrador.","allOf":[{"$ref":"#/components/schemas/PersonBaseDto"}]},"agent":{"description":"Informações do representante legal, presente quando aplicável na qualificação.","allOf":[{"$ref":"#/components/schemas/MemberAgentDto"}]}},"required":["since","role","person","agent"],"title":"RfbMemberDto"},"RfbDto":{"type":"object","properties":{"taxId":{"type":"string","description":"Número do CNPJ sem pontuação.","example":"37335118000180","format":"cnpj"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"name":{"type":"string","description":"Razão social.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"jurisdiction":{"type":"string","description":"Ente federativo responsável, presente quando `nature.id < 2000`.","example":"Uniao","format":"not empty"},"equity":{"type":"number","description":"Capital social","example":1000,"format":"float"},"nature":{"description":"Informações da natureza jurídica.","allOf":[{"$ref":"#/components/schemas/NatureDto"}]},"size":{"description":"Informações do porte.","allOf":[{"$ref":"#/components/schemas/CompanySizeDto"}]},"alias":{"type":"string","description":"Nome fantasia.","example":"CNPJA","format":"not empty"},"founded":{"type":"string","description":"Data de abertura.","example":"2020-06-05","format":"iso8601"},"head":{"type":"boolean","description":"Indica se o estabelecimento é a Matriz.","example":true},"statusDate":{"type":"string","description":"Data da situação cadastral.","example":"2020-06-05","format":"iso8601"},"status":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/OfficeStatusDto"}]},"reason":{"description":"Informações do motivo da situação cadastral, presente quando `status.id != 2`.","allOf":[{"$ref":"#/components/schemas/OfficeReasonDto"}]},"specialDate":{"type":"string","description":"Data da situação especial.","example":"2022-01-01","format":"iso8601"},"special":{"description":"Informações da situação especial, presente quando `specialDate != undefined`.","allOf":[{"$ref":"#/components/schemas/OfficeSpecialDto"}]},"address":{"description":"Informações do endereço.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"phones":{"description":"Lista de telefones.","type":"array","items":{"$ref":"#/components/schemas/PhoneDto"}},"emails":{"description":"Lista de e-mails.","type":"array","items":{"$ref":"#/components/schemas/EmailDto"}},"mainActivity":{"description":"Informações da atividade econômica principal.","allOf":[{"$ref":"#/components/schemas/ActivityDto"}]},"sideActivities":{"description":"Lista de atividades econômicas secundárias.","type":"array","items":{"$ref":"#/components/schemas/ActivityDto"}},"members":{"description":"Quadro de sócios e administradores.","type":"array","items":{"$ref":"#/components/schemas/RfbMemberDto"}}},"required":["taxId","updated","name","equity","nature","size","alias","founded","head","statusDate","status","address","phones","emails","mainActivity","sideActivities","members"],"title":"RfbDto"},"PersonMemberCompanyDto":{"type":"object","properties":{"id":{"type":"string","description":"Código da empresa, idem aos oito primeiros caracteres do CNPJ.","example":"37335118","format":"not empty"},"name":{"type":"string","description":"Razão social.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"jurisdiction":{"type":"string","description":"Ente federativo responsável, presente quando `nature.id < 2000`.","example":"Uniao","format":"not empty"},"equity":{"type":"number","description":"Capital social","example":1000,"format":"float"},"nature":{"description":"Informações da natureza jurídica.","allOf":[{"$ref":"#/components/schemas/NatureDto"}]},"size":{"description":"Informações do porte.","allOf":[{"$ref":"#/components/schemas/CompanySizeDto"}]}},"required":["id","name","equity","nature","size"],"title":"PersonMemberCompanyDto"},"PersonMemberDto":{"type":"object","properties":{"since":{"type":"string","description":"Data de entrada na sociedade.","example":"2020-06-05","format":"iso8601"},"role":{"description":"Informações da qualificação.","allOf":[{"$ref":"#/components/schemas/RoleDto"}]},"agent":{"description":"Informações do representante legal, presente quando aplicável na qualificação.","allOf":[{"$ref":"#/components/schemas/MemberAgentDto"}]},"company":{"description":"Informações da empresa.","allOf":[{"$ref":"#/components/schemas/PersonMemberCompanyDto"}]}},"required":["since","role","company"],"title":"PersonMemberDto"},"PersonDto":{"type":"object","properties":{"id":{"type":"string","description":"Código da pessoa.","example":"1e5ed433-0f39-4309-8e85-8d21a571b212","format":"uuid"},"type":{"type":"string","description":"Tipo da pessoa:  \n- `NATURAL`: Pessoa física.  \n- `LEGAL`: Pessoa jurídica.  \n- `FOREIGN`: Pessoa residente no exterior.  \n- `UNKNOWN`: Pessoa desconhecida.","example":"NATURAL","enum":["LEGAL","NATURAL","FOREIGN","UNKNOWN"]},"name":{"type":"string","description":"Nome ou razão social.","example":"João Silva","format":"not empty"},"taxId":{"type":"string","description":"CPF ou CNPJ, presente quando `type == 'NATURAL' | 'LEGAL'`.","example":"***123456**","format":"not empty"},"age":{"type":"string","description":"Faixa etária, presente quando `type == 'NATURAL'`.","example":"31-40","enum":["0-12","13-20","21-30","31-40","41-50","51-60","61-70","71-80","81+"]},"country":{"description":"País de origem, presente quando `type == 'FOREIGN'`.","allOf":[{"$ref":"#/components/schemas/CountryDto"}]},"membership":{"description":"Lista de sociedades participantes.","type":"array","items":{"$ref":"#/components/schemas/PersonMemberDto"}}},"required":["id","type","name","membership"],"title":"PersonDto"},"PersonPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Token da próxima página.","example":"8d47bdcbde4a7a2d4a98d5f555a19701","minLength":32,"maxLength":32,"format":"not empty"},"limit":{"type":"number","description":"Quantidade de registros lidos.","example":100,"maximum":100,"minimum":1,"format":"integer"},"count":{"type":"number","description":"Quantidade de registros disponíveis.","example":345,"minimum":0,"format":"integer"},"records":{"description":"Lista de pessoas que obedecem aos critérios de pesquisa.","type":"array","items":{"$ref":"#/components/schemas/PersonDto"}}},"required":["next","limit","count","records"],"title":"PersonPageDto"},"MemberDto":{"type":"object","properties":{"since":{"type":"string","description":"Data de entrada na sociedade.","example":"2020-06-05","format":"iso8601"},"person":{"description":"Informações do sócio ou administrador.","allOf":[{"$ref":"#/components/schemas/PersonBaseDto"}]},"role":{"description":"Informações da qualificação.","allOf":[{"$ref":"#/components/schemas/RoleDto"}]},"agent":{"description":"Informações do representante legal, presente quando aplicável na qualificação.","allOf":[{"$ref":"#/components/schemas/MemberAgentDto"}]}},"required":["since","person","role"],"title":"MemberDto"},"OfficeCompanyDto":{"type":"object","properties":{"id":{"type":"string","description":"Código da empresa, idem aos oito primeiros caracteres do CNPJ.","example":"37335118","format":"not empty"},"name":{"type":"string","description":"Razão social.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"jurisdiction":{"type":"string","description":"Ente federativo responsável, presente quando `nature.id < 2000`.","example":"Uniao","format":"not empty"},"equity":{"type":"number","description":"Capital social","example":1000,"format":"float"},"nature":{"description":"Informações da natureza jurídica.","allOf":[{"$ref":"#/components/schemas/NatureDto"}]},"size":{"description":"Informações do porte.","allOf":[{"$ref":"#/components/schemas/CompanySizeDto"}]},"simples":{"description":"Informações da opção pelo Simples Nacional.","allOf":[{"$ref":"#/components/schemas/SimplesNacionalDto"}]},"simei":{"description":"Informações do enquadramento no MEI.","allOf":[{"$ref":"#/components/schemas/SimplesSimeiDto"}]},"members":{"description":"Quadro de sócios e administradores.","type":"array","items":{"$ref":"#/components/schemas/MemberDto"}}},"required":["id","name","equity","nature","size","members"],"title":"OfficeCompanyDto"},"RegistrationStatusDto":{"type":"object","properties":{"id":{"type":"number","description":"Código da situação cadastral:  \n- `1`: Sem restrição.  \n- `2`: Bloqueado como destinatário na UF.  \n- `3`: Vedada operação como destinatário na UF.  \n- `10`: Emitente bloqueado no destino.","example":2,"format":"integer"},"text":{"type":"string","description":"Descrição da situação cadastral.","example":"Bloqueado como destinatário na UF","format":"not empty"}},"required":["id","text"],"title":"RegistrationStatusDto"},"RegistrationTypeDto":{"type":"object","properties":{"id":{"type":"number","description":"Código do tipo:  \n- `1`: IE Normal.  \n- `2`: IE Substituto Tributário.  \n- `3`: IE Não Contribuinte (Canteiro de Obras, IE Virtual, outros).  \n- `4`: IE Contribuinte da UF com Endereço em Outra UF.  \n- `5`: IE de Produtor Rural.  \n- `9`: IE Não Informada.","example":2,"format":"integer"},"text":{"type":"string","description":"Descrição do tipo.","example":"IE Substituto Tributário","format":"not empty"}},"required":["id","text"],"title":"RegistrationTypeDto"},"RegistrationDto":{"type":"object","properties":{"number":{"type":"string","description":"Número da Inscrição Estadual.","example":"0962101427","minLength":8,"maxLength":14,"format":"numeric"},"state":{"type":"string","description":"Unidade Federativa de registro.","example":"RS","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]},"enabled":{"type":"boolean","description":"Indica se habilitada como contribuinte.","example":true},"statusDate":{"type":"string","description":"Data da situação cadastral.","example":"2021-01-21","format":"iso8601"},"status":{"description":"Situação cadastral da inscrição.","allOf":[{"$ref":"#/components/schemas/RegistrationStatusDto"}]},"type":{"description":"Tipo da inscrição.","allOf":[{"$ref":"#/components/schemas/RegistrationTypeDto"}]}},"required":["number","state","enabled","statusDate","status","type"],"title":"RegistrationDto"},"OfficeSuframaDto":{"type":"object","properties":{"number":{"type":"string","description":"Número da inscrição SUFRAMA.","example":"200400029","format":"numeric"},"since":{"type":"string","description":"Data de inscrição na SUFRAMA.","example":"2020-01-01","format":"iso8601"},"approved":{"type":"boolean","description":"Indica se o projeto está aprovado.","example":true},"approvalDate":{"type":"string","description":"Data de aprovação do projeto.","example":"2021-01-01","format":"iso8601"},"status":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/SuframaStatusDto"}]},"incentives":{"description":"Lista de incentivos fiscais.","type":"array","items":{"$ref":"#/components/schemas/SuframaIncentiveDto"}}},"required":["number","since","approved","approvalDate","status","incentives"],"title":"OfficeSuframaDto"},"OfficeLinkDto":{"type":"object","properties":{"type":{"type":"string","description":"Tipo de arquivo a qual o link se refere.","example":"RFB_CERTIFICATE","enum":["RFB_CERTIFICATE","SIMPLES_CERTIFICATE","CCC_CERTIFICATE","SUFRAMA_CERTIFICATE","OFFICE_MAP","OFFICE_STREET"]},"url":{"type":"string","description":"URL pública de acesso ao arquivo.","example":"https://api.cnpja.com/rfb/certificate?taxId=37335118000180&signature=eyJ...vcIlg","format":"not empty"}},"required":["type","url"],"title":"OfficeLinkDto"},"OfficeDto":{"type":"object","properties":{"taxId":{"type":"string","description":"Número do CNPJ sem pontuação.","example":"37335118000180","format":"cnpj"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"company":{"description":"Informações da empresa.","allOf":[{"$ref":"#/components/schemas/OfficeCompanyDto"}]},"alias":{"type":"string","description":"Nome fantasia.","example":"CNPJA","format":"not empty"},"founded":{"type":"string","description":"Data de abertura.","example":"2020-06-05","format":"iso8601"},"head":{"type":"boolean","description":"Indica se o estabelecimento é a Matriz.","example":true},"statusDate":{"type":"string","description":"Data da situação cadastral.","example":"2020-06-05","format":"iso8601"},"status":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/OfficeStatusDto"}]},"reason":{"description":"Informações do motivo da situação cadastral, presente quando `status.id != 2`.","allOf":[{"$ref":"#/components/schemas/OfficeReasonDto"}]},"specialDate":{"type":"string","description":"Data da situação especial.","example":"2022-01-01","format":"iso8601"},"special":{"description":"Informações da situação especial, presente quando `specialDate != undefined`.","allOf":[{"$ref":"#/components/schemas/OfficeSpecialDto"}]},"address":{"description":"Informações do endereço.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"phones":{"description":"Lista de telefones.","type":"array","items":{"$ref":"#/components/schemas/PhoneDto"}},"emails":{"description":"Lista de e-mails.","type":"array","items":{"$ref":"#/components/schemas/EmailDto"}},"mainActivity":{"description":"Informações da atividade econômica principal.","allOf":[{"$ref":"#/components/schemas/ActivityDto"}]},"sideActivities":{"description":"Lista de atividades econômicas secundárias.","type":"array","items":{"$ref":"#/components/schemas/ActivityDto"}},"registrations":{"description":"Inscrições Estaduais.","type":"array","items":{"$ref":"#/components/schemas/RegistrationDto"}},"suframa":{"description":"Lista de inscrições SUFRAMA","type":"array","items":{"$ref":"#/components/schemas/OfficeSuframaDto"}},"links":{"description":"Lista de links para arquivos.","type":"array","items":{"$ref":"#/components/schemas/OfficeLinkDto"}}},"required":["taxId","updated","company","alias","founded","head","statusDate","status","address","phones","emails","mainActivity","sideActivities"],"title":"OfficeDto"},"CompanySimplesDto":{"type":"object","properties":{"optant":{"type":"boolean","description":"Indica se optante ou enquadrado.","example":true},"since":{"type":"string","description":"Data de inclusão no período vigente.","example":"2020-06-05","format":"iso8601"}},"required":["optant","since"],"title":"CompanySimplesDto"},"OfficePageRecordCompanyDto":{"type":"object","properties":{"id":{"type":"string","description":"Código da empresa, idem aos oito primeiros caracteres do CNPJ.","example":"37335118","format":"not empty"},"name":{"type":"string","description":"Razão social.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"jurisdiction":{"type":"string","description":"Ente federativo responsável, presente quando `nature.id < 2000`.","example":"Uniao","format":"not empty"},"equity":{"type":"number","description":"Capital social","example":1000,"format":"float"},"nature":{"description":"Informações da natureza jurídica.","allOf":[{"$ref":"#/components/schemas/NatureDto"}]},"size":{"description":"Informações do porte.","allOf":[{"$ref":"#/components/schemas/CompanySizeDto"}]},"simples":{"description":"Informações da opção pelo Simples Nacional.","allOf":[{"$ref":"#/components/schemas/CompanySimplesDto"}]},"simei":{"description":"Informações do enquadramento no MEI.","allOf":[{"$ref":"#/components/schemas/CompanySimplesDto"}]},"members":{"description":"Quadro de sócios e administradores.","type":"array","items":{"$ref":"#/components/schemas/MemberDto"}}},"required":["id","name","equity","nature","size","members"],"title":"OfficePageRecordCompanyDto"},"OfficePageRecordDto":{"type":"object","properties":{"taxId":{"type":"string","description":"Número do CNPJ sem pontuação.","example":"37335118000180","format":"cnpj"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"company":{"description":"Informações da empresa.","allOf":[{"$ref":"#/components/schemas/OfficePageRecordCompanyDto"}]},"alias":{"type":"string","description":"Nome fantasia.","example":"CNPJA","format":"not empty"},"founded":{"type":"string","description":"Data de abertura.","example":"2020-06-05","format":"iso8601"},"head":{"type":"boolean","description":"Indica se o estabelecimento é a Matriz.","example":true},"statusDate":{"type":"string","description":"Data da situação cadastral.","example":"2020-06-05","format":"iso8601"},"status":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/OfficeStatusDto"}]},"reason":{"description":"Informações do motivo da situação cadastral, presente quando `status.id != 2`.","allOf":[{"$ref":"#/components/schemas/OfficeReasonDto"}]},"specialDate":{"type":"string","description":"Data da situação especial.","example":"2022-01-01","format":"iso8601"},"special":{"description":"Informações da situação especial, presente quando `specialDate != undefined`.","allOf":[{"$ref":"#/components/schemas/OfficeSpecialDto"}]},"address":{"description":"Informações do endereço.","allOf":[{"$ref":"#/components/schemas/AddressDto"}]},"phones":{"description":"Lista de telefones.","type":"array","items":{"$ref":"#/components/schemas/PhoneDto"}},"emails":{"description":"Lista de e-mails.","type":"array","items":{"$ref":"#/components/schemas/EmailDto"}},"mainActivity":{"description":"Informações da atividade econômica principal.","allOf":[{"$ref":"#/components/schemas/ActivityDto"}]},"sideActivities":{"description":"Lista de atividades econômicas secundárias.","type":"array","items":{"$ref":"#/components/schemas/ActivityDto"}}},"required":["taxId","updated","company","alias","founded","head","statusDate","status","address","phones","emails","mainActivity","sideActivities"],"title":"OfficePageRecordDto"},"OfficePageDto":{"type":"object","properties":{"next":{"type":"string","description":"Token da próxima página.","example":"8d47bdcbde4a7a2d4a98d5f555a19701","minLength":32,"maxLength":32,"format":"not empty"},"limit":{"type":"number","description":"Quantidade de registros lidos.","example":100,"maximum":100,"minimum":1,"format":"integer"},"count":{"type":"number","description":"Quantidade de registros disponíveis.","example":345,"minimum":0,"format":"integer"},"records":{"description":"Lista de estabelecimentos que obedecem aos critérios de pesquisa.","type":"array","items":{"$ref":"#/components/schemas/OfficePageRecordDto"}}},"required":["next","limit","count","records"],"title":"OfficePageDto"},"ListQueryDto":{"type":"object","properties":{"names.in":{"description":"Termos a serem incluídos na razão social ou nome fantasia, separados por espaço para correspondência\nno mesmo estabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"CNPJá,Banco do Brasil,AMBEV S/A","type":"array","items":{"type":"string","format":"not empty"}},"names.nin":{"description":"Termos a serem excluídos na razão social ou nome fantasia, separados por espaço para correspondência\nno mesmo estabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"EI,Eireli,LTDA","type":"array","items":{"type":"string","format":"not empty"}},"company.name.in":{"description":"Termos a serem incluídos na razão social, separados por espaço para correspondência na mesma empresa,\nou separados por vírgula para correspondência em diferentes.","example":"CNPJá,Banco do Brasil,AMBEV S/A","type":"array","items":{"type":"string","format":"not empty"}},"company.name.nin":{"description":"Termos a serem excluídos na razão social, separados por espaço para correspondência na mesma empresa,\nou separados por vírgula para correspondência em diferentes.","example":"EI,Eireli,LTDA","type":"array","items":{"type":"string","format":"not empty"}},"company.equity.gte":{"type":"number","description":"Capital social maior ou igual ao valor especificado.","example":12345.67,"minimum":0,"format":"float"},"company.equity.lte":{"type":"number","description":"Capital social menor ou igual ao valor especificado.","example":98765.43,"minimum":0,"format":"float"},"company.nature.id.in":{"description":"Códigos das naturezas jurídicas a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/estrutura/natjur-estrutura/natureza-juridica-2021).","example":"1015,2011,3034","type":"array","items":{"type":"number","format":"integer"}},"company.nature.id.nin":{"description":"Códigos das naturezas jurídicas a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/estrutura/natjur-estrutura/natureza-juridica-2021).","example":"1015,2011,3034","type":"array","items":{"type":"number","format":"integer"}},"company.size.id.in":{"description":"Códigos dos portes a serem incluídos, separados por vírgula:  \n- `1`: Microempresa (ME).  \n- `3`: Empresa de Pequeno Porte (EPP).  \n- `5`: Demais.","example":"1,3","type":"array","items":{"type":"number","format":"integer"}},"company.simples.optant.eq":{"type":"boolean","description":"Indicador de opção pelo Simples Nacional:  \n- `true`: Apenas empresas optantes.  \n- `false`: Apenas empresas não optantes.","example":true},"company.simples.since.gte":{"type":"string","description":"Data de opção pelo Simples Nacional maior ou igual a especificada.","example":"2018-01-01","format":"iso8601"},"company.simples.since.lte":{"type":"string","description":"Data de opção pelo Simples Nacional menor ou igual a especificada.","example":"2020-12-31","format":"iso8601"},"company.simei.optant.eq":{"type":"boolean","description":"Indicador de enquadramento no MEI:  \n- `true`: Apenas empresas enquadradas.  \n- `false`: Apenas empresas não enquadradas.","example":true},"company.simei.since.gte":{"type":"string","description":"Data de enquadramento no MEI maior ou igual a especificada.","example":"2018-01-01","format":"iso8601"},"company.simei.since.lte":{"type":"string","description":"Data de enquadramento no MEI menor ou igual a especificada.","example":"2020-12-31","format":"iso8601"},"taxId.nin":{"description":"Identificadores de listas de CNPJs a serem excluídos, separados por vírgula.","example":"37505509-b2a5-42c2-94f4-aa99d2033bf5","type":"array","items":{"type":"string","format":"uuid"}},"alias.in":{"description":"Termos a serem incluídos no nome fantasia, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"CNPJá,Banco do Brasil,AMBEV S/A","type":"array","items":{"type":"string","format":"not empty"}},"alias.nin":{"description":"Termos a serem excluídos no nome fantasia, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"Eireli,LTDA","type":"array","items":{"type":"string","format":"not empty"}},"founded.gte":{"type":"string","description":"Data de abertura maior ou igual a especificada.","example":"2018-01-01","format":"iso8601"},"founded.lte":{"type":"string","description":"Data de abertura menor ou igual a especificada.","example":"2020-12-31","format":"iso8601"},"head.eq":{"type":"boolean","description":"Indicador de estabelecimento matriz:  \n- `true`: Apenas matrizes.  \n- `false`: Apenas filiais.","example":true},"statusDate.gte":{"type":"string","description":"Data da situação cadastral maior ou igual a especificada.","example":"2018-01-01","format":"iso8601"},"statusDate.lte":{"type":"string","description":"Data da situação cadastral menor ou igual a especificada.","example":"2020-12-31","format":"iso8601"},"status.id.in":{"description":"Códigos das situações cadastrais a serem incluídos, separados por vírgula:  \n- `1`: Nula.  \n- `2`: Ativa.  \n- `3`: Suspensa.  \n- `4`: Inapta.  \n- `8`: Baixada.","example":"3,4,8","type":"array","items":{"type":"number","format":"integer"}},"reason.id.in":{"description":"Códigos dos motivos das situações cadastrais a serem incluídos, separados por vírgula, conforme\n[Receita Federal 🡭](http://www.consultas.cge.rj.gov.br/scadastral.pdf).","example":"1,3,5","type":"array","items":{"type":"number","format":"integer"}},"specialDate.gte":{"type":"string","description":"Data da situação especial maior ou igual a especificada.","example":"2018-01-01","format":"iso8601"},"specialDate.lte":{"type":"string","description":"Data da situação especial menor ou igual a especificada.","example":"2020-12-31","format":"iso8601"},"special.id.in":{"description":"Códigos das situações especiais a serem incluídos, separados por vírgula, conforme\n[Receita Federal 🡭](http://www38.receita.fazenda.gov.br/cadsincnac/jsp/coleta/ajuda/topicos/Eventos_de_Alteracao.htm).","example":"405,410,417","type":"array","items":{"type":"number","format":"integer"}},"address.municipality.in":{"description":"Códigos dos municípios a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://www.ibge.gov.br/explica/codigos-dos-municipios.php).","example":"4106902,4205407,4314902","type":"array","items":{"type":"number","format":"integer"}},"address.municipality.nin":{"description":"Códigos dos municípios a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://www.ibge.gov.br/explica/codigos-dos-municipios.php).","example":"4106902,4205407,4314902","type":"array","items":{"type":"number","format":"integer"}},"address.street.in":{"description":"Termos a serem incluídos no logradouro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"Avenida Copacabana,Rua das Pedras,Rua Oscar Freire","type":"array","items":{"type":"string","format":"not empty"}},"address.street.nin":{"description":"Termos a serem excluídos no logradouro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"Avenida Copacabana,Rua das Pedras,Rua Oscar Freire","type":"array","items":{"type":"string","format":"not empty"}},"address.number.in":{"description":"Números do logradouro a serem incluídos, separados por vírgula.","example":"10,435,10387","type":"array","items":{"type":"string","format":"not empty"}},"address.number.nin":{"description":"Números do logradouro a serem excluídos, separados por vírgula.","example":"10,435,10387","type":"array","items":{"type":"string","format":"not empty"}},"address.details.in":{"description":"Termos a serem incluídos no complemento, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"Cj 1403,Andar 4,Bloco C","type":"array","items":{"type":"string","format":"not empty"}},"address.details.nin":{"description":"Termos a serem excluídos no complemento, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"Cj 1403,Andar 4,Bloco C","type":"array","items":{"type":"string","format":"not empty"}},"address.district.in":{"description":"Termos a serem incluídos no bairro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"Leblon,Vila Olímpia,Belvedere","type":"array","items":{"type":"string","format":"not empty"}},"address.district.nin":{"description":"Termos a serem excluídos no bairro, separados por espaço para correspondência no mesmo\nestabelecimento, ou separados por vírgula para correspondência em diferentes.","example":"Leblon,Vila Olímpia,Belvedere","type":"array","items":{"type":"string","format":"not empty"}},"address.state.in":{"type":"array","description":"Unidades federativas a serem incluídas, separadas por vírgula.","example":"ES,RJ,SP","items":{"type":"string","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]}},"address.zip.in":{"description":"Códigos de endereçamento postal a serem incluídos, separados por vírgula.","example":"01430000,01452922,01310100","type":"array","items":{"type":"string","format":"numeric","maxLength":8,"minLength":8}},"address.zip.gte":{"type":"string","description":"Código de endereçamento postal maior ou igual ao especificado.","example":"01452922","minLength":8,"maxLength":8,"format":"numeric"},"address.zip.lte":{"type":"string","description":"Código de endereçamento postal menor ou igual ao especificado.","example":"01452922","minLength":8,"maxLength":8,"format":"numeric"},"address.country.id.in":{"description":"Códigos dos países a serem incluídos, separados por vírgula, conforme\n[M49 🡭](https://unstats.un.org/unsd/methodology/m49/).","example":"32,152,600","type":"array","items":{"type":"number","format":"integer"}},"address.country.id.nin":{"description":"Códigos dos países a serem excluídos, separados por vírgula, conforme\n[M49 🡭](https://unstats.un.org/unsd/methodology/m49/).","example":"32,152,600","type":"array","items":{"type":"number","format":"integer"}},"phones.ex":{"type":"boolean","description":"Indicador de existência de telefone:  \n- `true`: Apenas estabelecimentos com telefone.  \n- `false`: Apenas estabelecimentos sem telefone.","example":true},"phones.type.in":{"type":"array","description":"Tipos de telefone a serem incluídos, separados por vírgula.","example":"LANDLINE,MOBILE","items":{"type":"string","enum":["LANDLINE","MOBILE"]}},"phones.area.in":{"description":"Códigos de DDD a serem incluídos, separados por vírgula.","example":"11,13,15","type":"array","items":{"type":"string","format":"numeric","maxLength":2,"minLength":2}},"phones.area.nin":{"description":"Códigos de DDD a serem excluídos, separados por vírgula.","example":"11,13,15","type":"array","items":{"type":"string","format":"numeric","maxLength":2,"minLength":2}},"phones.area.gte":{"type":"string","description":"Códigos de DDD maior ou igual ao especificado.","example":"11","minLength":2,"maxLength":2,"format":"numeric"},"phones.area.lte":{"type":"string","description":"Códigos de DDD menor ou igual ao especificado.","example":"11","minLength":2,"maxLength":2,"format":"numeric"},"phones.number.in":{"description":"Números de telefone a serem incluídos, separados por vírgula.","example":"92635835,44594576,36285962","type":"array","items":{"type":"string","format":"numeric","maxLength":8,"minLength":8}},"phones.number.nin":{"description":"Números de telefone a serem excluídos, separados por vírgula.","example":"92635835,44594576,36285962","type":"array","items":{"type":"string","format":"numeric","maxLength":8,"minLength":8}},"emails.ex":{"type":"boolean","description":"Indicador de existência de e-mail:  \n- `true`: Apenas estabelecimentos com e-mail.  \n- `false`: Apenas estabelecimentos sem e-mail.","example":true},"emails.ownership.in":{"type":"array","description":"Tipos de propriedade de e-mail a serem incluídos, separados por vírgula.","example":"CORPORATE,ACCOUNTING","items":{"type":"string","enum":["ACCOUNTING","CORPORATE","PERSONAL"]}},"emails.address.in":{"description":"Endereços de e-mail a serem incluídos, separados por vírgula.","example":"alex.costa@company.com,jane.doe@gmail.com,support@domain.com","type":"array","items":{"type":"string","format":"e-mail"}},"emails.address.nin":{"description":"Endereços de e-mail a serem excluídos, separados por vírgula.","example":"alex.costa@company.com,jane.doe@gmail.com,support@domain.com","type":"array","items":{"type":"string","format":"e-mail"}},"emails.domain.in":{"description":"Domínios de e-mail a serem incluídos, separados por vírgula.","example":"cnpja.com,bb.com.br,ambev.com.br","type":"array","items":{"type":"string","format":"not empty"}},"emails.domain.nin":{"description":"Domínios de e-mail a serem excluídos, separados por vírgula.","example":"gmail.com,hotmail.com,yahoo.com","type":"array","items":{"type":"string","format":"not empty"}},"activities.id.in":{"description":"Códigos das atividades econômicas principais ou secundárias a serem incluídos, separados por vírgula,\nconforme [IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}},"activities.id.nin":{"description":"Códigos das atividades econômicas principais ou secundárias a serem excluídos, separados por vírgula,\nconforme [IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}},"mainActivity.id.in":{"description":"Códigos das atividades econômicas principais a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}},"mainActivity.id.nin":{"description":"Códigos das atividades econômicas principais a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}},"sideActivities.id.in":{"description":"Códigos das atividades econômicas secundárias a serem incluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}},"sideActivities.id.nin":{"description":"Códigos das atividades econômicas secundárias a serem excluídos, separados por vírgula, conforme\n[IBGE 🡭](https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura).","example":"0111301,1011201,3511501","type":"array","items":{"type":"number","format":"integer"}}},"title":"ListQueryDto"},"ListCreateDto":{"type":"object","properties":{"title":{"type":"string","description":"Título da lista.","example":"Minha Lista de Empresas","maxLength":50,"format":"not empty"},"description":{"type":"string","description":"Descrição da lista.","example":"Fornecedores da unidade de Manaus.","maxLength":2000,"format":"not empty"},"limit":{"type":"number","description":"Limite de estabelecimentos a serem obtidos ao gerar uma lista através de filtros.","example":10000,"maximum":1000000,"minimum":1,"format":"integer"},"items":{"description":"Números dos CNPJs sem pontuação, mutualmente exclusivo com `query`.","maxItems":1000000,"minItems":1,"type":"array","items":{"type":"string","format":"cnpj"}},"query":{"description":"+**1 ₪** por 10 registros.\nFiltros de pesquisa utilizados para gerar a lista de estabelecimentos, mutualmente exclusivo com `items`.\nOs CNPJs serão obtidos na primeira exportação e armazenados de forma estática, não sendo atualizados em execuções posteriores.","allOf":[{"$ref":"#/components/schemas/ListQueryDto"}]}},"required":["title"],"title":"ListCreateDto"},"ListDto":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único.","example":"5680a75e-750e-4c31-a1a1-e61e0e4f5618","format":"uuid"},"created":{"type":"string","description":"Data de criação.","example":"2024-03-11T17:30:20.757Z","format":"iso8601"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-03-27T08:47:56.384Z","format":"iso8601"},"title":{"type":"string","description":"Título da lista.","example":"Minha Lista de Empresas","maxLength":50,"format":"not empty"},"description":{"type":"string","description":"Descrição da lista.","example":"Fornecedores da unidade de Manaus.","maxLength":2000,"format":"not empty"},"size":{"type":"number","description":"Quantidade de estabelecimentos.","example":9264,"format":"integer"},"items":{"description":"Números dos CNPJs sem pontuação.","maxItems":1000000,"minItems":0,"type":"array","items":{"type":"string","format":"cnpj"}},"query":{"description":"Filtros de pesquisa utilizados para gerar a lista de estabelecimentos.\nOs CNPJs serão obtidos na primeira exportação e armazenados de forma estática, não sendo atualizados em execuções posteriores.","allOf":[{"$ref":"#/components/schemas/ListQueryDto"}]},"limit":{"type":"number","description":"Limite de estabelecimentos a serem obtidos ao gerar uma lista através de filtros.","example":10000,"maximum":1000000,"minimum":1,"format":"integer"}},"required":["id","created","updated","title","description","size","items"],"title":"ListDto"},"ListSummaryDto":{"type":"object","properties":{"id":{"type":"string","description":"Identificador único.","example":"5680a75e-750e-4c31-a1a1-e61e0e4f5618","format":"uuid"},"created":{"type":"string","description":"Data de criação.","example":"2024-03-11T17:30:20.757Z","format":"iso8601"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-03-27T08:47:56.384Z","format":"iso8601"},"title":{"type":"string","description":"Título da lista.","example":"Minha Lista de Empresas","maxLength":50,"format":"not empty"},"description":{"type":"string","description":"Descrição da lista.","example":"Fornecedores da unidade de Manaus.","maxLength":2000,"format":"not empty"},"size":{"type":"number","description":"Quantidade de estabelecimentos.","example":9264,"format":"integer"},"query":{"description":"Filtros de pesquisa utilizados para gerar a lista de estabelecimentos.\nOs CNPJs serão obtidos na primeira exportação e armazenados de forma estática, não sendo atualizados em execuções posteriores.","allOf":[{"$ref":"#/components/schemas/ListQueryDto"}]},"limit":{"type":"number","description":"Limite de estabelecimentos a serem obtidos ao gerar uma lista através de filtros.","example":10000,"maximum":1000000,"minimum":1,"format":"integer"}},"required":["id","created","updated","title","description","size"],"title":"ListSummaryDto"},"ListPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Token da próxima página.","example":"8d47bdcbde4a7a2d4a98d5f555a19701","minLength":32,"maxLength":32,"format":"not empty"},"limit":{"type":"number","description":"Quantidade de registros lidos.","example":100,"maximum":100,"minimum":1,"format":"integer"},"count":{"type":"number","description":"Quantidade de registros disponíveis.","example":345,"minimum":0,"format":"integer"},"records":{"description":"Listas que obedecem aos critérios de pesquisa.","type":"array","items":{"$ref":"#/components/schemas/ListSummaryDto"}}},"required":["next","limit","count","records"],"title":"ListPageDto"},"ListUpdateDto":{"type":"object","properties":{"title":{"type":"string","description":"Título da lista.","example":"Minha Lista de Empresas","maxLength":50,"format":"not empty"},"description":{"type":"string","description":"Descrição da lista.","example":"Fornecedores da unidade de Manaus.","maxLength":2000,"format":"not empty"},"items":{"description":"Números dos CNPJs sem pontuação, mutualmente exclusivo com `query`.","maxItems":1000000,"minItems":1,"type":"array","items":{"type":"string","format":"cnpj"}}},"title":"ListUpdateDto"},"ListJobOptionsDto":{"type":"object","properties":{"simples":{"type":"boolean","description":"+**1 ₪** Adiciona as informações de opção pelo\nSimples e enquadramento no MEI.","default":false},"simplesHistory":{"type":"boolean","description":"+**1 ₪** Adiciona o histórico de períodos\nanteriores do Simples e MEI.","default":false},"registrations":{"type":"array","description":"+**1 ₪** quando `registrationsSource` for `CCC`, \n+**1 ₪** por UF quando `registrationsSource` for `SINTEGRA`.\nAdiciona as Inscrições Estaduais para as selecionadas Unidades Federativas separadas por vírgula.\nAceita os termos especiais `ORIGIN` (mesma UF do endereço do estabelecimento) e `ALL` (todas).","example":"PR,RS,SC","items":{"type":"string","enum":["ORIGIN","ALL","AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]},"minItems":1},"registrationsSource":{"type":"string","description":"Fonte de dados para obtenção das Inscrições Estaduais:  \n- `AUTO`: Idem a utilizar `CCC`, sujeito a alterações no futuro caso credenciais sejam necessárias.  \n- `CCC`: Utiliza o Cadastro Centralizado de Contribuintes para leitura de todas as inscrições.  \n- `SINTEGRA`: Utiliza individualmente cada SINTEGRA estadual para leitura das inscrições.","default":"AUTO","enum":["AUTO","CCC","SINTEGRA"]},"suframa":{"type":"boolean","description":"+**1 ₪** Adiciona a inscrição na SUFRAMA.","default":false},"geocoding":{"type":"boolean","description":"+**1 ₪** Adiciona a latitude e longitude do endereço.","default":false},"strategy":{"type":"string","description":"Estratégia de cache utilizada na aquisição dos dados:  \n- `CACHE`: Entrega os dados do cache, evitando cobranças de créditos, se os dados não estiverem disponíveis resultará em um erro 404.  \n- `CACHE_IF_FRESH`: Retorna os dados do cache respeitando o limite em `maxAge`, se os dados estiverem desatualizados será consultado online.  \n- `CACHE_IF_ERROR`: Idem ao `CACHE_IF_FRESH`, mas se a consulta online falhar retorna os dados do cache respeitando o limite em `maxStale`.  \n- `ONLINE`: Consulta diretamente online, não recomendado pois ignora qualquer cache, sugerimos configurar `maxAge=1` como alternativa.","default":"CACHE_IF_ERROR","enum":["ONLINE","CACHE_IF_FRESH","CACHE_IF_ERROR","CACHE"]},"maxAge":{"type":"number","description":"Idade máxima, em dias, que um dado em cache é aceite, relevante para as estratégias `CACHE_IF_FRESH` e `CACHE_IF_ERROR`.","default":45,"maximum":3650,"minimum":1,"format":"integer"},"maxStale":{"type":"number","description":"Idade máxima, em dias, que um dado em cache é aceite em caso de erro na busca online, relevante apenas para a estratégia `CACHE_IF_ERROR`.","default":365,"maximum":3650,"minimum":1,"format":"integer"}},"title":"ListJobOptionsDto"},"ListExportCreateDto":{"type":"object","properties":{"options":{"description":"Opções de consulta dos estabelecimentos.","allOf":[{"$ref":"#/components/schemas/ListJobOptionsDto"}]}},"title":"ListExportCreateDto"},"ListExportIdDto":{"type":"object","properties":{"id":{"type":"string","description":"Código da exportação.","example":"db344b70-3daf-43f3-b324-0f204ebfbd99","format":"uuid"}},"required":["id"],"title":"ListExportIdDto"},"ListLinkDto":{"type":"object","properties":{"type":{"type":"string","description":"Tipo de arquivo a qual o link se refere.","example":"EXCEL","enum":["EXCEL","JSON_ZIP"]},"url":{"type":"string","description":"URL pública de acesso ao arquivo.","example":"https://storage.googleapis.com/cnpja/list/.../lista.xlsx","format":"not empty"}},"required":["type","url"],"title":"ListLinkDto"},"ListExportDto":{"type":"object","properties":{"updated":{"type":"string","description":"Date of last update","example":"2024-03-11T17:30:20.757Z","format":"iso8601"},"created":{"type":"string","description":"Date of creation","example":"2024-03-11T17:30:20.757Z","format":"iso8601"},"id":{"type":"string","description":"Unique identifier","example":"5680a75e-750e-4c31-a1a1-e61e0e4f5618","format":"uuid"},"status":{"type":"string","description":"Situação da exportação:  \n- `PENDING`: Exportação aguardando na fila, é permitido processar uma lista por vez.  \n- `PROCESSING`: Processamento dos dados empresariais em andamento.  \n- `PROCESSED`: Dados processados, aguardando exportação dos arquivos.  \n- `EXPORTING`: Exportação dos arquivos em andamento.  \n- `COMPLETED`: Exportação concluída com sucesso.  \n- `FAILED`: Exportação falhou, confira detalhes no campo `statusReason`.","example":"COMPLETED","enum":["PENDING","PROCESSING","PROCESSED","EXPORTING","COMPLETED","FAILED"]},"statusReason":{"type":"string","description":"Motivo de falha da exportação.","example":"Saldo insuficiente","format":"not empty"},"progress":{"type":"number","description":"Percentual de conclusão da exportação.","example":0.5,"format":"float"},"options":{"description":"Opções de consulta dos estabelecimentos.","allOf":[{"$ref":"#/components/schemas/ListJobOptionsDto"}]},"links":{"description":"Lista de links para arquivos.","type":"array","items":{"$ref":"#/components/schemas/ListLinkDto"}}},"required":["updated","created","id","status","statusReason","progress","options","links"],"title":"ListExportDto"},"ListExportPageDto":{"type":"object","properties":{"next":{"type":"string","description":"Token da próxima página.","example":"8d47bdcbde4a7a2d4a98d5f555a19701","minLength":32,"maxLength":32,"format":"not empty"},"limit":{"type":"number","description":"Quantidade de registros lidos.","example":100,"maximum":100,"minimum":1,"format":"integer"},"count":{"type":"number","description":"Quantidade de registros disponíveis.","example":345,"minimum":0,"format":"integer"},"records":{"description":"Exportações pertencentes a lista.","type":"array","items":{"$ref":"#/components/schemas/ListExportDto"}}},"required":["next","limit","count","records"],"title":"ListExportPageDto"},"LegacyRegistrationDto":{"type":"object","properties":{"status":{"type":"string","description":"Situação cadastral: `NULA`, `ATIVA`, `SUSPENSA`, `INAPTA` ou `BAIXADA`.","example":"ATIVA","enum":["NULA","ATIVA","SUSPENSA","INAPTA","BAIXADA"]},"status_date":{"type":"string","description":"Data da situação especial.","example":"2022-01-01","format":"iso8601"},"status_reason":{"type":"string","description":"Motivo da situação cadastral.","example":"Extinção Por Encerramento Liquidação Voluntária","format":"not empty"},"special_status":{"type":"string","description":"Descrição da situação especial.","example":"Início de Liquidação Judicial","format":"not empty"},"special_status_date":{"type":"string","description":"Data da situação especial.","example":"2022-01-01","format":"iso8601"}},"required":["status","status_date","status_reason","special_status","special_status_date"],"title":"LegacyRegistrationDto"},"LegacyAddressDto":{"type":"object","properties":{"street":{"type":"string","description":"Logradouro.","example":"Avenida Brigadeiro Faria Lima","format":"not empty"},"number":{"type":"string","description":"Número.","example":"2369","format":"not empty"},"details":{"type":"string","description":"Complemento.","example":"Conj 1102","format":"not empty"},"neighborhood":{"type":"string","description":"Bairro ou distrito.","example":"Jardim Paulistano","format":"not empty"},"city":{"type":"string","description":"Município.","example":"São Paulo","format":"not empty"},"city_ibge":{"type":"string","externalDocs":{"description":"Código do município conforme tabela do IBGE.","url":"https://www.ibge.gov.br/explica/codigos-dos-municipios.php"},"example":"3550308","format":"numeric"},"state":{"type":"string","description":"Sigla da Unidade Federativa.","example":"SP","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]},"state_ibge":{"type":"string","description":"Código da Unidade Federativa conforme IBGE.","example":"35","format":"numeric"},"zip":{"type":"string","description":"Código de Endereçamento Postal.","example":"01452922","minLength":8,"maxLength":8,"format":"numeric"}},"required":["street","number","details","neighborhood","city","city_ibge","state","state_ibge","zip"],"title":"LegacyAddressDto"},"LegacyLegalNatureDto":{"type":"object","properties":{"code":{"type":"string","externalDocs":{"description":"Código da natureza jurídica conforme table do IBGE.","url":"https://concla.ibge.gov.br/estrutura/natjur-estrutura/natureza-juridica-2021"},"example":"2062","format":"numeric"},"description":{"type":"string","description":"Descrição da natureza jurídica.","example":"Sociedade Empresária Limitada","format":"not empty"}},"required":["code","description"],"title":"LegacyLegalNatureDto"},"LegacySimplesNacionalDto":{"type":"object","properties":{"last_update":{"type":"string","description":"Data da última atualização do Simples Nacional.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"simples_optant":{"type":"boolean","description":"Indica se optante pelo Simples Nacional.","example":true},"simples_included":{"type":"string","description":"Data de inclusão no período vigente.","example":"2020-06-05","format":"iso8601"},"simples_excluded":{"type":"string","description":"[Removido] Data de encerramento do último período.","example":"2021-06-05","format":"iso8601"},"simei_optant":{"type":"boolean","description":"Indica se enquadrado no MEI.","example":true}},"required":["last_update","simples_optant","simples_included","simples_excluded","simei_optant"],"title":"LegacySimplesNacionalDto"},"LegacySintegraRegistrationDto":{"type":"object","properties":{"number":{"type":"string","description":"Número da Inscrição Estadual.","example":"0962101427","format":"numeric"},"state":{"type":"string","description":"Unidade Federativa de registro.","example":"RS","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]},"enabled":{"type":"boolean","description":"Indica se habilitada como contribuinte.","example":true}},"required":["number","state","enabled"],"title":"LegacySintegraRegistrationDto"},"LegacySintegraDto":{"type":"object","properties":{"last_update":{"type":"string","description":"Data da última atualização do Cadastro de Contribuintes.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"home_state_registration":{"type":"string","description":"Número da Inscrição Estadual no estado de origem.","example":"0962101427","format":"numeric"},"registrations":{"description":"Lista de Inscrições Estaduais.","type":"array","items":{"$ref":"#/components/schemas/LegacySintegraRegistrationDto"}}},"required":["last_update","home_state_registration","registrations"],"title":"LegacySintegraDto"},"LegacyActivityDto":{"type":"object","properties":{"code":{"type":"string","externalDocs":{"description":"Código da atividade econômica conforme table do IBGE.","url":"https://concla.ibge.gov.br/busca-online-cnae.html?view=estrutura"},"example":"6311900","format":"numeric"},"description":{"type":"string","description":"Descrição da atividade econômica.","example":"Tratamento de dados, provedores de serviços de aplicação e serviços de hospedagem na internet","format":"not empty"}},"required":["code","description"],"title":"LegacyActivityDto"},"LegacyRoleDto":{"type":"object","properties":{"code":{"type":"string","externalDocs":{"description":"Código da qualificação conforme tabela da Receita Federal.","url":"http://www.consultas.cge.rj.gov.br/codsocio.pdf"},"example":"49","format":"numeric"},"description":{"type":"string","description":"Descrição da qualificação.","example":"Sócio-Administrador","format":"not empty"}},"required":["code","description"],"title":"LegacyRoleDto"},"LegacyMemberAgentDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome ou razão social.","example":"João Silva","format":"not empty"},"tax_id":{"type":"string","description":"CPF ou CNPJ.","example":"***123456**","format":"not empty"},"home_country":{"type":"string","description":"Nome do país de origem.","example":"BRASIL","format":"not empty"},"role":{"description":"Informações da qualificação.","allOf":[{"$ref":"#/components/schemas/LegacyRoleDto"}]}},"required":["name","tax_id","home_country","role"],"title":"LegacyMemberAgentDto"},"LegacyMemberDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome ou razão social.","example":"João Silva","format":"not empty"},"tax_id":{"type":"string","description":"CPF ou CNPJ.","example":"***123456**","format":"not empty"},"home_country":{"type":"string","description":"Nome do país de origem.","example":"BRASIL","format":"not empty"},"role":{"description":"Informações da qualificação.","allOf":[{"$ref":"#/components/schemas/LegacyRoleDto"}]},"legal_rep":{"description":"Presente quando aplicável na qualificação  \nInformações do representante legal.","allOf":[{"$ref":"#/components/schemas/LegacyMemberAgentDto"}]}},"required":["name","tax_id","home_country","role","legal_rep"],"title":"LegacyMemberDto"},"LegacyFilesDto":{"type":"object","properties":{"registration":{"type":"string","description":"Comprovante de inscrição em PDF.","example":"https://api.cnpja.com/[...]","format":"url"},"membership":{"type":"string","description":"Quadro de sócios e administradores em PDF.","example":"https://api.cnpja.com/[...]","format":"url"}},"required":["registration","membership"],"title":"LegacyFilesDto"},"LegacyMapsDto":{"type":"object","properties":{"roads":{"type":"string","description":"Mapa aéreo de vias.","example":"https://api.cnpja.com/[...]","format":"url"},"satellite":{"type":"string","description":"Mapa aéreo de satélite.","example":"https://api.cnpja.com/[...]","format":"url"},"street":{"type":"string","description":"Visão da rua.","example":"https://api.cnpja.com/[...]","format":"url"}},"required":["roads","satellite","street"],"title":"LegacyMapsDto"},"LegacyCompanyDto":{"type":"object","properties":{"last_update":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"name":{"type":"string","description":"Razão social.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"alias":{"type":"string","description":"Nome fantasia.","example":"CNPJA","format":"not empty"},"tax_id":{"type":"string","description":"Número do CNPJ.","example":"37335118000180","format":"cnpj"},"type":{"type":"string","description":"Tipo do estabelecimento: `MATRIZ` ou `FILIAL`.","example":"MATRIZ","enum":["MATRIZ","FILIAL"]},"founded":{"type":"string","description":"Data de abertura.","example":"2020-06-05","format":"iso8601"},"size":{"type":"string","description":"Porte da empresa: `ME`, `EPP` ou `DEMAIS`.","example":"ME","enum":["ME","EPP","DEMAIS"]},"capital":{"type":"number","description":"Capital social.","example":1000,"format":"float"},"email":{"type":"string","description":"Endereço de e-mail.","example":"contato@cnpja.com","format":"e-mail"},"phone":{"type":"string","description":"Número do telefone.","example":"11971564144","format":"numeric"},"phone_alt":{"type":"string","description":"Número do telefone alternativo.","example":"11971564144","format":"numeric"},"federal_entity":{"type":"string","description":"Ente federativo responsável.","example":"Uniao","format":"not empty"},"registration":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/LegacyRegistrationDto"}]},"address":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/LegacyAddressDto"}]},"legal_nature":{"description":"Informações da natureza jurídica.","allOf":[{"$ref":"#/components/schemas/LegacyLegalNatureDto"}]},"simples_nacional":{"description":"Informações do Simples Nacional.","allOf":[{"$ref":"#/components/schemas/LegacySimplesNacionalDto"}]},"sintegra":{"description":"Informações do Cadastro de Contribuintes.","allOf":[{"$ref":"#/components/schemas/LegacySintegraDto"}]},"primary_activity":{"description":"Informações da atividade econômica principal.","allOf":[{"$ref":"#/components/schemas/LegacyActivityDto"}]},"secondary_activities":{"description":"Lista de atividades econômicas secundárias.","type":"array","items":{"$ref":"#/components/schemas/LegacyActivityDto"}},"membership":{"description":"Quadro de sócios e administradores.","type":"array","items":{"$ref":"#/components/schemas/LegacyMemberDto"}},"partnership":{"type":"object","properties":{},"required":[]},"files":{"description":"Links para download de arquivos.","allOf":[{"$ref":"#/components/schemas/LegacyFilesDto"}]},"maps":{"description":"Links para download de mapas.","allOf":[{"$ref":"#/components/schemas/LegacyMapsDto"}]}},"required":["last_update","name","alias","tax_id","type","founded","size","capital","email","phone","phone_alt","federal_entity","registration","address","legal_nature","simples_nacional","sintegra","primary_activity","secondary_activities","membership","partnership","files","maps"],"title":"LegacyCompanyDto"},"CreditoDto":{"type":"object","properties":{"perpetual":{"type":"number","description":"Créditos acumulados de meses anteriores.","example":2000,"format":"integer"},"transient":{"type":"number","description":"Créditos do mês atual.","example":10000,"format":"integer"}},"required":["perpetual","transient"],"title":"CreditoDto"},"CompanyOfficeDto":{"type":"object","properties":{"taxId":{"type":"string","description":"Número do CNPJ sem pontuação.","example":"37335118000180","format":"cnpj"},"alias":{"type":"string","description":"Nome fantasia.","example":"CNPJA","format":"not empty"},"founded":{"type":"string","description":"Data de abertura.","example":"2020-06-05","format":"iso8601"},"head":{"type":"boolean","description":"Indica se o estabelecimento é a Matriz.","example":true},"statusDate":{"type":"string","description":"Data da situação cadastral.","example":"2020-06-05","format":"iso8601"},"status":{"description":"Informações da situação cadastral.","allOf":[{"$ref":"#/components/schemas/OfficeStatusDto"}]},"reason":{"description":"Informações do motivo da situação cadastral, presente quando `status.id != 2`.","allOf":[{"$ref":"#/components/schemas/OfficeReasonDto"}]},"specialDate":{"type":"string","description":"Data da situação especial.","example":"2022-01-01","format":"iso8601"},"special":{"description":"Informações da situação especial, presente quando `specialDate != undefined`.","allOf":[{"$ref":"#/components/schemas/OfficeSpecialDto"}]},"mainActivity":{"description":"Informações da atividade econômica principal.","allOf":[{"$ref":"#/components/schemas/ActivityDto"}]}},"required":["taxId","alias","founded","head","statusDate","status","mainActivity"],"title":"CompanyOfficeDto"},"CompanyDto":{"type":"object","properties":{"id":{"type":"string","description":"Código da empresa, idem aos oito primeiros caracteres do CNPJ.","example":"37335118","format":"not empty"},"name":{"type":"string","description":"Razão social.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"jurisdiction":{"type":"string","description":"Ente federativo responsável, presente quando `nature.id < 2000`.","example":"Uniao","format":"not empty"},"equity":{"type":"number","description":"Capital social","example":1000,"format":"float"},"nature":{"description":"Informações da natureza jurídica.","allOf":[{"$ref":"#/components/schemas/NatureDto"}]},"size":{"description":"Informações do porte.","allOf":[{"$ref":"#/components/schemas/CompanySizeDto"}]},"simples":{"description":"Informações da opção pelo Simples Nacional.","allOf":[{"$ref":"#/components/schemas/CompanySimplesDto"}]},"simei":{"description":"Informações do enquadramento no MEI.","allOf":[{"$ref":"#/components/schemas/CompanySimplesDto"}]},"members":{"description":"Quadro de sócios e administradores.","type":"array","items":{"$ref":"#/components/schemas/MemberDto"}},"offices":{"description":"Lista de estabelecimentos.","type":"array","items":{"$ref":"#/components/schemas/CompanyOfficeDto"}}},"required":["id","name","equity","nature","size","members","offices"],"title":"CompanyDto"},"CccDto":{"type":"object","properties":{"taxId":{"type":"string","description":"Número do CNPJ ou CPF sem pontuação.","example":"37335118000180","format":"cnpj|cpf"},"updated":{"type":"string","description":"Data da última atualização.","example":"2024-06-05T17:52:39.136Z","format":"iso8601"},"name":{"type":"string","description":"Razão social ou nome do produtor rural.","example":"CNPJA TECNOLOGIA LTDA","format":"not empty"},"originState":{"type":"string","description":"Unidade Federativa de origem.","example":"PR","enum":["AC","AL","AM","AP","BA","CE","DF","ES","GO","MA","MG","MS","MT","PA","PB","PE","PI","PR","RJ","RN","RO","RR","RS","SC","SP","SE","TO"]},"registrations":{"description":"Inscrições Estaduais.","type":"array","items":{"$ref":"#/components/schemas/RegistrationDto"}}},"required":["taxId","updated","name","originState","registrations"],"title":"CccDto"}}},"x-tagGroups":[{"name":"Dados Empresariais","tags":["Estabelecimentos","Empresas","Pessoas","Códigos Postais"]},{"name":"Portais Públicos","tags":["Receita Federal","Simples Nacional","Cadastro de Contribuintes","Suframa"]},{"name":"Utilitários","tags":["Listas de CNPJ","Créditos Restantes"]},{"name":"Outros","tags":["Descontinuados"]}]}