Versions Compared

Old Version 2

changes.mady.by.user Brian Dixon

Saved on

compared with

New Version Current

changes.mady.by.user Amber Cowles

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Charge Catalog Full Name

Datatype is Hierarchical String.

This is the full test path of the Charge Catalog.

...

This can be used in place of the Charge Catalog Name. This expects the full catalog Path.

Each Catalog Name in the full path should be separated by the HIERARCHYPATH_CONCATENATOR .

Service Type

Datatype is String.

...

Permitted values are from the SERVICE_TYPE List Values

All Service Types are valid for Service Charge Imports.

Bill Date

Datatype is StringDate.

This can come from a mapping or the Import File selection form. Mapping takes precedence.

...

This will override the Charge Catalog Description for Billing.

Expense GLA

Datatype is Hierarchical String.

Override Amount

Datatype is String Number.

This is only allowed if the Charge Catalog entry allows 'Override Charge Amount '.

Stop Date

Datatype is StringDate.

Default value is blank.

Used for MRCs only.

...

New Override Amount

Datatype is String Number.

Default value is blank.

This is only allowed if the Charge Catalog entry allows overrides. Used for updates.

New Quantity

Datatype is Stringis Number

Default value is blank.

Used for UPDATE only.

RECID

Datatype is String Number.

Default value is blank.

This is used only as a lookup key for Charge Updates.

Effective Date

Data type is String.

Default value is blank.

This is not a date field. Allowed values are: BACKDATE or TODAY

Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use BACKDATE as the Effective Date.

Prorate Flag

Datatype is Boolean.

Default Value = is False.

Permitted Values: 1, Yes, and True sets the Prorate flag to True [1].

All other Values will enter as False [0].

Quantity

Datatype is String.

UPDATE flag

Data type is Boolean.

Default value is False.

Permitted Values: 1, Yes, and True will set the Prorate flag to True [1].

If set, this import will UPDATE existing records. If the import cannot find an existing record to UPDATE, it will error.

Number.

Service RECID

Datatype is Number.

...

Flags / Conditional Logic

SERVICE_CHARGE_TYPE

...

Default Value = 'NONRECURRING'

  • This flag is only needed if there are multiple Charges with the same Names that have the different types.
  • If this is set, it must be set to the code of one of the CHARGE_TYPE List Values from the List Values grid.
  • The only allowed values are the System Use Values: MONTHLY_RECURRING, NONRECURRING, QUARTERLY, SEMI_ANNUAL, and ANNUAL_RECURRING.

UPDATE

Datatype is Boolean.

Default value is False.

Permitted Values: 1, Yes, or True will turn on this flag.

...

Warnings and Errors

The following warnings display if the Service Charge UPDATE fails:

  All other values are false.

If set, this import will UPDATE existing records. If the import cannot find an existing record to UPDATE, it will error.

Effective Date

Data type is String.

Default Value is TODAY.

Allowed values are BACKDATE and TODAY.

This flag is used to determine the date that an updated charge will stop and restart.

Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated, will always use BACKDATE as the Effective Date.

See the Notes for more details.

Errors

When an Import Line fails, it is usually because the Line falls into one of the following categories:

  1. 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

  2. The value provided from another table is Inactive
     Toggle cloak
     Cloak
    • Error : Trying to use Inactive Charge Catalog <chargeCatalogName>, on service <serviceId>

  3. 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

  4. 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
The following errors display if the Service Charge INSERT or UPDATE fails:
...
    • 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'.

  2. 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 an NRC has been billed, it cannot be updated in any way.
If an existing Monthly Recurring Charge has been billed,  it can be updated. Changing then Updating the GLA, Amount, Quantity, or Prorate Flag,  the new Charge stops the previous will stop the existing Charge and create a new Charge  record begins  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  used 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  current existing charge has been billed through.