This endpoint is used in performing transactions from and to a customer's deposit account and ledger account. Multiple entries can be made to either of these accounts by filling in the affected accounts in the credits and debits array parameters.
Note
This endpoint to be used for deposits and withdrawals to and fro a customer's savings account.
Note that the sum total of debits must be equal to the sum total of credits.
Important Use Cases
- Single Customer Savings Account Debit to Single GL: This endpoint is useful for performing a credit of a GL and a corresponding single debit of customer savings account.
This simply implies that a customer account is debited for a particular transaction but the transaction amount is then credited to the GL specified in the body of the request and vice versa.
The total sum of debit on the customer's savings account must be equal to the multiple credits of the GLs.
Example request body for this use case is shown below:
{
"officeId": "1",
"transactionDate": "14 January 2023",
"comments": "Transfer from Account to GLs",
"currencyCode": "NGN",
"credits": [
{
"glAccountId": "42",
"amount": "30000"
},
],
"debits": [],
"operationType": "Debit",
"referenceNumber": "HT-CQWUDH11",
"customerAccounts": [
{
"customerAccountId": "000000001",
"amount": "30000"
}
]
}
- Multiple GLs Debit to Single Customer Savings Account Credit: This endpoint is also useful for performing a credit of a customer savings accounts and a corresponding debit of multiple GLs.
This simply implies that a customer account is credited for a particular transaction while the sum total of the transaction amount is debited from several assigned GLs specified in the body of the request.
The total sum of debit on all the GLs must be equal to the credit on the customer's savings account.
Example request body for this use case is shown below:
{
"officeId": "1",
"transactionDate": "24 November 2022",
"comments": "Transfer from GLs to Savings Account",
"currencyCode": "NGN",
"credits": [],
"debits": [
{
"glAccountId": "42",
"amount": "30000"
},
{
"glAccountId": "45",
"amount": "30000"
},
{
"glAccountId": "50",
"amount": "40000"
}
],
"operationType": "Credit",
"referenceNumber": "HT-CQWUDH12",
"customerAccounts": [
{
"customerAccountId": "000000001",
"amount": "100000"
}
]
}
- Single Customer Account Debit to Single GL Credit: This endpoint is also useful for single debit from a savings account and a single entry into a GL and vice versa.
Example request body for this use case is shown below:
{
"officeId": "1",
"transactionDate": "14 November 2022",
"comments": "Transfer from GL to Account",
"currencyCode": "NGN",
"credits": [],
"debits": [
{
"glAccountId": "42",
"amount": "30000"
}
],
"operationType": "Credit",
"referenceNumber": "HT-CQWUDH12",
"customerAccounts": [
{
"customerAccountId": "000000001",
"amount": "30000"
}
]
}