Balance & Statement: Entry APIs
Access detailed entry-level information for transactions.
Endpoints
GET
/v1/entries
Get statements - List transactions from an account to get a statement and consolidate values. (Deprecated)
Parameters
branch
string
The account branch
account
string
The account number
initialDate
string
Initial date for entries (YYYY-MM-DD)
finalDate
string
Final date for entries (YYYY-MM-DD)
Response
{
"entries": [
{
"entryId": "string",
"accountKey": "1234/567890",
"amount": {
"value": 1000,
"currency": "USD"
},
"description": "Transaction description",
"entryDate": "2024-01-01",
"type": "DEBIT",
"balance": {
"value": 5000,
"currency": "USD"
}
}
]
}
GET
/v2/entries
Get statements (v2) - Enhanced version for listing transactions from accounts.
Parameters
accountKeys
array
List of account keys (branch/account format)
initialDate
string
Initial date for entries (YYYY-MM-DD)
finalDate
string
Final date for entries (YYYY-MM-DD)
page
integer
Page number for pagination
size
integer
Number of items per page
Response
{
"entries": [
{
"entryId": "string",
"accountKey": "1234/567890",
"amount": {
"value": 1000,
"currency": "USD"
},
"description": "Transaction description",
"entryDate": "2024-01-01",
"type": "DEBIT",
"balance": {
"value": 5000,
"currency": "USD"
},
"metadata": {
"transactionId": "string",
"correlationId": "string"
}
}
],
"pagination": {
"page": 0,
"size": 20,
"totalElements": 100,
"totalPages": 5
}
}
GET
/v1/entries/metadata
Get entries metadata information.
Parameters
accountKeys
array
List of account keys
Response
{
"metadata": [
{
"accountKey": "1234/567890",
"totalEntries": 150,
"dateRange": {
"earliest": "2024-01-01",
"latest": "2024-01-31"
},
"summary": {
"totalDebits": {
"value": 50000,
"currency": "USD"
},
"totalCredits": {
"value": 45000,
"currency": "USD"
}
}
}
]
}
GET
/v1/cubes/entries
Get aggregated entry information from data cubes using MDX queries.
Parameters
mdxQuery
string
MDX query for cube data retrieval
Response
{
"cubeData": [
{
"dimension": "ENTRY_TYPE",
"measure": "AMOUNT",
"value": 25000,
"currency": "USD",
"period": "2024-01"
}
],
"metadata": {
"query": "MDX query string",
"executionTime": "200ms",
"resultCount": 1
}
}