MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetAccountingLedgerAccounts

GetAccountingLedgerAccounts

Description

Command to get general journal entries' data.

Attributes

package
modernbill
subpackage
mbapi
version
0.9
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<ledgerAccountID><!-- int --></ledgerAccountID>
			<parentLedgerAccountID><!-- int --></parentLedgerAccountID>
			<ledgerAccountNumber><!-- int --></ledgerAccountNumber>
			<ledgerAccountType><!-- int --></ledgerAccountType>
			<ledgerAccountName><!-- int --></ledgerAccountName>
			<ledgerAccountTransKey><!-- int --></ledgerAccountTransKey>
		</params>
	</mbapi>

Example Response

	<mbapi>
		<header>
			<remoteSessionID><!-- hex --></remoteSessionID>
			<errorCount><!-- int --></errorCount>
			<errors>
				<error>
					<title><!-- string --></title>
					<message><!-- string --></message>
				</error>
			</errors>
			<numResults><!-- int --></numResults>
			<numAffectedRows><!-- int --></numAffectedRows>
		</header>
		<results>
			<ledger_accounts>
				<account>
					<ledgerAccountID><!-- int --></ledgerAccountID>
					<parentLedgerAccountID><!-- int --></parentLedgerAccountID>
					<ledgerAccountNumber><!-- int --></ledgerAccountNumber>
					<ledgerAccountType><!-- int --></ledgerAccountType>
					<ledgerAccountName><!-- string --></ledgerAccountName>
					<ledgerAccountTransKey><!-- string --></ledgerAccountTransKey>
				</account>
			</ledger_accounts>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetAccountingLedgerAccounts.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetAccountingLedgerAccounts parameters.

Children
ledgerAccountID
Type
int
Description

The ID of the ledger account to fetch. This will always select at most 1 ledger account.

parentLedgerAccountID
Type
int
Description

The parent ID of the ledger account to fetch. This will always select at most 1 ledger account.

ledgerAccountNumber
Type
int
Description

The Number of the ledger account to fetch. This will always select at most 1 ledger account.

ledgerAccountType
Type
int
Description

The type ID of the ledger accounts you want to fetch.

ledgerAccountName
Type
int
Description

The ledger account API name to search by.

ledgerAccountTransKey
Type
int
Description

The translation key to search by.

Response Elements

mbapi
Type
group
Description

MBAPI response document root.

Children
header
Type
group
Description

Contains result meta data: data about the result itself.

Children
remoteSessionID
Type
hex
Description

A session ID that may be used for authentication instead of a remote access hash.

errorCount
Type
int
Description

The number of errors that occured.

errors
Type
group
Description

Contains any errors that occured.

Children
error
Type
group
Description

Contains information relating to a single error. Occurs header errorCount times.

Children
title
Type
string
Description

The title of the error.

message
Type
string
Description

The error message.

numResults
Type
int
Description

The number of results that have been returned. For Get commands.

numAffectedRows
Type
int
Description

The number of rows that have been affected. For Set commands.

results
Type
group
Description

Contains any results.

Children
ledger_accounts
Type
group
Description

Contains all ban results.

Children
account
Type
group
Description

Contains all results for a single ban. Occurs header numResults times.

Children
ledgerAccountID
Type
int
Description

The ID of the ledger account.

parentLedgerAccountID
Type
int
Description

The ID of the ledger account parent of this account.

ledgerAccountNumber
Type
int
Description

Ledger account number of this account.

ledgerAccountType
Type
int
Description

The ledger account type.

ledgerAccountName
Type
string
Description

The ledger account API name.

ledgerAccountTransKey
Type
string
Description

The ledger account translation key or display name.