Skip to main content
This guide follows brokerage revenue from calculation to a paid invoice, and covers what to do when a figure is wrong or a retailer disputes an invoice. Everything here lives under Billing → Brokerage.
The Brokerage hub has six tabs: Overview, Contracts, Revenue, Runs, Invoices & RCTIs and Analytics. The header actions, such as New run, Raise invoice, import and settings, are available from every tab. Off their own tab they show as icons; hover to see the name.

How revenue gets billed

Each contract (brokerage record, identified by its OppID — the external ID) earns revenue for each connection (NMI or MIRN) and period. That revenue is billed in one of two ways, set per supplier: You can see and change each supplier’s method under Invoices & RCTIs → Supplier billing. Metering providers default to RCTI.
Every contract also has an Invoice Recipient (contract Settings tab): Supplier or Account. To bill the retailer, set it to Supplier. A contract set to Account is invoiced to the customer on its own invoice.

The monthly workflow

1

Run the month's revenue

On the Runs tab click New run, select the contracts and dates, then click Preview revenue. The run opens as a Draft so you can preview it before anything goes live. See Running a run for each field.
2

Review the draft

On the run’s Overview tab, check the If committed panel: new, changed and removed lines, the net change, coverage gaps and lines that need review.If a line’s figure looks wrong, fix the cause (missing tariff, missing meter data) and use Retry calculation, which starts a new draft over the same contracts and dates.
3

Commit or approve

  • Without approval rules, click Commit run.
  • When the run needs approval, click Submit for approval. An approver reviews the Approval tab and clicks Approve (or Reject). See Approvals for when a run needs one.
Approving a run raises invoices for every recipient that isn’t held or paid by RCTI. On the Approval tab you can Hold a recipient to keep it out of this invoice, and Release hold later.
4

Raise the invoice

If invoices weren’t raised on approval, click Raise invoice on the committed run (or from Invoices & RCTIs). The Raise invoice from unbilled revenue wizard walks through:
  1. Select suppliers (skipped when you start from a run)
  2. Unbilled revenue — tick the lines to bill
  3. Adjust fields — override the description or reference for this invoice only
  4. Billing contact — the Xero contact to bill
  5. Preview & raise — check the lines and totals, then click Raise invoice
The invoice is created as a draft in Xero. A negative total is raised as a credit note.
5

Send and reconcile

Approve and send the invoice in Xero. Under Invoices & RCTIs, open View & reconcile on an invoice and use Refresh from Xero to pick up its status and payment.
The Unbilled revenue step only lists lines that can be raised. Lines waiting on a supplier’s RCTI aren’t listed — the step tells you how many there are and to import the supplier’s statement instead.
To see how the month landed against forecast, and what’s at risk next, open the Analytics tab.

Running a run

A run calculates revenue for a set of contracts up to an end date. Start one in either of two ways:
  • New run on the Runs tab opens the Brokerage Run wizard.
  • Run for this contract (the icon on a contract’s page) starts a draft run of that contract up to today and opens it straight away.
1

Records

Narrow the list with the filters: Root Supplier, Root Account, Connection, External ID, Status, Rate Type, Start Date (From) and End Date (To). Select contracts and click Add to Selection. Selected Records shows what you’ve picked, with counts by status.
2

Review

Check the totals, then set the options:
  • Raise missing revenue adds estimates and zero-value placeholder lines where data is missing. These aren’t actual usage and can’t be invoiced.
  • Minimum adjustment sets the smallest difference from already-billed revenue that the run proposes as an adjustment.
  • Batch Description (optional) names the run.
  • Start date and Calculation End Date (both optional) limit the period calculated.
A contract with no rate basis blocks the run. Per-unit contracts need tariff rates; percentage contracts need tariff rates or basis categories. Go back and add them, or remove those contracts.
3

Preview

Click Preview revenue for N records. The run is created as a Draft and its page opens.
On the run’s page, Overview shows the run’s totals and the If committed preview, Revenue lists its draft lines and Records lists the contracts it covered. From a draft you can Commit run (or Submit for approval) or Discard it. Retry calculation starts a new draft over the same contracts and dates. To analyse revenue outside UMS, use Export CSV on the Revenue tab.

Approvals

Approval rules live in Brokerage settings: click the settings icon in the Brokerage header. In the Approval section:
  • Scheduled runs (Scheduled runs section) always wait for approval. Manual runs wait only when Manual Runs Require Approval is on.
  • Approvers can approve a run. Leave it empty to let anyone with brokerage edit access approve.
  • Require Separate Approver stops whoever started or submitted a run from approving it, unless they’re a named approver.
  • Above the Dual Approval Threshold, a run needs a second approval from one of the Secondary approvers.
  • Approval Reminder Days, Approval Escalation Days and Escalation approver chase runs left waiting.

Supplier statements (RCTIs)

When a supplier sends you a statement of what it is paying (a recipient-created tax invoice, or a commission report), import it as an RCTI rather than as plain revenue.
1

Start the import

On Invoices & RCTIs, click Upload RCTI. (From Import, turn on This file is a supplier statement (RCTI).)
2

Fill in the details

  • Supplier — who the statement is from.
  • RCTI number — the statement’s number. If it has none (Yurika’s reports don’t), leave it blank: it’s saved as RCTI-YYYY-MM from the statement period.
  • RCTI date and Statement period from / to.
  • Amounts include GST — turn on if the statement’s amounts are GST-inclusive.
  • Default charge type — for rows that don’t say whether they’re metering, VAS or other.
Known formats (Yurika, Diamond, Mondo, Plus ES, SmartestEnergy, Synergy, ZEN) are recognised automatically, with their columns mapped for you.
3

Check the preview

Each row is matched to a contract for that supplier, NMI and period:
  • Update — the statement fills in a calculated figure (“Fills in calculated XwithX with Y”); the difference shows as a variance.
  • Create — no calculated line existed, so one is added.
  • Error — fix and re-upload, or tick Exclude for that row.
  • A row on a contract set to bill the customer is still matched, with a warning to set its Invoice Recipient to Supplier.
If a row overlaps revenue that’s already billed, tick Adjustment (or Mark N overlap(s) as adjustments) to record it as the supplier’s difference instead.
4

Accept

Click Open RCTI, then Accept RCTI:
  • Turn on Raise invoice in Xero if you invoice this supplier for its statements. The whole statement is billed to that supplier on one invoice, whatever each contract’s recipient.
  • Otherwise its lines are marked as invoiced against the RCTI number (or the External invoice number you enter).
Two statements from the same supplier can’t share an RCTI number. If a supplier sends two unnumbered statements in one month, give the second its own number.

Correcting revenue

Calculated revenue is read-only once a run is committed, so the original figure is always kept. Corrections are recorded as adjustment lines. Open a line from the Revenue tab:
If you move a line but the old OppID still covers that NMI for the period, UMS asks you to confirm. End or remove the NMI on the old OppID’s agreement afterwards, or a later run will bill the period there again.

Proposed adjustments from a run

When a run recalculates a period you’ve already billed (for example, revised meter data arrived), it proposes the difference as a draft adjustment line. On the run’s Approval tab, click Review on a recipient:
  • Accept difference keeps the billed amount and drops the line. Later runs won’t propose it again unless the recalculated figure changes.
  • Drop line removes a draft line and returns its period to gaps.
  • Leave it in to bill the difference on the next invoice.

Gaps

The Revenue tab’s Coverage view shows each connection by month as Billed, Calculated, RCTI, Gap or Excluded, with the reason for each gap: not installed, no invoice, no meter data, missing tariff rate, account inactive, or not yet run. Fix the cause, then rerun.

When a retailer disputes an invoice

1

Find the lines

On Invoices & RCTIs, click View & reconcile on the invoice.
2

Choose the fix

  • Wrong amounts on a draft or unpaid invoice: select the affected rows and click Release selected. This returns them to unbilled without voiding the invoice. Correct them with Adjust or override, then raise them again or add them back (below).
  • The whole invoice is wrong: use Void invoice from the row menu. This cancels it in Xero and releases every line.
  • The invoice is paid: lines can’t be released. Raise a credit or a corrected line on the next invoice instead.
3

Tie corrected lines back to the original invoice (optional)

If you’ve edited the invoice directly in Xero, select the corrected lines on the Revenue tab, click Set Invoice ID with the invoice number, then Mark Invoiced. They then show as invoiced and won’t be raised again.
Void invoices from UMS, not by deleting them in Xero. Voiding in UMS releases the lines so they can be raised again.

Troubleshooting