GetAccountingGeneralJournal

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>
			<generalJournalID><!-- int --></generalJournalID>
			<generalDateCreated><!-- double --></generalDateCreated>
			<generalDateCreatedGreaterThan><!-- double --></generalDateCreatedGreaterThan>
			<generalDateCreatedLessThan><!-- double --></generalDateCreatedLessThan>
			<generalDateCreatedGreatest><!-- double --></generalDateCreatedGreatest>
			<generalDateCreatedLeast><!-- double --></generalDateCreatedLeast>
			<generalDescription><!-- string --></generalDescription>
			<generalDebitAmount><!-- double --></generalDebitAmount>
			<generalDebitAmountGreaterThan><!-- double --></generalDebitAmountGreaterThan>
			<generalDebitAmountLessThan><!-- double --></generalDebitAmountLessThan>
			<generalDebitAmountGreatest><!-- double --></generalDebitAmountGreatest>
			<generalDebitAmountLeast><!-- double --></generalDebitAmountLeast>
			<generalDescription><!-- int --></generalDescription>
			<generalDebitAmount><!-- double --></generalDebitAmount>
			<generalDebitAmountGreaterThan><!-- double --></generalDebitAmountGreaterThan>
			<generalDebitAmountLessThan><!-- double --></generalDebitAmountLessThan>
			<generalDebitAmountGreatest><!-- double --></generalDebitAmountGreatest>
			<generalDebitAmountLeast><!-- double --></generalDebitAmountLeast>
			<currencyID><!-- string --></currencyID>
		</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>
			<journalEntries>
				<entry>
					<generalJournalID><!-- int --></generalJournalID>
					<generalDateCreated><!-- int --></generalDateCreated>
					<generalDescription><!-- string --></generalDescription>
					<generalDebitAmount><!-- double --></generalDebitAmount>
					<generalCreditAmount><!-- double --></generalCreditAmount>
					<currencyID><!-- string --></currencyID>
				</entry>
			</journalEntries>
		</results>
	</mbapi>

		

Request Elements

mbapi

Type

group

Description

MBAPI request document root.

Children

command

Type

string

Description

Required. The string GetAccountingGeneralJournal.

showXMLHeader

Type

boolean

Description

Whether to show an XML header in the results.

params

Type

group

Description

GetAccountingGeneralJournal parameters.

Children

generalJournalID

Type

int

Description

Limit the data you receive to ID's you pass.

generalDateCreated

Type

double

Description

General journal entry date created.

generalDateCreatedGreaterThan

Type

double

Description

General journal entry date created to be greater than.

generalDateCreatedLessThan

Type

double

Description

General journal entry date created to be less than.

generalDateCreatedGreatest

Type

double

Description

General journal entry date created to be less than or equal to.

generalDateCreatedLeast

Type

double

Description

General journal entry date created to be greater than or equal to.

generalDescription

Type

string

Description

The description of this general journal entry.

generalDebitAmount

Type

double

Description

General journal debit amount.

generalDebitAmountGreaterThan

Type

double

Description

General journal debit amount to be greater than.

generalDebitAmountLessThan

Type

double

Description

General journal debit amount to be less than.

generalDebitAmountGreatest

Type

double

Description

General journal debit amount to be less than or equal to.

generalDebitAmountLeast

Type

double

Description

General journal debit amount to be greater than or equal to.

generalDescription

Type

int

Description

The description of this general journal entry.

generalDebitAmount

Type

double

Description

General journal debit amount.

generalDebitAmountGreaterThan

Type

double

Description

General journal debit amount to be greater than.

generalDebitAmountLessThan

Type

double

Description

General journal debit amount to be less than.

generalDebitAmountGreatest

Type

double

Description

General journal debit amount to be less than or equal to.

generalDebitAmountLeast

Type

double

Description

General journal debit amount to be greater than or equal to.

currencyID

Type

string

Description

Currency ID 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

journalEntries

Type

group

Description

Contains all ban results.

Children

entry

Type

group

Description

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

Children

generalJournalID

Type

int

Description

The ID of the general journal entry.

generalDateCreated

Type

int

Description

The timestamp this entry was created.

generalDescription

Type

string

Description

The description of this general journal entry.

generalDebitAmount

Type

double

Description

The debit amount of this general journal entry.

generalCreditAmount

Type

double

Description

The credit amount of this general journal entry SHOULD always be the same as debit amount.

currencyID

Type

string

Description

The currencyID of this entry.