Functional Weave
Code in TypeScript

Suites · telecoms

Telecoms billing

Rating and billing for telecoms: calls from a rate deck, data allowances and overage, roaming, plus recurring plan billing and VAT.

55 capabilities (27 core, 28 optional) and 11 gaps, in build order. Put each line in the file that calls it, then fune build.

Calculates tax from published rules; it is not tax advice. Have an accountant check how the app uses it before anyone files a return.

1. Usage rating

Turn usage records into charges.

telecoms.call-rating core
Rates a call from a rate deck: longest-prefix destination, billing increments, connection fee and minimum charge.
Rate a call from a rate deck: longest-prefix destination match, billing increments, connection fee and minimum charge.
import { rateCall } from "#fune/telecoms.call-rating@^1";
telecoms.data-allowance core
Data used and remaining in a bundle, and the overage charge in whole blocks with a spend cap.
Mobile data allowance used and remaining, and the overage charge in whole blocks with an optional spend cap.
import { dataAllowance } from "#fune/telecoms.data-allowance@^1";
telecoms.roaming-charge core
Roaming charges for a trip from a dated zone tariff: daily fees, data, calls and texts.
Roaming charges for a trip abroad from a dated tariff table of zones: daily fees, data, calls and texts.
import { roamingCharge } from "#fune/telecoms.roaming-charge@^1";
subscriptions.usage-tiered optional
Tiered or volume pricing for other metered usage.
Price metered usage against tiers, graduated or volume, with an optional flat fee per tier.
import { priceUsage } from "#fune/subscriptions.usage-tiered@^1";
validation.phone-e164 optional
Normalises numbers to E.164 before prefix matching.
Normalise a phone number to E.164 (+447700900123) using a default country's trunk and dialling prefixes.
import { validatePhoneE164 } from "#fune/validation.phone-e164@^2";
  • cdr-ingest Collecting and parsing call detail records from switches or carriers (mediation) is yours.

2. Plans and recurring billing

Bill the monthly plan and its add-ons.

subscriptions.next-billing-date core
Next renewal date from the billing anchor, month-end safe.
The next renewal date after a given day, from a billing anchor and interval; month-end safe.
import { nextBillingDate } from "#fune/subscriptions.next-billing-date@^1";
subscriptions.invoice core
The renewal invoice: plan, add-ons, usage, discounts and VAT.
A subscription renewal invoice: plan, add-ons and usage, coupon discounts by billing period, and VAT.
import { renewalInvoice } from "#fune/subscriptions.invoice@^1";
subscriptions.proration optional
Credit and charge for a mid-cycle plan change.
Mid-cycle plan change: credit for unused time on the old plan and charge for the rest of the period on the new one.
import { prorateChange } from "#fune/subscriptions.proration@^1";
subscriptions.dunning-schedule optional
Retry dates for a failed payment.
Retry dates for a failed subscription payment from a retry policy, in calendar or business days.
import { dunningSchedule } from "#fune/subscriptions.dunning-schedule@^1";

3. Amounts from money-basics

Hold money as currency-tagged integer minor units and do plain arithmetic on it safely.

money.amount core
The Money type ({ minor, currency }) every other money capability takes and returns.
A currency-tagged monetary amount held in integer minor units.
import { money } from "#fune/money.amount@^1";
money.add core
Adds and subtracts amounts, refusing to mix currencies by accident.
Add, subtract and negate monetary amounts, refusing to mix currencies.
import { addMoney } from "#fune/money.add@^1";
money.sum core
Totals a list of amounts, with an explicit currency for an empty list.
Total a list of monetary amounts, with an explicit currency for the empty case.
import { sumMoney } from "#fune/money.sum@^1";
money.compare core
Compares, mins, maxes and clamps amounts of one currency without unwrapping them.
Compare two amounts of one currency, refusing to compare across currencies; min, max and clamp too.
import { compareMoney, minMoney, maxMoney, clampMoney } from "#fune/money.compare@^2";

4. Rates and rounding from money-basics

Apply percentages and divide amounts with the rounding stated, never a float.

money.apply-rate core
Applies a basis-point rate (VAT, discount, commission) to an amount with explicit rounding.
Apply a rate expressed in basis points to a monetary amount, with an explicit rounding mode.
import { applyRate } from "#fune/money.apply-rate@^1";
math.round-div core
Integer division with a named rounding mode, for any money maths the others do not cover.
Integer division with an explicit rounding mode, for money arithmetic that must not drift.
import { roundDiv } from "#fune/math.round-div@^1";
math.basis-points optional
Converts "12.5%" to and from basis points exactly, for rates typed in by users.
Convert a rate between percent, basis points and a plain ratio exactly, as decimal text or integer basis points.
import { convertRate, toBasisPoints, fromBasisPoints } from "#fune/math.basis-points@^2";
math.percent-change optional
Percentage change between two figures in basis points, for "up 4.2% on last month".
Percentage change from one value to another, in basis points, with an explicit rounding mode.
import { percentChange } from "#fune/math.percent-change@^1";
math.rational optional
Exact fractions for rates that must not drift across many steps.
Exact fraction arithmetic, always reduced, for rates and ratios that must not drift.
import { calculateRational, rational, addRational, subtractRational, multiplyRational, divideRational, compareRational, rationalToInteger } from "#fune/math.rational@^2";
math.round-div-big optional
Rounded division on numbers past 2^53, for very large totals.
Divide two integers of any size with an explicit rounding mode, on decimal strings, for exact money sums past 2^53.
import { roundDivBig } from "#fune/math.round-div-big@^1";

5. Splitting from money-basics

Divide an amount between people, periods or lines so the parts add back to the whole.

money.allocate core
Splits an amount by ratios (60/40, by quantity) without losing or inventing a penny.
Split an amount across ratios without losing or inventing a single minor unit.
import { allocate } from "#fune/money.allocate@^1";
money.split-even optional
Splits an amount into n near-equal parts that sum exactly, for instalments or shares.
Split an amount into n near-equal parts that add back up to exactly the whole.
import { splitEven } from "#fune/money.split-even@^1";

6. Display and input from money-basics

Show amounts to people and read what they type.

money.format core
Renders an amount as text with the currency's real number of decimal places.
Render a monetary amount as text, using the currency's real minor-unit precision.
import { formatMoney } from "#fune/money.format@^1";
money.parse optional
Reads "£1,234.50" or "1.234,50 €" typed by a user into minor units, strictly.
Parse "£1,234.50" or "1.234,50 €" into integer minor units, strictly: no guessing, no rounding.
import { parseMoney } from "#fune/money.parse@^1";
money.currency-digits optional
How many decimal places each ISO 4217 currency has, for input boxes and validation.
How many decimal places a currency's minor unit has, from the ISO 4217 list.
import { currencyDigits } from "#fune/money.currency-digits@^1";

7. Other currencies from money-basics

Convert between currencies at a rate you hold.

money.convert optional
Converts an amount at a supplied exact rate with explicit rounding.
Convert an amount to another currency at a supplied exact rate, with an explicit rounding mode.
import { convertMoney } from "#fune/money.convert@^1";

8. Calendar arithmetic from dates-basics

Move and measure ISO dates exactly, with no date library and no clock reads.

dates.add-days core
Shifts a date by whole days, for due dates and windows.
Shift an ISO date by a whole number of days, forwards or backwards, with exact calendar arithmetic.
import { addDays } from "#fune/dates.add-days@^1";
dates.add-months core
Adds months clamping to month end, so 31 January plus a month is the end of February.
Add calendar months to an ISO date, clamping to the month end: 31 Jan + 1 month is 28 or 29 Feb.
import { addMonths } from "#fune/dates.add-months@^1";
dates.days-between core
Signed calendar days between two dates, for ages of invoices and stays.
Calendar days from one ISO date to another, signed: negative when the second date is earlier.
import { daysBetween } from "#fune/dates.days-between@^1";
dates.month-boundaries core
First and last day of a date's month, for monthly periods and statements.
The first day, last day and length of the calendar month containing a date.
import { monthBoundaries } from "#fune/dates.month-boundaries@^1";
dates.day-of-week core
ISO weekday of a date, for weekend rules and opening hours.
The ISO 8601 day of the week for a date: 1 is Monday through 7 is Sunday.
import { dayOfWeek } from "#fune/dates.day-of-week@^1";
dates.is-leap-year optional
Whether a year is a leap year, for 365/366-day calculations.
Whether a year is a Gregorian leap year: every 4th, except centuries, except every 400th.
import { isLeapYear } from "#fune/dates.is-leap-year@^1";
dates.overlap optional
Days two date ranges share, for prorating and clash checks.
Days two date ranges have in common, with the end of each range stated as inclusive or exclusive.
import { overlapDays } from "#fune/dates.overlap@^1";
dates.age optional
Age in whole years on a date, handling 29 February birthdays.
Age in whole years on a given date, with 29 February birthdays ageing on 1 March in other years.
import { age } from "#fune/dates.age@^1";

9. Periods and reporting dates from dates-basics

Put dates into the periods reports are grouped by.

dates.quarter core
Calendar and fiscal quarter of a date for any year-start month.
Calendar quarter and fiscal quarter of a date, with the fiscal year and quarter date ranges, for any start month.
import { quarter } from "#fune/dates.quarter@^1";
dates.week-number optional
ISO week number and week-year, for weekly reports.
ISO 8601 week number and week-numbering year of a date: weeks start Monday, week 1 holds the first Thursday.
import { weekNumber } from "#fune/dates.week-number@^1";
dates.day-count-fraction optional
Year fraction by ACT/365F, ACT/360, 30/360 or ACT/ACT, for interest periods.
Year fraction between two dates by ACT/365F, ACT/360, 30/360, 30E/360 or ACT/ACT ISDA, as an exact fraction.
import { dayCountFraction } from "#fune/dates.day-count-fraction@^1";

10. Working days and holidays from dates-basics

Skip weekends and public holidays when counting or adding days.

dates.bank-holidays core
UK bank holidays for a region and year, as gov.uk publishes them.
UK bank and public holidays for a region and year, as published by gov.uk, including one-off holidays.
import { bankHolidays } from "#fune/dates.bank-holidays@^1";
dates.add-business-days core
Moves a date by working days, skipping weekends and a holiday list.
Move a date forward or back by working days, skipping weekends and a caller-supplied holiday list.
import { addBusinessDays } from "#fune/dates.add-business-days@^1";
dates.business-days-between core
Working days between two dates, for SLAs and notice periods.
Working days between two dates, excluding weekends and a caller-supplied holiday list.
import { businessDaysBetween } from "#fune/dates.business-days-between@^1";

11. Repeating schedules from dates-basics

Generate the dates of something that repeats.

dates.recurrence optional
The next n dates of a rule: monthly on the 31st, last Friday, every two weeks.
The next n dates of a repeating rule: monthly on a day, last weekday of the month, every k days or weeks, yearly.
import { recurrence } from "#fune/dates.recurrence@^1";

12. Times and durations from dates-basics

Work with times of day, durations and timestamps.

time.duration optional
Parses and adds durations like 1h30m in whole minutes, and formats the total.
Parse durations written as 1h30m, 90m or 01:30, add them up in whole minutes, and format the total.
import { duration } from "#fune/time.duration@^1";
time.minutes-between optional
Minutes between two local date-times, across midnight.
Minutes from one local date and time to another, correct across midnight; wall-clock time, no time zones.
import { minutesBetween } from "#fune/time.minutes-between@^1";
time.round-to-increment optional
Rounds minutes to a billing increment such as 6 or 15.
Round a duration in minutes to a billing increment such as 6 or 15 minutes, up, down or to nearest.
import { roundToIncrement } from "#fune/time.round-to-increment@^1";
time.iso-to-unix optional
RFC 3339 timestamps to Unix seconds.
An RFC 3339 timestamp with a Z or offset, such as 2026-09-26T13:00:00+01:00, to Unix time in whole seconds.
import { isoToUnix } from "#fune/time.iso-to-unix@^1";
time.unix-to-iso optional
Unix seconds to an ISO 8601 UTC timestamp.
Unix time in seconds to an ISO 8601 UTC timestamp such as 2026-09-26T12:00:00Z, for years 0001 to 9999.
import { unixToIso } from "#fune/time.unix-to-iso@^1";
time.countdown optional
Seconds left until a moment and a 4:05 style timer text.
Seconds left until a Unix time, whether it has passed, and a timer text like 4:05, for tokens or retry waits.
import { countdown } from "#fune/time.countdown@^1";

13. VAT from uk-tax

Work out VAT from the dated rates HMRC publishes.

finance.tax.vat-rate core Unreviewed
The VAT rate in force for a jurisdiction, category and date; the others look it up.
Look up the VAT rate in force for a jurisdiction, category and date.
import { vatRate } from "#fune/finance.tax.vat-rate@^1";
finance.tax.add-vat core Unreviewed
Net to gross: VAT on a net amount at the rate on the date of supply.
Add VAT to a net amount using the rate in force on the date of supply.
import { addVat } from "#fune/finance.tax.add-vat@^1";
finance.tax.remove-vat core Unreviewed
Gross to net: the VAT already inside a VAT-inclusive price.
Extract the VAT already included in a gross amount, using the rate in force on the date of supply.
import { removeVat } from "#fune/finance.tax.remove-vat@^1";
finance.tax.vat-return optional Unreviewed
The nine-box VAT return totals for a period from categorised sales and purchases.
UK nine-box VAT return totals for a period from categorised sales and purchases (VAT Notice 700/12).
import { vatReturn } from "#fune/finance.tax.vat-return@^1";
finance.tax.vat-flat-rate optional Unreviewed
VAT due under the Flat Rate Scheme by business sector, for small businesses on it.
UK VAT Flat Rate Scheme: VAT due on gross turnover at the sector's dated rate, limited cost rate and first-year 1% off.
import { flatRateVat } from "#fune/finance.tax.vat-flat-rate@^1";

14. Tax periods from uk-tax

Put dates into the UK periods tax is worked out over.

dates.uk-tax-year core
Which UK tax year (6 April to 5 April) a date falls in.
The UK personal tax year containing a date: 6 April to 5 April, with HMRC's label.
import { ukTaxYear } from "#fune/dates.uk-tax-year@^1";

15. Tax identifiers from uk-tax

Check the numbers HMRC and Companies House issue before storing them.

validation.uk-vat-number core
Checks a UK VAT registration number's checksum.
Check a UK VAT registration number against HMRC's mod-97 checksum, including the post-2010 9755 variant.
import { isUkVatNumber } from "#fune/validation.uk-vat-number@^1";
validation.uk-utr optional
Checks a Unique Taxpayer Reference's check digit.
Check an HMRC Unique Taxpayer Reference's modulus 11 check digit, accepting the K and spacing people type.
import { validateUkUtr } from "#fune/validation.uk-utr@^2";
validation.uk-company-number optional
Checks and pads a Companies House company number.
Check a Companies House company number's format and prefix (SC, NI, OC, LP...) and zero-pad it to eight characters.
import { validateUkCompanyNumber } from "#fune/validation.uk-company-number@^2";

Gaps

What this kind of app usually needs that Functional Weave does not have yet: write these yourself, or use a service.

  • number-porting Number porting, provisioning SIMs and lines are carrier processes caps does not have.
  • ofcom-rules Ofcom billing rules (e.g. end-of-contract notifications, price-rise terms) are policy you implement.
  • fx-rate-source Where exchange rates come from: money.convert takes a rate you supply; fetching and storing daily rates (ECB, a provider's API) is yours.
  • money-storage Storing amounts: the database columns (integer minor units plus a currency code) and their migrations are yours.
  • time-zones Time zones and daylight saving: caps works in ISO dates, UTC and wall-clock times; converting with the IANA tz rules is yours.
  • locale-formatting Showing dates in a user's language and format ("3 octobre 2026"): caps returns ISO dates, not localised text.
  • non-uk-holidays Public holidays outside the UK: dates.bank-holidays is UK only; pass another country's list to the working-day functions yourself.
  • mtd-submission Making Tax Digital: submitting the return to HMRC's VAT API (OAuth, fraud-prevention headers, obligations) is yours; caps gives the nine boxes.
  • corporation-tax Corporation tax and self-assessment income tax computations are not in caps.
  • vat-number-lookup Checking that a VAT number is registered (HMRC's lookup API) is network work; caps checks the checksum only.