IN CadastroObjetoContrato.integrador

De CIGAM WIKI
Revisão de 19h27min de 10 de fevereiro de 2022 por Camila.Oliveira (discussão | contribs) (ListarIndividual)

Voltar

CadastrarObjetoContrato

Cadastra Objeto contrato em uma única requisição. Os dados do Objeto do Contrato deverá 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:


Retorno:
   Se sucesso:
      Exemplo de retorno SOAP:


      Exemplo de retorno REST:


   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.

LiberarPendentes

  • Parâmetros:


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

ListarId

  • Parâmetros:


Retorno:
   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:


Retorno:
   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:


Retorno:
   Se sucesso:

Índice

    • Tipo: String 4
  • contaReajuste
    • Tipo: String 6
  • contaMulta
    • Tipo: String 6
  • contaDesconto
    • Tipo: String 6
  • Tipo
    • Tipo: String 1
  • natureza
    • Tipo: String 1
  • codigoMaterial
    • Tipo: String 20
  • complementoHistorico
    • Tipo: String 60
  • tipoOperacao
    • Tipo: String 5
  • tipoOperacaoReajuste
    • Tipo: String 5
  • tipoDePagamento
    • Tipo: String 2
  • deveGerar
    • Tipo: String 1
  • complementoNota
    • Tipo: String 1
  • incluirItensParcelaNf
    • Tipo: Bool 1
  • usuarioModificacao
    • Tipo: String 3
  • sessao
    • Tipo: Int 8
  • cobranca
    • Tipo: String 1
  • horaAdicional
  • indiceSomenteReajuste
    • Tipo: String 1
  • adiantarretornocobranca
    • Tipo: String 1
  • periodicidadePorItem
    • Tipo: String 1
  • formaDeCobranca
    • Tipo: String 1
  • modalidadeVencimento
    • Tipo: String 1
  • portadorCobranca
    • Tipo: String 3
  • portadorPrevisao
    • Tipo: String 3
  • usuarioCriacao
    • Tipo: String 34
  • dataModificacao
    • Tipo: Date DD/MM/AA
  • Ativo
    • Tipo: Bool
  • usrcotr1
    • Tipo: String 206
  • usrcotr2
    • Tipo: Date DD/MM/AA
  • usrcotr3
    • Tipo: Float 11.2


   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:


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