Settlements

Settlements are the periodic cycles that move funds from receivable accounts to the customer's MAIN current account, applying fees and taxes.

They are read-only: the API allows querying settlements that have already occurred, but not triggering them. Settlements run automatically according to the customer's configuration (typically once a day per receivable account).

Model

{
  "id": 9001,
  "cycleDate": "2026-05-14",
  "status": "SETTLED",
  "settledAt": "2026-05-14T18:00:00-03:00",
  "currencyCode": "ARS",

  "summary": {
    "receivablesSettled": {
      "count": 547,
      "amount": 4500000.00
    },
    "collectedAmount": 4450000.00,
    "difference": -50000.00,

    "byPaymentMethod": [
      { "method": "CVU",     "amount": 3500000.00, "count": 234 },
      { "method": "CASH",    "amount": 950000.00,  "count": 87  },
      { "method": "CVU_TAX", "amount": 12500.00,   "count": 45  }
    ],

    "fees": [
      { "type": "PROCESSING_FEE",  "amount": 22500.00, "description": "Comisión sobre cobranza" },
      { "type": "TAX_IIBB",        "amount": 270000.00, "description": "Retención IIBB" },
      { "type": "TAX_IVA",         "amount": 12150.00, "description": "IVA sobre comisión" }
    ],

    "netAmount": 4195350.00
  },

  "source": {
    "receivableAccountId": 4242
  },
  "destination": {
    "currentAccountId": 17,
    "accountType": "MAIN"
  },
  "itemsCount": 547,
  "creationDate": "2026-05-14T18:00:00-03:00"
}

Statuses

Status	Meaning
SCHEDULED	Settlement scheduled, not yet executed
PROCESSING	Executing (typically seconds)
SETTLED	Completed successfully
FAILED	Failed during execution. If this happens, contact support with the id.

Summary

Field	Description
receivablesSettled.count	Number of receivables marked as SETTLED in this cycle
receivablesSettled.amount	Sum of the invoiced amount across those receivables
collectedAmount	Sum of the amount actually collected (that entered the receivable account)
difference	collectedAmount - receivablesSettled.amount. Negative = more was invoiced than collected
byPaymentMethod	Breakdown of collected funds by payment method (CVU, CASH, CVU_TAX, etc.)
fees[]	Fees and taxes applied
netAmount	Net amount settled to the destination account (collectedAmount - sum(fees))

Positive or negative differences

Because the system does not automatically link movements to receivables, discrepancies can occur:

• Negative difference (difference < 0): more was invoiced than actually came in. Some receivables remained uncollected but were still marked as SETTLED to close the cycle.
• Positive difference (difference > 0): more money came in than was invoiced (e.g., payment for receivables issued in previous cycles).

Accounting reconciliation is performed by the integrator on the ERP side using the settlement report.

Endpoints

Method	Path	Description
GET	/v1/settlements	List with filters
GET	/v1/settlements/{id}	Detail
GET	/v1/settlements/{id}/items	Detail of settled receivables

Filters

GET /v1/settlements

Parameter	Type	Description
receivableAccountId	int64	Settlements for a specific account
status	enum	SCHEDULED, PROCESSING, SETTLED, FAILED
fromDate, toDate	YYYY-MM-DD	cycleDate range
currentAccountId	int64	Settlements that entered a current account
page, count	int	Pagination

Items of a settlement

GET /v1/settlements/{id}/items lists the receivables that were marked as SETTLED in that cycle, useful for accounting reconciliation:

[
  {
    "id": 88001,
    "settlementId": 9001,
    "receivableId": 99001,
    "receivableLegalNumber": "0001-00012345",
    "receivableType": "INVOICE",
    "clientId": 1042,
    "associateId": 88,
    "grossAmount": 45000.00,
    "fees": [
      { "type": "PROCESSING_FEE", "amount": 225.00 }
    ],
    "netAmount": 44775.00,
    "relatedMovementIds": [88123, 88130]
  },
  ...
]

Standard pagination with page, count.

Webhook

{
  "type": "settlement.completed",
  "data": {
    "settlement": { ... full object ... }
  }
}

The event fires once per settlement, as soon as it transitions to SETTLED. Each receivable individually also fires receivable.settled.

Exports

For monthly accounting reconciliation, use asynchronous reports:

POST /v1/reports/settlements
{
  "fromDate": "2026-05-01",
  "toDate": "2026-05-31",
  "format": "XLSX"
}