|
|
| Linha 2 029: |
Linha 2 029: |
| <b>Retornos:</b><br/> | | <b>Retornos:</b><br/> |
| Se sucesso:<br/> | | Se sucesso:<br/> |
| {{#tree: minExpandLevel=2 | | | {{#tree: minExpandLevel=6 | |
| *cadastroEmpresa
| | *cadastroEmpresa |
| **empresas
| | **empresas |
| ***empresa
| | ***empresa |
| ****codigo
| | ****codigo |
| ***** Tipo: String 6
| | ***** Tipo: String 6 |
| ****nomeCompleto
| | ****nomeCompleto |
| ***** Tipo: String 60
| | ***** Tipo: String 60 |
| ****contato
| | ****contato |
| ***** Tipo: String 30
| | ***** Tipo: String 30 |
| ****fantasia
| | ****fantasia |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****pessoa
| | ****pessoa |
| ***** Tipo: Bool
| | ***** Tipo: Bool |
| ****fone
| | ****fone |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****faxFone
| | ****faxFone |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****endereco
| | ****endereco |
| ***** Tipo: String 40
| | ***** Tipo: String 40 |
| ****bairro
| | ****bairro |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****municipio
| | ****municipio |
| ***** Tipo: String 30
| | ***** Tipo: String 30 |
| ****numero
| | ****numero |
| ****complemento
| | ****complemento |
| ****uf
| | ****uf |
| ***** Tipo: String 2
| | ***** Tipo: String 2 |
| ****cnpjCpf
| | ****cnpjCpf |
| ***** Tipo: String 14
| | ***** Tipo: String 14 |
| ****inscricao
| | ****inscricao |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****tipoInscricaoEstadual
| | ****tipoInscricaoEstadual |
| ****conceito
| | ****conceito |
| *****codigoConceito
| | *****codigoConceito |
| *****ordem
| | *****ordem |
| *****descricao
| | *****descricao |
| *****bloqueiaPedido
| | *****bloqueiaPedido |
| *****bloqueiaNfSaida
| | *****bloqueiaNfSaida |
| *****bloqueiaOrdem
| | *****bloqueiaOrdem |
| *****bloqueiaNfEntrada
| | *****bloqueiaNfEntrada |
| *****bloqueiaOrcamento
| | *****bloqueiaOrcamento |
| *****bloqueiaSolicitacao
| | *****bloqueiaSolicitacao |
| ****divisao
| | ****divisao |
| *****codigoDivisao
| | *****codigoDivisao |
| *****descricao
| | *****descricao |
| ****aniversario
| | ****aniversario |
| ****cadastro
| | ****cadastro |
| ***** Tipo: Date
| | ***** Tipo: Date |
| ****indicacao
| | ****indicacao |
| *****codigo
| | *****codigo |
| *****nomeCompleto
| | *****nomeCompleto |
| ****representante
| | ****representante |
| *****codigo
| | *****codigo |
| *****nomeCompleto
| | *****nomeCompleto |
| ****contabilCliente
| | ****contabilCliente |
| ***** Tipo: String 8
| | ***** Tipo: String 8 |
| ****responsavel
| | ****responsavel |
| *****codigo
| | *****codigo |
| *****nomeCompleto
| | *****nomeCompleto |
| ****contabilFornecedor
| | ****contabilFornecedor |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****condicaoPagamento
| | ****condicaoPagamento |
| ***** Tipo: String 3
| | ***** Tipo: String 3 |
| ****tipoPagamento
| | ****tipoPagamento |
| ***** Tipo: String 2
| | ***** Tipo: String 2 |
| ****tipoOperacao
| | ****tipoOperacao |
| *****codigoTipoOperacao
| | *****codigoTipoOperacao |
| *****descricao
| | *****descricao |
| *****codigoNatureza
| | *****codigoNatureza |
| *****descricaoNatureza
| | *****descricaoNatureza |
| ****tipoEmpresa
| | ****tipoEmpresa |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****atividade
| | ****atividade |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****mercado
| | ****mercado |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****usuarioModificacao
| | ****usuarioModificacao |
| ****enviarCarta
| | ****enviarCarta |
| ****tabelaDePreco
| | ****tabelaDePreco |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****agendaInterna
| | ****agendaInterna |
| ***** Tipo: String 6
| | ***** Tipo: String 6 |
| ****pais
| | ****pais |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| *****codigoBacen
| | *****codigoBacen |
| ****centralizadora
| | ****centralizadora |
| *****codigo
| | *****codigo |
| *****nomeCompleto
| | *****nomeCompleto |
| ****inscricaoMunicipal
| | ****inscricaoMunicipal |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****suframa
| | ****suframa |
| ***** Tipo: String 20
| | ***** Tipo: String 20 |
| ****tipoFrete
| | ****tipoFrete |
| ***** Tipo: String 1
| | ***** Tipo: String 1 |
| ****ultimaAtualizacao
| | ****ultimaAtualizacao |
| ****unidadeDeNegocio
| | ****unidadeDeNegocio |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****portadorPadrao
| | ****portadorPadrao |
| ***** Tipo: String 3
| | ***** Tipo: String 3 |
| ****ativo
| | ****ativo |
| ***** Tipo: Bool
| | ***** Tipo: Bool |
| ****sessao
| | ****sessao |
| ***** Tipo: Int 8
| | ***** Tipo: Int 8 |
| ****contabilAdiantamentoCliente
| | ****contabilAdiantamentoCliente |
| ***** Tipo: String 8
| | ***** Tipo: String 8 |
| ****contabilAdiantamentoFornecedor
| | ****contabilAdiantamentoFornecedor |
| ***** Tipo: String 8
| | ***** Tipo: String 8 |
| ****centroArmazenagem
| | ****centroArmazenagem |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****indiceCredito
| | ****indiceCredito |
| ***** Tipo: String 5
| | ***** Tipo: String 5 |
| ****usuarioCriacao
| | ****usuarioCriacao |
| ***** Tipo: String 3
| | ***** Tipo: String 3 |
| ****dataModificacao
| | ****dataModificacao |
| ***** Tipo: Date
| | ***** Tipo: Date |
| ****regiaoEntrega
| | ****regiaoEntrega |
| **** Tipo: String 3
| | **** Tipo: String 3 |
| ****setor
| | ****setor |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****regimeTributario
| | ****regimeTributario |
| ***** Tipo: String 2
| | ***** Tipo: String 2 |
| ****prefixoCNAE
| | ****prefixoCNAE |
| ***** Tipo: String 6
| | ***** Tipo: String 6 |
| ****basePrazoDiferenciado
| | ****basePrazoDiferenciado |
| ***** Tipo: String 6
| | ***** Tipo: String 6 |
| ****possuiRetencaoISS
| | ****possuiRetencaoISS |
| ***** Tipo: String 6
| | ***** Tipo: String 6 |
| ****centroArmazeMaterialAlternativo
| | ****centroArmazeMaterialAlternativo |
| *****codigo
| | *****codigo |
| *****descricao
| | *****descricao |
| ****filtroDataDIRF
| | ****filtroDataDIRF |
| ***** Tipo: String 1
| | ***** Tipo: String 1 |
| ****tipoImovel
| | ****tipoImovel |
| ***** Tipo: String 1
| | ***** Tipo: String 1 |
| ****listarISS
| | ****listarISS |
| ***** Tipo: String 1
| | ***** Tipo: String 1 |
| ****diaVencimento
| | ****diaVencimento |
| ***** Tipo: String 2
| | ***** Tipo: String 2 |
| ****limiteFaturamento
| | ****limiteFaturamento |
| ***** Tipo: String 2
| | ***** Tipo: String 2 |
| ****grauDeRelacionamento
| | ****grauDeRelacionamento |
| ***** Tipo: String 2
| | ***** Tipo: String 2 |
| ****sufixoCNAE
| | ****sufixoCNAE |
| ***** Tipo: String 3
| | ***** Tipo: String 3 |
| ****toleranciaVencimento
| | ****toleranciaVencimento |
| ***** Tipo: String 3
| | ***** Tipo: String 3 |
| ****nivelDeCredito
| | ****nivelDeCredito |
| **** Tipo: String 3
| | **** Tipo: String 3 |
| ****creditoLiberado
| | ****creditoLiberado |
| ***** Tipo: Bool
| | ***** Tipo: Bool |
| ****cnaeServico
| | ****cnaeServico |
| ****contatos
| | ****contatos |
| ****contatoEmpresa
| | ****contatoEmpresa |
| *****sequenciaContato
| | *****sequenciaContato |
| *****pessoaContato
| | *****pessoaContato |
| *****email
| | *****email |
| *****fone
| | *****fone |
| *****recebeEmailNfe
| | *****recebeEmailNfe |
| *****recebeEmailCartaCobranca
| | *****recebeEmailCartaCobranca |
| *****recebeEmailCobranca
| | *****recebeEmailCobranca |
| *****recebeEmailBoleto
| | *****recebeEmailBoleto |
| ****email
| | ****email |
| ****recebeEmailNfe
| | ****recebeEmailNfe |
| ****recebeEmailCartaCobranca
| | ****recebeEmailCartaCobranca |
| ****recebeEmailCobranca
| | ****recebeEmailCobranca |
| ****recebeEmailBoleto
| | ****recebeEmailBoleto |
| ****obsEmpresa
| | ****obsEmpresa |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******observacao |
| *****observacaoEmpresa
| | *****observacaoEmpresa |
| ******sequencia
| | ******sequencia |
| ******tipoOBS
| | ******tipoOBS |
| ******observacao
| | ******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/> |
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:
- <cadastroEmpresa>
- <empresas>
- <empresa>
- <codigo>
- <nomeCompleto>
- <contato>
- <fone>
- <faxFone>
- <endereco>
- <bairro>
- <municipio>
- <uf>
- <cep>
- <cnpjCpf>
- <inscrito>
- <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>
- <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>
- <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>
- <recebeEmailCobranca>
- notificacaoBloquetoEmail,
- 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>
- 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>
- </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>
- Distribuição das Tags Json:
- {
- "empresas": [
- {
- "codigo": "",
- "nomeCompleto": "",
- "contato": "",
- "fone": "",
- "faxFone": "",
- "endereco": "",
- "bairro": "",
- "municipio": "",
- "uf": "",
- "cep": "",
- "cnpjCpf": "",
- "inscrito": "",
- "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": "",
- "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": "",
- "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": "",
- "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": ""
- }
- ]
- }
- ]
- }
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoEmpresaInicial
- codigoEmpresaFinal
- nomeInicial
- nomeFinal
- fantasiaInicial
- fantasiaFinal
- pessoa
- codigoDivisaoinicial
- codigoDivisaoFinal
- codigoAtividadeInicial
- codigoAtividadeFinal
- cnpjCpfInicial
- cnpjCpfFinal
- municipioInicial
- municipioFinal
- ativo
- 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.
ListarEmpresasCompleto
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoEmpresaInicial
- codigoEmpresaFinal
- nomeInicial
- nomeFinal
- fantasiaInicial
- fantasiaFinal
- pessoa
- codigoDivisaoinicial
- codigoDivisaoFinal
- codigoAtividadeInicial
- codigoAtividadeFinal
- cnpjCpfInicial
- cnpjCpfFinal
- municipioInicial
- municipioFinal
- ativo
- dataInicial
- horaInicial
- dataFinal
- horaFinal
- suprimirNivelFilhoVazio
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoRepresentante
- Obrigatório, Tipo: String 6
- somenteAtivos
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoEmpresa
- Obrigatório, Tipo: String 6
Retornos:
Se sucesso:
{"minExpandLevel":2}
- codigoRepresentante
- nomeCompleto
- Fantasia
- Contato
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoCentralizadora
Retornos:
Se sucesso:
{"minExpandLevel":2}
- codigoEmpresa
- nomeCompleto
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
{"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.
