MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetPackageLedgerEntries

GetPackageLedgerEntries

Description

Command to get package ledger entries. These are the accounting entries that are created each time a package is renewed.

Attributes

package
modernbill
subpackage
mbapi
version
0.9
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<packageLedgerID><!-- int --></packageLedgerID>
			<packageID><!-- int --></packageID>
			<generalLedgerType><!-- int --></generalLedgerType>
			<journalType><!-- string --></journalType>
			<ledgerAccountID><!-- int --></ledgerAccountID>
			<packageLedgerDebit><!-- double --></packageLedgerDebit>
			<packageLedgerDebitGreaterThan><!-- double --></packageLedgerDebitGreaterThan>
			<packageLedgerDebitLessThan><!-- double --></packageLedgerDebitLessThan>
			<packageLedgerDebitGreatest><!-- double --></packageLedgerDebitGreatest>
			<packageLedgerDebitLeast><!-- double --></packageLedgerDebitLeast>
			<packageLedgerCredit><!-- double --></packageLedgerCredit>
			<packageLedgerCreditGreaterThan><!-- double --></packageLedgerCreditGreaterThan>
			<packageLedgerCreditLessThan><!-- double --></packageLedgerCreditLessThan>
			<packageLedgerCreditGreatest><!-- double --></packageLedgerCreditGreatest>
			<packageLedgerCreditLeast><!-- double --></packageLedgerCreditLeast>
			<packageLedgerComment><!-- string --></packageLedgerComment>
			<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>
			<packageLedgerEntries>
				<packageLedgerEntry>
					<packageLedgerID><!-- int --></packageLedgerID>
					<packageID><!-- int --></packageID>
					<generalLedgerType><!-- int --></generalLedgerType>
					<journalType><!-- string --></journalType>
					<ledgerAccountID><!-- int --></ledgerAccountID>
					<packageLedgerDebit><!-- double --></packageLedgerDebit>
					<packageLedgerCredit><!-- double --></packageLedgerCredit>
					<packageLedgerComment><!-- string --></packageLedgerComment>
					<currencyID><!-- string --></currencyID>
				</packageLedgerEntry>
			</packageLedgerEntries>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetPackageLedgerEntries.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetProducts parameters.

Children
packageLedgerID
Type
int
Description

Package Ledger ID, if you want to get a specific one.

packageID
Type
int
Description

Package ID to get all the ledger entries for.

generalLedgerType
Type
int
Description

General ledger type to search by.

journalType
Type
string
Description

Journal type of the ledger entry to search by.

ledgerAccountID
Type
int
Description

Ledger Account ID of the ledger account the entry is going to use.

packageLedgerDebit
Type
double
Description

Package Ledger Debit amount.

packageLedgerDebitGreaterThan
Type
double
Description

Package Ledger Debit amount to be greater than.

packageLedgerDebitLessThan
Type
double
Description

Package Ledger Debit amount to be less than.

packageLedgerDebitGreatest
Type
double
Description

Package Ledger Debit amount to be less than or equal to.

packageLedgerDebitLeast
Type
double
Description

Package Ledger Debit amount to be greater than or equal to.

packageLedgerCredit
Type
double
Description

Package Ledger Credit amount.

packageLedgerCreditGreaterThan
Type
double
Description

Package Ledger Credit amount to be greater than.

packageLedgerCreditLessThan
Type
double
Description

Package Ledger Credit amount to be less than.

packageLedgerCreditGreatest
Type
double
Description

Package Ledger Credit amount to be less than or equal to.

packageLedgerCreditLeast
Type
double
Description

Package Ledger Credit amount to be greater than or equal to.

packageLedgerComment
Type
string
Description

Ledger Entry Comment

currencyID
Type
string
Description

Currency ID the entry will be made in.

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
None
Description
None
Children
packageLedgerEntries
Type
None
Description
None
Children
packageLedgerEntry
Type
None
Description
None
Children
packageLedgerID
Type
int
Description

Package Ledger ID, if you want to get a specific one.

packageID
Type
int
Description

Package ID to get all the ledger entries for.

generalLedgerType
Type
int
Description

General ledger type to search by.

journalType
Type
string
Description

Journal type of the ledger entry to search by.

ledgerAccountID
Type
int
Description

Ledger Account ID of the ledger account the entry is going to use.

packageLedgerDebit
Type
double
Description

Package Ledger Debit amount.

packageLedgerCredit
Type
double
Description

Package Ledger Credit amount.

packageLedgerComment
Type
string
Description

Ledger Entry Comment

currencyID
Type
string
Description

Currency ID the entry will be made in.