IN CadastroEmpresas.integrador: mudanças entre as edições
| Linha 340: | Linha 340: | ||
*<b>Distribuição das Tags XML:</b> | *<b>Distribuição das Tags XML:</b> | ||
{{#tree: | {{#tree: | ||
*<cadastroEmpresa> | *<cadastroEmpresa> | ||
**<empresas> | ** <empresas> | ||
***<empresa> | *** <empresa> | ||
****< | **** <codigo> | ||
****<nomeCompleto | **** <nomeCompleto> | ||
****<contato | **** <contato> | ||
****< | **** <fone> | ||
****< | **** <faxFone> | ||
****< | **** <endereco> | ||
****< | **** <bairro> | ||
****< | **** <municipio> | ||
****< | **** <uf> | ||
****< | **** <cep> | ||
****< | **** <cnpjCpf> | ||
****< | **** <inscrito> | ||
****< | ***** 0 - False, 1 - True | ||
****< | **** <inscricao> | ||
****< | ***** Se o parâmetro "inscrito" for "false", o parâmetro "inscrição" deve ser “ISENTO”. | ||
****< | **** <conceito> | ||
****< | **** <divisao> | ||
*****< | **** <dtNascimento> | ||
*****< | **** <indicacao> | ||
*****< | **** <representante> | ||
*****< | **** <percentualComissaoBaixa> | ||
*****< | **** <contabilCliente> | ||
*****< | **** <responsavel> | ||
*****< | **** <fantasia> | ||
*****< | **** <pessoa> | ||
*****< | ***** 0 - Jurídica, 1 - Física | ||
****< | **** <contabilFornecedor> | ||
****< | **** <codigoCondicaoPagamento> | ||
*****< | **** <codigoTipoPagamento> | ||
*****< | **** <codigoTipoOperacao> | ||
****< | **** <irrfAcumulado> | ||
****< | **** <tipoEmpresa> | ||
****< | **** <atividade> | ||
****< | **** <funcionarios> | ||
*****< | **** <faturamento> | ||
*****< | **** <limiteDeCredito> | ||
****< | **** <mercado> | ||
****< | **** <enviarCarta> | ||
*****< | **** <tabelaPrecos> | ||
*****< | **** <agendaInterna> | ||
****< | **** <codigoPais> | ||
****< | **** <centralizadora> | ||
****< | **** <atrasoMedio> | ||
*****< | **** <numero> | ||
*****< | **** <complemento> | ||
****< | **** <inscricaoMunicipal> | ||
****< | **** <suframa> | ||
****< | **** <tipoFrete> | ||
****< | **** <percentualIndenizacao> | ||
****< | **** <percDescontoSugestaoItens> | ||
*****< | **** <percentualDesconto2> | ||
*****< | **** <jurosPadrao> | ||
*****< | **** <unidadeDeNegocio> | ||
*****< | **** <codigoPortadorPadrao> | ||
****< | **** <ativo> | ||
****< | ***** Passar True ou False | ||
*****< | **** <codigoContabilAdiantamentoCli> | ||
*****< | **** <codigoContabilAdiantamentoForn> | ||
****< | **** <codigoCentroArmazenagem> | ||
****< | **** <codigoIndiceCredito> | ||
*****< | **** <codigoRegiaoEntrega> | ||
*****< | **** <dtValidadeCredito> | ||
****< | **** <codigoSetor> | ||
****< | **** <codigoRegimeTributario> | ||
**** | **** <dtUltimaConsultaCredito> | ||
**** | **** <validadeCobrancaAdmin> | ||
****< | **** <dtUltimaVenda> | ||
****< | **** <prefixoCnae> | ||
****< | **** <basePrazoDiferenciado> | ||
****< | **** <possuiRetencaoIss> | ||
***** | **** <codigoCentroArmazenagemMatAlte> | ||
*****< | **** <filtroDataDirf> | ||
****< | **** <tipoImovel> | ||
****< | **** <listarIss> | ||
**** | **** <diaVencimento> | ||
*****< | **** <limiteFaturamento> | ||
*****< | **** <grauRelacionamento> | ||
*****< | **** <sufixoCnae> | ||
****< | **** <toleranciaVencimento> | ||
****< | **** <nivelCredito> | ||
*****< | **** <listarDirf> | ||
*****< | **** <conveniada> | ||
****< | **** <creditoLiberado> | ||
****< | **** <percentualFrete> | ||
****< | **** <codigoEan> | ||
****< | **** <percentualAcrescimoLimite> | ||
****< | **** <percentualAcrescimoPreco> | ||
****< | **** <utilizaPrazoDiferenciado> | ||
*****< | **** <tgPadraoNfs> | ||
*****< | **** <limiteCreditoMensal> | ||
****< | **** <optanteSimples> | ||
****< | **** <Usrempr1> | ||
****< | **** <Usrempr2> | ||
****< | **** <cnaeServico> | ||
****< | **** <Usrempr4> | ||
****< | **** <valorFrete> | ||
*****< | **** <recebeEmailNfe> | ||
*****< | ***** opcoesAuxiliares, | ||
****< | ***** posicao 1 | ||
****< | **** <recebeEmailCartaCobranca> | ||
****<usuarioCriacao | **** <recebeEmailCobranca> | ||
****< | ***** notificacaoBloquetoEmail, | ||
****<setor> | ***** posicao 1 | ||
*****< | **** <recebeEmailBoleto> | ||
*****< | ***** notificacaoBloquetoEmail, | ||
****< | ***** posicao 2 | ||
****< | **** <contatos> | ||
****< | ***** <contatoEmpresa> | ||
****< | ***** <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> | ||
***</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: | {{#tree: | ||
*{ | *{ | ||
**"empresas":[ | ** "empresas": [ | ||
***{ | *** { | ||
****"codigo":"", | **** "codigo": "", | ||
****"nomeCompleto":"", | **** "nomeCompleto": "", | ||
****"contato":"", | **** "contato": "", | ||
****" | **** "fone": "", | ||
****" | **** "faxFone": "", | ||
****" | **** "endereco": "", | ||
****" | **** "bairro": "", | ||
****" | **** "municipio": "", | ||
****" | **** "uf": "", | ||
****" | **** "cep": "", | ||
****" | **** "cnpjCpf": "", | ||
****" | **** "inscrito": "", | ||
**** | ***** 0 - False, 1 - True | ||
****" | **** "inscricao": "", | ||
****" | ***** Se o parâmetro "inscrito" for "false", o parâmetro "inscrição" deve ser “ISENTO”. | ||
****" | **** "conceito": "", | ||
****" | **** "divisao": "", | ||
**** | **** "dtNascimento": "", | ||
**** | **** "indicacao": "", | ||
**** | **** "representante": "", | ||
**** | **** "percentualComissaoBaixa": "", | ||
**** | **** "contabilCliente": "", | ||
**** | **** "responsavel": "", | ||
**** | **** "fantasia": "", | ||
**** | **** "pessoa": "", | ||
*****" | ***** 0 - Jurídica, 1 - Física | ||
**** | **** "contabilFornecedor": "", | ||
****" | **** "codigoCondicaoPagamento": "", | ||
****" | **** "codigoTipoPagamento": "", | ||
**** | **** "codigoTipoOperacao": "", | ||
**** | **** "irrfAcumulado": "", | ||
**** | **** "tipoEmpresa": "", | ||
****" | **** "atividade": "", | ||
**** | **** "funcionarios": "", | ||
**** | **** "faturamento": "", | ||
****" | **** "limiteDeCredito": "", | ||
****" | **** "mercado": "", | ||
****" | **** "enviarCarta": "", | ||
**** | **** "tabelaPrecos": "", | ||
**** | **** "agendaInterna": "", | ||
**** | **** "codigoPais": "", | ||
**** | **** "centralizadora": "", | ||
**** | **** "atrasoMedio": "", | ||
**** | **** "numero": "", | ||
**** | **** "complemento": "", | ||
****" | **** "inscricaoMunicipal": "", | ||
****" | **** "suframa": "", | ||
**** | **** "tipoFrete": "", | ||
**** | **** "percentualIndenizacao": "", | ||
****" | **** "percDescontoSugestaoItens": "", | ||
**** | **** "percentualDesconto2": "", | ||
**** | **** "jurosPadrao": "", | ||
**** | **** "unidadeDeNegocio": "", | ||
**** | **** "codigoPortadorPadrao": "", | ||
****" | **** "ativo": "", | ||
****" | ***** Passar True ou False | ||
****" | **** "codigoContabilAdiantamentoCli": "", | ||
****" | **** "codigoContabilAdiantamentoForn": "", | ||
**** | **** "codigoCentroArmazenagem": "", | ||
**** | **** "codigoIndiceCredito": "", | ||
****" | **** "codigoRegiaoEntrega": "", | ||
****" | **** "dtValidadeCredito": "", | ||
****" | **** "codigoSetor": "", | ||
****" | **** "codigoRegimeTributario": "", | ||
**** | **** "dtUltimaConsultaCredito": "", | ||
**** | **** "validadeCobrancaAdmin": "", | ||
****" | **** "dtUltimaVenda": "", | ||
****" | **** "prefixoCnae": "", | ||
****" | **** "basePrazoDiferenciado": "", | ||
**** | **** "possuiRetencaoIss": "", | ||
**** | **** "codigoCentroArmazenagemMatAlte": "", | ||
****" | **** "filtroDataDirf": "", | ||
****" | **** "tipoImovel": "", | ||
****" | **** "listarIss": "", | ||
****" | **** "diaVencimento": "", | ||
**** | **** "limiteFaturamento": "", | ||
**** | **** "grauRelacionamento": "", | ||
****" | **** "sufixoCnae": "", | ||
****" | **** "toleranciaVencimento": "", | ||
****" | **** "nivelCredito": "", | ||
****" | **** "listarDirf": "", | ||
****" | **** "conveniada": "", | ||
****" | **** "creditoLiberado": "", | ||
****" | **** "percentualFrete": "", | ||
****" | **** "codigoEan": "", | ||
****" | **** "percentualAcrescimoLimite": "", | ||
****" | **** "percentualAcrescimoPreco": "", | ||
****" | **** "utilizaPrazoDiferenciado": "", | ||
**** "tgPadraoNfs": "", | |||
**** | **** "limiteCreditoMensal": "", | ||
**** | **** "optanteSimples": "", | ||
**** | **** "Usrempr1": "", | ||
**** | **** "Usrempr2": "", | ||
**** | **** "cnaeServico": "", | ||
**** | **** "Usrempr4": "", | ||
**** | **** "valorFrete": "", | ||
***** | **** "recebeEmailNfe": "", | ||
**** | ***** opcoesAuxiliares, | ||
****"recebeEmailCartaCobranca":"", | ***** posicao 1 | ||
****"recebeEmailCobranca":"", | **** "recebeEmailCartaCobranca": "", | ||
**** | **** "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
- Requisição
- Soap: http://servidor/CadastroEmpresas.integrador.asmx
- Rest/JSon: http://servidor/CadastroEmpresas.integrador.ashx/metodo
- Tipo de registro: EMPCAD
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.
