Bank Transactions
| Name | Type | Path |
|---|---|---|
| GetBankTransaction | GET | /api/BankTransaction/{bankTransactionId} |
| Get a Bank Transaction | ||
| CreateBankTransaction | POST | /api/BankTransaction |
| Create a bank transaction | ||
| LockBankTransaction | POST | /api/BankTransaction/{bankTransactionId}/lock |
| Lock a bank transaction | ||
| UnlockBankTransaction | POST | /api/BankTransaction/{bankTransactionId}/unlock |
| Unlock a bank transaction | ||
| UpdateBankTransaction | PATCH | /api/BankTransaction/{bankTransactionId} |
| Update a bank transaction | ||
| DeleteBankTransaction | DELETE | /api/BankTransaction/{bankTransactionId} |
| Delete a Bank Transaction |
Further Bank Transaction information:
Create a new Bank Transaction for a specified bank account.
POST /api/bankTransaction
Deposit with required fields only
{
"bankAccountRef": "LEGEACUR",
"description": "A Bank transaction",
"bankDate": "2023-09-12",
"depositAmount": 45.23
}
Withdrawal including optional fields
{
"bankAccountRef": "LEGEACUR",
"description": "A Bank transaction",
"bankDate": "2023-09-12",
"bankReference": "AB-123",
"merchantName": "A Merchant",
"postDate": "2023-09-11",
"paymentMethodRef": "BC",
"withdrawalAmount": 120.56,
"depositAmount": 0.0
}
Amount rules
- One of depositAmount or withdrawalAmount must be supplied and greater than zero
- Only one of depositAmount and withdrawalAmount can be greater than zero
Reference: POST /api/BankTransaction
Updated September 2025