MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetPackageAddonLedgerEntries

GetPackageAddonLedgerEntries

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>
			<packageAddonLedgerID><!-- int --></packageAddonLedgerID>
			<packageAddonID><!-- int --></packageAddonID>
			<generalLedgerType><!-- int --></generalLedgerType>
			<journalType><!-- string --></journalType>
			<ledgerAccountID><!-- int --></ledgerAccountID>
			<packageAddonLedgerDebit><!-- double --></packageAddonLedgerDebit>
			<packageAddonLedgerDebitGreaterThan><!-- double --></packageAddonLedgerDebitGreaterThan>
			<packageAddonLedgerDebitLessThan><!-- double --></packageAddonLedgerDebitLessThan>
			<packageAddonLedgerDebitGreatest><!-- double --></packageAddonLedgerDebitGreatest>
			<packageAddonLedgerDebitLeast><!-- double --></packageAddonLedgerDebitLeast>
			<packageAddonLedgerCredit><!-- double --></packageAddonLedgerCredit>
			<packageAddonLedgerCreditGreaterThan><!-- double --></packageAddonLedgerCreditGreaterThan>
			<packageAddonLedgerCreditLessThan><!-- double --></packageAddonLedgerCreditLessThan>
			<packageAddonLedgerCreditGreatest><!-- double --></packageAddonLedgerCreditGreatest>
			<packageAddonLedgerCreditLeast><!-- double --></packageAddonLedgerCreditLeast>
			<packageAddonLedgerComment><!-- string --></packageAddonLedgerComment>
			<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>
			<packageAddonLedgerEntries>
				<packageAddonLedgerEntry>
					<packageAddonLedgerID><!-- int --></packageAddonLedgerID>
					<packageAddonID><!-- int --></packageAddonID>
					<generalLedgerType><!-- int --></generalLedgerType>
					<journalType><!-- string --></journalType>
					<ledgerAccountID><!-- int --></ledgerAccountID>
					<packageAddonLedgerDebit><!-- double --></packageAddonLedgerDebit>
					<packageAddonLedgerCredit><!-- double --></packageAddonLedgerCredit>
					<packageAddonLedgerComment><!-- string --></packageAddonLedgerComment>
					<currencyID><!-- string --></currencyID>
				</packageAddonLedgerEntry>
			</packageAddonLedgerEntries>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetPackageAddonLedgerEntries.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetProducts parameters.

Children
packageAddonLedgerID
Type
int
Description

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

packageAddonID
Type
int
Description

Package Addon 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.

packageAddonLedgerDebit
Type
double
Description

Package Addon Ledger Debit amount.

packageAddonLedgerDebitGreaterThan
Type
double
Description

Package Addon Ledger Debit amount to be greater than.

packageAddonLedgerDebitLessThan
Type
double
Description

Package Addon Ledger Debit amount to be less than.

packageAddonLedgerDebitGreatest
Type
double
Description

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

packageAddonLedgerDebitLeast
Type
double
Description

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

packageAddonLedgerCredit
Type
double
Description

Package Addon Ledger Credit amount.

packageAddonLedgerCreditGreaterThan
Type
double
Description

Package Addon Ledger Credit amount to be greater than.

packageAddonLedgerCreditLessThan
Type
double
Description

Package Addon Ledger Credit amount to be less than.

packageAddonLedgerCreditGreatest
Type
double
Description

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

packageAddonLedgerCreditLeast
Type
double
Description

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

packageAddonLedgerComment
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
packageAddonLedgerEntries
Type
None
Description
None
Children
packageAddonLedgerEntry
Type
None
Description
None
Children
packageAddonLedgerID
Type
int
Description

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

packageAddonID
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.

packageAddonLedgerDebit
Type
double
Description

Package Ledger Debit amount.

packageAddonLedgerCredit
Type
double
Description

Package Ledger Credit amount.

packageAddonLedgerComment
Type
string
Description

Ledger Entry Comment

currencyID
Type
string
Description

Currency ID the entry will be made in.