Respostas do Serviço

Estimated reading: 7 minutes 10 views

Estrutura da Resposta do Serviço

Atributos da Resposta

Atributo	Descrição
`nome_arquivo`	Nome do arquivo no processamento
`datahora`	Data e hora do processamento no WebService
`dataoperacao`	Data do movimento considerada pelo sistema da CRA
`codigo`	Código da mensagem
`ocorrencia`	Descrição da mensagem
`registro`	Linha do registro do arquivo com erro
`total_registros`	Total de registros que foram processados com sucesso

Exemplos de Respostas

Envio de Remessa

Sucesso

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?-->
<relatorio>
    <nome_arquivo>B9901308.121</nome_arquivo>
    <comarca codmun="3550308">
        <datahora>201208131020</datahora>
        <dataoperacao>20120814</dataoperacao>
        <codigo>0000</codigo>
        <ocorrencia>REGISTROS OK</ocorrencia>
        <total_registros>10</total_registros>
    </comarca>
</relatorio>

Exceção (Recusa Parcial)

Como um arquivo de remessa pode conter títulos para várias comarcas, o serviço de upload pode recusar uma remessa parcialmente ou completamente.

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?-->
<relatorio>
    <nome_arquivo>B9901308.121</nome_arquivo>
    <comarca codmun="3550308">
        <datahora>201208131020</datahora>
        <codigo>0000</codigo>
        <ocorrencia>REGISTROS OK</ocorrencia>
        <total_registros>10</total_registros>
    </comarca>
    <comarca codmun="3509502">
        <datahora>201208101020</datahora>
        <dataoperacao>20120814</dataoperacao>
        <registro>10</registro>
        <codigo>1217</codigo>
        <ocorrencia>APRESENTANTE NÃO AUTORIZADO A ENVIAR TÍTULOS PARA O MUNICÍPIO (3509502 - PIRACURUCA)</ocorrencia>
        <total_registros>0</total_registros>
    </comarca>
</relatorio>

Exceção (Recusa Completa)

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?-->
<relatorio>
    <nome_arquivo>B9901008.121</nome_arquivo>
    <comarca codmun="3550308">
        <datahora>201804181559</datahora>
        <total_registros>0</total_registros>
    </comarca>
    <comarca codmun="3509502">
        <datahora>201208101020</datahora>
        <registro>10</registro>
        <codigo>1217</codigo>
        <ocorrencia>Campo 17 TRANSAÇÃO - VALOR DO TITULO DEVE SER NUMERICO</ocorrencia>
        <total_registros>0</total_registros>
    </comarca>
</relatorio>

Erro no Arquivo

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo> B9901008.121</nome_arquivo>
    <codigo>1001</codigo>
    <ocorrencia>ARQUIVO JA TRANSMITIDO</ocorrencia>
</relatorio>

Erro no Código de Barras

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<relatorio>
    <nome_arquivo>BG132205.251</nome_arquivo>
    <comarca CodMun="4300307">
        <datahora>202505221733</datahora>
        <dataoperacao>20250522</dataoperacao>
        <total_registros>0</total_registros>
        <codigo>1309</codigo>
        <ocorrencia>CAMPO 55 TRANSAÇÃO - LINHA DIGITAVEL INVALIDA</ocorrencia>
    </comarca>
</relatorio>

Envio de Imagem

Envio de Remessa com Imagem

Esse modo de mensagem é ativado por parâmetro interno do sistema devido ao impacto no tempo da resposta. A mensagem considera as imagens no registro do primeiro devedor.

<relatorio>
    <nome_arquivo>B9991001.186</nome_arquivo>
    <comarca codmun="2200202">
        <datahora>201901101714</datahora>
        <dataoperacao>20190110</dataoperacao>
        <total_registros>10</total_registros>
        <titulos>
            <titulo>
                <nome_devedor>SR. AARON CORTS</nome_devedor>
                <documento_devedor>28891000141</documento_devedor>
                <saldo>692.91</saldo>
                <numero_titulo>35468930037</numero_titulo>
                <nosso_numero>802150541451059</nosso_numero>
                <imagem>Corrompida</imagem>
            </titulo>
            <titulo>
                <nome_devedor>RICARDO CALDEIRA</nome_devedor>
                <documento_devedor>06572000199</documento_devedor>
                <saldo>60.23</saldo>
                <numero_titulo>33922734313</numero_titulo>
                <nosso_numero>426048244534158</nosso_numero>
                <imagem>Sem imagem</imagem>
            </titulo>
            <titulo>
                <nome_devedor>DR. ZIRALDO PACHECO COLAO FILHO</nome_devedor>
                <documento_devedor>37015000185</documento_devedor>
                <saldo>766.11</saldo>
                <numero_titulo>89975829217</numero_titulo>
                <nosso_numero>741775808168472</nosso_numero>
                <imagem>Gravada</imagem>
            </titulo>
        </titulos>
        <codigo>0000</codigo>
        <ocorrencia>REGISTROS OK</ocorrencia>
    </comarca>
</relatorio>

Envio de Imagem do Título Após Remessa

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<remessas>
    <remessa>
        <sequencial>33</sequencial>
        <titulos>
            <titulo>
                <documento_devedor>39346889187</documento_devedor>
                <nosso_numero>2087753600052</nosso_numero>
                <numero_titulo>1412650</numero_titulo>
                <saldo>2442.86</saldo>
                <mensagem>
                    <codigo>2196</codigo>
                    <descricao>Título não encontrado.</descricao>
                </mensagem>
            </titulo>
        </titulos>
    </remessa>
</remessas>

Desistência/Cancelamento/Autorização

Envio com Sucesso

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?-->
<relatorio>
    <nome_arquivo>DP9901308.121</nome_arquivo>
    <titulo>
        <datahora>201208101020</datahora>
        <numero_cartorio>01</numero_cartorio>
        <numero_titulo>00345468</numero_titulo>
        <numero_protocolo>1234</numero_protocolo>
        <data_protocolo>13082012</data_protocolo>
        <codigo>0000</codigo>
        <ocorrencia> SOLICITAÇÃO RECEBIDA COM SUCESSO </ocorrencia>
    </titulo>
</relatorio>

Envio com Erro

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?-->
<relatorio>
    <nome_arquivo>DP9901008.121</nome_arquivo>
    <titulo>
        <datahora>201208101020</datahora>
        <numero_cartorio>01</numero_cartorio>
        <numero_titulo>003454689</numero_titulo>
        <numero_protocolo>12345</numero_protocolo>
        <data_protocolo>14082012</data_protocolo>
        <codigo>2007</codigo>
        <ocorrencia>DATA DO PROTOCOLO (DDMMAAAA) INVÁLIDA</ocorrencia>
    </titulo>
</relatorio>

Downloads (Confirmação e Retorno)

Download de Confirmação

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?-->
<relatorio>
    <nome_arquivo>C9901308.111</nome_arquivo>
    <datahora>201208131430</datahora>
    <codigo>0002</codigo>
    <ocorrencia>NOME DO ARQUIVO INVÁLIDO</ocorrencia>
</relatorio>

Download de Retorno

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no" ?-->
<relatorio>
    <nome_arquivo>R9901508.121</nome_arquivo>
    <datahora>201208151509</datahora>
    <codigo>0003</codigo>
    <ocorrencia>NÃO HÁ REGISTROS DE RETORNO NESTA DATA</ocorrencia>
</relatorio>

Consulta de Título

Quando o título não for encontrado

<!--?xml version="1.0" encoding="ISO-8859-1" standalone="no"?-->
<consulta>
    <data_consulta>30/09/2016</data_consulta>
</consulta>

Artigos

Lista de mensagens