Latner Documentation

How to Create an Equipment Swap

Equipment Swap replaces a piece of equipment that is already on hire with another one, on the same rental contract, in a single step - so a breakdown on site doesn't turn into a pile of paperwork.

Overview

Machines break down, get called in for a service, or simply aren't coping with the job. The customer still needs a machine on site, and you still need the hire to keep running. Equipment Swap off hires what's there and starts the replacement on the same contract, on one screen.

  • The swap works on a single contract line that is currently On Rent. Both Equipment lines and Sub Hire Equipment lines can be swapped.

  • The Off Hire Date you enter becomes the off hire date for the equipment coming back; the Start Date becomes the start date for the replacement.

  • The replacement is added as a new line on the contract in Reserved status. It copies the original line's rates, charge days per week and expected off hire date, and it records which line it replaced.

  • The original line moves to Off Hire and a completed Off Hire record is created on the contract automatically.

  • You can have Latner create the delivery docket for the replacement and the pick-up docket for the returning equipment as part of the same flow.

  • The replacement can be your own equipment or sub hire equipment from a supplier.

Before You Begin

Equipment Swap needs very little set-up - mostly it needs a contract in the right state.

Requirement

Where to Find It

Edit Rental Contract permission

Security › Configuration › Permission Groups › Rental › Options. Without it, Equipment Swap doesn't appear in the Options menu.

An active rental contract with a line On Rent

The option is greyed out on contracts that are Completed, Cancelled or Lost, and the Equipment Number search only lists lines that are currently On Rent.

Allow Equipment Rentals from Different Branches (optional)

Security › Settings › Rental. When it's off, the replacement can only be equipment from the contract's own branch.

Use Branch Closing Time as Default Off Hire Time (optional)

Security › Settings › Rental. When it's on, the times on the swap default to the branch's closing and opening times.

Allow Rates Below Floor Rate permission (optional)

Security › Configuration › Permission Groups › Rental › Field. Only needed when the replacement is sub hire equipment and its rates fall below the floor rate.

00-settings.png
The two rental settings that change how the swap behaves, found by searching "Branch" in Security › Settings

Equipment Swap is for equipment that genuinely changes on site. If the machine on site was always the right one and it's the equipment number on the contract that is wrong, use Change Equipment On Hire instead - it corrects the record without off hiring anything or adding a line.

Creating the Equipment Swap

Step 1 - Open the rental contract

Go to Rental › Rental Contracts and open the contract with the equipment that needs replacing. Check the Details tab and note the line you're swapping - it needs a Detail Status of On Rent.

01-contract-lines.png
Line 2 is On Rent, so it can be swapped. The Returned line above it cannot

Step 2 - Choose Options › Equipment Swap

Select Options at the top right of the contract, then Equipment Swap.

02-options-menu.png
Equipment Swap sits just above Change Equipment On Hire in the Options menu

Step 3 - Read the two halves of the form

The dialog is in two parts. Equipment On Rent is what's coming back, and Replacement Equipment is what's going out. Every field marked below is required.

03-equipment-swap-dialog.png
The Equipment Swap dialog, with the contract number already filled in for you

Step 4 - Choose the equipment coming off hire

In the Equipment On Rent section, search the Equipment Number field and pick the line you're replacing. The search only offers lines on this contract that are On Rent, so anything already off hire, returned or not yet delivered won't appear.

  • Rental Contract - filled in for you and cannot be changed.

  • Class - fills in from the line you choose and is read-only.

  • Equipment Number - required. The search lists the line number, equipment number and description.

04-choose-on-rent-line.png
The search lists only On Rent lines, with their line numbers so you can tell duplicates apart

Step 5 - Set the Off Hire Date

Enter the date and time the equipment stops being on hire. This is the date the customer stops being charged for it, so use the time the machine actually came off the job.

Picking the line also fills the Class in the Replacement Equipment section with the same class, which is usually what you want - like for like.

05-off-hire-date.png
The Off Hire Date drives the billing on the original line, so it's worth getting right the first time

Step 6 - Choose the replacement equipment

Leave Line Type as Equipment to send out one of your own machines, then search the Equipment Number field in the Replacement Equipment section.

  • Line Type - required. Equipment or Sub Hire Equipment.

  • Class - required. Change it if you're replacing with a different class; the Equipment Number clears when you do.

  • Equipment Number - required for an Equipment line. The list is limited to rentable equipment in the chosen class, and to the contract's branch unless Allow Equipment Rentals from Different Branches is enabled.

Rows are highlighted in orange when that machine is sitting in a run up or return inspection, so you can see at a glance which units still have work to clear before they go out.

06-choose-replacement.png
The replacement search shows the branch and available quantity for each unit in the class

Step 7 - Set the Start Date and check the form

Enter the date and time the replacement starts on hire. It's often the same day as the off hire, but it doesn't have to be - use the real times and the billing follows.

07-completed-form.png
A completed swap: ES32002 comes off hire at 8:00 am and ES32006 starts at 10:00 am the same day

The Start Date can't be later than the line's Expected Off Hire Date. If it is, saving fails with Expected Off Hire Date cannot be before the Start Date, because the replacement line inherits the expected off hire date from the line it replaces. Extend the contract line's expected off hire date first, then run the swap.

Step 8 - Create the transport dockets (optional)

Tick Delivery to raise a delivery docket for the replacement, and Pick-Up to raise a pick-up docket for the equipment coming back. The button at the bottom changes from Finish to Next, and you step through the docket forms before the swap is saved.

09-create-transport-options.png
With either box ticked, the button becomes Next rather than Finish

The Create Delivery form opens first, already carrying the customer, site, contact and addresses from the contract, and listing the replacement equipment. The Create Pick Up form follows with the equipment coming off hire. Line numbers show as TBD because the contract line doesn't exist yet, and the quantities are fixed to the quantity on the line being swapped. Check the Due Date / Time and the addresses on each docket before moving on.

10-create-delivery.png
The delivery docket for the replacement machine, prefilled from the contract

Step 9 - Save

Select Finish on the last form. Latner confirms with Equipment Swapped and the contract refreshes with the new line on it.

Swapping To or From Sub Hire Equipment

When your own fleet can't cover the replacement, set Line Type to Sub Hire Equipment. The form then asks for the sub hire details instead of an equipment number:

  • Sub Hire Equipment Number - defaults to X- followed by the class name. Replace it with the supplier's unit number once you know it.

  • Supplier and Supplier Site - both required. Choosing a supplier defaults the site to that supplier's first site, and any pop-up note on the supplier is shown.

  • Sub Hire Rental Rates - the pricing method and rates you're paying the supplier for the replacement.

08-sub-hire-fields.png
A sub hire replacement asks for the supplier, the site and the rates you'll be charged

It also works the other way around. If the line coming off hire is a sub hire item, Line Type locks to Equipment - a sub hire line can only be replaced with equipment you own, which is exactly what you want when a supplier's machine goes back and yours takes over.

08b-sub-hire-on-rent.png
Swapping a sub hire line: Line Type is greyed out and fixed to Equipment

After the Swap

  • The original line moves to Off Hire with the off hire date you entered, and its equipment's rental status becomes Off Hire.

  • A new line is added at the end of the contract with the next line number, in Reserved status (or Pending Delivery if you created a delivery docket). Its sub status shows what it's waiting on next, such as a purchase order, payment or a delivery docket.

  • The replacement line copies the original line's rates, pricing method, charge days per week, quantity and expected off hire date, and records that it replaced the original line.

  • The replacement equipment's rental status becomes Reserved, so it can't be committed to another contract.

  • A completed Off Hire record appears on the contract's Off Hire tab, using the contract's delivery contact, phone, email and address.

  • Any delivery and pick-up dockets you asked for appear on the Transport tab.

11-after-swap-lines.png
After the swap: line 2 is Off Hire and the replacement has been added as line 4 in Reserved
12-off-hire-record.png
The swap raises a completed Off Hire record with the contract's site contact details

The swap off hires the equipment - it does not return it. The original machine stays on the contract in Off Hire until you process a Return, which is what brings it back into the fleet and closes off its meter reading and inspection. Until then it isn't available to hire to anyone else.

FAQs

Equipment Swap is greyed out in the Options menu. Why?

The contract is Completed, Cancelled or Lost. Swaps only run on live contracts - reopen the contract first if the equipment really did change on site.

The line I want to swap isn't in the Equipment Number list.

Only lines that are currently On Rent can be swapped, and only Equipment and Sub Hire Equipment lines. A line still in Reserved or Pending Delivery hasn't gone out yet, so change the equipment on the line itself instead. A line already Off Hire or Returned has finished its run.

The replacement machine I want isn't in the list.

The list is limited to rentable equipment in the class shown, and to the contract's branch unless Allow Equipment Rentals from Different Branches is enabled. Change the Class if you're replacing with a different class, and check the machine isn't already on hire or reserved elsewhere.

Saving fails with "Expected Off Hire Date cannot be before the Start Date".

The replacement line inherits the expected off hire date from the line it replaces, and your Start Date is later than that date. Update the expected off hire date on the contract line to cover the new hire period, then run the swap again.

Can I swap only part of a line?

No. The swap off hires the whole quantity on the line and puts the same quantity on the replacement line. If only some of the units are being replaced, off hire the units coming back on their own first, then add the replacement.

I got the equipment number wrong - it was never on site. Should I swap it?

No. Use Change Equipment On Hire. It repoints the existing line - along with its transport, inspections, off hires, returns, invoices and meter readings - at the correct machine, without off hiring anything or adding a line. Equipment Swap is for equipment that genuinely changed on site.

Does the customer get charged twice for the changeover day?

Only if the dates overlap. Each line is billed against its own dates - the original up to its off hire date and time, the replacement from its start date and time - so set the times to reflect what actually happened on site.

Can I undo a swap?

There's no single undo. The swap leaves two things behind: an Off Hire record on the original line, and a new Reserved line for the replacement. Cancel the off hire to put the original line back On Rent, and delete the replacement line while it's still Reserved and has no transport docket against it.

Watch the Demo

Prefer to watch it? Step through the same flow here.