com.ibm.rpm.financial.containers
GenericChargeCode

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

GenericChargeCode
Extends: com.ibm.rpm.framework.RPMObject
Child objects:
   com.ibm.rpm.financial.containers.ChargeCode
   com.ibm.rpm.financial.containers.ChargeCodeCategory

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

A GenericChargeCode is either a charge code or a charge code category. It is used to load or delete either the charge code or the charge code category that matches the provided identifier (see RPMObject.ID).

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

ID

Field Summary
xsd:string description
   Detailed description of the charge code.
xsd:string externalID
   The identifier used to reference an external system.
xsd:string name
   Name of the charge code or charge code category, as displayed in the RPM client.

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 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.
RPMObject parent
   The parent of the RPMObject.

Field Detail

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.


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.


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.


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.


parent


RPMObject parent
The parent of the RPMObject.

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.