MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetAccountingControlRel

GetAccountingControlRel

Description

Command to get ban data, how other data is related to bans, and some data related to bans.

Attributes

package
modernbill
subpackage
mbapi
version
0.9
author
Kris Bailey

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<groupingType><!-- int --></groupingType>
			<generalLedgerID><!-- int --></generalLedgerID>
			<controls>
				<control>
					<controlType><!-- int --></controlType>
					<controlID><!-- int --></controlID>
				</control>
			</controls>
		</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>
				<ban>
					<banID><!-- int --></banID>
					<banString><!-- string --></banString>
					<banType><!-- int --></banType>
					<banActive><!-- boolean --></banActive>
					<banCount><!-- int --></banCount>
					<banDateLastUsed><!-- int --></banDateLastUsed>
				</ban>
			</ledger>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetAccountingControlRel.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetAccountingControlRel parameters.

Children
groupingType
Type
int
Description

Return grouping type, 0 = group by ledger entries, 1 = group by controls

generalLedgerID
Type
int
Description

Limit the data to a specific ledger row.

controls
Type
group
Description

Control Groups.

Children
control
Type
group
Description

Control set.

Children
controlType
Type
int
Description

Limit data to bans of this type.

  • 0: line items
  • 1: clients
  • 2: invoices
  • 3: packages
  • 4: tax zones
  • 5: tax zone groups
  • 6: products
  • 7: coupons

controlID
Type
int
Description

The control id(s) you want to only get results 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
group
Description

Contains any results.

Children
ledger
Type
group
Description

Contains all ban results.

Children
ban
Type
group
Description

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

Children
banID
Type
int
Description

The ID of the ban.

banString
Type
string
Description

The ban name for the order form. Names need not be unique. Operations are performed on IDs. Names are merely for display.

banType
Type
int
Description

The type of ban.

  • 0: e-mail
  • 1: ip

banActive
Type
boolean
Description

Whether the ban is active. Inactive bans won't show up on order forms, among other obviously appropriate things.

banCount
Type
int
Description

The number of times this ban item has been "hit".

banDateLastUsed
Type
int
Description

The Unix timestamp of when the ban was last "hit".