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

De CIGAM WIKI
Linha 1 818: Linha 1 818:


==== ListarEmpresasPorRepresentante ====
==== ListarEmpresasPorRepresentante ====
<p align="justify"><i>
</i></p>


*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
*codigoRepresentante
** Obrigatório, Tipo: String 6
*somenteAtivos
** Tipo: Bool
}}
<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/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
*codigoEmpresa
** Tipo: String 6
*nomeCompleto
** Tipo: String 60
*fantasia
** Tipo: String 20
*contato
** Tipo: String 30
*cnpjCpf
** Tipo: String 14
*fone
** Tipo: String 20
*faxFone
** Tipo: String 20
*endereco
** Tipo: String 40
*bairro
** Tipo: String 20
*municipio
** Tipo: String 30
*uf
** Tipo: String 2
*cep
** Tipo: Int 8
*inscrito
** Tipo: Bool
*inscricao
** Tipo: String 20
*conceito
** Tipo: String 1
*codigoDivisao
** Tipo: String 2
*descricaoDivisao
** Tipo: String 20
*dataNascimento
** Tipo: Date
*ultimoMovimento
** Tipo: Date
*cadastro
** Tipo: Date
*codigoIndicacao
** Tipo: String 6
*codigoRepresentante
** Tipo: String 6
*nomeCompletoRepresentante
** Tipo: String 60
*percentualComissaoBaixa
** Tipo: Float 3.2
*contabilCliente
** Tipo: String 8
*codigoResponsavel
** Tipo: String 6
*pessoa
** Tipo: Bool
*codigoContabilFornecedor
** Tipo: String 8
*codigoCondicaoPagamento
** Tipo: String 3
*codigoTipoPagamento
** Tipo: String 2
*codigoTipoOperacao
** Tipo: String 5
*irrfAcumulado
** Tipo: Float 13.2
*tipoEmpresa
** Tipo: String 2
*atividade
** Tipo: String 3
*funcionarios
** Tipo: Int 6
*faturamento
** Tipo: Float 13.2
*limiteCredito
** Tipo: Float 13.2
*codigoMercado
** Tipo: String 2
*codigoUsuarioModificacao
** Tipo: String 3
*enviarCarta
** Tipo: String 1
*tabelaPrecos
** Tipo: String 6
*agendaInterna
** Tipo: String 6
*codigoPais
** Tipo: String 3
*codigoCentralizadora
** Tipo: String 6
*atrasoMedio
** Tipo: Int 5
*numero
** Tipo: String 10
*complemento
** Tipo: String 15
*inscricaoMunicipal
** Tipo: String 20
*suframa
** Tipo: String 20
*tipoFrete
** Tipo: String 1
*percentualIndenizacao
** Tipo: Float 3.2
*percDescontoSugestaoItens
** Tipo: Float 3.2
*percentualDesconto2
** Tipo: Float 3.2
*jurosPadrao
** Tipo: Float 3.2
*ultimaAtualizacao
** Tipo: Date
*codigoUnidadeNegocio
** Tipo: String 3
*nomeCompletoUnidadeNegocio
** Tipo: String 60
*codigoPortadorPadrao
** Tipo: String 3
*ativo
** Tipo: Bool
*sessao
** Tipo: Int 8
*codigoContabilAdiantamentoCli
** Tipo: String 8
*codigoContabilAdiantamentoForn
** Tipo: String 8
*codigoCentroArmazenagem
** Tipo: String 4
*codigoIndiceCredito
** Tipo: String 5
*codigoUsuarioCriacao
** Tipo: String 3
*dataModificacao
** Tipo: Date
*codigoRegiaoEntrega
** Tipo: String 3
*dataValidadeCredito
** Tipo: Date
*codigoSetor
** Tipo: String 25
*codigoRegimeTributario
** Tipo: String 2
*ultimaConsultaCredito
** Tipo: Date
*validadeCobrancaAdmin
** Tipo: Date
*ultimaVenda
** Tipo: Date
*prefixoCnae
** Tipo: String 6
*basePrazoDiferenciado
** Tipo: String 6
*possuiRetencaoIss
** Tipo: String 6
*codigoCentroArmazenagemMatAlte
** Tipo: String 6
*filtroDataDirf
** Tipo: String 1
*tipoImovel
** Tipo: String 1
*listarIss
** Tipo: String 1
*diaVencimento
** Tipo: String 2
*limiteFaturamento
** Tipo: String 2
*grauRelacionamento
** Tipo: String 3
*sufixoCnae
** Tipo: String 3
*toleranciaVencimento
** Tipo: String 3
*nivelCredito
** Tipo: String 3
*listarDirf
** Tipo: Bool
*conveniada
** Tipo: Bool
*creditoLibefrado
** Tipo: Bool
*PercentualFrete
** Tipo: Float 3.4
*codigoEan
** Tipo: Float 13.1
*percentualAcrescimoLimite
** Tipo: Float 8.6
*percentualAcrescimoPreco
** Tipo: Float 8.6
*utilizaPrazoDiferenciado
** Tipo: Float 11.2
*tgPadraoNfs
** Tipo: Float 11.2
*limiteCreditoMensal
** Tipo: Float 13.2
*optanteSimples
** Tipo: Float 13.2
*Usrempr1
** Tipo: String 20
*Usrempr2
** Tipo: String 20
*cnaeServico
** Tipo: String 20
*Usrempr4
** Tipo: Date
*valorFrete
** Tipo: Float 1.2
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>


==== ListarRepresentantesPorEmpresa  ====
==== ListarRepresentantesPorEmpresa  ====

Edição das 17h50min 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

ListarEmpresasPorCentralizadora

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.