| Table of Contents | ||||
|---|---|---|---|---|
|
Capability
This Import will allow the User to add or update Charges on Services for Billing. In order to add a charge to a Service, the "Billable" flag of the Service must already be set.
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.
...
For updates, the import needs to find the charges to update. At a minimum, the Service ID, Charge Catalog, and Charge Type must be provided. Optionally the Start Date, Override Amount, and Quantity can be provided. If the values provided match more than one charge, then all of those that match will be updated. 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.
Allowed values can be formatted, unformatted, or it can be a Service Alias value.
Charge Catalog Name
Conditionally Required (unless Charge Catalog Full Name is provided instead)
...
The SERVICE_CHARGE_TYPE flag can also be used to help define which catalog you are trying to use.
NOTE: Instead of mapping the Catalog Name or the Catalog Full Name, the Catalog can be set in the Import Record Format.
If the Import Record Format has a value and it is also mapped, the mapped value takes precedence.
Charge Catalog Full Name
Conditionally Required (unless Charge Catalog Name is provided instead)
Datatype is Hierarchical String.
Default value is blank.
This is the full hierarchical path of the Charge Catalog.
...
The SERVICE_CHARGE_TYPE flag can also be used to help define which catalog you are trying to use.
NOTE: Instead of mapping the Catalog Name or the Catalog Full Name, the Catalog can be set in the Import Record Format.
If the Import Record Format has a value and it is also mapped, the mapped value takes precedence.
Service Type
Datatype is String.
If a value is provided the Import will Import will limit the Service ID Search to Services of that type.
Allowed values are from the SERVICE_TYPE List Values.
All Service Types are valid for Service Charge Imports.
...
This will override the Charge Catalog Description for Billing.
Expense GLA
Datatype is Hierarchical String.
Override Amount
Datatype is Number.
...
If this is set, it must be set to the code of one of the CHARGE_TYPE List Values from the the List Values grid grid.
Allowed values are the System Use Values: MONTHLY_RECURRING, NONRECURRING, QUARTERLY, SEMI_ANNUAL, and ANNUAL_RECURRING.
...
When an Import Line fails, it is usually because the Line falls into one of the following categories:
The value provided from another table was not found, or multiple matches found within the Database
Toggle cloak Cloak - Error : No Matching Charge Catalog entries for '<chargeCatalogName>'
- Error : Multiple Matching Charge Catalog entries for '<chargeCatalogName>'
- Error : No service record for service ID <serviceId>
- Error : Multiple service records for service ID <serviceId>
- Error : Invalid Expense GLA '<EXPENSE_GLA>'
- Error : Invalid Charge Catalog '<chargeCatalogName>'
- Error : Full Charge Catalog Path <CHRG_CATALOG_FULL_NAME> is Invalid
The value provided from another table is Inactive
Toggle cloak Cloak - Error : Trying to use Inactive Charge Catalog <chargeCatalogName>, on service <serviceId>
A blank value was provided, for a field with a required value
Toggle cloak Cloak - Error : Missing Charge Catalog"
- Error : Service ID is blank
- Error : Service ID not set
The value provided is not acceptable for the record type being created
Toggle cloak Cloak - Warning: Not updating Prorate flag because new Stop Date is before today
- Warning: Not updating Amount because new Stop Date is before today
- Warning: Not updating Override Amount because new Stop Date is before today
- Warning: Not updating Quantity because new Stop Date is before today
- Warning: Not updating GLA because new Stop Date is before today
- Error : Unable to convert '<BILL_DATE>' into a valid date
- Error : Unable to convert '<STOP_DATE>' into a valid date
- Error : Trying to assign amount for Non-Overridable Charge <chargeCatalogName>, on service <serviceId>
- Error : Service <serviceId> is Available
- Error : Service <serviceId> is not Billable
- 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 : Import Format references obsolete 'Amount' field. Replace it with 'Override_Amt'.
The System was unable to save the record
Toggle cloak Cloak - Error : Failed to save Services_Charges record; <errorMessage>
If you experience any of these Errors, without another accompanying Message about what might have caused the Save Failure, please submit a Ticket to PCR.
Notes
By default, the GLA Charges import always adds new charges. It never updates or removes charges. This can create duplicates.
If the UPDATE flag is 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.
If an NRC has been billed, it cannot be updated in any way.
For an existing Monthly Recurring Charge, if you update the GLA, Amount, or Quantity, it will stop the existing Charge and create a new Charge with the appropriate changes. The date of this stop and start is determined by the Effective Date flag. If this is set to 'TODAY', then it will stop the existing charge with yesterday's date, and start the new charge with today's date. If it is set to 'BACKDATE', then it will use the date that the existing charge has been billed through.
If you update existing Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), they will stop and start like MRCs, but they will always behave as if the Effective Data is set to 'BACKDATE'.