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

De CIGAM WIKI
Linha 543: Linha 543:
***** <tgTipoOS>
***** <tgTipoOS>
***** <funcao>
***** <funcao>
***** <contabilClienteLongoPrazo>
***** <Usrcemp1>
***** <Usrcemp1>
***** <Usrcemp2>
***** <Usrcemp2>
Linha 551: Linha 550:
***** <dataExpedicao>
***** <dataExpedicao>
*****   </contatoEmpresa>
*****   </contatoEmpresa>
****   </contatos>
****        <obsEmpresa>
****        <obsEmpresa>
*****        <obs>
*****        <obs>
Linha 573: Linha 571:
******            <observacao>
******            <observacao>
*****          </obs>
*****          </obs>
****          </obsEmpresa>
****          <permiteSobrescreverBranco>
****          <permiteSobrescreverBranco>
*****        Passar True ou False
*****        Passar True ou False
*****          <b>Importante:</b> Ao optar por "True" os parâmetro não enviados irão atualizar seus respectivos campos com branco.  
*****          <b>Importante:</b> Ao optar por "True" os parâmetro não enviados irão atualizar seus respectivos campos com branco.  
****          <contabilClienteLongoPrazo>
***      </empresa>
***      </empresa>
**  </empresas>
**  </empresas>
Linha 756: Linha 754:
****** "tgTipoOS": "",
****** "tgTipoOS": "",
****** "funcao": "",
****** "funcao": "",
****** "contabilClienteLongoPrazo": "",
****** "Usrcemp1": "",
****** "Usrcemp1": "",
****** "Usrcemp2": "",
****** "Usrcemp2": "",
Linha 790: Linha 787:
*****        Passar True ou False
*****        Passar True ou False
*****          <b>Importante:</b> Ao optar por "True" os parâmetro não enviados irão atualizar seus respectivos campos com branco.  
*****          <b>Importante:</b> Ao optar por "True" os parâmetro não enviados irão atualizar seus respectivos campos com branco.  
****        "contabilClienteLongoPrazo": "",
***      }
***      }
**  ]
**  ]

Edição das 13h38min de 15 de setembro de 2023

Voltar
Integrador > WebServices > IN CadastroEmpresas.integrador

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

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

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

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

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

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

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

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

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

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

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