Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Buscar dados de uma pessoa jurídica no Sintegra, Receita Federal ou em Ambos.

Chamada

GET [URLAPI]/ConectorDadosGlobaisAPI/api/v1/Pessoa/{cnpj}/tas

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Sistema Global > Módulo de Aplicações Globais em Web > API Conector Dados Globais


Imagem 1 - Permissionamento da API Conector Dados Globais

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

CNPJ

CNPJ da pessoa jurídica à ser consultado

string

Obrigatório. Pode conter pontos e traços, porém não barras. Deve conter todos os 14 números do CNPJ.

ChaveAutenticacaoChave de autenticação usada no TAS - Totvs API Services.stringObrigatório.
UFUF ou Identificador IBGE da UF - Obrigatório caso a FonteConsulta seja S - Sintegra. stringNão há.
RotinaERPRotina do ERP consumindo a API.stringObrigatório.
FonteConsultaS - Sintegra, R - Receita Federal(Valor padrão), A - Receita Federal e Sintegra.string

Quando definido S - Sintegra, será realizada 1 consulta ao TAS.

Quando definido R - Receita Federal, será realizada 1 consulta ao TAS.

Quando definido A - Receita Federal e Sintegra, serão realizadas 2 consultas ao TAS.

OBS: Quando definido A e houver erro ao buscar dados no Sintegra, serão exibidos apenas os dados da Receita.

Parâmetros do Corpo (Body Parameters)

Não há.

Códigos do Recurso (Response Codes)

  • OK (200)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "cnpj": "string - Retornado em ambas fontes.",
  "razaoSocial": "string - Retornado em ambas fontes.",
  "nomeFantasia": "string - Retornado em ambas fontes.",
  "naturezaJuridica": "string - Retornado em ambas fontes.",
  "logradouro": "string - Retornado em ambas fontes.",
  "numero": "string - Retornado em ambas fontes.",
  "complemento": "string - Retornado em ambas fontes.",
  "bairro": "string - Retornado em ambas fontes.",
  "municipio": "string - Retornado em ambas fontes.",
  "cep": "string - Retornado em ambas fontes.",
  "uf": "string - Retornado em ambas fontes.",
  "email": "string - Retornado em ambas fontes.",
  "telefone": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "efr": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "situacaoCadastral": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "dataSituacaoCadastral": " - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "dataInicioAtividade": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "atividadeEconomica": "string - Retornado em ambas fontes.",
  "atividadesEconomicasSecundarias": [
    "string - Retornado em ambas fontes."
  ],
  "tipoCNPJ": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "situacaoEspecial": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "dataSituacaoEspecial": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "motivoSituacao": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "porte": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "capitalSocial": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "urlComprovante": "string - Retornado apenas para R - Receita Federal e A - Receita Federal e Sintegra.",
  "inscricoesEstaduais": [
    {
      "inscricaoEstadual": "string - Retornado apenas para S - Sintegra e A - Receita Federal e Sintegra.",
      "dataInicioAtividade": "string - Retornado apenas para S - Sintegra e A - Receita Federal e Sintegra.",
      "dataSituacaoCadastral": "string - Retornado apenas para S - Sintegra e A - Receita Federal e Sintegra.",
      "regimeRecolhimento": "string - Retornado apenas para S - Sintegra e A - Receita Federal e Sintegra.",
      "observacao": "string - Retornado apenas para S - Sintegra e A - Receita Federal e Sintegra.",
      "situacaoCadastral": "string - Retornado apenas para S - Sintegra e A - Receita Federal e Sintegra."
    }
  ]
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}