Reconciliation Workflow
This page provides detailed information regarding the reconciliation workflows within the Koncili API.
Reconciliation Creation
- New Reconciliation: Submitted by the integrator.
- Koncili API: Validates, processes, and forwards the data.
- Koncili: Stores the information and prepares the environment for the submission of financial entries.
The request sent via POST /reconciliation undergoes several validation stages before being accepted:
-
Channel Validation (account): The account specified in the payload must be enabled for API imports. Otherwise, the request will be rejected.
-
Reconciliation Period Validation: The
periodInitDatefield must be chronologically earlier than theperiodEndDate. -
Period Conflict Validation: - The system verifies if there is already an active reconciliation for the specified channel.
- The system checks if the newly submitted period conflicts with any previously registered period, whether through total or partial overlap.
Entry Submission
The request sent via POST /reconciliation/release undergoes several validation stages before being accepted:
-
Channel Validation (account): The account specified in the payload must be enabled for API imports. Otherwise, the request will be rejected.
-
Release Type Validation: The
releaseTypefield must be set toIN_CASHfor order-related entries. -
Entry Validation: The accepted entry types are:
COMISSION,SHIP,RETURN_COMISSION,RETURN_SHIP, andSALE. Additionally, the mathematical signs (positive/negative) of each entry's value are validated. -
Entry Conflict Validation: The entries must not already exist in the system. If a duplicate entry is detected, the request will return an error.
The reconciliation process is asynchronous. After the entries are submitted, Koncili processes the data and notifies the integrator once the reconciliation is complete. This notification is sent via the registered URL (for more information on notifications, visit: Async Notifications).