Integração de Cadastros de Proprietário (Contratado/Beneficiário)


Método para integrar proprietários (beneficiários), que constam no RNTRC do veículo.


Request


  • ENDPOINT: Proprietario/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 E Caractere 1-1 14 1.0
4 CnpjCpf CPF ou CNPJ do proprietário E Caractere 1-1 14 1.0
5 RazaoSocial Razão social E Caractere 1-1 100 1.0
6 NomeFantasia Nome fantasia E Caractere 1-1 100 1.0
7 RG Registro Geral/Número da Carteira de Identidade para pessoa física E Caractere 1-0 50 1.0
8 RGOrgaoExpedidor Órgão expedidor para pessoa física E Caractere 1-0 10 1.0
9 RNTRC Registro nacional de transportadores de carga E Inteiro 1-1 10 1.0
10 IE Inscrição Estadual para pessoa jurídica E Inteiro 1-0 15 1.0
11 TipoContrato Tipo de contrato do proprietário a ser integrado
1: Frota,
2: Cooperado,
3: Agregado/Terceiro)		 E Inteiro 1-1 1 1.0
12 DataNascimento * Data de nascimento do proprietário pessoa física E Data 1-1 yy-MM-dd 1.0
13 Inss INSS do proprietário E Caractere 1-0 100 1.0
14 HabilitarContratoCiotAgregado True: Gerar CIOT Agregado para o proprietário;
False: Gerar CIOT Padrão (Default)		 E Booleano 1-1 True/False 1.0
15 NomeMae * Nome da mãe do proprietário pessoa física E Caractere 1-0 100 1.1
16 NomePai * Nome do pai do proprietário pessoa física E Caractere 1-0 100 1.1
17 Contatos Array de Objetos com os dados de contato de um proprietário A 1-1
18.1 Email E-mail do proprietário E Caractere 1-0 20 1.0
18.2 Telefone Telefone do proprietário E Caractere 1-1 20 1.0
18.3 Celular Celular do proprietário E Inteiro 1-0 10 1.0
19 Enderecos Array de Objetos com os dados de endereço de um proprietário A 1-1
19.1 CEP CEP E Caractere 1-1 8 1.0
19.2 Endereco Endereço do proprietário E Caractere 1-1 100 1.0
19.3 Complemento Complemento E Caractere 1-0 100 1.0
19.4 Numero Número E Inteiro 1-0 10 1.0
19.5 Bairro Bairro E Caractere 1-1 100 1.0
19.6 IBGECidade Código IBGE da cidade E Inteiro 1-1 10 1.0
19.7 IBGEEstado Código IBGE do estado E Inteiro 1-1 10 1.0
19.8 BACENPais Código BACEN do país E Inteiro 1-1 10 1.0

*Campos opcionais para integração do cadastro, mas obrigatórios para vincular cartão.


Modelo de Json - Request


{
  "CNPJAplicacao": "",
  "Token": "",
  "CNPJEmpresa": "",
  "CnpjCpf": "",
  "RazaoSocial": "",
  "NomeFantasia": "",
  "RG": "",
  "RGOrgaoExpedidor": "",
  "RNTRC": "",
  "IE": "",
  "TipoContrato": 1,
  "DataNascimento": "1990-12-31",
  "Inss": "",
  "NomeMae": "",
  "NomePai": "",
  "HabilitarContratoCiotAgregado": false,
  "Contatos": [
    {
      "Email": "",
      "Telefone": "",
      "Celular": ""
    }
  ],
  "Enderecos": [
    {
      "CEP": "",
      "Endereco": "",
      "Complemento": "",
      "Numero": 0,
      "Bairro": "",
      "IBGECidade": 0,
      "IBGEEstado": 0,
      "BACENPais": 0,
    }
  ]
}


Response


Índice Chave Descrição Elem. Tipo Ocor. Tam. Versão
1 Sucesso True: Caso não tenha acontecido nenhuma exceção ou validação no processo mesmo não trazendo dados no retorno
False: Quaisquer validações ou exceção não tratada pelo sistema que impediu o processo de ser concluído		 E Booleano 1-1 True/False 1.0
2 Mensagem Mensagem de retorno E Caractere 1-1 100 1.0
3 Objeto Objeto pai que contém o proprietário integrado G 0-1 1.0
3.1 IdProprietario Código do proprietário E Inteiro 1-1 10 1.0
3.2 CnpjCpf CNPJ ou CPF do proprietário E Caractere 1-1 14 1.0
3.3 RazaoSocial Razão social E Caractere 1-1 100 1.0
3.4 NomeFantasia Nome fantasia E Caractere 1-1 100 1.0
3.5 RG RG E Caractere 0-1 20 1.0
3.6 RGOrgaoExpedidor Órgão expedidor E Caractere 0-1 100 1.0
3.7 IE IE E Inteiro 0-1 15 1.0
3.8 RNTRC Registro nacional de transportadores de carga E Inteiro 1-1 10 1.0
3.9 TipoContrato Tipo de contrato do proprietário a ser integrado
1: Frota,
2: Cooperado,
3: Agregado/Terceiro)		 E Inteiro 1-1 1 1.0
3.10 RNTRC Registro nacional de transportadores de carga E Inteiro 1-1 10 1.0
3.11 Inss INSS do proprietário E Caractere 0-1 100 1.0
3.12 Ativo Representa que o registro está disponível E Booleano 1-1 True/False 1.0
3.13 Contatos Objeto pai que contém uma lista de contatos do proprietário A 1-1 1.0
3.13.1 IdProprietario Código do proprietário E Inteiro 1-1 10 1.0
3.13.2 IdEmpresa Código da empresa E Inteiro 1-1 10 1.0
3.13.3 IdContato Código do contato E Inteiro 1-1 10 1.0
3.13.4 Telefone Telefone do proprietário E Caractere 1-1 20 1.0
3.13.5 Celular Celular do proprietário E Caractere 0-1 20 1.0
3.13.6 Email E-mail E Caractere 0-1 200 1.0
3.14 Enderecos Objeto pai que contém uma lista de endereços do proprietário A 1-1 1.0
3.14.1 IdProprietario Código do proprietário E Inteiro 1-1 10 1.0
3.14.2 IdEmpresa Código da empresa E Inteiro 1-1 10 1.0
3.14.3 IdEndereco Código do endereço E Inteiro 1-1 10 1.0
3.14.4 CEP CEP do endereço E Caractere 1-1 8 1.0
3.14.5 Endereco Endereço do proprietário E Caractere 1-1 100 1.0
3.14.6 Complemento Complemento E Caractere 0-1 100 1.0
3.14.7 Numero Número E Inteiro 0-1 10 1.0
3.14.8 Bairro Bairro E Caractere 1-1 100 1.0
3.14.9 IdCidade Código da Cidade E Inteiro 1-1 10 1.0
3.14.10 IdEstado Código do Estado E Inteiro 1-1 10 1.0
3.14.11 IdPais Código do País E Inteiro 1-1 10 1.0
3.14.12 Pais Objeto pai que contém os dados do País do endereço G 1-1 - 1.0
3.14.12.1 IdPais Código do País E Inteiro 1-1 10 1.0
3.14.12.2 Nome Nome do País E Caractere 1-1 100 1.0
3.14.12.3 Sigla Sigla E Caractere 0-1 3 1.0
3.14.12.4 BACEN Código de BACEN do País E Inteiro 1-1 10 1.0
3.14.13 Estado Objeto pai que contém os dados do Estado do endereço G 1-1 - 1.0
3.14.13.1 IdEstado Código do Estado E Inteiro 1-1 10 1.0
3.14.13.2 IdPais Código do País E Inteiro 1-1 10 1.0
3.14.13.3 Nome Nome E Caractere 1-1 100 1.0
3.14.13.4 Sigla Sigla E Caractere 1-1 2 1.0
3.14.13.5 IBGE Código de IBGE do Estado E Inteiro 1-1 10 1.0
3.14.14 Cidade Objeto pai que contém os dados da Cidade do endereço G 1-1
3.14.14.1 IdCidade Código da Cidade E Inteiro 1-1 10 1.0
3.14.14.2 IdEstado Código do Estado E Inteiro 1-1 10 1.0
3.14.14.3 Nome Nome da Cidade E Caractere 1-1 100 1.0
3.14.14.4 IBGE Código de IBGE da Cidade E Inteiro 1-1 10 1.0
3.14.14.5 Latitude Latitude E Decimal 0-1 10,7 1.0
3.14.14.6 Longitude Longitude E Decimal 0-1 10,7 1.0
3.14.12.7 Pais Objeto pai que contém os dados do País do endereço G 1-1 - 1.0
3.14.12.7.1 IdPais Código do País E Inteiro 1-1 10 1.0
3.14.12.7.2 Nome Nome do País E Caractere 1-1 100 1.0
3.14.12.7.3 Sigla Sigla E Caractere 0-1 3 1.0
3.14.12.7.4 BACEN Código de BACEN do País E Inteiro 1-1 10 1.0


Modelo de Json - Response


{
  "Sucesso": true,
  "Mensagem": null,
  "Objeto": {
    "IdProprietario": ,
    "CnpjCpf": "",
    "RazaoSocial": "",
    "NomeFantasia": "",
    "RG": "",
    "RGOrgaoExpedidor": "",
    "IE": "",
    "RNTRC": "",
    "StatusIntegracao": 1,
    "TipoContrato": 1,
    "Inss": "",
    "Ativo": true,
    "Contatos": [
      {
        "IdProprietario": 0,
        "IdEmpresa": 0,
        "IdContato": 1,
        "Celular": "",
        "Telefone": ""
      }
    ],
    "Enderecos": [
      {
        "IdProprietario": 0,
        "IdEmpresa": 0,
        "IdEndereco": 0,
        "CEP": "",
        "Endereco": "",
        "Complemento": "",
        "Numero": 0,
        "Bairro": "",
        "IdCidade": 0,
        "IdEstado": 0,
        "IdPais": 0,
        "Pais": {
          "IdPais": 0,
          "Nome": "",
          "Sigla": null,
          "BACEN": 0 
        },
        "Estado": {
          "IdEstado": 0,
          "IdPais": 0,
          "Nome": "",
          "Sigla": "",
          "Regiao": 0,
          "IBGE": ,
          "Pais": {
            "IdPais": ,
            "Nome": "",
            "Sigla": null,
            "BACEN": 0
          }
        },
        "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": 0,
              "Nome": "",
              "Sigla": null,
              "BACEN": 0
            }
          }
        }
      }
    ]
  }
}