MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetProductAddonLedgerEntries

GetProductAddonLedgerEntries

Description

Command to get product addon ledger entries and their filter cycles and currencies.

Attributes

Product
modernbill
subProduct
mbapi
version
0.9
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<productAddonLedgerID><!-- int --></productAddonLedgerID>
			<productAddonID><!-- int --></productAddonID>
			<generalLedgerType><!-- int --></generalLedgerType>
			<journalType><!-- string --></journalType>
			<ledgerAccountID><!-- int --></ledgerAccountID>
			<productAddonLedgerDebit><!-- double --></productAddonLedgerDebit>
			<productAddonLedgerDebitGreaterThan><!-- double --></productAddonLedgerDebitGreaterThan>
			<productAddonLedgerDebitLessThan><!-- double --></productAddonLedgerDebitLessThan>
			<productAddonLedgerDebitGreatest><!-- double --></productAddonLedgerDebitGreatest>
			<productAddonLedgerDebitLeast><!-- double --></productAddonLedgerDebitLeast>
			<productAddonLedgerCredit><!-- double --></productAddonLedgerCredit>
			<productAddonLedgerCreditGreaterThan><!-- double --></productAddonLedgerCreditGreaterThan>
			<productAddonLedgerCreditLessThan><!-- double --></productAddonLedgerCreditLessThan>
			<productAddonLedgerCreditGreatest><!-- double --></productAddonLedgerCreditGreatest>
			<productAddonLedgerCreditLeast><!-- double --></productAddonLedgerCreditLeast>
			<productAddonLedgerComment><!-- string --></productAddonLedgerComment>
			<currencyID><!-- string --></currencyID>
			<getproductAddonLedgerCurrenyIDs><!-- int --></getproductAddonLedgerCurrenyIDs>
			<getproductAddonLedgerCycleIDs><!-- int --></getproductAddonLedgerCycleIDs>
		</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>
			<productAddonLedgerEntries>
				<productAddonLedgerEntry>
					<productAddonLedgerID><!-- int --></productAddonLedgerID>
					<productAddonID><!-- int --></productAddonID>
					<generalLedgerType><!-- int --></generalLedgerType>
					<journalType><!-- string --></journalType>
					<ledgerAccountID><!-- int --></ledgerAccountID>
					<productAddonLedgerDebit><!-- double --></productAddonLedgerDebit>
					<productAddonLedgerCredit><!-- double --></productAddonLedgerCredit>
					<productAddonLedgerComment><!-- string --></productAddonLedgerComment>
					<currencyID><!-- string --></currencyID>
					<currencies>
						<currency>
							<currencyID><!-- string --></currencyID>
						</currency>
					</currencies>
					<cycles>
						<cycle>
							<cycleID><!-- string --></cycleID>
						</cycle>
					</cycles>
				</productAddonLedgerEntry>
			</productAddonLedgerEntries>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetProductAddonLedgerEntries.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetProductAddonLedgerEntries parameters.

Children
productAddonLedgerID
Type
int
Description

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

productAddonID
Type
int
Description

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

productAddonLedgerDebit
Type
double
Description

Product Addon Ledger Debit amount.

productAddonLedgerDebitGreaterThan
Type
double
Description

Product Addon Ledger Debit amount to be greater than.

productAddonLedgerDebitLessThan
Type
double
Description

Product Addon Ledger Debit amount to be less than.

productAddonLedgerDebitGreatest
Type
double
Description

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

productAddonLedgerDebitLeast
Type
double
Description

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

productAddonLedgerCredit
Type
double
Description

Product Addon Ledger Credit amount.

productAddonLedgerCreditGreaterThan
Type
double
Description

Product Addon Ledger Credit amount to be greater than.

productAddonLedgerCreditLessThan
Type
double
Description

Product Addon Ledger Credit amount to be less than.

productAddonLedgerCreditGreatest
Type
double
Description

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

productAddonLedgerCreditLeast
Type
double
Description

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

productAddonLedgerComment
Type
string
Description

Ledger Entry Comment

currencyID
Type
string
Description

Currency ID the entry will be made in.

getproductAddonLedgerCurrenyIDs
Type
int
Description

Whether to return the currency ids each entry is valid for.

getproductAddonLedgerCycleIDs
Type
int
Description

Whether to return the cycle ids each entry is valid for.

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
productAddonLedgerEntries
Type
None
Description
None
Children
productAddonLedgerEntry
Type
None
Description
None
Children
productAddonLedgerID
Type
int
Description

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

productAddonID
Type
int
Description

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

productAddonLedgerDebit
Type
double
Description

Product Ledger Debit amount.

productAddonLedgerCredit
Type
double
Description

Product Ledger Credit amount.

productAddonLedgerComment
Type
string
Description

Ledger Entry Comment

currencyID
Type
string
Description

Currency ID the entry will be made in.

currencies
Type
group
Description

Contains the filter currency ids

Children
currency
Type
group
Description

Contains

Children
currencyID
Type
string
Description

Currency ID

cycles
Type
group
Description

Contains the filter cycle ids

Children
cycle
Type
group
Description

Contains

Children
cycleID
Type
string
Description

Cycle ID