IN CadastroEmpresas.integrador: mudanças entre as edições

De CIGAM WIKI
Sem resumo de edição
Sem resumo de edição
Linha 1 635: Linha 1 635:
***** Tipo: String 30
***** Tipo: String 30
****numero
****numero
*****
****complemento
****complemento
*****
****uf
****uf
***** Tipo: String 2
***** Tipo: String 2
Linha 1 691: Linha 1 693:
*****descricao
*****descricao
****usuarioModificacao
****usuarioModificacao
***** .
****enviarCarta
****enviarCarta
****tabelaDePreco
****tabelaDePreco
Linha 1 734: Linha 1 737:
***** Tipo: Date
***** Tipo: Date
****regiaoEntrega
****regiaoEntrega
**** Tipo: String 3
***** Tipo: String 3
****setor
****setor
*****codigo
*****codigo
Linha 1 766: Linha 1 769:
***** Tipo: String 3
***** Tipo: String 3
****nivelDeCredito
****nivelDeCredito
**** Tipo: String 3
***** Tipo: String 3
****creditoLiberado
****creditoLiberado
***** Tipo: Bool  
***** Tipo: Bool  
Linha 1 782: Linha 1 785:
*****rg
*****rg
*****orgaoExpedidor
*****orgaoExpedidor
*****sexo
****** F (Feminino), M (Masculino) ou O (Outros)
*****ativo
****** S (Sim) ou N (Não)
****email
****email
****recebeEmailNfe
****recebeEmailNfe
Linha 1 802: Linha 1 809:
****cpfProdutorRural
****cpfProdutorRural
****tipoAssinanteNfcom
****tipoAssinanteNfcom
***** Passar 0 (Nenhum), 1 (Comercial), 2 (Industrial), 3 (Residencia/Pessoa Física), 4 (Produtor Rural),
***** 0 (Nenhum), 1 (Comercial), 2 (Industrial), 3 (Residencia/Pessoa Física), 4 (Produtor Rural),
***** 5 (Órgão de Adm pública), 6 (Prestador), 7 (Missões diplomáticas), 8 (Igrejas) ou 99 (Outros)
***** 5 (Órgão de Adm pública), 6 (Prestador), 7 (Missões diplomáticas), 8 (Igrejas) ou 99 (Outros)
****municipioPrestacao
****municipioPrestacao
***** Passar P (Prestador) ou T (Tomador)
***** P (Prestador) ou T (Tomador)
****tipoEnteGovernamental
****tipoEnteGovernamental
***** Passar 0 (Nenhum), 1 (União), 2 (Estado), 3 (Distrito Federal) ou 4 (Município)
***** 0 (Nenhum), 1 (União), 2 (Estado), 3 (Distrito Federal) ou 4 (Município)
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
Linha 1 983: Linha 1 990:
***** <superior>
***** <superior>
***** <sexo>
***** <sexo>
****** Passar F (Feminino), M (Masculino) ou O (Outros)
***** <tratamento>
***** <tratamento>
***** <sessao>
***** <sessao>
Linha 2 025: Linha 2 033:
***** <orgaoExpedidor>
***** <orgaoExpedidor>
***** <dataExpedicao>
***** <dataExpedicao>
***** <ativo>
****** Passar S (Sim) ou N (Não)
*****   </contatoEmpresa>
*****   </contatoEmpresa>
****        <obsEmpresa>
****        <obsEmpresa>
Linha 2 210: Linha 2 220:
****** "superior": "",
****** "superior": "",
****** "sexo": "",
****** "sexo": "",
******* Passar F (Feminino), M (Masculino) ou O (Outros)
****** "tratamento": "",
****** "tratamento": "",
****** "sessao": "",
****** "sessao": "",
Linha 2 252: Linha 2 263:
****** "orgaoExpedidor": "",
****** "orgaoExpedidor": "",
****** "dataExpedicao": "",
****** "dataExpedicao": "",
****** "ativo": "",
******* Passar S (Sim) ou N (Não)
*****   }
*****   }
****   ]
****   ]

Edição das 18h13min de 6 de março de 2026

Voltar
Integrador > WebServices > IN CadastroEmpresas.integrador

Requisição

Métodos

Cadastrar

Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:


Parâmetros:


Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

Excluir

Parâmetros:


Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

Voltar ao início

ListarIndividual

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarPorCnpjCpf

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

    Se listarEndereco for falso, então só ira listar empresa, nomeCompleto e fantasia.

Voltar ao início

ListarId

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarModificacoes

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarEmpresas

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarEmpresasCompleto

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

CadastrarEmpresas

Método que tem por finalidade cadastrar Empresa/Pessoas e contatos de empresas. Os dados da Empresa/Pessoas deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.
Ao passar um código de uma empresa já cadastrada é possível alterar seus dados.


Parâmetros:


Distribuição das Tags XML:


Distribuição das Tags Json:


Retornos:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

ListarPendentes

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

LiberarPendentes

Parâmetros:


Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se erro na conexão com banco de dados:
      A conexão com o banco de dados e/ou comando SQL possui erros.

   Se ID inválido ou não encontrado:
      Falha ao liberar registro.

   Se sucesso:
      Sucesso.

Voltar ao início

ListarEmpresasPorCentralizadora

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarEmpresasPorRepresentante

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarRepresentantesPorEmpresa

Parâmetros:


Retornos:
   Se sucesso:


   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

Voltar ao início

ListarTransportadoras

Parâmetros:


Voltar ao início