Andamento em XML

Estimated reading: 6 minutes 46 views

Visão Geral e Parâmetros

O objetivo deste serviço é viabilizar que informações complementares dos títulos (andamento e emolumentos) sejam enviadas para a CRA.

Informação: O serviço de emolumentos continuará funcionando normalmente caso queira continuar usando ele apenas para envio dos emolumentos.

O serviço permitirá o recebimento das duas informações (andamento e custas) ou apenas uma delas.

Parâmetros de Envio

Os dados devem ser enviados via protocolo SOAP.
A autenticação é básica, com usuário e senha fornecidos pela CRA.
Após a autenticação serão validados os parâmetros de entrada e por último a crítica do arquivo.

Serviço Disponível

TituloComplemento: Envio do status do andamento no cartório e emolumentos/custas cartorárias para eventuais consultas para retirada ou cancelamento.

Parâmetros do Serviço

userArq: Nome do arquivo no formato MAAADDMM.AAS.
userDados: Conteúdo do arquivo XML.

Notas Técnicas

O encoding do XML deve estar de acordo com ISO-8859-1.
O conteúdo dos arquivos enviados para CRA devem seguir o padrão de codificação ASCII.

Estrutura e Nomenclatura do Arquivo

Nomenclatura do Arquivo

MCCCDDMM.AAS

M:: Constante – Identifica tratar-se do arquivo de andamento.
CCC:: Código do Apresentante/Portador ou constante 000.
DD:: Dia do envio do arquivo de andamento.
MM:: Mês do envio do arquivo de andamento.
AA:: Ano do envio do arquivo de andamento.
S:: Número Sequencial do arquivo de andamento (mínimo 1, máximo 9).

Estrutura do Arquivo

DADOS DO TÍTULO

ATRIBUTO	DESCRIÇÃO	OBRIGATÓRIO	TAMANHO	TIPO
`CODIGO`	CÓDIGO DO APRESENTANTE	SIM	Variável	ALFANUMÉRICO
`PROTOCOLO`	PROTOCOLO DO CARTÓRIO	SIM	Variável	ALFANUMÉRICO
`DOCUMENTO_DEVEDOR`	DOCUMENTO DO DEVEDOR	SIM	Variável	NUMÉRICO
`DATA_PROTOCOLO`	DATA DO PROTOCOLO	SIM	010	DATA
`NUMERO_TITULO`	NÚMERO DO TÍTULO	SIM	Variável	NUMÉRICO
`NOSSO_NUMERO`	NOSSO NÚMERO INFORMADO NO TITULO	SIM	Variável	NUMÉRICO
`VALOR`	VALOR DO TÍTULO	SIM	Variável	DECIMAL
`SALDO`	SALDO DO TÍTULO	SIM	Variável	DECIMAL

EMOLUMENTOS

ATRIBUTO	DESCRIÇÃO	OBRIGATÓRIO	TAMANHO	TIPO
`TIPO`	TIPO DAS CUSTAS 1 – RETIRADA 2 – CANCELAMENTO	SIM	001	INTEIRO
`TOTAL`	TOTAL DAS CUSTAS PRÉ-CALCULADAS	SIM	Variável	DECIMAL
`VIGENCIA`	VIGÊNCIA DAS CUSTAS	SIM	010	DATA

ANDAMENTO

ATRIBUTO	DESCRIÇÃO	OBRIGATÓRIO	TAMANHO	TIPO
`CODIGO`	Ocorrência AA: Apontado AB: Em intimação – Pessoal AC: Em intimação – Eletrônica AD: Em intimação – AR / Correios AE: Publicacao por Edital AF: Em intimação – Aguardando AR AG: Intimado – Aguardando tríduo AI: Pedido de Retirada – Aguardando tríduo AJ: Protesto do banco cancelado (Exclusivo para apresentante Banco) AK: Pagamento por Boleto – Aguardando compensação	SIM	002	ALFABÉTICO
`DATA`	DATA DO ANDAMENTO (FORMATO d/m/Y H:i:s)	SIM	Variável	ALFANUMÉRICO

Exemplo de XML de Envio

<complementos>
    <apresentantes>
        <apresentante>
            <codigo>111</codigo>
            <titulos>
                <titulo>
                    <protocolo>0000000000</protocolo>
                    <documento_devedor>99999999999</documento_devedor>
                    <data_protocolo>09/12/2016</data_protocolo>
                    <numero_titulo>987987</numero_titulo>
                    <nosso_numero>987987987987987</nosso_numero>
                    <valor>166.31</valor>
                    <emolumentos>
                        <emolumento>
                            <tipo>1</tipo>
                            <vigencia>11/04/2022</vigencia>
                            <total>30.4</total>
                        </emolumento>
                    </emolumentos>
                    <andamentos>
                        <andamento>
                            <codigo>AA</codigo>
                            <data>01/01/2023 20:10:10</data>
                        </andamento>
                        <andamento>
                            <codigo>AB</codigo>
                            <data>01/01/2023 20:10:10</data>
                        </andamento>
                    </andamentos>
                </titulo>
                 <titulo>
                    <protocolo>0000000001</protocolo>
                    <documento_devedor>99999999991</documento_devedor>
                    <data_protocolo>09/12/2016</data_protocolo>
                    <numero_titulo>1239875</numero_titulo>
                    <nosso_numero>987987987847987</nosso_numero>
                    <valor>166.31</valor>
                    <emolumentos>
                        <emolumento>
                            <tipo>1</tipo>
                            <vigencia>11/04/2022</vigencia>
                            <total>12.4</total>
                        </emolumento>
                    </emolumentos>
                    <andamentos>
                        <andamento>
                            <codigo>AI</codigo>
                            <data>01/01/2023 20:10:10</data>
                        </andamento>
                    </andamentos>
                </titulo>
            </titulos>
        </apresentante>
    </apresentantes>
</complementos>

Mensagens de Resposta

Exemplo de Mensagem com Recusa Completa

<relatorio>
  <nome_arquivo>M0002507.231</nome_arquivo>
  <codigo>2292</codigo>
  <ocorrencia>CAMPOS INVÁLIDOS OU NÃO INFORMADOS (APRESENTANTES).</ocorrencia>
</relatorio>

Enviando Somente Andamento

<complementos>
    <apresentantes>
        <apresentante>
            <codigo>111</codigo>
            <titulos>
                <titulo>
                    <protocolo>0000000000</protocolo>
                    <documento_devedor>99999999999</documento_devedor>
                    <mensagens>
                        <andamento>
                            <codigo>2322</codigo>
                            <descricao>Andamento inserido.</descricao>
                        </andamento>
                    </mensagens>
                </titulo>
            </titulos>
        </apresentante>
    </apresentantes>
</complementos>

Enviando Somente Emolumentos

<complementos>
    <apresentantes>
        <apresentante>
            <codigo>111</codigo>
            <titulos>
                <titulo>
                    <protocolo>0000000000</protocolo>
                    <documento_devedor>99999999999</documento_devedor>
                    <mensagens>
                        <emolumento>
                            <codigo>2318</codigo>
                            <descricao>Custas atualizadas.</descricao>
                        </emolumento>
                    </mensagens>
                </titulo>
            </titulos>
        </apresentante>
    </apresentantes>
</complementos>

Enviando Andamento e Emolumento

<complementos>
    <apresentantes>
        <apresentante>
            <codigo>111</codigo>
            <titulos>
                <titulo>
                    <protocolo>0000000000</protocolo>
                    <documento_devedor>99999999999</documento_devedor>
                    <mensagens>
                        <emolumento>
                            <codigo>2318</codigo>
                            <descricao>Custas atualizadas.</descricao>
                        </emolumento>
                        <andamento>
                            <codigo>2322</codigo>
                            <descricao>Andamento inserido.</descricao>
                        </andamento>
                    </mensagens>
                </titulo>
            </titulos>
        </apresentante>
    </apresentantes>
</complementos>

Tabela de Códigos de Mensagem

CÓDIGO	DESCRIÇÃO
2292	CAMPOS INVÁLIDOS OU NÃO INFORMADOS (ATRIBUTO)
2304	FOI ENCONTRADO MAIS DE UM TÍTULO COM OS DADOS INFORMADOS
2137	CAMPO (ATRIBUTO) INVÁLIDO.
2318	CUSTAS ATUALIZADAS
2196	TÍTULO NÃO ENCONTRADO
2322	ANDAMENTO INSERIDO
2334	O ARQUIVO POSSUI REGISTROS EM DUPLICIDADE. CONSULTE O LOG NO SISTEMA PARA MAIS INFORMAÇÕES.
2335	REGISTRO EM DUPLICIDADE

Diferenças de Serviços (Migração)

Para quem já usa o serviço de envio de custas, aqui estão as mudanças para reaproveitar o mesmo serviço:

O Endpoint do serviço deve ser alterado de CustasTitulo para TituloComplemento.
A tag raiz do XML foi alterada de <custas_titulo> para <complementos>.

Agora é possível inserir informações adicionais no XML, como a tag <andamentos>.