Fluxo geral do Koncili

Nesta página, você encontrará os detalhes sobre o fluxo geral na API do Koncili.

---

Este fluxo define o comportamento geral esperado de uma aplicação integradora com a API do Koncili. A integração tem como objetivo central apoiar o processo de conciliação financeira de pedidos realizados em marketplaces. O integrador deve:

1. Envio dos pedidos: Os pedidos devem ser enviados à API do Koncili. Com base nesses dados, o sistema poderá identificar os pedidos conciliáveis, cruzando as informações fornecidas com os dados de lançamento(s) disponibilizados posteriormente

2. Criação da conciliação: Forneça os dados necessários para iniciar o processo de conciliação no sistema

3. Envio dos lançamentos: Envie os lançamentos relacionados a cada pedido

4. Resultado da conciliação: O Koncili processa a conciliação e notifica quando a conciliação estiver concluída

Informações

Descrição do fluxo de conciliação

Participantes:

• Integrador: Seu sistema, responsável por enviar pedidos e lançamentos
• API: Interface segura para comunicação com o sistema de conciliação
• Koncili: Núcleo de processamento que executa a conciliação financeira

Fluxo principal:

1. Consulta inicial das contas

• O integrador consulta as contas disponíveis (GET /my-accounts) para validação prévia

2. Envio de pedidos

• O Integrador envia os pedidos para a API
• Fluxo bem-sucedido:
  • API encaminha para Koncili → Koncili confirma recebimento → API retorna 200 Ok
• Cenário de erro:
  • API retorna 4xx/5xx em caso de falha (dados inválidos, autenticação falha, bloqueio, etc.)

3. Criação da conciliação

• Após sucesso no envio dos pedidos:
  • Integrador envia dados complementares para criação da conciliação
• Fluxo bem-sucedido:
  • API → Koncili → Confirmação → 201 Created
  • Cenário de erro: Retorno 4xx/5xx

Bloqueio: Não é possível enviar lançamentos sem conciliação criada

4. Envio de lançamentos

• Integrador envia lançamentos financeiros associados aos pedidos
• Fluxo bem-sucedido:
  • API → Koncili → Confirmação → 200 OK
• Cenário de erro:
  • Retorno 4xx/5xx
  • Impacto: Conciliação não pode ser finalizada

Bloqueio: Não é possível enviar lançamentos para uma conciliação fechada

5. Processamento e notificação

• Após recebimento de todos os lançamentos:
  • Koncili executa a conciliação automaticamente e ao finalizar notifica o integrador, via URL de notificação cadastrada (para mais informações sobre as notificações acesse: Notificações)