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

De CIGAM WIKI
Sem resumo de edição
Sem resumo de edição
 
(6 revisões intermediárias pela mesma usuária não estão sendo mostradas)
Linha 1: Linha 1:
{{VoltarPagina}}
{{VoltarPagina}}
[[Integrador]] >  
[[Integrador]] >  
[[IN_CIGAM Integrador|WebServices]] >
[[IN_CIGAM Integrador#Genérico|WebServices]] >
[[IN CadastroEmpresas.integrador]]
[[IN CadastroEmpresas.integrador]]


Linha 16: Linha 16:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:</p><br>
         <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 354: Linha 354:
*tipoAssinanteNfcom  
*tipoAssinanteNfcom  
** Tipo: Int 5
** Tipo: Int 5
** Passar 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)


*municipioPrestacao
*municipioPrestacao
** Passar P (Prestador) ou T (Tomador)
** Passar P (Prestador) ou T (Tomador)
*tipoEnteGovernamental
** Passar 0 (Nenhum), 1 (União), 2 (Estado), 3 (Distrito Federal) ou 4 (Município)
}}
}}


Linha 378: Linha 383:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 403: Linha 408:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 731: Linha 736:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 797: Linha 802:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 826: Linha 831:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 1 157: Linha 1 162:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 1 535: Linha 1 540:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 1 630: Linha 1 635:
***** Tipo: String 30
***** Tipo: String 30
****numero
****numero
*****
****complemento
****complemento
*****
****uf
****uf
***** Tipo: String 2
***** Tipo: String 2
Linha 1 686: Linha 1 693:
*****descricao
*****descricao
****usuarioModificacao
****usuarioModificacao
***** .
****enviarCarta
****enviarCarta
****tabelaDePreco
****tabelaDePreco
Linha 1 729: Linha 1 737:
***** Tipo: Date
***** Tipo: Date
****regiaoEntrega
****regiaoEntrega
**** Tipo: String 3
***** Tipo: String 3
****setor
****setor
*****codigo
*****codigo
Linha 1 761: 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 777: Linha 1 785:
*****rg
*****rg
*****orgaoExpedidor
*****orgaoExpedidor
*****ativo
****email
****email
****recebeEmailNfe
****recebeEmailNfe
Linha 1 796: Linha 1 805:
****sobreFontePagadora
****sobreFontePagadora
****cpfProdutorRural
****cpfProdutorRural
****tipoAssinanteNfcom  
****tipoAssinanteNfcom
***** 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)
****municipioPrestacao
***** P (Prestador) ou T (Tomador)
****tipoEnteGovernamental
***** 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 813: Linha 1 828:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">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.</i><br>'''Ao passar um código de uma empresa já cadastrada é possível alterar seus dados.'''</p><br>
         <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">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.</i><br>'''Obs.: Ao passar um código de uma empresa já cadastrada é possível alterar seus dados.'''</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 1 835: Linha 1 850:
}}
}}


<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags XML:</b></p>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags XML:</b></p><br>
{{#tree: |
{{#tree: |
*<cadastroEmpresa>
*<cadastroEmpresa>
Linha 1 972: Linha 1 987:
***** <superior>
***** <superior>
***** <sexo>
***** <sexo>
****** Passar F (Feminino), M (Masculino) ou O (Outros)
***** <tratamento>
***** <tratamento>
***** <sessao>
***** <sessao>
Linha 2 014: Linha 2 030:
***** <orgaoExpedidor>
***** <orgaoExpedidor>
***** <dataExpedicao>
***** <dataExpedicao>
***** <ativo>
****** Passar S (Sim) ou N (Não)
*****   </contatoEmpresa>
*****   </contatoEmpresa>
****        <obsEmpresa>
****        <obsEmpresa>
Linha 2 051: Linha 2 069:
****        <orgaoPublico>
****        <orgaoPublico>
****        <tipoAssinanteNfcom>
****        <tipoAssinanteNfcom>
*****        Passar 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)
****        <municipioPrestacao>
****        <municipioPrestacao>
*****        Passar P (Prestador) ou T (Tomador)
*****        Passar P (Prestador) ou T (Tomador)
****        <tipoEnteGovernamental>
*****        Passar 0 (Nenhum), 1 (União), 2 (Estado), 3 (Distrito Federal) ou 4 (Município)
***      </empresa>
***      </empresa>
**  </empresas>
**  </empresas>
Linha 2 058: Linha 2 080:
}}
}}


<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags Json:</b></p>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags Json:</b></p><br>
{{#tree:
{{#tree:
*{
*{
Linha 2 195: Linha 2 217:
****** "superior": "",
****** "superior": "",
****** "sexo": "",
****** "sexo": "",
******* Passar F (Feminino), M (Masculino) ou O (Outros)
****** "tratamento": "",
****** "tratamento": "",
****** "sessao": "",
****** "sessao": "",
Linha 2 237: Linha 2 260:
****** "orgaoExpedidor": "",
****** "orgaoExpedidor": "",
****** "dataExpedicao": "",
****** "dataExpedicao": "",
****** "ativo": "",
******* Passar S (Sim) ou N (Não)
*****   }
*****   }
****   ]
****   ]
Linha 2 276: Linha 2 301:
****        "orgaoPublico": "",
****        "orgaoPublico": "",
****        "tipoAssinanteNfcom": "",
****        "tipoAssinanteNfcom": "",
****        "municipioPrestacao": ""
*****        Passar 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)
****        "municipioPrestacao": "",
*****        Passar P (Prestador) ou T (Tomador)
*****        Passar P (Prestador) ou T (Tomador)
****        "tipoEnteGovernamental": ""
*****        Passar 0 (Nenhum), 1 (União), 2 (Estado), 3 (Distrito Federal) ou 4 (Município)
***      }
***      }
**  ]
**  ]
Linha 2 301: Linha 2 330:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 2 364: Linha 2 393:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |


Linha 2 399: Linha 2 428:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 2 432: Linha 2 461:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 2 768: Linha 2 797:
     </tr>
     </tr>
     <tr>
     <tr>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
         <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 2 802: Linha 2 831:
</table></center>
</table></center>


<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<!--<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
     <tr>
     <tr>
         <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarTransportadoras</b></font></td>
         <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarTransportadoras</b></font></td>
Linha 2 812: Linha 2 841:
{{VoltarInicio}}</td>
{{VoltarInicio}}</td>
     </tr>
     </tr>
</table></center>
</table></center>-->

Edição atual tal como às 17h30min de 6 de outubro 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.
Obs.: 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