BeyondERP.Newsletter
Menu

Setup page · Project management and accounting

Vendor payment retention terms

A setup page where you define vendor payment retention terms: the share of vendor invoices your organization holds back until a project reaches a set stage of completion.

Used by
Project manager
Business process
Manage project financials
Menu item
PSAVendorRetentionTerms
Main table
PSAVendorRetentionTermsTable
Data entity
ProjVendorRetentionTermEntity
Setup steps
1 on this page
Show what matters for
PAGE GUIDEWhat the page does and how to use it8 sections. Choose a role to highlight what matters to you.
Everyone

1What it is and why

What it isA setup page where you define vendor payment retention terms: the share of vendor invoices your organization holds back until a project reaches a set stage of completion.
What you do hereUse this page to set the retention percentage for vendor payments and the share of retained amounts to release at each completion level.
ExampleFor example, BEAT's term for the trainer V-0520 retains 20.00 percent until 50.00 percent of the ordered hours are delivered and releases it at 100.00 percent, so of the first 15,000.00 invoice BEAT pays 12,000.00 and holds 3,000.00.
Vendor payment retention terms page in Dynamics 365
The page in Dynamics 365. page title tab to open what to set or check
Functional consultant · Solution architect

2Where it fits

Business processManage project financials
Menu pathProject management and accounting › Setup › Retention › Vendor payment retention terms
Set up firstProject management and accounting parameters Microsoft Learn
Used next byAll projects Microsoft Learn Project purchase orders Microsoft Learn
Related pagesVendor invoices with retention Microsoft Learn
End user · Functional consultant

3How to do it

About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.

Step by step, with screenshots

Set up Vendor payment retention terms1 screen

Use this page to set the retention percentage for vendor payments and the share of retained amounts to release at each completion level.

  1. Screen 1

    Create a vendor retention term

    Go to Project management and accounting > Setup > Retention > Vendor payment retention terms

    1. Select New
    2. Enter a description (the rule ID is assigned automatically)
    3. Select Add line in the terms
    4. Enter the percentage of units delivered and the percentage to retain
    5. Leave Percentage to release at 0 on the first line, and use it on later lines to release retained amounts
    6. Select Save
    2DescriptionVendor retention
    Percentage of units delivered100.00
    Percentage to retain10.00
    Percentage to release0.00
    Create a vendor retention term (zoomed on the outlined fields)
    Show the full screenCreate a vendor retention term
    page title tab to open what to set or check

Steps from Microsoft

  1. Go to Project management and accounting > Setup > Retention > Vendor payment retention terms.
  2. Select New; the Rule ID is filled in for you.
  3. In the Description field, enter a short description.
  4. On the Terms FastTab, select Add line.
  5. Enter the Percentage of units delivered and the Percentage to retain.
  6. Add lines for the Percentage to release at each completion level.

Source: Microsoft Learn

Fields on the page

FieldWhat it meansExampleTable column
Rule IDThe ID of the term, filled in automatically.Microsoft Learn VRT-0003VendorRetentionTermId
Percentage of units deliveredThe share of the ordered units the vendor has delivered on the project; amounts are retained until delivery reaches this level.Microsoft Learn 50.00WorkPercentageComplete
Percentage to retainThe share of the vendor invoice amount held back.Microsoft Learn 20.00PaymentRetentionPercentage
Percentage to releaseThe share of earlier retained amounts released at a completion level.Microsoft Learn 0.00PaymentRetentionReleasePercentage
DescriptionA short description of the vendor retention term.Microsoft Learn Trainer 20% until half deliveredDescription

Common errors and fixes

MessageWhat to do
No retention is taken on a project vendor invoice.The term isn't on the project's Vendor agreements FastTab for that vendor. Add a vendor agreement line with the term. Microsoft Learn

Test checklist

  1. Create a term with lines 50% delivered / 20% retain / 0% release, 80% / 10% / 10% and 100% / 0% / 100%.
  2. On a test project, add a Vendor agreements line with Account code Table, the vendor and the new term.
  3. Create a purchase order for the vendor on the project and check the retention term shows on it.
  4. Invoice the first 50% of units and check that 20% of the invoice amount is retained and the rest is payable.
  5. Invoice the remaining units and check that the held amounts are released at 80% and 100%.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Set up Vendor payment retention termsOne retention term per agreed retention pattern, with a separate line for each completion milestone (Percentage of units delivered) and its own Percentage to retain and Percentage to release, ending with a 100% line that releases what is still heldLearn says to enter a separate term line for each level of project completion, each with its own retain and release percentage. The Learn example ends with a 100% line that retains nothing and releases 100%, so the vendor is paid in full at completion.Which vendors should a vendor payment retention term apply to on a project?Creating the term but never adding it to the project. The term only works once it is selected on the project's Vendor agreements FastTab for the vendor, the vendor group or All vendors.Test: Vendor retention held and released by completion

Feature management and licence

Licence or add-inOn the live system, Project manager maintains this page.

Checked in Dynamics 365

Solution architect

5Design impact

Shared or per companyPer company: each legal entity has its own records. Microsoft data model
Can it be undoneHard to reverse: Terms can be edited or replaced on the project's Vendor agreements FastTab, but retention already taken on posted vendor invoices is only paid out through the release percentages as the project reaches each completion level. Microsoft Learn
If you change it laterVendor invoices for projects whose vendor agreement uses the term retain the percentage until delivery reaches each level, and release earlier retention by the release percentage. Microsoft Learn
Technical architect

6Technical

Menu itemPSAVendorRetentionTerms Checked in Dynamics 365
FormPSAVendorRetentionTerms Checked in Dynamics 365
TablePSAVendorRetentionTermsTableShown as “Retainage schedule” in Record infoChecked in Dynamics 365
Data entitiesProjVendorRetentionTermEntityProject vendor retention term Microsoft data model
Who can open itPrivilegesInquire vendor retention PSAVendRetentionInquireMaintain vendor retention PSAVendRetentionProjManagerDutiesMaintain vendor retention PSAVendRetentionProjManager
1 security roleProject manager ProjProjectManager
Checked in Dynamics 365
Roles to set it up and use itTo set it up or change itProject manager ProjProjectManagerGive people one of these roles. On this system, 1 role can open this page.Checked in Dynamics 365
Actions on the pageOptions: Personalize, Page options, ShareChecked in Dynamics 365
Developer

7Developer

Open it by URLhttps://<your-environment>/?mi=PSAVendorRetentionTerms
Integrate withProjVendorRetentionTermEntity data entity Microsoft data model
Data migrationProjVendorRetentionTermEntity (Project vendor retention term): loaded for each company, in Microsoft's default template 650 - Project accounting.Load order: Microsoft's default template 650 - Project accounting loads Project vendor retention term at execution unit 1, level 30, sequence 10. Lower levels load first, and entities at the same level load in sequence order.Load first: the default templates at lower levels (System setup to General ledger)Microsoft Learn
Table definitionPSAVendorRetentionTermsTable columns and relations Microsoft data model
Everyone

8Sources