IN CadastroObjetoContrato.integrador

Voltar

• Requisição
  • Soap: http://servidor/CadastroObjetoContrato.integrador.asmx
  • Rest/JSon: http://servidor/CadastroObjetoContrato.integrador/metodo
    • Tipo de registro: CTOBJE
      

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:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20
• statusRegistro
  • Tipo: String 1
  • L=Liberado, P=Pendente
  • Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
• ObjetocontratoXml
  • Tipo: String -
  • Conteúdo de um arquivo XML com os Objetos de contratos
  • Obrigatório apenas para requisições SOAP.
• ObjetocontratosJson
  • Tipo: String -
  • Conteúdo de um arquivo JSON com os Objetos de contratos
  • Obrigatório apenas para requisições REST/JSON.

• Distribuição das Tags XML:
  

{"minExpandLevel":2}

• <cadastroObjetosContrato>
  • <objetosContrato>
    • <objetoContrato>
      • <codigoDoObjeto>INTG30</codigoDoObjeto>
      • <descricao>CADASTRADO VIA INTEGRADOR</descricao>
      • <objeto>INTEGRADO</objeto>
      • <valor>10</valor>
      • <indice>UFIR</indice>
      • <modalidade>R</modalidade>
      • <tipo>M</tipo>
      • <natureza>C</natureza>
      • <periodicidade>1</periodicidade>
      • <periodicidadePorItem>S</periodicidadePorItem>
      • <conta>010101</conta>
      • <historico>P01</historico>
      • <deveGerar>F</deveGerar>
      • <tipoDePagamento>05</tipoDePagamento>
      • <tipoOperacao>59916</tipoOperacao>
      • <incluirItensParcelaNf>1</incluirItensParcelaNf>
      • <indiceSomenteReajuste>S</indiceSomenteReajuste>
      • <gerarParcelaAutoFaturam>1</gerarParcelaAutoFaturam>
      • <adiantarretornocobranca>S</adiantarretornocobranca>
      • <complementoNota>4</complementoNota>
      • <complementoHistorico>CFE. @C REF O PERIODO DE @I A @F</complementoHistorico>
      • <modalidadeVencimento>P</modalidadeVencimento>
      • <gravaObservacao>S</gravaObservacao>
      • <diasVencimentoFaturamento>5</diasVencimentoFaturamento>
      • <portadorCobranca>001</portadorCobranca>
      • <portadorPrevisao>010</portadorPrevisao>
    • </objetoContrato>
  • </objetosContrato>
• </cadastroObjetosContrato>

• Distribuição das Tags Json:
  

{"minExpandLevel":2}

• {
  • "objetosContrato": [{
    • "codigoDoObjeto": "INTG30",
    • "descricao": "CADASTRADO VIA INTEGRADOR",
    • "objeto": "INTEGRADO",
    • "valor": "10",
    • "indice": "UFIR",
    • "modalidade": "R",
    • "tipo": "M",
    • "natureza": "C",
    • "periodicidade": "1",
    • "periodicidadePorItem": "S",
    • "conta": "010101",
    • "historico": "P01",
    • "deveGerar": "F",
    • "tipoDePagamento": "05",
    • "tipoOperacao": "59916",
    • "incluirItensParcelaNf": "1",
    • "indiceSomenteReajuste": "S",
    • "gerarParcelaAutoFaturam": "1",
    • "adiantarretornocobranca": "S",
    • "complementoNota": "4",
    • "complementoHistorico": "CFE. @C REF O PERIODO DE @I A @F",
    • "modalidadeVencimento": "P",
    • "gravaObservacao": "S",
    • "diasVencimentoFaturamento": "5",
    • "portadorCobranca": "001",
    • "portadorPrevisao": "010"
  • }]
• }

Retorno:
   Se sucesso:
      Exemplo de retorno SOAP:

{"minExpandLevel":2}

• <retorno>
  • <mensagem>sucesso</mensagem>
    • <detalhes>
      • <registro>
        • <id>1149</id>
      • </registro>
    • </detalhes>
• </retorno>

      Exemplo de retorno REST:

{"minExpandLevel":2}

• {
  • "mensagem": "sucesso",
  • "detalhes": [{
    • "registro": {
      • "id": "1149"
    • }
  • }]
• }

   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:
  

{"minExpandLevel":2}

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

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:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20

Retorno:
   Se sucesso:

{"minExpandLevel":2}

• codigoDoObjeto
  • 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.

ListarIndividual

• Parâmetros:
  

{"minExpandLevel":2}

• pin
  • Obrigatório, Tipo: String 20
• codigoDoObjeto
  • Obrigatório, Tipo: String 12

Retorno:
   Se sucesso:

{"minExpandLevel":2}

• codigoDoObjeto
  • Tipo: String 8
• Descrição
  • Tipo: String 60
• Objeto
  • Tipo: String 3001
• modalidade
  • Tipo: String 1
• periodicidade
  • Tipo: Int 2
• Conta
  • Tipo: String 6
• Histórico
  • Tipo: String 4
• Í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.

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

Retorno:
   Se sucesso:

{"minExpandLevel":2}

• codigoDoObjeto
  • Tipo: String 8
• Descrição
  • Tipo: String 60
• Objeto
  • Tipo: String 3001
• modalidade
  • Tipo: String 1
• periodicidade
  • Tipo: Int 2
• Conta
  • Tipo: String 6
• Histórico
  • Tipo: String 4
• Í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:
  

{"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.

Retorno:
   Se sucesso:

{"minExpandLevel":2}

• idRegistro
  • Tipo: Int 14
• Acao
  • Tipo: String 1
• statusRegistro
  • Tipo: String 1
• dataRequisicao
  • Tipo: Date
• horaRequisicao
  • Tipo: Int 8

   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.