Release AR Retainage

Form ID: (AR510000)

You use this form to create retainage documents and consolidated retainage documents for documents with retainage that have a nonzero unreleased retainage amount. For more details, see Consolidated Retainage Documents.

You can configure the system to automatically release the retainage documents that are created on this form by selecting the Automatically Release Retainage Documents check box on the Accounts Receivable Preferences (AR101000) form.

If the Approval Workflow feature is enabled on the Enable/Disable Features (CS100000) form and an approval map has been set up for the Invoice or Credit Memo document types, the retainage documents created on this form will get the Pending Approval status if the Hold Documents on Entry check box is cleared on the Accounts Receivable Preferences (AR101000) form. If the Hold Documents on Entry check box is selected, the retainage documents will get the On Hold status.

Note:

This form is available only if the Retainage Support feature is enabled on the Enable/Disable Features (CS100000) form.

Table Toolbar

The table toolbar includes standard buttons and buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are listed below.


Button	Description
Process	Initiates the creation of retainage documents for the documents with retainage that you have selected in the table (by selecting the corresponding unlabeled check boxes).
Process All	Initiates the creation of retainage documents for all documents with retainage listed on the form.

Selection Area

In this area, you select the criteria for the document lines and documents with retainage to be listed in the table.

Note:

If a document has the Pay by Line check box selected on the Invoices and Memos (AR301000) form, and at least one of its lines meets the selection criteria, the whole document is shown in the table.


Element	Description
Company/Branch	The company, branch, or company group for which you want to view documents and document lines with retainage and create retainage documents. By default, the current branch is selected. You can select a branch, company, or company group to which you have access. If a company or a branch is selected in this box, the Post Period box shows the periods from the company calendar. If a company group is selected or the box is empty, the periods from the master calendar are shown. This box appears on the form only if the Multi-Branch Support feature is enabled on the Enable/Disable Features (CS100000) form. This setting is required if the Multiple Base Currencies feature is enabled.
Date	The date on which you want to create the retainage documents that you process. By default, the current business date is selected. You can enter only a date that corresponds to a financial period that has been generated on the Master Financial Calendar (GL201000) form. If the date that you enter belongs to a financial period that has not yet been generated in the system—for example, for a date in the distant future or past—the system will display an error message, and you will not be able to save the document.
Post Period	The financial period to which you want to post the retainage documents. By default, the financial period of the specified date is selected.
Customer	The customer for which you want to view documents and document lines with retainage and create retainage documents. The list of values may be limited as follows: If a branch, company, or company group is selected in the Company/Branch box, a customer is listed (and available for selection) if the Restrict Visibility To box on the Financial tab of the Customers (AR303000) form is empty or contains this branch, the company of this branch, or company group. If the Company/Branch box is empty, a customer is listed (and available for selection) if one of the following is true: The Restrict Visibility To box is empty for the customer—that is, the customer’s visibility is not restricted. A branch, company, or company group is specified in the Restrict Visibility To box for the customer, and your user account is assigned to the role specified in the Access Role box of the Configuration Settings section of one of the following: the Branch Details tab of Branches (CS102000) form for the branch, or the Company Details tab of the Companies (CS101500) form for the company. Note: These visibility restrictions are applicable only if the Customer and Vendor Visibility Restriction feature is enabled on the Enable/Disable Features (CS100000) form.
Project	The project for which you want to view documents and document lines with retainage and create retainage documents. This box appears on the form only if the Project Accounting feature is enabled on the Enable/Disable Features (CS100000) form.
Project Task	The project task of the selected project box for which you want to release retainage or view document lines or documents with retainage. This box appears on the form only if the Payment Application by Line feature is enabled on the Enable/Disable Features (CS100000) form.
Account Group	The account group of the account specified for the document lines for which you want to release retainage or view document lines or documents with retainage. This box appears on the form only if the Payment Application by Line feature is enabled on the Enable/Disable Features (CS100000) form.
Cost Code	The cost code associated with the document lines for which you want to release retainage or view document lines or documents with retainage. This box appears on the form only if the Payment Application by Line and Cost Codes features are enabled on the Enable/Disable Features (CS100000) form.
Inventory ID	The inventory ID of the item associated with the document lines for which you want to release retainage or view document lines or documents with retainage. This box appears on the form only if the Payment Application by Line feature is enabled on the Enable/Disable Features (CS100000) form.
Ref. Nbr.	The reference number of the document with retainage. If you navigated to the current form by clicking Release Retainage on the More menu of the Invoices and Memos (AR301000) form, this box displays the reference number of the document that had been opened on the form.
Show Lines with Open Balance	A check box that indicates (if selected) that the document lines or documents with retainage that have an open balance should be listed in the table, along with the document lines and documents with retainage that have been fully paid.
Retainage Percent	The percent to be retained in the document lines or documents that are processed. The system uses the value you specify in this box when you select Process or Process All to calculate the retainage to be released for the document lines and documents selected in the table or all document lines and documents that are listed in the table. By default, 100 is specified in this box, but you can override this value. Note: If you want to release the retainage percent specified in this box for the document lines and documents, you do not need to manually override the default values provided by the value in this box.
Retainage to Release	The amount of the unreleased retainage to be released. This box is unavailable for editing and initially contains 0.00. Before you perform processing on this form, the system calculates this value as the sum of the values in the Retainage to Release column for the rows with the Included check box selected, if applicable. After you click Process All on the form toolbar, the system calculates this value as the sum of all values in the Retainage to Release column for the listed rows. The amount shown in this box has the opposite sign of that used for the amounts in the original document lines on the Invoices and Memos (AR301000). Depending on the sign of the total retainage to release for each original document, the system generates either a retainage invoice (if the Retainage to Release value is greater than or equal to 0.00) or a retainage credit memo (if the Retainage to Release value is less than 0.00).

Table

This table displays the documents with retainage that have a nonzero unreleased retainage amount and that meet the criteria specified in the Selection area.

Note:

If the Activate Migration Mode check box is selected on the Accounts Receivable Preferences (AR101000) form, the table displays only migrated documents with retainage.

Table 1. Table Columns
Column	Description
Included	An unlabeled check box that you select to create a retainage document for this document with retainage if you click Process. You select the check box in the column header to create retainage documents for all documents with retainage listed on the current page.
Branch	The branch to which this document is related.
Type	The type of the AR document—Invoice or Credit Memo.
Line Nbr.	The number of the document line. If the column is empty, the document was created with the Pay by Line check box cleared in the Summary area of the Invoices and Memos (AR301000) form. This column appears on the form only if the Payment Application by Line feature is enabled on the Enable/Disable Features (CS100000) form.
Reference Nbr.	The reference number of the document with retainage.
Customer	The identifier of the customer associated with the document.
Percent to Release	The percent of the unreleased retainage amount to be released. By default, 100 is specified. By default, the system populates this column with the value in the Retainage Percent setting of the Selection area; if you change that value, it is copied to this column for all rows. You can override the default value, if necessary.
Retainage to Release	The retained amount to be released. The system calculates this value as the percent (specified in the Percent to Release column) of the unreleased retainage amount. You can override this value, if necessary; if you do, the system will recalculate the percent to release accordingly. For credit memos, this amount is shown with the opposite sign of that used for the amounts in the original credit memo lines on the Invoices and Memos (AR301000) form.
Unreleased Retainage	The remaining unreleased retainage amount of the document with retainage after the amount specified in the Retainage to Release column is released. For credit memos, this amount is shown with the opposite sign of that used for the amounts in the original credit memo lines on the Invoices and Memos (AR301000) form.
Date	The date when the document with retainage has been created.
Total Amount	The total amount of the document with retainage, including the retainage amount. For credit memos, this amount is shown with the opposite sign of that used for the amounts in the original credit memo lines on the Invoices and Memos (AR301000) form.
Currency	The currency used for the document. This column appears on the form only if the Multicurrency Accounting feature is enabled on the Enable/Disable Features (CS100000) form.
Project	The project for which the document has been created. This column appears on the form only if the Project Accounting feature is enabled on the Enable/Disable Features (CS100000) form.
Description	The user-defined description of the document.
Post Period	The financial period to which the document has been posted.
Customer Order	The document's reference number or identifier as assigned by the customer.