Integração de Filiais


Método para integração de filiais (que derivam do CNPJ matriz da empresa).

Obs: As integrações realizadas pelas filiais irão utilizar os mesmos dados de autenticação da matriz.

Request


  • ENDPOINT: Filial/Integrar
  • VERBO: POST


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 CNPJAplicacao CNPJ para autenticação E Caractere 1-1 14 1.0
2 Token Gerado a partir do CNPJ de autenticação para validar permissões de acesso E Caractere 1-1 100 1.0
3 CNPJEmpresa CNPJ da empresa vinculada a essa filial E Caractere 1-1 14 1.0
4 CNPJ CNPJ da filial E Caractere 1-1 14 1.0
5 RazaoSocial Razão social da filial E Caractere 1-1 100 1.0
6 NomeFantasia Nome fantasia da filial E Caractere 1-1 100 1.0
7 Sigla Sigla da filial E Caractere 1-1 10 1.0
8 CEP CEP da filial E Caractere 1-1 8 1.0
9 Endereco Endereço E Caractere 1-1 100 1.0
10 Numero Número do endereço E Inteiro 1-0 10 1.0
11 Bairro Bairro E Caractere 1-1 100 1.0
12 Telefone Telefone com DDD E Caractere 1-1 11 1.0
13 Email E-mail da filial E Caractere 1-1 100 1.0
14 codigoIbgeCidade Código IBGE da cidade da filial E Inteiro 1-1 10 1.0
15 codigoIbgeEstado Código IBGE do estado da filial E Inteiro 1-1 10 1.0
16 CodigoBACENPais Código BACEN do país da filial E Inteiro 1-1 10 1.0
17 Latitude Latitude E Decimal 1-0 10,7 1.0
18 Longitude Longitude E Decimal 1-0 10,7 1.0


Modelo de Json - Request


{
  "CNPJAplicacao": "",
  "Token": "",
  "CNPJEmpresa": "",
  "CNPJ": "",
  "RazaoSocial": "",
  "NomeFantasia": "",
  "Sigla": "",
  "CEP": "",
  "Endereco": "",
  "Numero": ,
  "Bairro": "",
  "Telefone": "",
  "Email": "",
  "codigoIbgeCidade": 0,
  "codigoIbgeEstado": 0,
  "CodigoBACENPais": 0,
  "Latitude": 0.0,
  "Longitude": 0.0
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 Sucesso Requisição realizada com sucesso ou não E Booleano 1-1 True/False 1.0
2 Mensagem Mensagem de retorno E Caractere 1-1 100 1.0
3 Objeto Elemento pai que contém as informações da filial G 0-1 1.0
3.1 IdFilial Código da filial adicionada E Inteiro 1-1 10 1.0
3.2 CNPJ CNPJ da filial adicionada E Caractere 1-1 14 1.0
3.3 RazaoSocial Razão social da filial E Caractere 1-1 100 1.0
3.4 NomeFantasia Nome fantasia da filial E Caractere 1-1 100 1.0
3.5 Sigla Sigla E Caractere 1-1 10 1.0
3.6 CEP CEP da filial E Caractere 1-1 8 1.0
3.7 Endereco Endereço da filial E Caractere 1-1 100 1.0
3.8 Numero Número da filial E Inteiro 0-1 10 1.0
3.9 Bairro Bairro da filial E Caractere 1-1 100 1.0
3.10 Telefone Telefone E Caractere 1-1 11 1.0
3.11 Email E-mail da filial E Caractere 1-1 100 1.0
3.12 IdEmpresa Código da empresa vinculada E Inteiro 1-1 10 1.0
3.13 IdCidade Código da cidade da empresa vinculada E Inteiro 1-1 10 1.0
3.14 IdEstado Código do estado da empresa vinculada E Inteiro 1-1 10 1.0
3.15 IdPais Código do país da empresa vinculada E Inteiro 1-1 10 1.0
3.16 Ativo Se a filial está ativa ou não no sistema E Booleano 1-1 True/False 1.0
3.17 Cidade Elemento pai que contém a cidade a qual a filial pertence G 1-1
3.17.1 IdCidade Código da cidade da filial E Inteiro 1-1 10 1.0
3.17.2 IdPais Código do país da filial E Inteiro 1-1 10 1.0
3.17.3 IdEstado Código do país da filial E Inteiro 1-1 10 1.0
3.17.4 Nome Nome da cidade da filial E Caractere 1-1 100 1.0
3.17.5 IBGE Número IBGE da cidade E Inteiro 1-1 10 1.0
3.17.6 Latitude Latitude da cidade E Decimal 0-1 10,7 1.0
3.17.7 Longitude Longitude da cidade E Decimal 0-1 10,7 1.0
3.17.8 Estado Elemento pai que contém o estado a qual a filial pertence G 1-1
3.17.8.1 IdEstado Código do estado da filial E Inteiro 1-1 10 1.0
3.17.8.2 Nome Nome do estado da filial E Caractere 1-1 100 1.0
3.17.8.3 Sigla Sigla do estado da filial E Caractere 1-1 10 1.0
3.17.8.4 Regiao Enum de regiões do brasil podendo ser eles:
0 - Não encontrada;
1 - Sul;
2 - Sudeste;
3 - Norte;
4 - Nordeste;
5 - Centro-Oeste;		 E Inteiro 1-1 10 1.0
3.17.8.5 IBGE IBGE do estado da filial E Inteiro 1-1 10 1.0
3.17.8.6 País Elemento pai que contém o país a qual a filial pertence G 1-1
3.17.8.6.1 IdPais Código do país da filial E Inteiro 1-1 10 1.0
3.17.8.6.2 Nome Nome do país da filial E Caractere 1-1 100 1.0
3.17.8.6.3 Sigla Sigla do país da filial E Caractere 0-1 10 1.0
3.17.8.6.4 BACEN BACEN do país da filial E Inteiro 1-1 10 1.0


Modelo de Json - Response


{
  "Sucesso": true,
  "Mensagem": null,
  "Objeto": {
    "IdFilial": 0,
    "CNPJ": "",
    "RazaoSocial": "",
    "NomeFantasia": "",
    "Sigla": "",
    "CEP": "",
    "Endereco": "",
    "Numero": ,
    "Bairro": "",
    "Telefone": "",
    "Email": "",
    "IdEmpresa": 0,
    "IdCidade": 0,
    "IdEstado": 0,
    "IdPais": 0,
    "Ativo": true,
    "Latitude": ,
    "Longitude": ,
    "Cidade": {
      "IdCidade": 0,
      "IdPais": 0,
      "IdEstado": 0,
      "Nome": "",
      "IBGE": 0,
      "Latitude": 0.0,
      "Longitude": 0.0,
      "Estado": {
        "IdEstado": 0,
        "IdPais": 0,
        "Nome": "",
        "Sigla": "",
        "Regiao": 0,
        "IBGE": 0,
        "Pais": {
          "IdPais": ,
          "Nome": "",
          "Sigla": null,
          "BACEN": 0
        }
      }
    }
  }
}