IN CadastroEnderecosCobrancaEmpresas.integrador

Voltar
Integrador > WebServices > IN CadastroEnderecosCobrancaEmpresas.integrador

• Requisição
  • Soap: http://servidor/CadastroEnderecosCobrancaEmpresas.integrador.asmx
  • Rest/JSon: http://servidor/CadastroEnderecosCobrancaEmpresas.integrador.ashx/metodo
    • Tipo de registro: EMPCOB

Cadastrar

• Parâmetros:
  

{"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
• idCorrelato
  • Tipo: Int
  • Este parâmetro não é obrigatório, é uma alternativa ao parâmetro "empresa", pois pode
  • estar vinculando a uma empresa que ainda não está cadastrada, e esta pendente de importação.
  • Sempre que o idCorrelato for menor ou igual a zero, o parâmetro “empresa” é obrigatório.
• codigoEmpresa
  • Obrigatório, Tipo: String 6
• codigoCobranca
  • Tipo: String 6
• sugestao
  • Tipo: String 1
• ordem
  • Tipo: String 1
• endereco
  • Tipo: String 50
• municipio
  • Tipo: String 30
• bairro
  • Tipo: String 20
• cep
  • Tipo: Int 8
• uf
  • Tipo: String 2
• pais
  • Tipo: String 3
• complemento
  • Tipo: String 20
• numero
  • 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.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

Voltar ao início

Excluir

• Parâmetros:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20
• codigoEmpresa
  • Obrigatório, Tipo: String 6
• codigoCobranca
  • 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.

Voltar ao início

LiberarPendentes

• Parâmetros:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20
• id
  • Obrigatório, Tipo: Int

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.

Voltar ao início

ListarId

• Parâmetros:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20

Retornos:
   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.

Voltar ao início

ListarIndividual

• Parâmetros:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20
• codigoEmpresa
  • Tipo: String 6
• codigoCobranca
  • Tipo: String 6

Retornos:
   Se sucesso:

{"minExpandLevel":2}

• codigoEmpresa
  • Tipo: String 6
• codigoCobranca
  • Tipo: String 6
• sugestao
  • Tipo: String 1
• ordem
  • Tipo: String 1
• endereco
  • Tipo: String 40
• municipio
  • Tipo: String 30
• bairro
  • Tipo: String 20
• cep
  • Tipo: Int 8
• uf
  • Tipo: String 2
• pais
  • Tipo: String 3
• sessao
  • Tipo: Int 8
• codigoUsuarioModificacao
  • Tipo: String 3
• codigoUsuarioCriacao
  • Tipo: String 3
• dataModificacao
  • Tipo: Date
• numero
  • Tipo: String 6
• complemento
  • Tipo: String 20

   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.

Voltar ao início

ListarModificacoes

• Parâmetros:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20
• dataInicial
  • Tipo: Date
• horaInicial
  • Tipo: Time 6
• dataFinal
  • Tipo: Date
• horaFinal
  • Tipo: Time 6

Retornos:
   Se sucesso:

{"minExpandLevel":2}

• codigoEmpresa
  • Tipo: String 6
• codigoCobranca
  • Tipo: String 6
• sugestao
  • Tipo: String 1
• ordem
  • Tipo: String 1
• endereco
  • Tipo: String 40
• municipio
  • Tipo: String 30
• bairro
  • Tipo: String 20
• cep
  • Tipo: Int 8
• uf
  • Tipo: String 2
• pais
  • Tipo: String 3
• sessao
  • Tipo: Int 8
• codigoUsuarioModificacao
  • Tipo: String 3
• codigoUsuarioCriacao
  • Tipo: String 3
• dataModificacao
  • Tipo: Date
• numero
  • Tipo: String 6
• complemento
  • Tipo: String 20

   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.

Voltar ao início

ListarPendentes

• Parâmetros:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20
• acao
  • Obrigatório, Tipo: String 1
  • C=Cadastrar, E=Excluir
  • Se for informado algo diferente de C ou E não será aplicado nenhum filtro
• statusRegistro
  • Obrigatório, 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
  • Tipo: Int 14
• acao
  • Tipo: String 1
• statusRegistro
  • Tipo: String 1
• dataRequisicao
  • Tipo: Date
• horaRequisicao
  • Tipo: Int 8
• idCorrelato
  • Tipo: Int 14
• codigoEmpresa
  • Tipo: String 6
• codigoCobranca
  • Tipo: String 6

   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.

Voltar ao início