LedgerEntry class: Difference between revisions
From Catglobe Wiki
More actions
 Created page with "{{CGscriptClass_Template |Name=<nowiki>LedgerEntry</nowiki> |Description=<nowiki>Represents a ledger entry in the budget for a resource.</nowiki> |Methods= {{CGscriptMethods_Temp..."  | 
				No edit summary  | 
				||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
|Name=<nowiki>LedgerEntry</nowiki>  | |Name=<nowiki>LedgerEntry</nowiki>  | ||
|Description=<nowiki>Represents a ledger entry in the budget for a resource.</nowiki>  | |Description=<nowiki>Represents a ledger entry in the budget for a resource.</nowiki>  | ||
|InheritsFrom=object|Constructors=  | |||
{{CGscriptConstructors_Template|Parameters=  | |||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>ledgerName</nowiki>|Description=<nowiki>Name of the ledger that this entry belongs to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=Invoice|Name=<nowiki>invoice</nowiki>|Description=<nowiki>Invoice to associate the Ledger Entry with</nowiki>}}  | |||
|Description=<nowiki>Create new Ledger Entry</nowiki>}}  | |||
{{CGscriptConstructors_Template|Parameters=  | |||
{{CGscriptParameters_Template|Type=string|Name=<nowiki>ledgerName</nowiki>|Description=<nowiki>Name of the ledger that this entry belongs to</nowiki>|Comma=,}}{{CGscriptParameters_Template|Type=CostBill|Name=<nowiki>invoice</nowiki>|Description=<nowiki>Invoice to associate the Ledger Entry with</nowiki>}}  | |||
|Description=<nowiki>Create new Ledger Entry</nowiki>}}  | |||
|Methods=  | |Methods=  | ||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}  | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}}  | ||
|Properties=  | |Properties=  | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AccountName</nowiki>|HasGetter=1|Description=<nowiki>Gets the account name for the ledger entry.</nowiki>}}  | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>AccountName</nowiki>|HasGetter=1|Description=<nowiki>Gets the account name for the ledger entry.</nowiki>}}  | ||
{{CGscriptProperties_Template|ReturnType=  | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>AccountNumber</nowiki>|HasGetter=1|Description=<nowiki>Gets the account number for the ledger entry.</nowiki>}}  | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Actual</nowiki>|HasGetter=1|Description=<nowiki>Gets the actual amount for the ledger entry.</nowiki>}}  | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Actual</nowiki>|HasGetter=1|Description=<nowiki>Gets the actual amount for the ledger entry.</nowiki>}}  | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Budget</nowiki>|HasGetter=1|Description=<nowiki>Gets the budgetted amount for the ledger entry.</nowiki>}}  | {{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>Budget</nowiki>|HasGetter=1|Description=<nowiki>Gets the budgetted amount for the ledger entry in current selected currency.</nowiki>}}  | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Currency</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Currency used for this ledger entry. Set to Empty to use default currency</nowiki>}}  | |||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>Description</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Description of this ledger entry</nowiki>}}  | |||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>EntryId</nowiki>|HasGetter=1|Description=<nowiki>Unique id for this ledger entry</nowiki>}}  | |||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>ExchangeRate</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Exchange rate between selected currency and default currency</nowiki>}}  | |||
{{CGscriptProperties_Template|ReturnType=LedgerType constant|Name=<nowiki>LedgerType</nowiki>|HasGetter=1|Description=<nowiki>Type of ledger entry, Asset = 1, Liablility = 2, Revenue = 3, Cost = 4</nowiki>}}  | |||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>NumberOfUnits</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Number of units</nowiki>}}  | |||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}  | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}}  | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Description=<nowiki>Get information about this class.</nowiki>}}  | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}}  | ||
{{CGscriptProperties_Template|ReturnType=number|Name=<nowiki>UnitCost</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Cost per unit in the selected currency</nowiki>}}  | |||
}}  | }}  | ||
Latest revision as of 03:29, 1 February 2021
LedgerEntry
Represents a ledger entry in the budget for a resource.
Parent class
Inherits from object
Constructors
- (string ledgerName "Name of the ledger that this entry belongs to", Invoice invoice "Invoice to associate the Ledger Entry with") - Create new Ledger Entry
 - (string ledgerName "Name of the ledger that this entry belongs to", CostBill invoice "Invoice to associate the Ledger Entry with") - Create new Ledger Entry
 
Methods
- (From object) string ToString() - The string representation of the object.
 
Properties
- string AccountName { get;  } - Gets the account name for the ledger entry.
 - int AccountNumber { get;  } - Gets the account number for the ledger entry.
 - number Actual { get;  } - Gets the actual amount for the ledger entry.
 - number Budget { get;  } - Gets the budgetted amount for the ledger entry in current selected currency.
 - string Currency { get; set; } - Currency used for this ledger entry. Set to Empty to use default currency
 - string Description { get; set; } - Description of this ledger entry
 - int EntryId { get;  } - Unique id for this ledger entry
 - number ExchangeRate { get; set; } - Exchange rate between selected currency and default currency
 - LedgerType constant LedgerType { get;  } - Type of ledger entry, Asset = 1, Liablility = 2, Revenue = 3, Cost = 4
 - int NumberOfUnits { get; set; } - Number of units
 - string ObjectTypeName { get;  } - The name of the type of object.
 - (From object) TypeInformation TypeInformation { get;  } - Get information about this class.
 - number UnitCost { get; set; } - Cost per unit in the selected currency