DOCUMENTAÇÃO

Consulta documentos por sua referência

Chamada: ListarDocPorReferencia

Esta função tem por intuito realizar a consulta pela referência dos documentos cadastrados.

Existe uma limitação de quantidade de consultas permitidas por hora. Ao ultrapassar esta quantidade, o webservices retorna o erro 192 – Número de consultar por hora excedido.

Formato de entrada: 

<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <sessao>XXXX</sessao> 
    <documentos>
            <referencia>XXXX</referencia>
            <referencia>YYYY</referencia>
            <referencia>ZZZZ</referencia>
    </documentos>
</documentoeletronico>
Parâmetro Formato Obrigatório Descrição
sessao Texto S Chave de acesso cadastrada para sua empresa.
documentos Texto S Node para definição de documentos a serem inseridos.
referencia Texto S Referência de um documento ou uma lista de referências de documentos.

Formato de saída: 

<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <CodErro />
    <MsgErro />
        <documentos>
        <documento docto_referencia="" docto_status="" docto_validade="" />
        <documento docto_referencia="" docto_status="" docto_validade="" />
        </documentos>
</documentoeletronico>
Parâmetro Formato Descrição
CodErro Numérico Código de erro (ver Códigos de Erros).
MsgErro Texto Mensagem de Erro
docto_referencia Texto Referência do documento.
docto_status Texto Status do documento. Valores possíveis:
  • A - Vigente/Ativo;
  • B - Bloqueado;
  • C - Cancelado;
  • D - Em Definição de Papéis;
  • E - Erro no encerramento de uma parte
      • Pode ocorrer em duas situações:
      1-Uma parte ficou sem representante para efetuar assinatura. Exemplo: foi definido que um representante assina por duas partes diferentes com mesmo CNPJ. No momento que o representante efetuar a assinatura na primeira parte, ele é, automaticamente, removido da segunda parte, ficando essa última parte sem representante. O contrato entrará no status “E”, erro, alertando que uma parte está sem representante
      2-Quantidade de assinaturas insuficientes na parte. Exemplo: Cliente utiliza qtde mínima de assinaturas para encerramento da parte. Foi definido uma quantidade mínima de duas assinaturas para determinado relacionamento, porem no contrato foi incluído somente um representante na parte. No momento que o representante efetuar a assinatura o contrato entrará no status “E” alertando que essa parte não pode ser encerrada devido á quantidade mínima de assinatura solicitada
  • G - Aguardando ativação de outro contrato;
  • P - Pendente de assinatura/ aprovação;
  • R - Recusado;
  • T - Aguardando Carimbo de Tempo;
  • V - Vencido;.
docto_validade Texto Validade do documento.
Voltar para Consulta Relação de Documentos Cancelamento de Documento