Introduction
This documentation describes the Conciliations API endpoints for managing and querying transaction records in TotalCoin.
Authentication
API access control is done through OAuth 2.0 with Bearer Tokens.
Endpoint
POST
api/auth/login
Request
{
"company": "",
"username": "",
"password": ""
}
| Field | Type | Description | Required |
|---|---|---|---|
| company | String | Company Name | Yes |
| username | String | Username | Yes |
| password | String | Password | Yes |
Response (HTTP 200)
{
"token": "",
"expires_in": 3600
}
| Field | Type | Description |
|---|---|---|
| token | String | Authentication token |
| expires_in | Number | Token expiration time in seconds |
Common Errors
| Code | Description |
|---|---|
| 401 | Invalid or wrong credentials |
| 403 | Insufficient permissions to access the API |
Conciliation Endpoints
Get Conciliation Report
GET
api/conciliations/report
Query Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| start_date | String | Start date (YYYY-MM-DD) | Yes |
| end_date | String | End date (YYYY-MM-DD) | Yes |
| currency | String | Report currency (USD, EUR, etc.) | No |
| status | String | Transaction status (completed, pending, failed) | No |
Response (HTTP 200)
{
"report_id": "rep_123456789",
"total_transactions": 150,
"total_amount": 15000.00,
"currency": "USD",
"transactions": [
{
"transaction_id": "txn_123",
"date": "2024-03-13T10:00:00Z",
"amount": 100.00,
"status": "completed",
"description": "Payment for invoice #123"
}
]
}
| Field | Type | Description |
|---|---|---|
| report_id | String | Unique report ID |
| total_transactions | Number | Total number of transactions |
| total_amount | Number | Total amount of transactions |
| currency | String | Report currency |
| transactions | Array | List of detailed transactions |
Important Notes
• All requests must include the authentication token in the Authorization header: Bearer {token}
• Dates must be in ISO 8601 format (YYYY-MM-DD)
• Date range cannot exceed 30 days
• Reports are generated asynchronously and may take several minutes to complete