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

De CIGAM WIKI
Linha 340: Linha 340:


*<b>Distribuição das Tags XML:</b>
*<b>Distribuição das Tags XML:</b>
{{#tree: minExpandLevel=6 |
{{#tree:
 
*<cadastroEmpresa>
*<cadastroEmpresa>
**<empresas>
** <empresas>
***<empresa>
***   <empresa>
****<código/>
****       <codigo>
****<nomeCompleto/>
****       <nomeCompleto>
****<contato />
****       <contato>
****<fantasia/>
****       <fone>
****<pessoa/>
****       <faxFone>
****<fone/>
****       <endereco>
****<faxFone/>
****       <bairro>
****<endereco />
****       <municipio>
****<bairro/>
****       <uf>
****<municipio/>
****       <cep>
****<numero/>
****       <cnpjCpf>
****<complemento />
****       <inscrito>
****<uf/>
*****        0 - False, 1 - True
****<cnpjCpf/>
****        <inscricao>
****<inscricao/>
*****        Se o parâmetro "inscrito" for "false", o parâmetro "inscrição" deve ser “ISENTO”.
****<tipoInscricaoEstadual/>
****        <conceito>
****<conceito>
****       <divisao>
*****<codigoConceito/>
****       <dtNascimento>
*****<ordem/>
****       <indicacao>
*****<descrição/>
****        <representante>
*****<bloqueiaPedido/>
****       <percentualComissaoBaixa>
*****<bloqueiaNfSaida/>
****        <contabilCliente>
*****<bloqueiaOrdem/>
****       <responsavel>
*****<bloqueiaNfEntrada/>
****        <fantasia>
*****<bloqueiaOrcamento/>
****       <pessoa>
*****<bloqueiaSolicitacao/>
*****       0 - Jurídica, 1 - Física
****</conceito>
****        <contabilFornecedor>
****<divisao>
****       <codigoCondicaoPagamento>
*****<codigoDivisao/>
****        <codigoTipoPagamento>
*****<descrição/>
****        <codigoTipoOperacao>
****</divisao>
****        <irrfAcumulado>
****<aniversario/>
****        <tipoEmpresa>
****<cadastro/>
****       <atividade>
****<indicacao>
****        <funcionarios>
*****<codigo />
****       <faturamento>
*****<nomeCompleto/>
****        <limiteDeCredito>
****</indicacao>
****        <mercado>
****<representante>
****       <enviarCarta>
*****<codigo/>
****       <tabelaPrecos>
*****<nomeCompleto/>
****        <agendaInterna>
****</representante>
****       <codigoPais>
****<contabilCliente/>
****        <centralizadora>
****<responsavel>
****       <atrasoMedio>
*****<codigo />
****       <numero>
*****<nomeCompleto/>
****       <complemento>
****</responsavel>
****       <inscricaoMunicipal>
****<contabilFornecedor/>
****       <suframa>
****<condicaoPagamento/>
****        <tipoFrete>
****<tipoPagamento/>
****       <percentualIndenizacao>
****<tipoOperacao>
****        <percDescontoSugestaoItens>
*****<codigoTipoOperacao />
****        <percentualDesconto2>
*****<descricao />
****       <jurosPadrao>
*****<codigoNatureza />
****       <unidadeDeNegocio>
*****<descricaoNatureza />
****        <codigoPortadorPadrao>
****</tipoOperacao>
****       <ativo>
****<tipoEmpresa>
*****       Passar True ou False
*****<codigo />
****        <codigoContabilAdiantamentoCli>
*****<descricao />
****       <codigoContabilAdiantamentoForn>
****</tipoEmpresa>
****       <codigoCentroArmazenagem>
****<atividade>
****       <codigoIndiceCredito>
*****<código/>
****        <codigoRegiaoEntrega>
*****<descricao/>
****       <dtValidadeCredito>
****</atividade>
****        <codigoSetor>
****<mercado>
****       <codigoRegimeTributario>
*****<codigo />
****       <dtUltimaConsultaCredito>
*****<descricao />
****       <validadeCobrancaAdmin>
****</mercado>
****       <dtUltimaVenda>
****<usuarioModificacao />
****       <prefixoCnae>
****<enviarCarta/>
****       <basePrazoDiferenciado>
****<tabelaDePreco>
****        <possuiRetencaoIss>
*****<codigo />
****       <codigoCentroArmazenagemMatAlte>
*****<descricao />
****        <filtroDataDirf>
****</tabelaDePreco>
****       <tipoImovel>
****<agendaInterna />
****        <listarIss>
****<pais>
****       <diaVencimento>
*****<codigo/>
****        <limiteFaturamento>
*****<descricao/>
****       <grauRelacionamento>
*****<codigoBacen/>
****       <sufixoCnae>
****</pais>
****       <toleranciaVencimento>
****<centralizadora>
****       <nivelCredito>
*****<codigo/>
****        <listarDirf>
*****<nomeCompleto/>
****       <conveniada>
****</centralizadora>
****        <creditoLiberado>
****<inscricaoMunicipal />
****       <percentualFrete>
****<suframa />
****       <codigoEan>
****<tipoFrete />
****        <percentualAcrescimoLimite>
****<ultimaAtualizacao/>
****       <percentualAcrescimoPreco>
****<unidadeDeNegocio>
****        <utilizaPrazoDiferenciado>
*****<codigo />
****        <tgPadraoNfs>
*****<descricao />
****       <limiteCreditoMensal>
****</unidadeDeNegocio>
****       <optanteSimples>
****<portadorPadrao />
****       <Usrempr1>
****<sessão/>
****       <Usrempr2>
****<contabilAdiantamentoCliente/>
****       <cnaeServico>
****<contabilAdiantamentoFornecedor/>
****       <Usrempr4>
****<centroArmazenagem>
****       <valorFrete>
*****<código/>
****       <recebeEmailNfe>
*****<descrição/>
***** opcoesAuxiliares,
****</centroArmazenagem>
*****       posicao 1
****<indiceCredito />
****        <recebeEmailCartaCobranca>
****<usuarioCriacao/>
****       <recebeEmailCobranca>
****<regiaoEntrega />
*****     notificacaoBloquetoEmail,
****<setor>
*****     posicao 1
*****<codigo />
****        <recebeEmailBoleto>
*****<descricao />
*****   notificacaoBloquetoEmail,
****</setor>
*****           posicao 2
****<regimeTributario />
****   <contatos>
****<prefixoCNAE />
*****   <contatoEmpresa>
****<basePrazoDiferenciado />
***** <sequenciaContato>
****<possuiRetencaoISS />
***** <pessoaContato>
****<centroArmazeMaterialAlternativo>
***** <email>
*****<codigo />
***** <fone>
*****<descricao />
***** <recebeEmailNfe>
****</centroArmazeMaterialAlternativo>
***** <recebeEmailCartaCobranca>
****<filtroDataDIRF />
***** <recebeEmailCobranca>
****<tipoImovel />
***** <recebeEmailBoleto>
****<listarISS />
***** <fone>
****<diaVencimento/>
***** <homePage>
****<limiteFaturamento/>
***** <observacao>
****<grauDeRelacionamento />
***** <sid>
****<sufixoCNAE />
***** <senha>
****<toleranciaVencimento />
***** <numeroIp>
****<nivelDeCredito />
***** <celular>
****<creditoLiberado/>
***** <ramal>
****<cnaeServico />
***** <foto>
****<contatos>
***** <pessoaFisica>
*****<contatoEmpresa>
***** <superior>
******<sequenciaContato/>
***** <sexo>
******<pessoaContato/>
***** <tratamento>
******<email/>
***** <sessao>
******<fone />
***** <usuarioModificacao>
******<recebeEmailNfe/>
***** <usuarioCriacao>
******<recebeEmailCartaCobranca/>
***** <dataModificacao>
******<recebeEmailCobranca/>
***** <setor>
******<recebeEmailBoleto/>
***** <validadeCredenciamento>
*****</contatoEmpresa>
***** <utilizaTransferPrice>
****</contatos>
***** <contibuinteExclusivoISS>
****<email/>
***** <dataAtualizacao>
****<recebeEmailNfe/>
***** <contaFinanceira>
****<recebeEmailCartaCobranca/>
***** <relacionamento>
****<recebeEmailCobranca/>
***** <controleRemessas>
****<recebeEmailBoleto/>
***** <opcoesAuxiliares>
***</empresa>
****** se informado,
**</empresas>
****** ignora os campos separados
*</cadastroEmpresa>
***** <validacaoContatoItemOs>
***** <recebeEmailPagamentos>
***** <notificacaoBloquetoEmail>
****** se informado,
****** ignora os campos separados
***** <tipoPessoa>
***** <recebeEmailSolicitacao>
***** <diaSemanaInicio>
***** <diaSemanaTermino>
***** <utilizarModalidadePagamento>
***** <recebeEmailAcompanhamento>
***** <participaPesquisaEmail>
***** <notificaVendaContrato>
***** <regraEnvioEmail>
***** <participacaoCotas>
***** <diasDuplicata>
***** <descontoAteVencimento>
***** <posicaoGeografica>
***** <tgTipoOS>
***** <codigoFuncao>
***** <contabilClienteLongoPrazo>
***** <Usrcemp1>
***** <Usrcemp2>
***** <Usrcemp3>
*****   </contatoEmpresa>
****   </contatos>
****        <obsEmpresa>
*****         <obs>
******            <sequencia>
******            <tipoOBS>
*******              01 - NFE,
*******            02 - OC,
*******              03 - NFE e OC,
*******              04 - NFS,
*******              05 - Pedido
*******              06 - NFS e PEDIDO,
*******              07 - OS,
*******              08 - OS/NFS e Pedido,
*******              09 - Geral,
*******              10 - Atividade,
*******              11 - Convênio,
*******              12 - Compl. Item Pedido,
*******              13 - Transportadora,
*******              14 - ANTT Transportadora,
*******              15 - Certidão Negativa de Débitos
******            <observacao>
*****          </obs>
****         </obsEmpresa>
***     </empresa>
**   </empresas>
* </cadastroEmpresa>
}}
}}




*<b>Distribuição das Tags Json:</b>
*<b>Distribuição das Tags Json:</b>
{{#tree: minExpandLevel=6 |
{{#tree:
 
*{
*{
**"empresas":[
** "empresas": [
***{
***     {
****"codigo":"",
****       "codigo": "",
****"nomeCompleto":"",
****       "nomeCompleto": "",
****"contato":"",
****       "contato": "",
****"fantasia":"",
****       "fone": "",
****"pessoa":"",
****       "faxFone": "",
****"fone":"",
****       "endereco": "",
****"faxFone":"",
****       "bairro": "",
****"endereco":"",
****       "municipio": "",
****"bairro":"",
****       "uf": "",
****"municipio":"",
****       "cep": "",
****"numero":"",
****       "cnpjCpf": "",
****"complemento":"",
****       "inscrito": "",
****"uf":"",
*****        0 - False, 1 - True
****"cnpjCpf":"",
****       "inscricao": "",
****"inscricao":"",
*****        Se o parâmetro "inscrito" for "false", o parâmetro "inscrição" deve ser “ISENTO”.
****"tipoInscricaoEstadual":"",
****       "conceito": "",
****"conceito":{
****       "divisao": "",
*****"codigoConceito":"",
****       "dtNascimento": "",
*****"ordem":"",
****       "indicacao": "",
*****"descricao":"",
****       "representante": "",
*****"bloqueiaPedido":"",
****       "percentualComissaoBaixa": "",
*****"bloqueiaNfSaida":"",
****       "contabilCliente": "",
*****"bloqueiaOrdem":"",
****       "responsavel": "",
*****"bloqueiaNfEntrada":"",
****       "fantasia": "",
*****"bloqueiaOrcamento":"",
****       "pessoa": "",
*****"bloqueiaSolicitacao":"",
*****       0 - Jurídica, 1 - Física
*****"descricao":"",
****        "contabilFornecedor": "",
****"cadastro":"",
****       "codigoCondicaoPagamento": "",
****"indicacao":{
****       "codigoTipoPagamento": "",
*****"codigo":"",
****       "codigoTipoOperacao": "",
*****"nomeCompleto":"",
****       "irrfAcumulado": "",
*****"nomeCompleto":"",
****       "tipoEmpresa": "",
****"responsavel":{
****       "atividade": "",
*****"codigo":"",
****       "funcionarios": "",
*****"nomeCompleto":"",
****       "faturamento": "",
****"condicaoPagamento":"",
****       "limiteDeCredito": "",
****"tipoPagamento":"",
****       "mercado": "",
****"tipoOperacao":{
****       "enviarCarta": "",
*****"codigoTipoOperacao":"",
****       "tabelaPrecos": "",
*****"descricao":"",
****       "agendaInterna": "",
*****"codigoNatureza":"",
****       "codigoPais": "",
*****"descricaoNatureza":"",
****       "centralizadora": "",
*****"descricao":"",
****       "atrasoMedio": "",
*****"descricao":"",
****       "numero": "",
*****"descricao":"",
****       "complemento": "",
****"enviarCarta":"",
****       "inscricaoMunicipal": "",
****"tabelaDePreco":{
****       "suframa": "",
*****"codigo":"",
****       "tipoFrete": "",
*****"descricao":"",
****       "percentualIndenizacao": "",
****"pais":{
****       "percDescontoSugestaoItens": "",
*****"codigo":"",
****       "percentualDesconto2": "",
*****"descricao":"",
****       "jurosPadrao": "",
*****"codigoBacen":"",
****       "unidadeDeNegocio": "",
*****"nomeCompleto":"",
****       "codigoPortadorPadrao": "",
****"suframa":"",
****       "ativo": "",
****"tipoFrete":"",
*****        Passar True ou False
****"ultimaAtualizacao":"",
****        "codigoContabilAdiantamentoCli": "",
****"unidadeDeNegocio":{
****       "codigoContabilAdiantamentoForn": "",
*****"codigo":"",
****       "codigoCentroArmazenagem": "",
*****"descricao":"",
****       "codigoIndiceCredito": "",
****"sessao":"",
****       "codigoRegiaoEntrega": "",
****"contabilAdiantamentoCliente":"",
****       "dtValidadeCredito": "",
****"contabilAdiantamentoFornecedor":"",
****       "codigoSetor": "",
****"centroArmazenagem":{
****       "codigoRegimeTributario": "",
*****"codigo":"",
****       "dtUltimaConsultaCredito": "",
*****"descricao":"",
****       "validadeCobrancaAdmin": "",
****"usuarioCriacao":"",
****       "dtUltimaVenda": "",
****"regiaoEntrega":"",
****       "prefixoCnae": "",
****"setor":{
****       "basePrazoDiferenciado": "",
*****"codigo":"",
****       "possuiRetencaoIss": "",
*****"descricao":"",
****       "codigoCentroArmazenagemMatAlte": "",
****"prefixoCNAE":"",
****       "filtroDataDirf": "",
****"basePrazoDiferenciado":"",
****       "tipoImovel": "",
****"possuiRetencaoISS":"",
****       "listarIss": "",
****"centroArmazeMaterialAlternativo":{
****       "diaVencimento": "",
*****"codigo":"",
****       "limiteFaturamento": "",
*****"descricao":"",
****       "grauRelacionamento": "",
****"tipoImovel":"",
****       "sufixoCnae": "",
****"listarISS":"",
****       "toleranciaVencimento": "",
****"diaVencimento":"",
****       "nivelCredito": "",
****"limiteFaturamento":"",
****       "listarDirf": "",
****"grauDeRelacionamento":"",
****       "conveniada": "",
****"sufixoCNAE":"",
****       "creditoLiberado": "",
****"toleranciaVencimento":"",
****       "percentualFrete": "",
****"nivelDeCredito":"",
****       "codigoEan": "",
****"creditoLiberado":"",
****       "percentualAcrescimoLimite": "",
****"cnaeServico":"",
****       "percentualAcrescimoPreco": "",
****"contatos":[
****       "utilizaPrazoDiferenciado": "",
*****{
****       "tgPadraoNfs": "",
******"sequenciaContato":"",
****       "limiteCreditoMensal": "",
******"pessoaContato":"",
****       "optanteSimples": "",
******"email":"",
****       "Usrempr1": "",
******"fone":"",
****       "Usrempr2": "",
******"recebeEmailNfe":"",
****       "cnaeServico": "",
******"recebeEmailCartaCobranca":"",
****       "Usrempr4": "",
******"recebeEmailCobranca":"",
****       "valorFrete": "",
******"recebeEmailBoleto":"",
****       "recebeEmailNfe": "",
****"recebeEmailNfe":"",
*****     opcoesAuxiliares,
****"recebeEmailCartaCobranca":"",
*****        posicao 1
****"recebeEmailCobranca":"",
****       "recebeEmailCartaCobranca": "",
****"recebeEmailBoleto":
****       "recebeEmailCobranca": "",
***}
*****     notificacaoBloquetoEmail,
**]
*****     posicao 1
*}
****        "recebeEmailBoleto": "",
 
*****   notificacaoBloquetoEmail,
*****        posicao 2
****        "contatos": [
*****                  {
****** "sequenciaContato": "",
****** "pessoaContato": "",
****** "email": "",
****** "fone /": "",
****** "recebeEmailNfe": "",
****** "recebeEmailCartaCobranca": "",
****** "recebeEmailCobranca": "",
****** "recebeEmailBoleto": "",
****** "fone": "",
****** "homePage": "",
****** "observacao": "",
****** "sid": "",
****** "senha": "",
****** "numeroIp": "",
****** "celular": "",
****** "ramal": "",
****** "foto": "",
****** "pessoaFisica": "",
****** "superior": "",
****** "sexo": "",
****** "tratamento": "",
****** "sessao": "",
****** "usuarioModificacao": "",
****** "usuarioCriacao": "",
****** "dataModificacao": "",
****** "setor": "",
****** "validadeCredenciamento": "",
****** "utilizaTransferPrice": "",
****** "contibuinteExclusivoISS": "",
****** "dataAtualizacao": "",
****** "contaFinanceira": "",
****** "relacionamento": "",
****** "controleRemessas": "",
****** "opcoesAuxiliares": "",
******* se informado,
******* ignora os campos separados
****** "validacaoContatoItemOs": "",
****** "recebeEmailPagamentos": "",
****** "notificacaoBloquetoEmail": "",
******* se informado,
******* ignora os campos separados
****** "tipoPessoa": "",
****** "recebeEmailSolicitacao": "",
****** "diaSemanaInicio": "",
****** "diaSemanaTermino": "",
****** "utilizarModalidadePagamento": "",
****** "recebeEmailAcompanhamento": "",
****** "participaPesquisaEmail": "",
****** "notificaVendaContrato": "",
****** "regraEnvioEmail": "",
****** "participacaoCotas": "",
****** "diasDuplicata": "",
****** "descontoAteVencimento": "",
****** "posicaoGeografica": "",
****** "tgTipoOS": "",
****** "codigoFuncao": "",
****** "contabilClienteLongoPrazo": "",
****** "Usrcemp1": "",
****** "Usrcemp2": "",
****** "Usrcemp3": "",
*****   }
****   ]
****        "obsEmpresa":[
*****        {
*****            "sequencia":"",
*****            "tipoOBS":"",
******              01 - NFE,
******              02 - OC,
******              03 - NFE e OC,
******              04 - NFS,
******              05 - Pedido
******              06 - NFS e PEDIDO,
******              07 - OS,
******              08 - OS/NFS e Pedido,
******              09 - Geral,
******              10 - Atividade,
******              11 - Convênio,
******              12 - Compl. Item Pedido,
******              13 - Transportadora,
******              14 - ANTT Transportadora,
******              15 - Certidão Negativa de Débitos
*****          "observacao": ""
*****            }
****          ]
***      }
**  ]
*  }
}}
}}
<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/>
<b>Retornos:</b><br/>
<b>Retornos:</b><br/>

Edição das 18h49min de 12 de novembro de 2021

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.

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.

  • 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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.