BeyondERP.Newsletter
Menu

Setup page · Project management and accounting

Customer payment retention terms

A setup page where you define customer payment retention terms: the share of each project invoice that the customer holds back until the project reaches a set stage of completion.

Used by
Project accountant, Project assistant, Project manager and 1 more role
Business process
Manage project contracts
Menu item
PSACustomerRetentionTerms
Main table
PSACustomerRetentionTermTable
Data entity
ProjCustomerRetentionTermEntity
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 customer payment retention terms: the share of each project invoice that the customer holds back until the project reaches a set stage of completion.
What you do hereUse this page to have the retention amount worked out and taken off project invoices automatically.
ExampleFor example, BEAT's term RET-10 holds back 10.00 percent of each invoice until the project is 50.00 percent complete, so on a 20,000.00 invoice for PRJ-0042 the customer is billed 18,000.00 and 2,000.00 is retained.
Customer 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

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 Customer payment retention terms1 screen

Use this page to have the retention amount worked out and taken off project invoices automatically.

  1. Screen 1

    Create a customer retention term

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

    1. Select New
    2. Enter a description (the retention term number is assigned automatically)
    3. Select Add line in the schedule
    4. Enter the percentage of work complete and the customer payment retention percentage
    5. Select Save
    2DescriptionCustomer retention
    Percentage of work complete100.00
    Customer payment retention percentage10.00
    Create a customer retention term (zoomed on the outlined fields)
    Show the full screenCreate a customer retention term
    page title tab to open what to set or check

Steps from Microsoft

  1. Go to Project management and accounting > Setup > Retention > Customer payment retention terms.
  2. Select New and enter a Description for the term.
  3. In the Schedule section, select Add line and enter the Percentage of work complete and the Customer payment retention percentage.
  4. Add a line for each completion level the contract names.
  5. Select the term on the billing rule of the project contract, then create an invoice proposal.

Source: Microsoft Learn

Fields on the page

FieldWhat it meansExampleTable column
Percentage of work completeThe project completion level until which amounts are retained.Microsoft Learn 50.00CompletePercent
Customer payment retention percentageThe share of the invoice amount held back until that completion level.Microsoft Learn 10.00RetainPercent
DescriptionA short description of the customer retention term.Microsoft data model 10% until half completeDescription

Common errors and fixes

MessageWhat to do
No retention is deducted on the invoice proposal.The term isn't on the contract's billing rule, or the project has passed the completion level. Check the billing rule and the term lines. Microsoft Learn

Test checklist

  1. Create term RET-10: 10.00 percent until 50.00 percent complete.
  2. Select it on the billing rule of contract CON-0018.
  3. Create an invoice proposal of 20,000.00 for PRJ-0042.
  4. Check that 2,000.00 is retained and 18,000.00 is billed.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Set up Customer payment retention termsOne term per retention pattern used in contracts, with a line for each completion level the contract namesThe retention percentage is deducted from customer invoices until the project reaches the agreed stage, so the term must mirror the contract.Manage customer retention in the system?Creating the term but not selecting it on the contract's billing rule; invoices then carry no retention.Test: Retention deducted on the invoice

Number sequences

ReferenceShared or per companyNote
Retention termPer companyNew records on this page take their Retention term from the PSAProjRetainScheduleId reference; BEAT uses number sequence Proj_107. Checked in Dynamics 365

Feature management and licence

Licence or add-inOn the live system, Project manager and Project assistant maintain this page; Project supervisor and Project accountant can open it.

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: A term can be edited, but retention already deducted on posted invoices is only billed when it is released. Microsoft Learn
If you change it laterInvoice proposals of contracts that use the term deduct the retention from the total of the invoice lines until the project reaches the completion level. Invoices already posted keep their retention. Microsoft Learn
Technical architect

6Technical

Menu itemPSACustomerRetentionTerms Checked in Dynamics 365
FormPSACustomerRetentionTerms Checked in Dynamics 365
TablePSACustomerRetentionTermTableShown as “Customer retention terms” in Record infoKey field: RetentionTermId, Description, CustAccount, Contract, ProjId, TransDate, BillingRuleIdChecked in Dynamics 365
Data entitiesProjCustomerRetentionTermEntityProject customer retention term Microsoft data model
Who can open itPrivilegesInquire customer retention PSACustomerRetentionInquireMaintain customer retention PSACustomerRetentionMaintainDutiesInquire into project contract master ProjProjectContractMasterInquireMaintain project contract master ProjProjectContractMasterMaintainInquire customer retention PSACustomerRetentionForAccMaintain customer retention PSACustomerRetentionForManager
4 security rolesProject accountant ProjProjectAccountantProject assistant ProjProjectClerkProject manager ProjProjectManagerProject supervisor ProjProjectSupervisor
Checked in Dynamics 365
Roles to set it up and use itTo set it up or change itProject manager ProjProjectManagerProject assistant ProjProjectClerkTo use itProject supervisor ProjProjectSupervisorProject accountant ProjProjectAccountantGive people one of these roles. On this system, 4 roles 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=PSACustomerRetentionTerms
Integrate withProjCustomerRetentionTermEntity data entity Microsoft data model
Data migrationProjCustomerRetentionTermEntity Term headers, loaded for each company.ProjCustomerRetentionTermScheduleEntity Term schedule lines, loaded after the headers.Load order: Microsoft's default template 650 - Project accounting loads Project customer retention term at execution unit 1, level 650, sequence 40. Load the schedule lines after the term headers.Load first: Project contractsMicrosoft Learn
Table definitionPSACustomerRetentionTermTable columns and relations Microsoft data model
Everyone

8Sources