com.ibm.rpm.financial.containers
ChargeCode

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.financial.containers.GenericChargeCode
   extended bycom.ibm.rpm.financial.containers.ChargeCode

ChargeCode
Extends: com.ibm.rpm.financial.containers.GenericChargeCode
Child objects: None

Related scope: com.ibm.rpm.financial.scope.ChargeCodeScope

A ChargeCode represents an organization's chart of accounts for non-labor cost estimating and tracking during project execution.

Parent is mandatory, allowed parent type is ChargeCodeCategory.

Note: Charge codes may not be deleted if they are a system chargecode or if they have a external reference number.

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Rules to delete: The object is deletable only if it doesn't have a external ID.

Field Summary
ChargeCode associatedChargeCode
    A link to the associated charge code.
xsd:boolean billable
   Billable benefits can be described as those that are typically passed to the project client, either as expense flow-thru or as revenue. The tracking of billable benefits is normally done in project real-time as billing occurs.
FinancialCategory financialCategory
    The financial category type for this charge code.
ChargeCodeState state
   Defines the current use of the charge code.

Inherited Field Summary
xsd:string contextName
   The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.
xsd:boolean deleted
   If the value of this field is set to true, then the RPMObject will be deleted when performing a save.
xsd:string description
   Detailed description of the charge code.
xsd:string externalID
   The identifier used to reference an external system.
xsd:string ID
   The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.
xsd:string name
   Name of the charge code or charge code category, as displayed in the RPM client.
RPMObject parent
   The parent of the RPMObject.

Field Detail

associatedChargeCode


ChargeCode associatedChargeCode
A link to the associated charge code.

Scoping: This field will be used by the API if the scope field associatedChargeCode is enabled.

Relationship: This field is a reference relationship.

Valid types:
com.ibm.rpm.financial.containers.ChargeCode

billable


xsd:boolean  billable
Billable benefits can be described as those that are typically passed to the project client, either as expense flow-thru or as revenue. The tracking of billable benefits is normally done in project real-time as billing occurs.

Null value: This field may never be null.


financialCategory


FinancialCategory financialCategory
The financial category type for this charge code.

Null value: This field may never be null during updates.

Relationship: This field is a reference relationship.

Default value: This default value is Benefit.


state


ChargeCodeState state
Defines the current use of the charge code.

Scoping: This field will be used by the API if the scope field state is enabled.

Relationship: This field is a reference relationship.

Valid types:
com.ibm.rpm.applicationadministration.containers.ChargeCodeState

Inherited Field Detail

contextName


xsd:string  contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


description


xsd:string  description
Detailed description of the charge code.

Maximum: The maximum length for this field is 2048 characters.


externalID


xsd:string  externalID
The identifier used to reference an external system.

Maximum: The maximum length for this field is 32 characters.


ID


xsd:string  ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject.

Read-only behavior: The value of this field is read only.


name


xsd:string  name
Name of the charge code or charge code category, as displayed in the RPM client.

Minimum: The minimum length for this field is 1 characters.

Maximum: The maximum length for this field is 50 characters.

Null value: This field may never be null.


parent


RPMObject parent
The parent of the RPMObject.

Null value: This field may never be null.

Scoping: This field will be used by the API if the scope field parent is enabled.

Read-only behavior: The value of this field is read only after the object was created.

Relationship: This field is a reference relationship.

X-Path availability: This field doesn't support X-Path queries.

Valid types:
com.ibm.rpm.financial.containers.ChargeCodeCategory