InternalStatement

Method Summary
boolean	addCredit(String description, double amount) Adds a credit entry to the register table for this statement. Description is required. The amount must be > 0. The amount goes in as negative.
boolean	addDebit(String description, double amount) Adds a debit entry to the register table for this activation key. Description is required. The amount must be > 0. The amount goes in as positive.
SystemDataView	getAdjustments() Returns a list of adjustments for this statement.
Data	getData() Returns information on this statement.
SystemDataView	getDetails() Returns a list of details for this statement.
InternalEnterprise	getEnterprise() Returns the enterprise associated with this statement.
String	getId() Returns the statement id
SystemDataView	getItems() Returns a list of items for this statement.
SystemDataView	getItemsByEnterprise() Returns a list items for this statement grouped by enterprise.
SystemDataView	getItemsByKey() Returns a list items for this statement grouped by key.
SystemDataView	getPalBillingDetails() Returns a list of pal billing details for this statement.
boolean	isAutoInvoice() Returns true if the statement is set up for auto payment.
boolean	isPaid() Returns true if the statement has been paid or marked paid.
	markFailed(String reason) Marks the statement as having failed. A reason is required.
boolean	markPaid() Marks the statement has having been paid externally. Returns true on success.
boolean	markWaived() Waives the fees for the entire statement.
boolean	processPayment(String authorization, String transactionId) Marks the statement as paid with the given authorization and transactionId.
boolean	rebuild() Rebuilds the statement. You must call reset first
boolean	reset(String reason) Resets the statement deleting invoice items except credits and debits.
String	toString() Returns a description of this object.

Method Detail

---

boolean addCredit(String description, double amount)

Adds a credit entry to the register table for this statement. Description is required. The amount must be > 0. The amount goes in as negative.

Parameters:

• String   description
• double   amount

Returns:  boolean

Since: 07-15-2010

---

boolean addDebit(String description, double amount)

Adds a debit entry to the register table for this activation key. Description is required. The amount must be > 0. The amount goes in as positive.

Parameters:

• String   description
• double   amount

Returns:  boolean

Since: 07-15-2010

---

SystemDataView getAdjustments()

Returns a list of adjustments for this statement.

Returns:  SystemDataView

DataList Name: EnterpriseStatementAdjustments

DataList Keys/Column Name	Column Type	Read Only
id	Number
statementId	Number
createDate	Date
effectiveDate	Date
description	String
amount	Decimal
type	Number
firstName	String
lastName	String

Since: 06-08-2010

---

Data getData()

Returns information on this statement.

Returns:  Data

Since: 04-27-2010

---

SystemDataView getDetails()

Returns a list of details for this statement.

Returns:  SystemDataView

DataList Name: EnterpriseStatementDetail

DataList Keys/Column Name	Column Type	Read Only
detailId	Number
palId	String
palName	String
enterpriseName	String
resellerClientCode	String
keyName	String
keyId	String
type	Number
reference	String
qty	Number
entryDate	Date

Since: 04-27-2010

---

InternalEnterprise getEnterprise()

Returns the enterprise associated with this statement.

Returns:  InternalEnterprise

Since: 04-18-2016

---

String getId()

Returns the statement id

Returns:  String

Since: 07-15-2010

---

SystemDataView getItems()

Returns a list of items for this statement.

Returns:  SystemDataView

DataList Name: EnterpriseStatementItem

DataList Keys/Column Name	Column Type	Read Only
itemId	Number
keyId	String
keyName	String
type	String
enterpriseId	String
enterpriseName	String
resellerClientCode	String
txExecCount	Number
txAccessCount	Number
txArchiveCount	Number
consolePersonalCount	Number
consoleEnterpriseCount	Number
webCount	Number
datasetCount	Number
datasetFee	Decimal
webFee	Decimal
txExecFee	Decimal
txAccessFee	Decimal
txArchiveFee	Decimal
consolePersonalFee	Decimal
consoleEnterpriseFee	Decimal
docExecCount	Number
docExecFee	Decimal
docStorageCount	Number
docStorageFee	Decimal
adjustmentFee	Decimal
monthlyFee	Decimal
hostingFee	Decimal
storageFee	Decimal
storageCount	Number
totalFee	Decimal

Since: 04-27-2010

---

SystemDataView getItemsByEnterprise()

Returns a list items for this statement grouped by enterprise.

Returns:  SystemDataView

DataList Name: EnterpriseStatementByEnterprise

DataList Keys/Column Name	Column Type	Read Only
enterpriseId	Number
enterpriseName	String
resellerClientCode	String
createDate	Date
txExecCount	Number
txAccessCount	Number
txArchiveCount	Number
docExecCount	Number
docStorageCount	Number
consolePersonalCount	Number
consoleEnterpriseCount	Number
webCount	Number
datasetCount	Number
txExecFee	Decimal
txAccessFee	Decimal
txArchiveFee	Decimal
consolePersonalFee	Decimal
consoleEnterpriseFee	Decimal
webFee	Decimal
datasetFee	Decimal
docExecFee	Decimal
docStorageFee	Decimal
storageCount	Number
monthlyFee	Decimal
hostingFee	Decimal
storageFee	Decimal
palBillingFee	Decimal
adjustmentFee	Decimal
totalFee	Decimal

Since: 07-20-2010

---

SystemDataView getItemsByKey()

Returns a list items for this statement grouped by key.

Returns:  SystemDataView

DataList Name: EnterpriseStatementByKey

DataList Keys/Column Name	Column Type	Read Only
keyId	String
keyName	String
type	String
txExecCount	Number
txAccessCount	Number
txArchiveCount	Number
docExecCount	Number
docStorageCount	Number
consolePersonalCount	Number
consoleEnterpriseCount	Number
webCount	Number
datasetCount	Number
txExecFee	Decimal
txAccessFee	Decimal
txArchiveFee	Decimal
consolePersonalFee	Decimal
consoleEnterpriseFee	Decimal
webFee	Decimal
datasetFee	Decimal
docExecFee	Decimal
docStorageFee	Decimal
storageCount	Number
monthlyFee	Decimal
hostingFee	Decimal
storageFee	Decimal
palBillingFee	Decimal
adjustmentFee	Decimal
totalFee	Decimal

Since: 07-20-2010

---

SystemDataView getPalBillingDetails()

Returns a list of pal billing details for this statement.

Returns:  SystemDataView

DataList Name: EnterprisePalStatementDetail

DataList Keys/Column Name	Column Type	Read Only
detailId	Number
palId	String
palName	String
enterpriseName	String
resellerClientCode	String
keyName	String
keyId	String
amount	Decimal
type	String
description	String
debit	Boolean
createDate	Date

Since: 05-30-2013

---

boolean isAutoInvoice()

Returns true if the statement is set up for auto payment.

Returns:  boolean

Since: 06-09-2010

---

boolean isPaid()

Returns true if the statement has been paid or marked paid.

Returns:  boolean

Since: 04-27-2010

---

markFailed(String reason)

Marks the statement as having failed. A reason is required.

Parameters:

• String   reason Required parameter. Maximum allowed size of parameter: 100

Since: 09-11-2012

---

boolean markPaid()

Marks the statement has having been paid externally. Returns true on success.

Returns:  boolean

Since: 06-01-2010

---

boolean markWaived()

Waives the fees for the entire statement.

Returns:  boolean

Since: 08-23-2011

---

boolean processPayment(String authorization, String transactionId)

Marks the statement as paid with the given authorization and transactionId.

Parameters:

• String   authorization Required parameter.
• String   transactionId Required parameter.

Returns:  boolean

Since: 04-18-2016

---

boolean rebuild()

Rebuilds the statement. You must call reset first

Returns:  boolean

Since: 02-01-2016

---

boolean reset(String reason)

Resets the statement deleting invoice items except credits and debits.

Parameters:

• String   reason Required parameter. Maximum allowed size of parameter: 100

Returns:  boolean

Since: 02-01-2016

---

String toString()

Returns a description of this object.

Returns:  String

Since: 04-27-2010