Console Webservice API

BillingEngine

Other API in Package

Console

Console System

Internal Console

Accesses billing information related to this Pal.

Method Summary
BillingEvent credit(String type, String description, double amount)

Creates a credit. Amount must be greater than 0.00.

BillingEvent debit(String type, String description, double amount)

Creates a debit. Amount must be greater than 0.00.

BillingEvent getEvent(String id)

Returns the event with id.

BillingEvent getEventByType(String type)

Returns the most recent event by type.

SystemDataView getEvents()

Provides access to the billing event history

String toString()

Returns a description of this object.

Method Detail


BillingEvent credit(String type, String description, double amount)

Creates a credit. Amount must be greater than 0.00.

Parameters:

  • String   type Required parameter. Maximum allowed size of parameter: 50
  • String   description Required parameter. Maximum allowed size of parameter: 255
  • double   amount Required parameter.

Returns:  BillingEvent

Since: 05-30-2013

top

BillingEvent debit(String type, String description, double amount)

Creates a debit. Amount must be greater than 0.00.

Parameters:

  • String   type Required parameter. Maximum allowed size of parameter: 50
  • String   description Required parameter. Maximum allowed size of parameter: 255
  • double   amount Required parameter.

Returns:  BillingEvent

Since: 05-30-2013

top

BillingEvent getEvent(String id)

Returns the event with id.

Parameters:

  • String   id Required parameter.

Returns:  BillingEvent

Since: 05-30-2013

top

BillingEvent getEventByType(String type)

Returns the most recent event by type.

Parameters:

  • String   type Required parameter.

Returns:  BillingEvent

Since: 12-05-2019

top

SystemDataView getEvents()

Provides access to the billing event history

Returns:  SystemDataView


DataList Name: PalBillingEvents
DataList Keys/Column Name Column Type Read Only
txId String  
txName String  
txDescription String  
eventId String  
type String  
description String  
createDate Date  
amount Decimal  
debit Boolean  

Since: 05-30-2013

top

String toString()

Returns a description of this object.

Returns:  String

Since: 05-30-2013

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: Nov 22, 2024 11:54 AM