Skip to main content

Gljournalentryapiv1

accountKeystring

the encoded key of the loan or savings account that this journal entry relates to

amountnumber

the amount of the journal entry

assignedBranchKeystring

the encoded key of the branch that this journal entry is associated with

bookingDatestring

the booking date of this journal entry

creationDatestring

the date and time when the transaction that caused this journal entry was created

encodedKeystring

the automatically generated encoded ID for this item

Example: 8a19b7057471f4af017472dc0fd80472
entryDatestring

the date on which this journal entry was entered into the ledger

entryIDnumber

a unique, incremental ID for ledger entries

glAccount object

Description for glAccount in GLJournalEntryApiV1

activatedboolean

whether this general ledger account is in use

allowManualJournalEntriesboolean

whether manual entries are allowed for this general ledger account

balancenumber

the current balance of this general ledger account

creationDatestring<date-time>

the date on which this general ledger account was created

currency object

Description for currency in GLAccountApiV1

codestring

the three letter ISO code for this currency

creationDatestring

the date on which this currency was created

currencySymbolPositionstring

indicates where the currency symbol should appear in relation to the numeric value

Possible values: [AFTER_NUMBER, BEFORE_NUMBER]

digitsAfterDecimalnumber

indicates how many decimal places are allowed for this currency. For example, a currenncy with 100 minor units to 1 major unit, there will be 2 decimal places.

isBaseCurrencyboolean

whether this currency is the base currency for your banking institution

lastModifiedDatestring

the date on which this currency was last modified

namestring

the name of this currency

symbolstring

the currency symnbol used for this currency

descriptionstring

an optional description for this general ledger account

encodedKeystring

the encoded key of this general ledger account

glCodestring

the numeric code for this general ledger account

lastModifiedDatestring<date-time>

the date on which this general ledger account was last modified

migrationEvent object

Description for migrationEvent in GLAccountApiV1

creationDatestring<date-time>

the date on which the data import was made

encodedKeystring

the encoded key of this data migration event

numCentresImportednumber

the number of centres which were imported during the data migration

numClientsImportednumber

the number of clients which were imported as part of the data migration

numGLAccountsImportednumber

the number of general ledger accounts which were imported as part of the data migration

numGroupsImportednumber

the number of groups which were imported as part of the data migration

numLoanRepaymentsImportednumber

the number of loan repayment transations which were imported as part of the data migration

numLoanTransactionsImportednumber

the number of loan transactions which were imported as part of the data migration

numLoansImportednumber

the number of loan accounts which were imported as part of the data migration

numSavingsImportednumber

the number of savings accounts which were imported as part of the data migration

statestring

whether the data import was accepted, is still in a draft state, or was rejected and all data reverted

Possible values: [REVERTED, DRAFT, APPROVED]

typestring

the type of migration event

Possible values: [IMPORT, EXPORT]

namestring

the name of this general ledger account

stripTrailingZerosboolean

controls how this account is organized into header accounts when there are trailing zeroes, for example, for the account code 1100, if this field is set to true, only the first two numbers will be recognised

typestring

the type of general ledger account

Possible values: [INCOME, EXPENSE, LIABILITY, ASSET, EQUITY]

usagestring

whether this general ledger account is a DETAIL account, in which case it will have a value, or a HEADER account, in which case its value will be calculated based on the sum of detail accounts under it.

Possible values: [HEADER, DETAIL]

notesstring

any notes relating to this journal entry

productKeystring

the product associated with this journal entry

productTypestring

the type of product associated with this journal entry

Possible values: [LOAN, SAVINGS]

reversalEntryKeystring

if this entry was subsequently revered by another journal entry, this field contains the encoded key of that journal entry

transactionIDstring

the transaction ID that caused this journal entry. Please note, multiple journal entries can have the same transaction ID, for example, when a repayment goes to cover fees, princial, taxes etc.

typestring

whether this journal entry represents funds coming in or going out

Possible values: [CREDIT, DEBIT]

userKeystring

the encoded key of the user who created this journal entry, if it was created manually

Gljournalentryapiv1
{
"accountKey": "string",
"amount": 0,
"assignedBranchKey": "string",
"bookingDate": "string",
"creationDate": "string",
"encodedKey": "8a19b7057471f4af017472dc0fd80472",
"entryDate": "string",
"entryID": 0,
"glAccount": {
"activated": true,
"allowManualJournalEntries": true,
"balance": 0,
"creationDate": "2024-07-29T15:51:28.071Z",
"currency": {
"code": "string",
"creationDate": "string",
"currencySymbolPosition": "AFTER_NUMBER",
"digitsAfterDecimal": 0,
"isBaseCurrency": true,
"lastModifiedDate": "string",
"name": "string",
"symbol": "string"
},
"description": "string",
"encodedKey": "string",
"glCode": "string",
"lastModifiedDate": "2024-07-29T15:51:28.071Z",
"migrationEvent": {
"creationDate": "2024-07-29T15:51:28.071Z",
"encodedKey": "string",
"numCentresImported": 0,
"numClientsImported": 0,
"numGLAccountsImported": 0,
"numGroupsImported": 0,
"numLoanRepaymentsImported": 0,
"numLoanTransactionsImported": 0,
"numLoansImported": 0,
"numSavingsImported": 0,
"state": "REVERTED",
"type": "IMPORT"
},
"name": "string",
"stripTrailingZeros": true,
"type": "INCOME",
"usage": "HEADER"
},
"notes": "string",
"productKey": "string",
"productType": "LOAN",
"reversalEntryKey": "string",
"transactionID": "string",
"type": "CREDIT",
"userKey": "string"
}