Skip to main content
POST
/
api
/
v1
/
account-statements
Account Settlement
curl --request POST \
  --url https://api.example.com/api/v1/account-statements
{
  "processedCount": 123,
  "settledCount": 123,
  "errors": [
    {}
  ],
  "executedAt": "<string>",
  "executedById": "<string>"
}

​
Overview

Executes automated settlement of account statements based on configured rules. This is typically run as a scheduled job but can be triggered manually by admins.

​
Authentication

Requires JWT authentication with ADMIN role only.

​
Request Body

No request body required. Uses system-configured settlement rules.

​
Response

​
processedCount
number
Number of statements processed
​
settledCount
number
Number of statements marked as settled
​
errors
array
List of errors encountered (if any)
​
executedAt
string
ISO 8601 timestamp of execution
​
executedById
string
User ID who triggered settlement

​
Settlement Logic

  1. Identifies unsettled statements with balance = 0 or marked as final
  2. Validates settlement conditions
  3. Marks statements as isSaldado: true
  4. Logs settlement actions

​
Status Codes

  • 200: Settlement executed successfully
  • 403: Not authorized (requires ADMIN)
  • 500: Settlement error (check errors array)

​
Example Response

{
  "success": true,
  "data": {
    "processedCount": 45,
    "settledCount": 12,
    "errors": [],
    "executedAt": "2024-03-15T12:00:00.000Z",
    "executedById": "admin-user-123"
  }
}

​
Configuration Endpoints

​
Get Settlement Config

GET /api/v1/account-statements/config
Returns current settlement configuration.

​
Update Settlement Config

PUT /api/v1/account-statements/config
Update settlement configuration (admin only).

​
Health Status

GET /api/v1/account-statements/health
Returns settlement job health status.

Build docs developers (and LLMs) love

Get started for freeTalk to us