Skip to main content

Koncili General Flow

This page provides detailed information regarding the general workflow within the Koncili API.

This workflow defines the standard behavior expected from an application integrating with the Koncili API. The core objective of this integration is to support the financial reconciliation process for orders placed across various marketplaces. The integrator is responsible for:

  1. Order Submission: Orders must be sent to the Koncili API. Based on this data, the system identifies reconcilable orders by cross-referencing the provided information with the disbursement entries made available later.

  2. Reconciliation Creation: Provide the necessary data to initiate the reconciliation process within the system.

  3. Entry Submission: Send the financial releases (disbursements/statements) related to each order.

  4. Reconciliation Results: Koncili processes the reconciliation and notifies the integrator once the process is complete.

Information

Reconciliation Workflow Description​

Participants:​

  • Integrator: Your system, responsible for sending orders and financial entries.
  • API: Secure interface for communication with the reconciliation system.
  • Koncili: The processing core that executes the financial reconciliation.

Main Flow:​

  1. Initial Account Query
  • The integrator queries available accounts (GET /my-accounts) for prior validation.
  1. Order Submission
  • The Integrator sends orders to the API.
  • Successful Flow:
    • API forwards to Koncili → Koncili confirms receipt → API returns 200 Ok.
  • Error Scenario:
    • API returns 4xx/5xx in case of failure (invalid data, authentication failure, account block, etc.).
  1. Reconciliation Creation
  • Following a successful order submission:
    • Integrator sends complementary data to create the reconciliation.
  • Successful Flow:
    • API → Koncili → Confirmation → 201 Created.
    • Error Scenario: Returns 4xx/5xx.

Constraint: Entries cannot be submitted without an active reconciliation.

  1. Entry Submission * Integrator sends financial entries associated with the orders.
  • Successful Flow:
    • API → Koncili → Confirmation → 200 OK
  • Error Scenario:
    • Returns 4xx/5xx
    • Impact: The reconciliation cannot be finalized.

Constraint: It is not possible to send entries to a closed reconciliation.

  1. Processing and Notification * Upon receipt of all entries:
  • Koncili executes the reconciliation automatically. Once finished, it notifies the integrator via the registered notification URL (for more information on notifications, visit: Notifications).