IN CadastroEmpresas.integrador: mudanças entre as edições
Sem resumo de edição |
|||
| Linha 1 956: | Linha 1 956: | ||
==== ListarEmpresasCompleto ==== | ==== ListarEmpresasCompleto ==== | ||
<p align="justify"><i> | |||
</i></p> | |||
*<b>Parâmetros:</b><br> | |||
{{#tree: minExpandLevel=2 | | |||
*pin | |||
** Obrigatório, Tipo: String 20 | |||
*codigoEmpresaInicial | |||
** Tipo: String 6 | |||
*codigoEmpresaFinal | |||
** Tipo: String 6 | |||
*nomeInicial | |||
** Tipo: String 60 | |||
*nomeFinal | |||
** Tipo: String 60 | |||
*fantasiaInicial | |||
** Tipo: String 20 | |||
*fantasiaFinal | |||
** Tipo: String 20 | |||
*pessoa | |||
** Tipo: Bool | |||
*codigoDivisaoinicial | |||
** Tipo: String 2 | |||
*codigoDivisaoFinal | |||
** Tipo: String 2 | |||
*codigoAtividadeInicial | |||
** Tipo: String 3 | |||
*codigoAtividadeFinal | |||
** Tipo: String 3 | |||
*cnpjCpfInicial | |||
** Tipo: String 14 | |||
*cnpjCpfFinal | |||
** Tipo: String 14 | |||
*municipioInicial | |||
** Tipo: String 30 | |||
*municipioFinal | |||
** Tipo: String 30 | |||
*ativo | |||
** Tipo: Bool | |||
*dataInicial | |||
** Tipo: Date | |||
*horaInicial | |||
** Tipo: Time 6 | |||
*dataFinal | |||
** Tipo: Date | |||
*horaFinal | |||
** Tipo: Time 6 | |||
*suprimirNivelFilhoVazio | |||
}} | |||
<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/> | |||
Se sucesso:<br/> | |||
{{#tree: minExpandLevel=2 | | |||
*cadastroEmpresa | |||
**empresas | |||
***empresa | |||
****codigo | |||
***** Tipo: String 6 | |||
****nomeCompleto | |||
***** Tipo: String 60 | |||
****contato | |||
***** Tipo: String 30 | |||
****fantasia | |||
***** Tipo: String 20 | |||
****pessoa | |||
***** Tipo: Bool | |||
****fone | |||
***** Tipo: String 20 | |||
****faxFone | |||
***** Tipo: String 20 | |||
****endereco | |||
***** Tipo: String 40 | |||
****bairro | |||
***** Tipo: String 20 | |||
****municipio | |||
***** Tipo: String 30 | |||
****numero | |||
****complemento | |||
****uf | |||
***** Tipo: String 2 | |||
****cnpjCpf | |||
***** Tipo: String 14 | |||
****inscricao | |||
***** Tipo: String 20 | |||
****tipoInscricaoEstadual | |||
****conceito | |||
*****codigoConceito | |||
*****ordem | |||
*****descricao | |||
*****bloqueiaPedido | |||
*****bloqueiaNfSaida | |||
*****bloqueiaOrdem | |||
*****bloqueiaNfEntrada | |||
*****bloqueiaOrcamento | |||
*****bloqueiaSolicitacao | |||
****divisao | |||
*****codigoDivisao | |||
*****descricao | |||
****aniversario | |||
****cadastro | |||
***** Tipo: Date | |||
****indicacao | |||
*****codigo | |||
*****nomeCompleto | |||
****representante | |||
*****codigo | |||
*****nomeCompleto | |||
****contabilCliente | |||
***** Tipo: String 8 | |||
****responsavel | |||
*****codigo | |||
*****nomeCompleto | |||
****contabilFornecedor | |||
***** Tipo: String 20 | |||
****condicaoPagamento | |||
***** Tipo: String 3 | |||
****tipoPagamento | |||
***** Tipo: String 2 | |||
****tipoOperacao | |||
*****codigoTipoOperacao | |||
*****descricao | |||
*****codigoNatureza | |||
*****descricaoNatureza | |||
****tipoEmpresa | |||
*****codigo | |||
*****descricao | |||
****atividade | |||
*****codigo | |||
*****descricao | |||
****mercado | |||
*****codigo | |||
*****descricao | |||
****usuarioModificacao | |||
****enviarCarta | |||
****tabelaDePreco | |||
*****codigo | |||
*****descricao | |||
****agendaInterna | |||
***** Tipo: String 6 | |||
****pais | |||
*****codigo | |||
*****descricao | |||
*****codigoBacen | |||
****centralizadora | |||
*****codigo | |||
*****nomeCompleto | |||
****inscricaoMunicipal | |||
***** Tipo: String 20 | |||
****suframa | |||
***** Tipo: String 20 | |||
****tipoFrete | |||
***** Tipo: String 1 | |||
****ultimaAtualizacao | |||
****unidadeDeNegocio | |||
*****codigo | |||
*****descricao | |||
****portadorPadrao | |||
***** Tipo: String 3 | |||
****ativo | |||
***** Tipo: Bool | |||
****sessao | |||
***** Tipo: Int 8 | |||
****contabilAdiantamentoCliente | |||
***** Tipo: String 8 | |||
****contabilAdiantamentoFornecedor | |||
***** Tipo: String 8 | |||
****centroArmazenagem | |||
*****codigo | |||
*****descricao | |||
****indiceCredito | |||
***** Tipo: String 5 | |||
****usuarioCriacao | |||
***** Tipo: String 3 | |||
****dataModificacao | |||
***** Tipo: Date | |||
****regiaoEntrega | |||
**** Tipo: String 3 | |||
****setor | |||
*****codigo | |||
*****descricao | |||
****regimeTributario | |||
***** Tipo: String 2 | |||
****prefixoCNAE | |||
***** Tipo: String 6 | |||
****basePrazoDiferenciado | |||
***** Tipo: String 6 | |||
****possuiRetencaoISS | |||
***** Tipo: String 6 | |||
****centroArmazeMaterialAlternativo | |||
*****codigo | |||
*****descricao | |||
****filtroDataDIRF | |||
***** Tipo: String 1 | |||
****tipoImovel | |||
***** Tipo: String 1 | |||
****listarISS | |||
***** Tipo: String 1 | |||
****diaVencimento | |||
***** Tipo: String 2 | |||
****limiteFaturamento | |||
***** Tipo: String 2 | |||
****grauDeRelacionamento | |||
***** Tipo: String 2 | |||
****sufixoCNAE | |||
***** Tipo: String 3 | |||
****toleranciaVencimento | |||
***** Tipo: String 3 | |||
****nivelDeCredito | |||
**** Tipo: String 3 | |||
****creditoLiberado | |||
***** Tipo: Bool | |||
****cnaeServico | |||
****contatos | |||
****contatoEmpresa | |||
*****sequenciaContato | |||
*****pessoaContato | |||
*****email | |||
*****fone | |||
*****recebeEmailNfe | |||
*****recebeEmailCartaCobranca | |||
*****recebeEmailCobranca | |||
*****recebeEmailBoleto | |||
****email | |||
****recebeEmailNfe | |||
****recebeEmailCartaCobranca | |||
****recebeEmailCobranca | |||
****recebeEmailBoleto | |||
****obsEmpresa | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
*****observacaoEmpresa | |||
******sequencia | |||
******tipoOBS | |||
******observacao | |||
}} | |||
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/> | |||
Se pin inválido:<br/> | |||
O usuário não possui direitos suficientes para executar esta rotina.<br/> | |||
<br/> | |||
Se nenhum registro encontrado:<br/> | |||
A consulta não retornou nenhum registro.<br/></p> | |||
==== ListarEmpresasPorRepresentante ==== | ==== ListarEmpresasPorRepresentante ==== | ||
Edição das 13h41min de 16 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.
ListarEmpresasCompleto
- Parâmetros:
Retornos:
Se sucesso:
**empresas
***empresa
****codigo
***** Tipo: String 6
****nomeCompleto
***** Tipo: String 60
****contato
***** Tipo: String 30
****fantasia
***** Tipo: String 20
****pessoa
***** Tipo: Bool
****fone
***** Tipo: String 20
****faxFone
***** Tipo: String 20
****endereco
***** Tipo: String 40
****bairro
***** Tipo: String 20
****municipio
***** Tipo: String 30
****numero
****complemento
****uf
***** Tipo: String 2
****cnpjCpf
***** Tipo: String 14
****inscricao
***** Tipo: String 20
****tipoInscricaoEstadual
****conceito
*****codigoConceito
*****ordem
*****descricao
*****bloqueiaPedido
*****bloqueiaNfSaida
*****bloqueiaOrdem
*****bloqueiaNfEntrada
*****bloqueiaOrcamento
*****bloqueiaSolicitacao
****divisao
*****codigoDivisao
*****descricao
****aniversario
****cadastro
***** Tipo: Date
****indicacao
*****codigo
*****nomeCompleto
****representante
*****codigo
*****nomeCompleto
****contabilCliente
***** Tipo: String 8
****responsavel
*****codigo
*****nomeCompleto
****contabilFornecedor
***** Tipo: String 20
****condicaoPagamento
***** Tipo: String 3
****tipoPagamento
***** Tipo: String 2
****tipoOperacao
*****codigoTipoOperacao
*****descricao
*****codigoNatureza
*****descricaoNatureza
****tipoEmpresa
*****codigo
*****descricao
****atividade
*****codigo
*****descricao
****mercado
*****codigo
*****descricao
****usuarioModificacao
****enviarCarta
****tabelaDePreco
*****codigo
*****descricao
****agendaInterna
***** Tipo: String 6
****pais
*****codigo
*****descricao
*****codigoBacen
****centralizadora
*****codigo
*****nomeCompleto
****inscricaoMunicipal
***** Tipo: String 20
****suframa
***** Tipo: String 20
****tipoFrete
***** Tipo: String 1
****ultimaAtualizacao
****unidadeDeNegocio
*****codigo
*****descricao
****portadorPadrao
***** Tipo: String 3
****ativo
***** Tipo: Bool
****sessao
***** Tipo: Int 8
****contabilAdiantamentoCliente
***** Tipo: String 8
****contabilAdiantamentoFornecedor
***** Tipo: String 8
****centroArmazenagem
*****codigo
*****descricao
****indiceCredito
***** Tipo: String 5
****usuarioCriacao
***** Tipo: String 3
****dataModificacao
***** Tipo: Date
****regiaoEntrega
**** Tipo: String 3
****setor
*****codigo
*****descricao
****regimeTributario
***** Tipo: String 2
****prefixoCNAE
***** Tipo: String 6
****basePrazoDiferenciado
***** Tipo: String 6
****possuiRetencaoISS
***** Tipo: String 6
****centroArmazeMaterialAlternativo
*****codigo
*****descricao
****filtroDataDIRF
***** Tipo: String 1
****tipoImovel
***** Tipo: String 1
****listarISS
***** Tipo: String 1
****diaVencimento
***** Tipo: String 2
****limiteFaturamento
***** Tipo: String 2
****grauDeRelacionamento
***** Tipo: String 2
****sufixoCNAE
***** Tipo: String 3
****toleranciaVencimento
***** Tipo: String 3
****nivelDeCredito
**** Tipo: String 3
****creditoLiberado
***** Tipo: Bool
****cnaeServico
****contatos
****contatoEmpresa
*****sequenciaContato
*****pessoaContato
*****email
*****fone
*****recebeEmailNfe
*****recebeEmailCartaCobranca
*****recebeEmailCobranca
*****recebeEmailBoleto
****email
****recebeEmailNfe
****recebeEmailCartaCobranca
****recebeEmailCobranca
****recebeEmailBoleto
****obsEmpresa
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
*****observacaoEmpresa
******sequencia
******tipoOBS
******observacao
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.
ListarTransportadoras
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.
