Payment Hold Options

Payment Hold Options (PHLDOP) table is used to control Payment Hold related options system-wide per Fiscal Year. This table should only be established when the Application Parameters (APPCTRL) Automated Payment Hold parameters is set to True. This indicates your site is using the automated payment hold feature of Advantage.

Field InformationField Information

The following are notable fields on the Payment Hold Options table:

Flags

Description

Hold Award Option

CVL options include Single Accounting Line or All Accounting Lines for a Vendor. The Default value is All Accounting Lines for a Vendor.

If set to Single Accounting Line a partial disbursement of payment request may result for any un-held accounting lines at the Award level.

If set to All Accounting Lines for a Vendor, then a payment request to a vendor will be held if at least one of the associated accounting lines is held at the Award Level.

Automated Payment Hold Department

This is a required field and must be valid on the Department (DEPT) table. The Automated Payment Hold Department code with the Automated Payment Hold Unit will be associated with either the Cancellation Type of Hold or Cancellation Type of PR Cancellation when a disbursement is cancelled.  These values will be used to create records with a Payment Hold Action of Hold Request on the Payment Hold Maintenance table.

The Hold Type, Automated Payment Hold Department, and Automated Payment Hold Unit will be used to validate the Hold Type on the Payment Hold Type by Department table.

Automated Payment Hold Unit

This is a require field and must be valid on the Unit (UNIT) table. The Automated Payment Hold Unit code with the Automated Payment Hold Department code will be associated with either the Cancellation Type of Hold or Cancellation Type of PR Cancellation when a disbursement is cancelled.  These values will be used to create records with a Payment Hold Action of Hold Request on the Payment Hold Maintenance table.

Cancellation Hold Type

The Cancellation Type of Hold is used to cancel disbursement transactions.  Submitted Cancellation transactions with Hold Cancellation Type will require creation of payment hold records on the Payment Hold Maintenance table instead of setting the User Hold to Yes and populating a Payment Hold Reason.  The Automated Payment Hold batch process will run prior to the AD Chain to populate the Hold Type fields on DISRQ table based on active payment hold requests on the Payment Hold Maintenance table, which will prevent the payment request from being disbursed.

The combination of the Cancellation Hold Type, Automated Payment Hold Department, and Automated Payment Unit entered must be a valid and active record on Payment Hold Type by Department table.

When looking for a matching record, the system will first validate the specified Payment Hold Type, Payment Hold Type Department, and Payment Hold Type Unit.  If a match cannot be found, it will attempt to find a match for the specified Payment Hold Type, Payment Hold Type Department, and a Payment Hold Type Unit of ALL.  If a match is still not found, the system will attempt to find a match for the specified Payment Hold Type, a Payment Hold Type Department of ALL, and a Payment Hold Type Unit of ALL.  If a match is still not found or is not active, an error will be issued.  

If a matching active record is found on the Payment Hold Type by Department table; however, the Hold Level is not set to Automated Vendor for the Hold Type, Payment Hold Type Department, and Payment Hold Type Unit, then an error will be issued.

Cancellation Payment Request Type

Cancellation Type of PR Cancellation is used to cancel disbursement transactions.  The combination of the Cancellation Payment Request Type, Automated Payment Hold Department, and Automated Payment Hold Unit entered must be a valid, active record on Payment Hold Type by Department table.

If a matching active record is found on the Payment Hold Type by Department table, however, the Hold Level is not set to Automated Vendor for the Hold Type, Payment Hold Type Department, and Payment Hold Type Unit, then an error will be issued.