This command is used to retrieve general ledger items based on a wide range of criteria. The ledger stores accounts payable and accounts receivable ledger entries as well as general ledger entries. They are differentiated by generalLedgerType. The ledger is permanent summary of all the supporting journals. We are updating the ledger in real- time instead of the more common paper-based practice of once daily. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetAccountingGeneralLedger command:
<mbapi> <command><!-- None --></command> <showXMLHeader><!-- None --></showXMLHeader> <params> <generalLedgerID><!-- int --></generalLedgerID> <invoiceID><!-- int --></invoiceID> <clientID><!-- int --></clientID> <currencyID><!-- int --></currencyID> <getClientData><!-- int --></getClientData> <getAvailableClientData><!-- int --></getAvailableClientData> <getAvailableInvoiceData><!-- int --></getAvailableInvoiceData> <getInvoiceData><!-- int --></getInvoiceData> <journalTableID><!-- int --></journalTableID> <journalTableName><!-- string --></journalTableName> <generalLedgerType><!-- int --></generalLedgerType> <ledgerAccountID><!-- int --></ledgerAccountID> <generalLedgerDateCreatedLessThan><!-- int --></generalLedgerDateCreatedLessThan> <generalLedgerDateCreated><!-- int --></generalLedgerDateCreated> <generalLedgerDateCreatedLessThan><!-- int --></generalLedgerDateCreatedLessThan> <generalLedgerDateCreatedGreaterThan><!-- int --></generalLedgerDateCreatedGreaterThan> <generalLedgerDebitAmountLessThan><!-- double --></generalLedgerDebitAmountLessThan> <generalLedgerDebitAmount><!-- double --></generalLedgerDebitAmount> <generalLedgerDebitAmountGreaterThan><!-- double --></generalLedgerDebitAmountGreaterThan> <generalLedgerCreditAmountLessThan><!-- double --></generalLedgerCreditAmountLessThan> <generalLedgerCreditAmount><!-- double --></generalLedgerCreditAmount> <generalLedgerCreditAmountGreaterThan><!-- double --></generalLedgerCreditAmountGreaterThan> <generalLedgerDescription><!-- string --></generalLedgerDescription> <groupByAndSum><!-- int --></groupByAndSum> <clientLastName><!-- string --></clientLastName> <clientFirstName><!-- string --></clientFirstName> <invoiceNumber><!-- string --></invoiceNumber> <sortDir><!-- None --></sortDir> <sortColumn><!-- None --></sortColumn> <recordOffset><!-- None --></recordOffset> <numRecords><!-- None --></numRecords> </params> </mbapi>
None
mbapi
command
showXMLHeader
params
generalLedgerID
The ID of the general ledger item to fetch. This will always select at most 1 ledger item.
invoiceID
The ID of the invoice whose ledger items you wish to retrieve.
clientID
The ID of the client whose ledger items you wish to retrieve.
currencyID
The ID of the currency for this record in the ledger.
getClientData
Whether or not to get rows with client ids AND join the client data.
getAvailableClientData
Whether or not to join the client data for rows WITH a client id without excluding rows without a client id.
getAvailableInvoiceData
Whether or not to join the invoice data for rows WITH an invoice id without excluding rows without an invoice id.
getInvoiceData
Whether or not to get invoice data.
journalTableID
The ID of the journal item whose ledger items you wish to retrieve. Used in conjuntion with the journalTableName to retrieve ledger items related to specific a journal item.
journalTableName
The table name of the related journal item. Used in conjuntion with the journalTableID to retrieve ledger items related to specific a journal item.
generalLedgerType
The type of the ledger items you wish to retrieve.
ledgerAccountID
The ID of the ledger account whose ledger items you wish to retrieve.
generalLedgerDateCreatedLessThan
The maximum UNIX timestamp for which a ledger item in the result set was created.
generalLedgerDateCreated
The exact UNIX timestamp for which a ledger item in the result set was created.
generalLedgerDateCreatedLessThan
The maximum UNIX timestamp for which a ledger item in the result set was created
generalLedgerDateCreatedGreaterThan
The minimum UNIX timestamp for which a ledger item in the result set was created
generalLedgerDebitAmountLessThan
The maximum monetary debit amount for a ledger item in the result set.
generalLedgerDebitAmount
The exact monetary debit amount for a ledger item in the result set.
generalLedgerDebitAmountGreaterThan
The minimum monetary debit amount for a ledger item in the result set.
generalLedgerCreditAmountLessThan
The maximum monetary credit amount for a ledger item in the result set.
generalLedgerCreditAmount
The exact monetary credit amount for a ledger item in the result set.
generalLedgerCreditAmountGreaterThan
The minimum monetary credit amount for a ledger item in the result set.
generalLedgerDescription
The descriptive string for a ledger item in the result set. This is compared with a LIKE statement
groupByAndSum
whether we want individual entries or if we want to group them and get the sum of the credits and debits.
clientLastName
Client last name to search by.
clientFirstName
Client first name to search by.
invoiceNumber
Invoice number to search by.
sortDir
sortColumn
recordOffset
numRecords