Skip to main content

Creating a Payment Claim

How to send a payment claim from a contract to release retention at Practical Completion or end of the Defects Liability period.

J
Written by James Coulson

A payment claim is how Retention Track formally requests the release of retention from a contractor — once you've reached Practical Completion or the end of the Defects Liability period. Retention Track puts together the claim, generates the email to the contractor, and tracks the claim's progress through to payment.

In this article we walk you through:

  1. When you can send a payment claim

  2. Prerequisites

  3. Sending a payment claim from the contract page

  4. PC and Defects retention — two separate claims

  5. How the outstanding balance is calculated

  6. Email recipients and the workspace CC list

  7. Linking the claim to a Xero invoice

  8. Closing and reverting a payment claim

  9. Jurisdictional differences (AU and NZ vs UK)

  10. Common errors and blocking conditions

When you can send a payment claim

Retention is held against a contract in two parts: a Practical Completion (PC) portion released at the contract's PC date, and a Defects portion released at the end of the defects liability period. Each portion is claimed separately — usually the PC claim is sent first, and the Defects claim some months or years later.

The Send Payment Claim button appears on the contract page as soon as:

  • The relevant claim window has opened — the PC Date for a PC claim, the Defects End Date for a Defects claim.

  • There is an outstanding retention balance still to claim on that portion.

  • No active payment claim already exists for that portion.

Note: UK workspaces send a payment reminder instead of a formal payment claim. The flow is the same — only the button labels, dialog title and email template differ. See the Jurisdictional differences section below.

Prerequisites

Before sending a payment claim, ensure that:

  • The contract has at least one contractor contact with an email address. The claim is sent to those contacts.

  • The contract's PC Date (or Defects End Date) has passed.

  • All Xero invoices on the contract are either fully paid, or already linked to a previous payment claim. Unpaid invoices block the claim — see Common errors below.

  • You have permission to update contracts in the workspace.

Sending a payment claim from the contract page

Open the contract you want to claim against. On the contract overview, locate the retention card for the portion you're claiming — there is one card for Practical Completion (PC) and one for Defects Liability. Each card shows its claim status and the actions available for that portion.

On the card for the portion you want to claim, click Send Payment Claim (or Send Payment Reminder on UK workspaces). A dialog will open.

What's in the dialog

The dialog title reads Send New Payment Claim (or Send Payment Reminder on UK). On some jurisdictions there is also an info banner near the top with state-specific notes (for example, a window-expiry warning, or a short reminder of statutory timing rules).

The dialog has two sections:

  • Claim Details — a read-only summary of what is being claimed. It lists:
    Total Retention Withheld — the total retention held against the contract so far.
    Less Retention Used — any retention that has already been consumed (for example, applied to defect costs).
    Less Retention Released — any retention already paid back.
    Outstanding Retention Balance — what's left, and the amount that will be claimed.
    Each line has a small pill indicating whether the figure is shown inclusive or exclusive of sales tax (GST or VAT). The claim itself is always recorded exclusive of sales tax.

  • Email Preview — a live render of the exact email that will be sent to the contractor. It uses a placeholder claim number (RT-XXXX-000000); the real claim number is generated when you click Send.

Note: There are no editable fields in this dialog. The amount and the email content are derived from the contract — to change them, you need to update the contract or the contractor's contacts before sending.

Submitting

Click Send Payment Claim (or Send Payment Reminder) at the bottom of the dialog. Retention Track will:

  1. Generate a claim number for the new claim (format RT-XXXX-XXXXXX, derived from the company name and a timestamp).

  2. Email the claim to the contractor's contacts, with your workspace's CC list copied in. The email is identical to the preview, with the placeholder claim number replaced by the real one.

  3. Stamp the claim with today's date as the date sent, and set the due date according to the contract's jurisdiction (AU and NZ only — UK reminders have no due date).

  4. Record a "Payment Claim Sent" event in the contract's activity log.

After the dialog closes, the retention card on the contract page updates to show the claim's status, claim number, date sent, due date, amount claimed, and a progress bar with paid / outstanding / used segments. The action buttons on the card change to reflect the new state — for example, options to record a payment schedule (AU and NZ), lodge an adjudication notice (AU and NZ), create a Xero invoice, close the claim, or revert the claim.

PC and Defects retention — two separate claims

Each contract holds retention in two portions, and each portion is claimed independently:

  • The Practical Completion portion is claimable from the contract's PC Date.

  • The Defects portion is claimable from the contract's Defects End Date.

There is no dropdown to choose between them in the dialog — the claim type is set by which retention card you opened the dialog from. The PC card sends a PC claim; the Defects card sends a Defects claim. Both can have active claims at the same time without interfering with each other.

The PC/Defects split on a contract defaults to 50% but is configured per-contract via the PC Retention Release % field on the contract form. See Creating a Contract for details.

How the outstanding balance is calculated

The Outstanding Retention Balance shown in the Claim Details card is calculated as:

Total Retention Withheld − Retention Used − Retention Released

For the specific portion you're claiming (PC or Defects). The figures come from:

  • Withheld — retention recorded against the contract through invoices (Xero or manually logged), manual journals, and retention adjustments. Pooled withheld retention is split into PC and Defects using the contract's PC Retention Release %.

  • Used — retention recorded as consumed (for example, applied to defect costs through a manual journal or credit note tagged as "used").

  • Released — retention already paid back, either via a retention payment recorded against the contract, or via a Xero credit note tagged as "released".

The balance is always calculated exclusive of sales tax; the inclusive-tax figure shown is for reference only. The amount stored on the claim record is the exclusive figure at the moment the claim is sent — it doesn't move retroactively if new invoices or payments are added later.

Note: Xero invoices that are already linked to an earlier payment claim are excluded from the calculation. This stops a still-in-progress release on one claim from blocking or distorting a fresh claim on the other portion.

Email recipients and the workspace CC list

The payment claim email is sent to:

  • To — every contractor contact on the contract. If the contract has multiple contacts, all of them are addressed on the same email.

  • CC — the workspace's Outbound Email CC Recipients list. Any address already in the To line is removed from the CC line to avoid duplicates.

The workspace CC list is the place to add your own team's internal addresses (e.g. [email protected]) so that everyone who needs visibility is automatically copied on outbound claims. It applies to every payment claim and adjudication email sent from the workspace — it is not configurable per contract.

To configure the CC list, open Workspace Settings from the left sidebar, find the Outbound Email CC Recipients card, and add or remove email addresses. Changes take effect immediately for the next claim sent.

Linking the claim to a Xero invoice

A payment claim is a request for payment — it doesn't, on its own, create an invoice in Xero. Once the claim has been sent, the retention card shows a Create Xero Invoice button that you can use to raise the matching invoice in Xero and link it to the claim. This is optional; you can leave the claim unlinked and record payments manually if you'd prefer.

Clicking Create Xero Invoice opens a dialog showing:

  • The Xero contact the invoice will be raised to.

  • A preview of the journal — typically a debit and credit against your Retention Debtors account, and if relevant your Defect Liabilities and Sales accounts.

  • An editable Description field, pre-populated with the retention portion, contract name, identifier, and a list of the related Xero invoice numbers.

  • (UK only) A Reverse Charge Tax Type dropdown — visible only if your company has reverse charge tax type mappings configured. Defaults to no reverse charge.

Click Create Xero Invoice to submit. Retention Track will raise the invoice in Xero and link it to the claim. The button is then replaced by a green Xero invoice created badge on the card, and payment progress is tracked through that Xero invoice's payments going forward.

Note: Three things have to be in place before the Xero invoice can be created — Xero is connected for the company, a Xero sales account is linked, and the contractor is linked to a Xero contact. The dialog shows action links to fix any that are missing. See Connecting to Xero.

Once a Xero invoice is linked to a payment claim, manually recording a retention payment against that portion is no longer offered — payment progress is taken from the Xero invoice's Amount Paid instead.

Closing and reverting a payment claim

After a claim has been sent, two further actions become available on the retention card: Close Payment Claim and Revert Payment Claim. They look similar but mean different things.

Closing a payment claim

Closing a claim marks it as resolved. Click Close Payment Claim (or Close Balance on UK workspaces). A short dialog asks for a Reason for Closing, then confirms.

Use this once the retention has been paid out in full, or when the matter is settled by agreement — for example, a negotiated final figure that differs from the original claim. The card then shows the claim as resolved, with the closing reason recorded.

A closed claim is final. You cannot send a fresh claim of the same type on the contract once it's closed — closing is the natural last step in the claim's lifecycle.

Reverting a payment claim

Reverting a claim withdraws it as though it hadn't been sent. Click Revert Payment Claim (or Revert Payment Reminder on UK workspaces). A short dialog asks for an optional Reason for Reverting, then confirms.

Use this when a claim was sent in error or needs to be re-issued with corrected details. Once reverted, the claim is moved to a collapsible Reverted Claims section at the bottom of the card (for the audit trail), and the Send Payment Claim button becomes available again so you can send a fresh claim for that portion.

If the claim had a Xero invoice raised from it, reverting will also void that invoice in Xero automatically. Note that Xero won't allow voiding an invoice that has payments applied — in that case, reverse the payment in Xero first.

Note: Closing and reverting are both internal actions — neither sends an email to the contractor. If you need to notify the contractor that a claim has been withdrawn or settled, do so separately.

For a full walkthrough — including how to undo a mistake and what each action does to the retention balance — see Closing and Reverting a Payment Claim.

Jurisdictional differences (AU and NZ vs UK)

The mechanics of sending a claim are the same everywhere — what changes is the label, the email template, and what's possible after the claim has been sent.

AU and NZ

UK

Button label

Send Payment Claim

Send Payment Reminder

Dialog title

Send New Payment Claim

Send Payment Reminder

Email template

Jurisdiction-specific, with statutory language for the relevant Security of Payment Act / CC Act

Plain reminder template — no statutory language

Due date on the claim

Calculated from the jurisdiction (e.g. 10 business days for NSW)

None

Follow-up actions

Record a Payment Schedule, Lodge / Raise an Adjudication Notice, Download Adjudication Package

Not applicable

Close label

Close Payment Claim

Close Balance

Revert label

Revert Payment Claim

Revert Payment Reminder

Within Australia, the claim window timing and the statutory due date are set per state or territory. Some jurisdictions also impose a window-expiry date — once that date passes, the retention card shows a "Retention Claim Window Expired" warning but you can still send the claim if needed. The email template explains the situation.

Common errors and blocking conditions

"Cannot submit retention claim — this contract has unpaid invoices"

If the contract still has unpaid Xero invoices that aren't already linked to a previous payment claim, the dialog shows this warning and the Send button is disabled. Resolve the open invoices first — either record payment on them in Xero or write off any residual amount — then re-open the claim dialog.

Xero invoices already linked to an earlier payment claim do not block a new claim, so PC and Defects claims can run in parallel without interfering with each other.

"Retention Claim Window Expired"

For Australian jurisdictions with a defined claim window end, this warning appears on the retention card once the window has closed. The Send Payment Claim button is still available — you can send the claim, but the contractor may have grounds to dispute it on timing. Consider seeking advice before proceeding.

The Send Payment Claim button is not visible at all

If you don't see a Send button on the retention card, one of the following is true:

  • The claim window has not yet opened — the PC Date or Defects End Date is still in the future. The card will show the date the window opens.

  • There is no outstanding balance to claim. The card will show "No Retention to Recover".

  • An active payment claim of this type already exists. Revert it first if you need to send a new one.

  • You don't have permission to update this contract. Speak to your workspace owner about your role.

"Contractor email address not found"

If none of the contractor contacts on the contract have an email address, the claim cannot be sent. Edit the contract or the contractor record to add at least one contact with a valid email address, then try again.

Did this answer your question?