Cadastrar
Método que tem por finalidade cadastrar a base de Empresa/Pessoas conforme os parâmetros e tipos indicados abaixo:
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P, por padrão, será cadastrado como P na tabela de integração
- codigoEmpresa
- Tipo: String 6
- Campo onde será inserido o código da empresa. Caso não for informado, o código será o próximo disponível para a sua ‘Divisão’.
- nomeCompleto
- Obrigatório, Tipo: String 60
- Existe uma verificação de caracteres inválidos: *, "?", "´", ":", "&", "|", "(", ")", "[", "]", "{", "}", ",", "%"
- contato
- fone
- faxFone
- endereco
- bairro
- municipio
- uf
- Cep
- cnpjCpf
- inscrito
- inscricao
- Obrigatório, Tipo: String 20
- Se o parâmetro "inscrito" for "false", o parâmetro "inscricao" deve ser “ISENTO”.
- conceito
- codigoDivisao
- dtNascimento
- codigoIndicacao
- codigoRepresentante
- percentualComissaoBaixa
- contabilCliente
- codigoResponsavel
- fantasia
- Obrigatório, Tipo: String 20
- pessoa
- codigoContabilFornecedor
- codigoCondicaoPagamento
- codigoTipoPagamento
- codigoTipoOperacao
- irrfAcumulado
- tipoEmpresa
- atividade
- funcionarios
- faturamento
- limiteCredito
- codigoMercado
- enviarCarta
- tabelaPrecos
- agendaInterna
- codigoPais
- codigoCentralizadora
- atrasoMedio
- numero
- complemento
- inscricaoMunicipal
- suframa
- tipoFrete
- percentualIndenizacao
- percDescontoSugestaoItens
- percentualDesconto2
- jurosPadrao
- codigoUnidadeNegocio
- Obrigatório, Tipo: String 3
- codigoPortadorPadrao
- ativo
- codigoContabilAdiantamentoCli
- codigoContabilAdiantamentoForn
- codigoCentroArmazenagem
- codigoIndiceCredito
- codigoRegiaoEntrega
- dtValidadeCredito
- codigoSetor
- codigoRegimeTriburario
- dtUltimaConsultaCredito
- validadeCobrancaAdmin
- ultimaVenda
- 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
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.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P, por padrão, será cadastrado como P na tabela de integração
- empresasXml
- Obrigatório para requisições SOAP. Tipo: String
- Conteúdo de um arquivo XML com as Empresas, contatos e representantes
- empresasJson
- Obrigatório para requisições REST/JSON. Tipo: String
- Conteúdo de um arquivo JSON com as Empresa, contatos e representantes.
- Distribuição das Tags XML:
- Distribuição das Tags Json:
{"minExpandLevel":6}
- {
- "empresas":[
- {
- "codigo":"",
- "nomeCompleto":"",
- "contato":"",
- "fantasia":"",
- "pessoa":"",
- "fone":"",
- "faxFone":"",
- "endereco":"",
- "bairro":"",
- "municipio":"",
- "numero":"",
- "complemento":"",
- "uf":"",
- "cnpjCpf":"",
- "inscricao":"",
- "tipoInscricaoEstadual":"",
- "conceito":{
- "codigoConceito":"",
- "ordem":"",
- "descricao":"",
- "bloqueiaPedido":"",
- "bloqueiaNfSaida":"",
- "bloqueiaOrdem":"",
- "bloqueiaNfEntrada":"",
- "bloqueiaOrcamento":"",
- "bloqueiaSolicitacao":"",
- "descricao":"",
- "cadastro":"",
- "indicacao":{
- "codigo":"",
- "nomeCompleto":"",
- "nomeCompleto":"",
- "responsavel":{
- "codigo":"",
- "nomeCompleto":"",
- "condicaoPagamento":"",
- "tipoPagamento":"",
- "tipoOperacao":{
- "codigoTipoOperacao":"",
- "descricao":"",
- "codigoNatureza":"",
- "descricaoNatureza":"",
- "descricao":"",
- "descricao":"",
- "descricao":"",
- "enviarCarta":"",
- "tabelaDePreco":{
- "codigo":"",
- "descricao":"",
- "pais":{
- "codigo":"",
- "descricao":"",
- "codigoBacen":"",
- "nomeCompleto":"",
- "suframa":"",
- "tipoFrete":"",
- "ultimaAtualizacao":"",
- "unidadeDeNegocio":{
- "codigo":"",
- "descricao":"",
- "sessao":"",
- "contabilAdiantamentoCliente":"",
- "contabilAdiantamentoFornecedor":"",
- "centroArmazenagem":{
- "codigo":"",
- "descricao":"",
- "usuarioCriacao":"",
- "regiaoEntrega":"",
- "setor":{
- "codigo":"",
- "descricao":"",
- "prefixoCNAE":"",
- "basePrazoDiferenciado":"",
- "possuiRetencaoISS":"",
- "centroArmazeMaterialAlternativo":{
- "codigo":"",
- "descricao":"",
- "tipoImovel":"",
- "listarISS":"",
- "diaVencimento":"",
- "limiteFaturamento":"",
- "grauDeRelacionamento":"",
- "sufixoCNAE":"",
- "toleranciaVencimento":"",
- "nivelDeCredito":"",
- "creditoLiberado":"",
- "cnaeServico":"",
- "contatos":[
- {
- "sequenciaContato":"",
- "pessoaContato":"",
- "email":"",
- "fone":"",
- "recebeEmailNfe":"",
- "recebeEmailCartaCobranca":"",
- "recebeEmailCobranca":"",
- "recebeEmailBoleto":"",
- "recebeEmailNfe":"",
- "recebeEmailCartaCobranca":"",
- "recebeEmailCobranca":"",
- "recebeEmailBoleto":
- }
- ]
- }
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoEmpresa
- Obrigatório, Tipo: String 6
Retornos:
Se sucesso:
{"minExpandLevel":2}
- codigoEmpresa
- nomeCompleto
- contato
- fone
- faxFone
- endereco
- bairro
- municipio
- Uf
- cep
- cnpjCpf
- inscrito
- inscricao
- conceito
- codigoDivisao
- dataNascimento
- ultimoMovimento
- cadastro
- codigoIndicacao
- codigoRepresentante
- percentualComissaoBaixa
- contabilCliente
- codigoResponsavel
- fantasia
- pessoa
- codigoContabilFornecedor
- codigoCondicaoPagamento
- codigoTipoPagamento
- codigoTipoOperacao
- irrfAcumulado
- tipoEmpresa
- atividade
- funcionarios
- faturamento
- limiteCredito
- codigoMercado
- codigoUsuarioModificacao
- enviarCarta
- tabelaPrecos
- agendaInterna
- codigoPais
- codigoCentralizadora
- atrasoMedio
- numero
- complemento
- inscricaoMunicipal
- suframa
- tipoFrete
- percentualIndenizacao
- percDescontoSugestaoItens
- percentualDesconto2
- jurosPadrao
- codigoUnidadeNegocio
- codigoPortadorPadrao
- ativo
- sessao
- codigoContabilAdiantamentoCli
- codigoContabilAdiantamentoForn
- codigoCentroArmazenagem
- codigoIndiceCredito
- codigoUsuarioCriacao
- dataModificacao
- codigoRegiaoEntrega
- dataValidadeCredito
- codigoSetor
- codigoRegimeTriburario
- ultimaConsultaCredito
- validadeCobrancaAdmin
- ultimaVenda
- prefixoCnae
- basePrazoDiferenciado
- possuiRetencaoIss
- centroArmazenagemMaterialAlt
- 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
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- dataInicial
- horaInicial
- dataFinal
- horaFinal
Retornos:
Se sucesso:
{"minExpandLevel":2}
- codigoEmpresa
- nomeCompleto
- contato
- fone
- faxFone
- endereco
- bairro
- municipio
- uf
- cep
- cnpjCpf
- inscricao
- conceito
- codigoDivisao
- dataNascimento
- ultimoMovimento
- cadastro
- codigoIndicacao
- codigoRepresentante
- percentualComissaoBaixa
- contabilCliente
- codigoResponsavel
- fantasia
- pessoa
- codigoContabilFornecedor
- codigoCondicaoPagamento
- codigoTipoPagamento
- codigoTipoOperacao
- inscrito
- irrfAcumulado
- tipoEmpresa
- atividade
- funcionarios
- faturamento
- limiteCredito
- codigoMercado
- codigoUsuarioModificacao
- enviarCarta
- tabelaPrecos
- agendaInterna
- codigoPais
- codigoCentralizadora
- atrasoMedio
- numero
- complemento
- inscricaoMunicipal
- suframa
- tipoFrete
- percentualIndenizacao
- percDescontoSugestaoItens
- percentualDesconto2
- jurosPadrao
- codigoUnidadeNegocio
- portadorPadrao
- ativo
- sessao
- codigoContabilAdiantamentoCli
- codigoContabilAdiantamentoForn
- codigoCentroArmazenagem
- codigoIndiceCredito
- codigoUsuarioCriacao
- dataModificacao
- codigoRegiaoEntrega
- validadeCredito
- codigoSetor
- codigoRegimeTriburario
- ultimaConsultaCredito
- validadeCobrancaAdmin
- ultimaVenda
- prefixoCnae
- basePrazoDiferenciado
- possuiRetencaoIss
- codigoCentroArmazenagemMatAlte
- filtroDataDirf
- tipoImovel
- listarIss
- diaVencimento
- limiteFaturamento
- grauRelacionamento
- sufixoCnae
- toleranciaVencimento
- nivelCredito
- listarDirf
- conveniada
- creditoLiberado
- percentualFrete
- ean
- percentualAcrescimoLimite
- percentualAcrescimoPreco
- utilizaPrazoDiferenciado
- tgPadraoNfs
- limiteCreditoMensal
- optanteSimples
- Usrempr1
- Usrempr2
- cnaeServico
- Usrempr4
- valorFrete
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- acao
- Tipo: String 1
- C=Cadastrar, E=Excluir
- Se for informado algo diferente de C ou E não será aplicado nenhum filtro
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
Retornos:
Se sucesso:
{"minExpandLevel":2}
- idRegistro
- acao
- statusRegistro
- dataRequisicao
- horaRequisicao
- idCorrelato
- codigoEmpresa
- nomeCompleto
- cnpjCpf
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- id
- liberarCorrelatos
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- cnpjCpf
- listarEndereco*
- Obrigatório, Tipo: Bool 1
Retornos:
Se sucesso:
{"minExpandLevel":2}
- codigoEmpresa
- nomeCompleto
- fantasia
- endereco
- bairro
- municipio
- uf
- cep
- numero
- complemento
- codigoPais
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
ListarEmpresasPorRepresentante
ListarRepresentantesPorEmpresa
ListarEmpresasPorCentralizadora
Excluir
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoEmpresa
- Obrigatório, Tipo: String 6
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.