| Table of Contents | ||||
|---|---|---|---|---|
|
Capability
This Import will allow the User to add or update Charges on Services for Billing.
By default this import will always Add new charges, not Update existing charges. Care should be taken, as this can create duplicate charges.
There is an optional UPDATE Flag that can be set to force the Import to do Updates instead of Adds.
The import cannot delete existing charges, but it can set an existing MRC charge Stop Date to end the charge.
Matches On
For adds and updates, the import will usually use the Service ID to find the Service record to apply the Charge to. In cases where the Service ID is blank, the Service records RECID can be used.
...
Alternatively, the Service Charge RECID can be provided, and this will override all other key values to find the exact Service Charge to update.
Fields
Service ID
Required
Datatype is String.
Charge Catalog Name
Required
Datatype is String.
...
The Charge Catalog Name expects just the name, and will only work if the name is unique in the whole catalog.
Charge Catalog Full Name
Datatype is String.
This is the full test path of the Charge Catalog.
...
For example, Charges > MRC > Monthly Fee
Service Type
Datatype is String.
Bill Date
Datatype is String.
This can come from a mapping or the Import File selection form. Mapping takes precedence.
...
This is the transaction date for NRCs or Start Date for MRCs
Description
Datatype is String.
This will override the Charge Catalog Description for Billing.
Expense GLA
Datatype is String.
The full GLA Path must be used with Components separated by " > ".
Override Amount
Datatype is Number.
This is only allowed if the Charge Catalog entry allows 'Override Charge Amount '.
Stop Date
Datatype is String.
Default value is blank.
Used for MRCs only.
NRCs ignore this field.
New Override Amount
Datatype is Number.
Default value is blank.
...
This field is only used for UPDATES.
New Quantity
Datatype is String.
Default value is blank.
This field is only used for UPDATES.
RECID
Datatype is String.
Default value is blank.
This field is only used for UPDATES.
Quantity
Datatype is String.
Default Value is 1.
Service RECID
Datatype is Number.
Default is blank.
This is used to specify the Service Record for Services that have a blank Service ID. If this is provided, the provided value must be a valid existing service RECID. If it is not, it will cause an error. The only Service Type permitted to have blank Service IDs is Other Services .
Child Records
Service Charges are a Child record of Services. As such, they can only be added to existing Service IDs.
Flags / Conditional Logic
SERVICE_CHARGE_TYPE:
Default Value is 'NONRECURRING'.
...
The only allowed values are the System Use Values: MONTHLY_RECURRING, NONRECURRING, QUARTERLY, SEMI_ANNUAL, and ANNUAL_RECURRING.
UPDATE:
Default value is False.
Data type is Boolean.
...
If set, the Import will only update existing Charges. This can be used to set Stop Dates on MRCs, or change Override Amounts, Quantity, Description, GLA, or Prorate flag.
PRORATE:
Default Value is False.
Datatype is Boolean.
...
All other Values will enter as False [0].
Effective Date
Data type is String.
Default value is blankTODAY.
This is not a date field. Allowed values are: BACKDATE or TODAY
This field is only used for UPDATES.
See the Notes for more details.
Warnings and Errors
The following warnings display if the Service Charge UPDATE fails:
...
- Error : Import Format references obsolete 'Amount' field. Replace it with 'Override_Amt'.
- Error : Service ID not set
- Error : Service ID is blank
- Error : No service record for service ID <serviceId>
- Error : Multiple service records for service ID <serviceId>
- Error : Service <serviceId> is Available
- Error : Service <serviceId> is not Billable
- Error : Full Charge Catalog Path <CHRG_CATALOG_FULL_NAME> is Invalid
- Error : Charge Type <CHARGE_TYPE_CODE> is Invalid
- Error : Service's Dept Hierarchy owner has no Billing Group
- Error : Service's Contact owner has no Billing Group
- Error : Service <serviceId> has no Owner
- Error : Trying to use Inactive Charge Catalog <chargeCatalogName>, on service <serviceId>
- Error : Trying to assign amount for Non-Overridable Charge <chargeCatalogName>, on service <serviceId>
- Error : Invalid Charge Catalog '<chargeCatalogName>'
- Error : No Matching Charge Catalog entries for '<chargeCatalogName>'
- Error : Multiple Matching Charge Catalog entries for '<chargeCatalogName>'
- Error : Missing Charge Catalog"
- Error : Invalid Expense GLA '<EXPENSE_GLA>'
- Error : Unable to convert '<BILL_DATE>' into a valid date
- Error : Unable to convert '<STOP_DATE>' into a valid date
- Error : Failed to save Services_Charges record; <errorMessage>
Notes
| Anchor | ||||
|---|---|---|---|---|
|
By default, the GLA Charges import always adds new charges. It never updates or removes charges. This can create duplicates.
...