APIs | Orientações Gerais

Tenha seus serviços integrados com a plataforma CERC de Duplicata.

Este documento descreve os endpoints e recursos disponíveis para realizar operações de tombamento, divididas entre as aplicações Tio Channel e Mapper. O tombamento envolve operações de avaliação e registro de contrato de duplicata.

A partir de agora, as operações de tombamento estão disponibilizadas em Endpoint de Avaliação, Registro, Atualizações e Conciliação pelo CERC.Docs, conforme listado abaixo.

Importante: as APIs permitem o envio de no máximo 1.000 registros por lote, e o retorno das consultas também está limitado a um máximo de 1.000 registros.

---

{baseURL}}

Homologação: https://api.int.cerc.com/

Produção: https://api.prd.cerc.com/

Avaliação de Duplicatas

1. APIs de Avaliação

1.1. Avaliações de Duplicatas em Lote

1.1.1. Solicitação de Avaliação de Duplicatas em Lote

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-validacoes

• Descrição: Criar um pedido de avaliação para um lote de duplicatas.

1.1.2. Consulta de Lotes de Avaliações

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-validacoes/{lote_id}

• Descrição: consultar o processamento de um lote de avaliações, detalhando itens enviados, consistidos e não consistidos.

1.1.2.1. Consulta de Avaliações - itens inválidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-validacoes/{lote_id}/itens-invalidos

• Descrição: consultar itens com dados inválidos em um lote de avaliações, incluindo as mensagens de erro geradas durante o processamento.

1.1.2.2. Consulta de Avaliações - itens recebidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-validacoes/{lote_id}/itens-recebidos

• Descrição: consultar todos os itens enviados em uma solicitação de avaliação em lote para um determinado lote.

1.1.2.3. Consulta de Avaliações - arquivo de retorno (download)

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-validacoes/{lote_id}/download

• Descrição: retorna o processamento de um lote de Avaliações em XML ou JSON, incluindo eventos, constatações, partes, recebíveis e documentos fiscais eletrônicos.

1.1.2.4. Consulta de Avaliações - arquivo de retorno (download resumido)

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/transaction-io/tio-mapper/v1/operations/lotes-de-validacoes/{lote_id}/download-resumido

• Descrição: retorna de forma simplificada o processamento de um lote de avaliações em XML ou JSON, incluindo eventos, constatações, partes, recebíveis e documentos fiscais eletrônicos.

1.2. Avaliações por chave de nota em Lote

1.2.1. Solicitação de Avaliação por chave de nota em Lote

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/avaliacoes-em-lote

• Descrição: Enviar avaliações em lote via API com poucos parâmetros necessários.

1.3. Consulta de dados das Avaliações

1.3.1. Busca de Avaliações de Duplicatas Mercantis

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/validacoes/busca-de-validacoes-duplicata-mercantil

• Descrição: consultar o status de avaliações, com lista filtrada pelos parâmetros enviados. Campos indicam se são requisições em lote ou avulsa.

1.3.2. Consulta de dados de Documento Fiscal Eletrônico (DF-e)

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/validacoes/{validacao_id}/documento-fiscal

• Descrição: consultar os dados de um documento fiscal eletrônico coletados por uma avaliação previamente solicitada.

1.3.3. Consulta de dados das partes

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/validacoes/{validacao_id}/partes

• Descrição: consultar dados das Partes do negócio que originou a duplicata, coletados via consulta de CPF/CNPJ da Receita Federal. Os dados são provenientes de uma avaliação solicitada ou de uma solicitação de registro.

1.3.4. Consulta dos Indicadores de Consistência

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/validacoes/{validacao_id}/constatacoes

• Descrição: consulta os indicadores de consistência de uma duplicata, fornecendo resultados dos algoritmos que analisam a coerência do documento fiscal e de seus participantes

1.3.5. Consulta de Eventos da Avaliação

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/validacoes/{validacao_id}/eventos

• Descrição: consultar eventos do processamento de uma avaliação, incluindo erros ocorridos.

Registro de Duplicatas

2. APIs de Registro

2.1. Registro de Operações e Duplicatas em lote

2.1.1. Solicitação de Registros em Lote

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-registros

• Descrição: criar uma solicitação de Registro para um lote de operações e duplicatas.

2.1.2. Consulta de Solicitações de lotes de Registros

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-registros/{loteId}

• Descrição: consultar o processamento de um lote de registros, informando itens enviados.

2.1.3. Consulta de Registros Inválidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-registros/{loteId}/itens-invalidos

• Descrição: consultar itens com dados inválidos em um lote de registros, incluindo as mensagens de erro geradas no processamento.

2.2. Consulta de dados dos Registros

2.2.1. Busca de Registros de Duplicata Mercantil

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/registros/busca-de-registros-duplicata-mercantil

• Descrição: consultar o status de registros "duplicata mercantil", com filtros para solicitações específicas e indicação de registros em lote ou avulsos.

2.2.2. Consulta do Registro

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/registros/{registro_id}

• Descrição: consultar dados do registro, acessível a Prestadores de Serviços e ao Agente de Registro, utilizando o identificador do registro obtido previamente.

2.2.3. Consulta de Eventos do registro

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/registros/{registro_id}/eventos

• Descrição: consultar eventos do processamento de um registro, com descrição vazia para status pendente, processando e aceito.

2.3. Consulta de Recebíveis

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/recebiveis/{recebivel_id}

• Descrição: esta documentação descreve a API para a consulta de dados de duplicatas.

2.4. Consulta de Atualização de Avaliações

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/registros/busca-de-constatacoes-de-validacoes-de-atualizacao

• Descrição: buscar notificações de atualizações de avaliações em registros, permitindo consultar novas análises e constatações geradas por alterações nos dados

3. APIs de Atualização de Registro

3.1. Atualizações de Conclusão de Registros

3.1.1. Solicitação de Atualizações de Conclusão de Registros em Lote

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-conclusoes-de-registro

• Descrição: criar solicitações em lote de atualização de conclusão de registro para registros autorizados.

3.1.2. Consulta de lotes de Atualizações de Conclusão de Registros

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-conclusoes-de-registro/{loteId}

• Descrição: consultar o processamento de um lote de atualizações de conclusão de registros, informando itens enviados, persistidos e não persistidos.

3.1.3. Consulta de Atualizações de Conclusão de Registros Inválidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-conclusoes-de-registro/{loteId}/itens-invalidos

• Descrição: consultar itens inválidos em um lote de atualizações de conclusão de registros, incluindo mensagens de erro geradas no processamento.

3.1.4. Consulta de Atualizações de Conclusão de Registros Recebidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-conclusoes-de-registro/{loteId}/itens-recebidos

• Descrição: identificador do lote de atualizações de conclusão de registros, retornado na solicitação POST ou consultado na busca de registros relacionados.

3.1.5. Busca de Conclusões de Registro

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/operacoes/busca-de-conclusoes-de-registro

• Descrição: consultar o status de solicitações de atualizações de conclusão de registro, com filtros opcionais.

3.2. Atualizações Não Conclusivas de Registros

3.2.1. Solicitação de Atualizações Não Conclusivas de Registros em Lote

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-atualizacoes-nao-conclusivas-de-registro

• Descrição: criar solicitações em lote de atualização não conclusiva de registro.

3.2.2. Consulta de Lotes de Solicitações de Atualizações Não Conclusivas de Registros

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-atualizacoes-nao-conclusivas-de-registro/{loteId}

• Descrição: consultar o processamento de um lote de atualizações não conclusivas de registros.

3.2.3. Consulta de Atualizações Não Conclusivas de Registros Inválidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-atualizacoes-nao-conclusivas-de-registro/{loteId}/itens-invalidos

• Descrição: consultar itens inválidos em um lote de atualizações não conclusivas de registros, incluindo mensagens de erro geradas no processamento.

3.2.4. Consulta de Atualizações Não Conclusivas de Registros Recebidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-atualizacoes-nao-conclusivas-de-registro/{loteId}/itens-recebidos

• Descrição: consultar todos os itens enviados em um lote de atualizações não conclusivas de registros.

3.2.5. Busca de Atualizações Não-Conclusivas

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/operacoes/busca-de-atualizacoes-nao-conclusivas-de-registro

• Descrição: consultar o status de solicitações de atualizações não conclusivas de registro, com filtros opcionais.

3.3. Atualizações Anulativas de Registros

3.3.1. Solicitação de Atualizações Anulativas de Registros em Lote

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/tio-mapper/v1/operations/lotes-de-cancelamentos-de-registro

• Descrição: solicitação de cancelamento de registros através de uma lista pré-estabelecida de motivos.

3.3.2. Consulta de Lotes de Solicitações de Atualizações Anulativas de Registros

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-cancelamentos-de-registro/{loteId}

• Descrição: consultar o processamento de um lote de atualizações de conclusão de registros, detalhando itens enviados.

3.3.3. Consulta de Atualizações Anulativas de Registros Inválidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-cancelamentos-de-registro/{loteId}/itens-invalidos

• Descrição: consultar itens inválidos em um lote de atualizações de conclusão de registros, com mensagens de erro do processamento.

3.3.4. Consulta de Atualizações Anulativas de Registros Recebidos

• Médoto: GET

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/lotes-de-cancelamentos-de-registro/{loteId}/itens-recebidos

• Descrição: consultar todos os itens enviados em um lote de atualizações de conclusão de registros.

3.3.5. Busca de Cancelamentos de Registro

• Médoto: POST

• Endpoint: {{baseURL}}/transaction-io/channel/v1/operations/operacoes/busca-de-cancelamentos-de-registro

• Descrição: consulta de lotes de cancelamentos de registros.

Conciliação

• Médoto: GET

• Endpoint: {{baseURL}}/publisher/electronic-invoice/v1/conciliations

• Descrição: busca conciliações de duplicatas

---

Em caso de erros, acesse:

Dicionário de Erros

A seguir, confira dois vídeos com as jornadas para utilização dos endpoints de registro e de avaliação:

Registro

Avaliação