{ "id": "legal", "title": "Legal practice", "summary": "Practice software for a law firm in England and Wales: conflict checks, limitation and court deadlines, time billing, client account retainers, disbursements, court fees and statutory interest.", "synonyms": [ "law firm", "solicitors", "lawyers", "legal practice", "practice management", "case management", "matter management", "legal billing", "litigation", "conveyancing firm", "chambers" ], "apps": [ "law firm practice management system", "case management app for solicitors", "legal billing software", "litigation deadline tracker", "conflict check tool" ], "language": "python", "includes": [ "money-basics", "dates-basics", "uk-tax", "validation-basics" ], "includedBy": [], "caveats": [ "England and Wales: limitation periods, CPR deadlines, court fees and statutory interest follow its rules. Not legal advice; a qualified lawyer must check every deadline the app computes.", "Calculates tax from published rules; it is not tax advice. Have an accountant check how the app uses it before anyone files a return." ], "sections": [ { "key": "intake", "title": "Client intake", "purpose": "Check for conflicts before taking a matter on.", "from": "legal", "members": [ { "id": "legal.conflict-name-match", "tier": "core", "why": "Fuzzy-matches a new client or party against existing names, best first, for a person to review.", "section": "intake", "from": "legal", "version": "1.0.1", "summary": "Fuzzy-match a name against existing clients and parties for a conflict check: normalised, token-sorted Jaro-Winkler.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "conflictNameMatch" ], "signatures": [ "def conflict_name_match(name: str, candidates: Sequence[str], threshold_basis_points: int) -> List[NameMatch]" ], "reference": "from fune.legal.conflict_name_match import conflict_name_match # legal.conflict-name-match@^1", "url": "http://www.functionalweave.com/functions/legal.conflict-name-match" } ], "gaps": [ { "key": "aml-checks", "text": "Identity and anti-money-laundering checks on new clients through a provider.", "section": "intake", "from": "legal" } ] }, { "key": "deadlines", "title": "Deadlines", "purpose": "Never miss a limitation date or a court deadline.", "from": "legal", "members": [ { "id": "legal.limitation-date", "tier": "core", "why": "The last day to bring a claim under the Limitation Act 1980, by claim type.", "section": "deadlines", "from": "legal", "version": "1.0.1", "summary": "The last day to bring a claim under the Limitation Act 1980, by claim type, from the date it accrued.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "limitationDate" ], "signatures": [ "def limitation_date(claim_type: str, accrual_date: str, knowledge_date: Optional[str]) -> LimitationPeriod" ], "reference": "from fune.legal.limitation_date import limitation_date # legal.limitation-date@^1", "url": "http://www.functionalweave.com/functions/legal.limitation-date" }, { "id": "legal.court-deadline", "tier": "core", "why": "A deadline under CPR 2.8: clear days, and short periods skipping weekends and bank holidays.", "section": "deadlines", "from": "legal", "version": "1.0.1", "summary": "A deadline in days under CPR 2.8: clear days, short periods skip weekends and bank holidays, court-closed days.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "courtDeadline" ], "signatures": [ "def court_deadline(trigger_date: str, days: int, rule: DeadlineRule, at_court_office: bool, court_closed_days: Sequence[str]) -> CourtDeadline" ], "reference": "from fune.legal.court_deadline import court_deadline # legal.court-deadline@^1", "url": "http://www.functionalweave.com/functions/legal.court-deadline" } ], "gaps": [ { "key": "diary-reminders", "text": "The matter diary, reminders and escalation when a deadline approaches.", "section": "deadlines", "from": "legal" } ] }, { "key": "time", "title": "Time and billing", "purpose": "Record time and bill it.", "from": "legal", "members": [ { "id": "legal.time-billing", "tier": "core", "why": "Fees from time entries rounded to 6-minute units at each fee earner's hourly rate.", "section": "time", "from": "legal", "version": "1.0.1", "summary": "Fees from time entries: each rounded to 6-minute (or other) units and priced at the fee earner's hourly rate.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "timeBilling" ], "signatures": [ "def time_billing(entries: Sequence[TimeEntry], rates: Sequence[FeeEarnerRate], unit_minutes: int, mode: RoundingMode) -> TimeBill" ], "reference": "from fune.legal.time_billing import time_billing # legal.time-billing@^1", "url": "http://www.functionalweave.com/functions/legal.time-billing" }, { "id": "time.round-to-increment", "tier": "core", "why": "Rounds minutes to the 6-minute unit for entries recorded by hand.", "section": "time", "from": "legal", "version": "1.0.0", "summary": "Round a duration in minutes to a billing increment such as 6 or 15 minutes, up, down or to nearest.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundToIncrement" ], "signatures": [ "def round_to_increment(minutes: int, increment: int, mode: RoundingMode) -> int" ], "reference": "from fune.time.round_to_increment import round_to_increment # time.round-to-increment@^1", "url": "http://www.functionalweave.com/functions/time.round-to-increment" }, { "id": "finance.invoice.calculate", "tier": "core", "why": "Totals the bill and its VAT by rate.", "section": "time", "from": "legal", "version": "1.0.1", "summary": "Calculate a complete invoice: line nets, VAT per line, totals and a VAT summary grouped by rate.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "calculateInvoice" ], "signatures": [ "def calculate_invoice(lines: Sequence[InvoiceLine], jurisdiction: str, invoice_date: str) -> Invoice" ], "reference": "from fune.finance.invoice.calculate import calculate_invoice # finance.invoice.calculate@^1", "url": "http://www.functionalweave.com/functions/finance.invoice.calculate" }, { "id": "professional.wip-valuation", "tier": "optional", "why": "Values unbilled time at cost or charge-out rates.", "section": "time", "from": "legal", "version": "1.0.0", "summary": "Value unbilled time (work in progress) at cost or charge-out rates, less a write-down percentage.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "wipValuation" ], "signatures": [ "def wip_valuation(entries: Sequence[WipEntry], basis: WipBasis, write_down_basis_points: int, currency: str) -> WipValuation" ], "reference": "from fune.professional.wip_valuation import wip_valuation # professional.wip-valuation@^1", "url": "http://www.functionalweave.com/functions/professional.wip-valuation" }, { "id": "professional.utilisation", "tier": "optional", "why": "Billable utilisation and realisation per fee earner.", "section": "time", "from": "legal", "version": "1.0.0", "summary": "Billable utilisation and billing, collection and overall realisation rates, in basis points.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "utilisationRates" ], "signatures": [ "def utilisation_rates(billable_minutes: int, available_minutes: int, standard_value: Money, billed_value: Money, collected_value: Money) -> UtilisationRates" ], "reference": "from fune.professional.utilisation import utilisation_rates # professional.utilisation@^1", "url": "http://www.functionalweave.com/functions/professional.utilisation" } ], "gaps": [] }, { "key": "client-money", "title": "Client account", "purpose": "Handle money held for clients.", "from": "legal", "members": [ { "id": "legal.retainer-drawdown", "tier": "core", "why": "Applies money held on account to bills in order: what each takes, what stays due, what is left.", "section": "client-money", "from": "legal", "version": "1.0.1", "summary": "Apply money held on account in client account to bills in order: what each bill takes, what stays due, what is left.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "retainerDrawdown" ], "signatures": [ "def retainer_drawdown(on_account: Money, bills: Sequence[RetainerBill]) -> RetainerDrawdown" ], "reference": "from fune.legal.retainer_drawdown import retainer_drawdown # legal.retainer-drawdown@^1", "url": "http://www.functionalweave.com/functions/legal.retainer-drawdown" } ], "gaps": [ { "key": "client-ledger", "text": "The client account ledger and three-way reconciliation the SRA Accounts Rules require.", "section": "client-money", "from": "legal" } ] }, { "key": "costs", "title": "Disbursements and court costs", "purpose": "Charge costs paid out for the client correctly.", "from": "legal", "members": [ { "id": "legal.disbursements-vat", "tier": "core", "why": "Whether a cost passed on is a disbursement outside VAT or a recharge with VAT, per HMRC Notice 700.", "section": "costs", "from": "legal", "version": "1.0.1", "summary": "Whether a cost passed to a client is a VAT disbursement (outside scope) or a recharge (VAT due), per HMRC Notice 700.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "disbursementVat" ], "signatures": [ "def disbursement_vat(facts: DisbursementFacts) -> DisbursementTreatment" ], "reference": "from fune.legal.disbursements_vat import disbursement_vat # legal.disbursements-vat@^1", "url": "http://www.functionalweave.com/functions/legal.disbursements-vat" }, { "id": "legal.court-fee", "tier": "optional", "why": "The court fee to issue a money claim, by claim value on a date.", "section": "costs", "from": "legal", "version": "1.0.2", "summary": "The court fee to issue a money claim in England and Wales, from the claim value bands in force on a date.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "courtFee" ], "signatures": [ "def court_fee(claim: Money, channel: FilingChannel, on_date: str) -> Money" ], "reference": "from fune.legal.court_fee import court_fee # legal.court-fee@^1", "url": "http://www.functionalweave.com/functions/legal.court-fee" } ], "gaps": [] }, { "key": "interest", "title": "Interest on debts and judgments", "purpose": "Add the interest a claim or judgment carries.", "from": "legal", "members": [ { "id": "legal.statutory-interest", "tier": "optional", "why": "Statutory interest on a judgment debt (8% simple) or a late commercial debt.", "section": "interest", "from": "legal", "version": "1.0.1", "summary": "Statutory interest on a judgment debt (8% simple, daily) or a late commercial debt, England and Wales.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "statutoryInterest" ], "signatures": [ "def statutory_interest(amount: Money, from_date: str, to_date: str, basis: InterestBasis) -> StatutoryInterest" ], "reference": "from fune.legal.statutory_interest import statutory_interest # legal.statutory-interest@^1", "url": "http://www.functionalweave.com/functions/legal.statutory-interest" }, { "id": "finance.late-payment-interest", "tier": "optional", "why": "Late Payment Act interest and fixed compensation on unpaid business invoices.", "section": "interest", "from": "legal", "version": "1.0.1", "summary": "UK statutory late payment interest (8% over Bank Rate) and fixed compensation under the Late Payment Act 1998.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "latePaymentInterest" ], "signatures": [ "def late_payment_interest(debt: Money, due_date: str, payment_date: str) -> LatePaymentClaim" ], "reference": "from fune.finance.late_payment_interest import late_payment_interest # finance.late-payment-interest@^1", "url": "http://www.functionalweave.com/functions/finance.late-payment-interest" } ], "gaps": [] }, { "key": "amounts", "title": "Amounts", "purpose": "Hold money as currency-tagged integer minor units and do plain arithmetic on it safely.", "from": "money-basics", "members": [ { "id": "money.amount", "tier": "core", "why": "The Money type ({ minor, currency }) every other money capability takes and returns.", "section": "amounts", "from": "money-basics", "version": "1.0.2", "summary": "A currency-tagged monetary amount held in integer minor units.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "money" ], "signatures": [ "def money(minor: int, currency: str) -> Money" ], "reference": "from fune.money.amount import money # money.amount@^1", "url": "http://www.functionalweave.com/functions/money.amount" }, { "id": "money.add", "tier": "core", "why": "Adds and subtracts amounts, refusing to mix currencies by accident.", "section": "amounts", "from": "money-basics", "version": "1.0.1", "summary": "Add, subtract and negate monetary amounts, refusing to mix currencies.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addMoney" ], "signatures": [ "def add_money(a: Money, b: Money) -> Money" ], "reference": "from fune.money.add import add_money # money.add@^1", "url": "http://www.functionalweave.com/functions/money.add" }, { "id": "money.sum", "tier": "core", "why": "Totals a list of amounts, with an explicit currency for an empty list.", "section": "amounts", "from": "money-basics", "version": "1.0.1", "summary": "Total a list of monetary amounts, with an explicit currency for the empty case.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "sumMoney" ], "signatures": [ "def sum_money(amounts: Sequence[Money], currency: str) -> Money" ], "reference": "from fune.money.sum import sum_money # money.sum@^1", "url": "http://www.functionalweave.com/functions/money.sum" }, { "id": "money.compare", "tier": "core", "why": "Compares, mins, maxes and clamps amounts of one currency without unwrapping them.", "section": "amounts", "from": "money-basics", "version": "2.0.0", "summary": "Compare two amounts of one currency, refusing to compare across currencies; min, max and clamp too.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "compareMoney", "minMoney", "maxMoney", "clampMoney" ], "signatures": [ "def compare_money(a: Money, b: Money) -> int", "def min_money(a: Money, b: Money) -> Money", "def max_money(a: Money, b: Money) -> Money", "def clamp_money(amount: Money, min: Money, max: Money) -> Money" ], "reference": "from fune.money.compare import compare_money, min_money, max_money, clamp_money # money.compare@^2", "url": "http://www.functionalweave.com/functions/money.compare" } ], "gaps": [] }, { "key": "rates", "title": "Rates and rounding", "purpose": "Apply percentages and divide amounts with the rounding stated, never a float.", "from": "money-basics", "members": [ { "id": "money.apply-rate", "tier": "core", "why": "Applies a basis-point rate (VAT, discount, commission) to an amount with explicit rounding.", "section": "rates", "from": "money-basics", "version": "1.0.1", "summary": "Apply a rate expressed in basis points to a monetary amount, with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "applyRate" ], "signatures": [ "def apply_rate(amount: Money, basis_points: int, mode: RoundingMode) -> Money" ], "reference": "from fune.money.apply_rate import apply_rate # money.apply-rate@^1", "url": "http://www.functionalweave.com/functions/money.apply-rate" }, { "id": "math.round-div", "tier": "core", "why": "Integer division with a named rounding mode, for any money maths the others do not cover.", "section": "rates", "from": "money-basics", "version": "1.0.0", "summary": "Integer division with an explicit rounding mode, for money arithmetic that must not drift.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundDiv" ], "signatures": [ "def round_div(numerator: int, denominator: int, mode: RoundingMode) -> int" ], "reference": "from fune.math.round_div import round_div # math.round-div@^1", "url": "http://www.functionalweave.com/functions/math.round-div" }, { "id": "math.basis-points", "tier": "optional", "why": "Converts \"12.5%\" to and from basis points exactly, for rates typed in by users.", "section": "rates", "from": "money-basics", "version": "2.0.0", "summary": "Convert a rate between percent, basis points and a plain ratio exactly, as decimal text or integer basis points.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "convertRate", "toBasisPoints", "fromBasisPoints" ], "signatures": [ "def convert_rate(value: str, from_unit: RateUnit, to_unit: RateUnit) -> str", "def to_basis_points(value: str, unit: RateUnit) -> int", "def from_basis_points(basis_points: int, unit: RateUnit) -> str" ], "reference": "from fune.math.basis_points import convert_rate, to_basis_points, from_basis_points # math.basis-points@^2", "url": "http://www.functionalweave.com/functions/math.basis-points" }, { "id": "math.percent-change", "tier": "optional", "why": "Percentage change between two figures in basis points, for \"up 4.2% on last month\".", "section": "rates", "from": "money-basics", "version": "1.0.0", "summary": "Percentage change from one value to another, in basis points, with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "percentChange" ], "signatures": [ "def percent_change(from_value: int, to_value: int, mode: RoundingMode) -> Optional[int]" ], "reference": "from fune.math.percent_change import percent_change # math.percent-change@^1", "url": "http://www.functionalweave.com/functions/math.percent-change" }, { "id": "math.rational", "tier": "optional", "why": "Exact fractions for rates that must not drift across many steps.", "section": "rates", "from": "money-basics", "version": "2.0.0", "summary": "Exact fraction arithmetic, always reduced, for rates and ratios that must not drift.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": true, "functions": [ "calculateRational", "rational", "addRational", "subtractRational", "multiplyRational", "divideRational", "compareRational", "rationalToInteger" ], "signatures": [ "def calculate_rational(a: Rational, op: RationalOp, b: Rational) -> Rational", "def rational(numerator: int, denominator: int) -> Rational", "def add_rational(a: Rational, b: Rational) -> Rational", "def subtract_rational(a: Rational, b: Rational) -> Rational", "def multiply_rational(a: Rational, b: Rational) -> Rational", "def divide_rational(a: Rational, b: Rational) -> Rational", "def compare_rational(a: Rational, b: Rational) -> int", "def rational_to_integer(r: Rational, mode: RoundingMode) -> int" ], "reference": "from fune.math.rational import calculate_rational, rational, add_rational, subtract_rational, multiply_rational, divide_rational, compare_rational, rational_to_integer # math.rational@^2", "url": "http://www.functionalweave.com/functions/math.rational" }, { "id": "math.round-div-big", "tier": "optional", "why": "Rounded division on numbers past 2^53, for very large totals.", "section": "rates", "from": "money-basics", "version": "1.0.0", "summary": "Divide two integers of any size with an explicit rounding mode, on decimal strings, for exact money sums past 2^53.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundDivBig" ], "signatures": [ "def round_div_big(numerator: str, denominator: str, mode: RoundingMode) -> str" ], "reference": "from fune.math.round_div_big import round_div_big # math.round-div-big@^1", "url": "http://www.functionalweave.com/functions/math.round-div-big" } ], "gaps": [] }, { "key": "splitting", "title": "Splitting", "purpose": "Divide an amount between people, periods or lines so the parts add back to the whole.", "from": "money-basics", "members": [ { "id": "money.allocate", "tier": "core", "why": "Splits an amount by ratios (60/40, by quantity) without losing or inventing a penny.", "section": "splitting", "from": "money-basics", "version": "1.0.1", "summary": "Split an amount across ratios without losing or inventing a single minor unit.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "allocate" ], "signatures": [ "def allocate(amount: Money, ratios: Sequence[int]) -> List[Money]" ], "reference": "from fune.money.allocate import allocate # money.allocate@^1", "url": "http://www.functionalweave.com/functions/money.allocate" }, { "id": "money.split-even", "tier": "optional", "why": "Splits an amount into n near-equal parts that sum exactly, for instalments or shares.", "section": "splitting", "from": "money-basics", "version": "1.0.0", "summary": "Split an amount into n near-equal parts that add back up to exactly the whole.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "splitEven" ], "signatures": [ "def split_even(amount: Money, parts: int) -> List[Money]" ], "reference": "from fune.money.split_even import split_even # money.split-even@^1", "url": "http://www.functionalweave.com/functions/money.split-even" } ], "gaps": [] }, { "key": "display", "title": "Display and input", "purpose": "Show amounts to people and read what they type.", "from": "money-basics", "members": [ { "id": "money.format", "tier": "core", "why": "Renders an amount as text with the currency's real number of decimal places.", "section": "display", "from": "money-basics", "version": "1.0.0", "summary": "Render a monetary amount as text, using the currency's real minor-unit precision.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "formatMoney" ], "signatures": [ "def format_money(amount: Money) -> str" ], "reference": "from fune.money.format import format_money # money.format@^1", "url": "http://www.functionalweave.com/functions/money.format" }, { "id": "money.parse", "tier": "optional", "why": "Reads \"£1,234.50\" or \"1.234,50 €\" typed by a user into minor units, strictly.", "section": "display", "from": "money-basics", "version": "1.0.0", "summary": "Parse \"£1,234.50\" or \"1.234,50 €\" into integer minor units, strictly: no guessing, no rounding.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "parseMoney" ], "signatures": [ "def parse_money(text: str, currency: str, style: NumberStyle) -> Money" ], "reference": "from fune.money.parse import parse_money # money.parse@^1", "url": "http://www.functionalweave.com/functions/money.parse" }, { "id": "money.currency-digits", "tier": "optional", "why": "How many decimal places each ISO 4217 currency has, for input boxes and validation.", "section": "display", "from": "money-basics", "version": "1.0.0", "summary": "How many decimal places a currency's minor unit has, from the ISO 4217 list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "currencyDigits" ], "signatures": [ "def currency_digits(currency: str) -> int" ], "reference": "from fune.money.currency_digits import currency_digits # money.currency-digits@^1", "url": "http://www.functionalweave.com/functions/money.currency-digits" } ], "gaps": [] }, { "key": "currencies", "title": "Other currencies", "purpose": "Convert between currencies at a rate you hold.", "from": "money-basics", "members": [ { "id": "money.convert", "tier": "optional", "why": "Converts an amount at a supplied exact rate with explicit rounding.", "section": "currencies", "from": "money-basics", "version": "1.0.0", "summary": "Convert an amount to another currency at a supplied exact rate, with an explicit rounding mode.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "convertMoney" ], "signatures": [ "def convert_money(amount: Money, rate: ExchangeRate, mode: RoundingMode) -> Money" ], "reference": "from fune.money.convert import convert_money # money.convert@^1", "url": "http://www.functionalweave.com/functions/money.convert" } ], "gaps": [] }, { "key": "date-arithmetic", "title": "Calendar arithmetic", "purpose": "Move and measure ISO dates exactly, with no date library and no clock reads.", "from": "dates-basics", "members": [ { "id": "dates.add-days", "tier": "core", "why": "Shifts a date by whole days, for due dates and windows.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Shift an ISO date by a whole number of days, forwards or backwards, with exact calendar arithmetic.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addDays" ], "signatures": [ "def add_days(iso: str, days: int) -> str" ], "reference": "from fune.dates.add_days import add_days # dates.add-days@^1", "url": "http://www.functionalweave.com/functions/dates.add-days" }, { "id": "dates.add-months", "tier": "core", "why": "Adds months clamping to month end, so 31 January plus a month is the end of February.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Add calendar months to an ISO date, clamping to the month end: 31 Jan + 1 month is 28 or 29 Feb.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addMonths" ], "signatures": [ "def add_months(iso: str, months: int) -> str" ], "reference": "from fune.dates.add_months import add_months # dates.add-months@^1", "url": "http://www.functionalweave.com/functions/dates.add-months" }, { "id": "dates.days-between", "tier": "core", "why": "Signed calendar days between two dates, for ages of invoices and stays.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar days from one ISO date to another, signed: negative when the second date is earlier.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "daysBetween" ], "signatures": [ "def days_between(start_iso: str, end_iso: str) -> int" ], "reference": "from fune.dates.days_between import days_between # dates.days-between@^1", "url": "http://www.functionalweave.com/functions/dates.days-between" }, { "id": "dates.month-boundaries", "tier": "core", "why": "First and last day of a date's month, for monthly periods and statements.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The first day, last day and length of the calendar month containing a date.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "monthBoundaries" ], "signatures": [ "def month_boundaries(iso: str) -> MonthBoundaries" ], "reference": "from fune.dates.month_boundaries import month_boundaries # dates.month-boundaries@^1", "url": "http://www.functionalweave.com/functions/dates.month-boundaries" }, { "id": "dates.day-of-week", "tier": "core", "why": "ISO weekday of a date, for weekend rules and opening hours.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The ISO 8601 day of the week for a date: 1 is Monday through 7 is Sunday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayOfWeek" ], "signatures": [ "def day_of_week(iso: str) -> int" ], "reference": "from fune.dates.day_of_week import day_of_week # dates.day-of-week@^1", "url": "http://www.functionalweave.com/functions/dates.day-of-week" }, { "id": "dates.is-leap-year", "tier": "optional", "why": "Whether a year is a leap year, for 365/366-day calculations.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Whether a year is a Gregorian leap year: every 4th, except centuries, except every 400th.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isLeapYear" ], "signatures": [ "def is_leap_year(year: int) -> bool" ], "reference": "from fune.dates.is_leap_year import is_leap_year # dates.is-leap-year@^1", "url": "http://www.functionalweave.com/functions/dates.is-leap-year" }, { "id": "dates.overlap", "tier": "optional", "why": "Days two date ranges share, for prorating and clash checks.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Days two date ranges have in common, with the end of each range stated as inclusive or exclusive.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "overlapDays" ], "signatures": [ "def overlap_days(a_start: str, a_end: str, b_start: str, b_end: str, end_inclusive: bool) -> int" ], "reference": "from fune.dates.overlap import overlap_days # dates.overlap@^1", "url": "http://www.functionalweave.com/functions/dates.overlap" }, { "id": "dates.age", "tier": "optional", "why": "Age in whole years on a date, handling 29 February birthdays.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Age in whole years on a given date, with 29 February birthdays ageing on 1 March in other years.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "age" ], "signatures": [ "def age(birth_date: str, on_date: str) -> int" ], "reference": "from fune.dates.age import age # dates.age@^1", "url": "http://www.functionalweave.com/functions/dates.age" } ], "gaps": [] }, { "key": "reporting-periods", "title": "Periods and reporting dates", "purpose": "Put dates into the periods reports are grouped by.", "from": "dates-basics", "members": [ { "id": "dates.quarter", "tier": "core", "why": "Calendar and fiscal quarter of a date for any year-start month.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar quarter and fiscal quarter of a date, with the fiscal year and quarter date ranges, for any start month.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "quarter" ], "signatures": [ "def quarter(iso: str, fiscal_year_start_month: int) -> Quarter" ], "reference": "from fune.dates.quarter import quarter # dates.quarter@^1", "url": "http://www.functionalweave.com/functions/dates.quarter" }, { "id": "dates.week-number", "tier": "optional", "why": "ISO week number and week-year, for weekly reports.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "ISO 8601 week number and week-numbering year of a date: weeks start Monday, week 1 holds the first Thursday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "weekNumber" ], "signatures": [ "def week_number(iso: str) -> IsoWeek" ], "reference": "from fune.dates.week_number import week_number # dates.week-number@^1", "url": "http://www.functionalweave.com/functions/dates.week-number" }, { "id": "dates.day-count-fraction", "tier": "optional", "why": "Year fraction by ACT/365F, ACT/360, 30/360 or ACT/ACT, for interest periods.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Year fraction between two dates by ACT/365F, ACT/360, 30/360, 30E/360 or ACT/ACT ISDA, as an exact fraction.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayCountFraction" ], "signatures": [ "def day_count_fraction(start_iso: str, end_iso: str, convention: DayCountConvention) -> YearFraction" ], "reference": "from fune.dates.day_count_fraction import day_count_fraction # dates.day-count-fraction@^1", "url": "http://www.functionalweave.com/functions/dates.day-count-fraction" } ], "gaps": [] }, { "key": "working-days", "title": "Working days and holidays", "purpose": "Skip weekends and public holidays when counting or adding days.", "from": "dates-basics", "members": [ { "id": "dates.bank-holidays", "tier": "core", "why": "UK bank holidays for a region and year, as gov.uk publishes them.", "section": "working-days", "from": "dates-basics", "version": "1.0.1", "summary": "UK bank and public holidays for a region and year, as published by gov.uk, including one-off holidays.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "bankHolidays" ], "signatures": [ "def bank_holidays(region: UkRegion, year: int) -> List[BankHoliday]" ], "reference": "from fune.dates.bank_holidays import bank_holidays # dates.bank-holidays@^1", "url": "http://www.functionalweave.com/functions/dates.bank-holidays" }, { "id": "dates.add-business-days", "tier": "core", "why": "Moves a date by working days, skipping weekends and a holiday list.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Move a date forward or back by working days, skipping weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addBusinessDays" ], "signatures": [ "def add_business_days(iso: str, days: int, holidays: Sequence[str]) -> str" ], "reference": "from fune.dates.add_business_days import add_business_days # dates.add-business-days@^1", "url": "http://www.functionalweave.com/functions/dates.add-business-days" }, { "id": "dates.business-days-between", "tier": "core", "why": "Working days between two dates, for SLAs and notice periods.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Working days between two dates, excluding weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "businessDaysBetween" ], "signatures": [ "def business_days_between(start_iso: str, end_iso: str, holidays: Sequence[str]) -> int" ], "reference": "from fune.dates.business_days_between import business_days_between # dates.business-days-between@^1", "url": "http://www.functionalweave.com/functions/dates.business-days-between" } ], "gaps": [] }, { "key": "repeating-dates", "title": "Repeating schedules", "purpose": "Generate the dates of something that repeats.", "from": "dates-basics", "members": [ { "id": "dates.recurrence", "tier": "optional", "why": "The next n dates of a rule: monthly on the 31st, last Friday, every two weeks.", "section": "repeating-dates", "from": "dates-basics", "version": "1.0.0", "summary": "The next n dates of a repeating rule: monthly on a day, last weekday of the month, every k days or weeks, yearly.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "recurrence" ], "signatures": [ "def recurrence(rule: RecurrenceRule, start_iso: str, count: int) -> List[str]" ], "reference": "from fune.dates.recurrence import recurrence # dates.recurrence@^1", "url": "http://www.functionalweave.com/functions/dates.recurrence" } ], "gaps": [] }, { "key": "times", "title": "Times and durations", "purpose": "Work with times of day, durations and timestamps.", "from": "dates-basics", "members": [ { "id": "time.duration", "tier": "optional", "why": "Parses and adds durations like 1h30m in whole minutes, and formats the total.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Parse durations written as 1h30m, 90m or 01:30, add them up in whole minutes, and format the total.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "duration" ], "signatures": [ "def duration(parts: Sequence[str]) -> Duration" ], "reference": "from fune.time.duration import duration # time.duration@^1", "url": "http://www.functionalweave.com/functions/time.duration" }, { "id": "time.minutes-between", "tier": "optional", "why": "Minutes between two local date-times, across midnight.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Minutes from one local date and time to another, correct across midnight; wall-clock time, no time zones.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "minutesBetween" ], "signatures": [ "def minutes_between(start_date: str, start_time: str, end_date: str, end_time: str) -> int" ], "reference": "from fune.time.minutes_between import minutes_between # time.minutes-between@^1", "url": "http://www.functionalweave.com/functions/time.minutes-between" }, { "id": "time.iso-to-unix", "tier": "optional", "why": "RFC 3339 timestamps to Unix seconds.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "An RFC 3339 timestamp with a Z or offset, such as 2026-09-26T13:00:00+01:00, to Unix time in whole seconds.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isoToUnix" ], "signatures": [ "def iso_to_unix(timestamp: str) -> int" ], "reference": "from fune.time.iso_to_unix import iso_to_unix # time.iso-to-unix@^1", "url": "http://www.functionalweave.com/functions/time.iso-to-unix" }, { "id": "time.unix-to-iso", "tier": "optional", "why": "Unix seconds to an ISO 8601 UTC timestamp.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Unix time in seconds to an ISO 8601 UTC timestamp such as 2026-09-26T12:00:00Z, for years 0001 to 9999.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "unixToIso" ], "signatures": [ "def unix_to_iso(seconds: int) -> str" ], "reference": "from fune.time.unix_to_iso import unix_to_iso # time.unix-to-iso@^1", "url": "http://www.functionalweave.com/functions/time.unix-to-iso" }, { "id": "time.countdown", "tier": "optional", "why": "Seconds left until a moment and a 4:05 style timer text.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Seconds left until a Unix time, whether it has passed, and a timer text like 4:05, for tokens or retry waits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "countdown" ], "signatures": [ "def countdown(until: int, now: int) -> Countdown" ], "reference": "from fune.time.countdown import countdown # time.countdown@^1", "url": "http://www.functionalweave.com/functions/time.countdown" } ], "gaps": [] }, { "key": "vat", "title": "VAT", "purpose": "Work out VAT from the dated rates HMRC publishes.", "from": "uk-tax", "members": [ { "id": "finance.tax.vat-rate", "tier": "core", "why": "The VAT rate in force for a jurisdiction, category and date; the others look it up.", "section": "vat", "from": "uk-tax", "version": "1.2.2", "summary": "Look up the VAT rate in force for a jurisdiction, category and date.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "vatRate" ], "signatures": [ "def vat_rate(jurisdiction: str, category: str, on_date: str) -> VatRate" ], "reference": "from fune.finance.tax.vat_rate import vat_rate # finance.tax.vat-rate@^1", "url": "http://www.functionalweave.com/functions/finance.tax.vat-rate" }, { "id": "finance.tax.add-vat", "tier": "core", "why": "Net to gross: VAT on a net amount at the rate on the date of supply.", "section": "vat", "from": "uk-tax", "version": "1.0.1", "summary": "Add VAT to a net amount using the rate in force on the date of supply.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addVat" ], "signatures": [ "def add_vat(net: Money, jurisdiction: str, category: str, on_date: str) -> VatBreakdown" ], "reference": "from fune.finance.tax.add_vat import add_vat # finance.tax.add-vat@^1", "url": "http://www.functionalweave.com/functions/finance.tax.add-vat" }, { "id": "finance.tax.remove-vat", "tier": "core", "why": "Gross to net: the VAT already inside a VAT-inclusive price.", "section": "vat", "from": "uk-tax", "version": "1.0.2", "summary": "Extract the VAT already included in a gross amount, using the rate in force on the date of supply.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "removeVat" ], "signatures": [ "def remove_vat(gross: Money, jurisdiction: str, category: str, on_date: str) -> VatBreakdown" ], "reference": "from fune.finance.tax.remove_vat import remove_vat # finance.tax.remove-vat@^1", "url": "http://www.functionalweave.com/functions/finance.tax.remove-vat" }, { "id": "finance.tax.vat-return", "tier": "optional", "why": "The nine-box VAT return totals for a period from categorised sales and purchases.", "section": "vat", "from": "uk-tax", "version": "1.0.1", "summary": "UK nine-box VAT return totals for a period from categorised sales and purchases (VAT Notice 700/12).", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "vatReturn" ], "signatures": [ "def vat_return(transactions: Sequence[VatTransaction], period_start: str, period_end: str) -> VatReturn" ], "reference": "from fune.finance.tax.vat_return import vat_return # finance.tax.vat-return@^1", "url": "http://www.functionalweave.com/functions/finance.tax.vat-return" }, { "id": "finance.tax.vat-flat-rate", "tier": "optional", "why": "VAT due under the Flat Rate Scheme by business sector, for small businesses on it.", "section": "vat", "from": "uk-tax", "version": "1.0.1", "summary": "UK VAT Flat Rate Scheme: VAT due on gross turnover at the sector's dated rate, limited cost rate and first-year 1% off.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "flatRateVat" ], "signatures": [ "def flat_rate_vat(turnover: Money, sector: str, limited_cost_business: bool, registration_date: Optional[str], supply_date: str) -> FlatRateVat" ], "reference": "from fune.finance.tax.vat_flat_rate import flat_rate_vat # finance.tax.vat-flat-rate@^1", "url": "http://www.functionalweave.com/functions/finance.tax.vat-flat-rate" } ], "gaps": [] }, { "key": "tax-year", "title": "Tax periods", "purpose": "Put dates into the UK periods tax is worked out over.", "from": "uk-tax", "members": [ { "id": "dates.uk-tax-year", "tier": "core", "why": "Which UK tax year (6 April to 5 April) a date falls in.", "section": "tax-year", "from": "uk-tax", "version": "1.0.0", "summary": "The UK personal tax year containing a date: 6 April to 5 April, with HMRC's label.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "ukTaxYear" ], "signatures": [ "def uk_tax_year(iso: str) -> UkTaxYear" ], "reference": "from fune.dates.uk_tax_year import uk_tax_year # dates.uk-tax-year@^1", "url": "http://www.functionalweave.com/functions/dates.uk-tax-year" } ], "gaps": [] }, { "key": "identifiers", "title": "Tax identifiers", "purpose": "Check the numbers HMRC and Companies House issue before storing them.", "from": "uk-tax", "members": [ { "id": "validation.uk-vat-number", "tier": "core", "why": "Checks a UK VAT registration number's checksum.", "section": "identifiers", "from": "uk-tax", "version": "1.0.0", "summary": "Check a UK VAT registration number against HMRC's mod-97 checksum, including the post-2010 9755 variant.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isUkVatNumber" ], "signatures": [ "def is_uk_vat_number(value: str) -> bool" ], "reference": "from fune.validation.uk_vat_number import is_uk_vat_number # validation.uk-vat-number@^1", "url": "http://www.functionalweave.com/functions/validation.uk-vat-number" }, { "id": "validation.uk-utr", "tier": "optional", "why": "Checks a Unique Taxpayer Reference's check digit.", "section": "identifiers", "from": "uk-tax", "version": "2.0.1", "summary": "Check an HMRC Unique Taxpayer Reference's modulus 11 check digit, accepting the K and spacing people type.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkUtr" ], "signatures": [ "def validate_uk_utr(value: str) -> UkUtr" ], "reference": "from fune.validation.uk_utr import validate_uk_utr # validation.uk-utr@^2", "url": "http://www.functionalweave.com/functions/validation.uk-utr" }, { "id": "validation.uk-company-number", "tier": "optional", "why": "Checks and pads a Companies House company number.", "section": "identifiers", "from": "uk-tax", "version": "2.0.1", "summary": "Check a Companies House company number's format and prefix (SC, NI, OC, LP...) and zero-pad it to eight characters.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkCompanyNumber" ], "signatures": [ "def validate_uk_company_number(value: str) -> UkCompanyNumber" ], "reference": "from fune.validation.uk_company_number import validate_uk_company_number # validation.uk-company-number@^2", "url": "http://www.functionalweave.com/functions/validation.uk-company-number" } ], "gaps": [] }, { "key": "contact", "title": "Contact details", "purpose": "Check and normalise a person's contact details before storing them.", "from": "validation-basics", "members": [ { "id": "validation.email", "tier": "core", "why": "Is an email address plausible, by a documented subset of RFC 5322.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Is this a plausible email address? A documented, pragmatic subset of RFC 5322, not the full grammar.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isEmail" ], "signatures": [ "def is_email(value: str) -> bool" ], "reference": "from fune.validation.email import is_email # validation.email@^1", "url": "http://www.functionalweave.com/functions/validation.email" }, { "id": "validation.phone-e164", "tier": "core", "why": "Normalises a phone number to +44… E.164 for a default country.", "section": "contact", "from": "validation-basics", "version": "2.0.0", "summary": "Normalise a phone number to E.164 (+447700900123) using a default country's trunk and dialling prefixes.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validatePhoneE164" ], "signatures": [ "def validate_phone_e164(value: str, default_country: str) -> PhoneE164" ], "reference": "from fune.validation.phone_e164 import validate_phone_e164 # validation.phone-e164@^2", "url": "http://www.functionalweave.com/functions/validation.phone-e164" }, { "id": "validation.uk-postcode", "tier": "core", "why": "Validates a UK postcode and puts it in canonical form.", "section": "contact", "from": "validation-basics", "version": "2.0.0", "summary": "Validate a UK postcode and normalise it to canonical upper case with one space before the inward code.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkPostcode" ], "signatures": [ "def validate_uk_postcode(value: str) -> UkPostcode" ], "reference": "from fune.validation.uk_postcode import validate_uk_postcode # validation.uk-postcode@^2", "url": "http://www.functionalweave.com/functions/validation.uk-postcode" }, { "id": "text.normalise-name", "tier": "optional", "why": "Tidies a typed name: spacing and title case with Mc, O' and hyphen rules.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Tidy a personal name: trim, collapse whitespace and title-case, with Mc, Mac, O', hyphen and van/de rules.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "normaliseName" ], "signatures": [ "def normalise_name(value: str) -> str" ], "reference": "from fune.text.normalise_name import normalise_name # text.normalise-name@^1", "url": "http://www.functionalweave.com/functions/text.normalise-name" }, { "id": "auth.normalise-email", "tier": "optional", "why": "Lower-cases an email's domain for storage and lookup.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Trim an email address and lower-case its domain for storage and lookup, or null if it is not a plausible address.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "normaliseEmail" ], "signatures": [ "def normalise_email(value: str) -> Optional[str]" ], "reference": "from fune.auth.normalise_email import normalise_email # auth.normalise-email@^1", "url": "http://www.functionalweave.com/functions/auth.normalise-email" } ], "gaps": [] }, { "key": "bank", "title": "Bank details", "purpose": "Check payee and customer bank details before money moves.", "from": "validation-basics", "members": [ { "id": "validation.iban", "tier": "core", "why": "Checks an IBAN's mod-97 checksum and its country's length.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Check an IBAN against the ISO 13616 mod-97-10 checksum and the registered length for its country.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isIban" ], "signatures": [ "def is_iban(value: str) -> bool" ], "reference": "from fune.validation.iban import is_iban # validation.iban@^1", "url": "http://www.functionalweave.com/functions/validation.iban" }, { "id": "validation.bic", "tier": "optional", "why": "Checks a SWIFT/BIC code's format and splits it.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Check the format of a SWIFT/BIC code (8 or 11 characters) and split it into its parts.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateBic" ], "signatures": [ "def validate_bic(value: str) -> BicCheck" ], "reference": "from fune.validation.bic import validate_bic # validation.bic@^1", "url": "http://www.functionalweave.com/functions/validation.bic" }, { "id": "validation.uk-sort-code-account", "tier": "optional", "why": "Checks a UK sort code and account number by the Vocalink modulus rules, against a table you supply.", "section": "bank", "from": "validation-basics", "version": "3.0.0", "summary": "Check a UK sort code and account number with the Vocalink/Pay.UK modulus rules, against a table you supply.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkSortCodeAccount" ], "signatures": [ "def validate_uk_sort_code_account(sort_code: str, account_number: str, table: UkModulusTable) -> UkSortCodeAccount" ], "reference": "from fune.validation.uk_sort_code_account import validate_uk_sort_code_account # validation.uk-sort-code-account@^3", "url": "http://www.functionalweave.com/functions/validation.uk-sort-code-account" }, { "id": "validation.uk-modulus-table", "tier": "optional", "why": "Parses Vocalink's VALACDOS and SCSUBTAB files into that table.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Parse Vocalink's VALACDOS.txt and SCSUBTAB.txt into the table UK sort code modulus checking needs.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "parseUkModulusTable" ], "signatures": [ "def parse_uk_modulus_table(valacdos: str, scsubtab: str) -> UkModulusTable" ], "reference": "from fune.validation.uk_modulus_table import parse_uk_modulus_table # validation.uk-modulus-table@^1", "url": "http://www.functionalweave.com/functions/validation.uk-modulus-table" } ], "gaps": [] }, { "key": "check-digits", "title": "Identifiers and check digits", "purpose": "Catch mistyped reference numbers by their check digits.", "from": "validation-basics", "members": [ { "id": "validation.luhn", "tier": "optional", "why": "Luhn mod-10 check, for card numbers and many reference numbers.", "section": "check-digits", "from": "validation-basics", "version": "1.0.0", "summary": "Check a digit string against the Luhn mod-10 checksum used by payment cards and many identifiers.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isLuhn" ], "signatures": [ "def is_luhn(value: str) -> bool" ], "reference": "from fune.validation.luhn import is_luhn # validation.luhn@^1", "url": "http://www.functionalweave.com/functions/validation.luhn" }, { "id": "validation.lei", "tier": "optional", "why": "Checks a Legal Entity Identifier's check digits.", "section": "check-digits", "from": "validation-basics", "version": "1.0.0", "summary": "Check a 20-character Legal Entity Identifier against its ISO 17442 / ISO 7064 MOD 97-10 check digits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateLei" ], "signatures": [ "def validate_lei(value: str) -> LeiCheck" ], "reference": "from fune.validation.lei import validate_lei # validation.lei@^1", "url": "http://www.functionalweave.com/functions/validation.lei" }, { "id": "validation.gtin", "tier": "optional", "why": "Checks an EAN/UPC/GTIN barcode number.", "section": "check-digits", "from": "validation-basics", "version": "1.1.0", "summary": "Check an EAN-8, UPC-A, EAN-13 or GTIN-14 barcode number against the GS1 mod-10 check digit.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateGtin" ], "signatures": [ "def validate_gtin(value: str) -> GtinCheck" ], "reference": "from fune.validation.gtin import validate_gtin # validation.gtin@^1", "url": "http://www.functionalweave.com/functions/validation.gtin" } ], "gaps": [] }, { "key": "masking", "title": "Displaying sensitive values", "purpose": "Show stored identifiers without exposing them.", "from": "validation-basics", "members": [ { "id": "text.mask", "tier": "optional", "why": "Masks all but the last digits of a card, account or phone number.", "section": "masking", "from": "validation-basics", "version": "1.0.0", "summary": "Mask all but the last n characters of a card, account or phone number, optionally keeping separators.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "mask" ], "signatures": [ "def mask(value: str, visible: int, mask_char: str, keep_separators: bool) -> str" ], "reference": "from fune.text.mask import mask # text.mask@^1", "url": "http://www.functionalweave.com/functions/text.mask" } ], "gaps": [] } ], "gaps": [ { "key": "aml-checks", "text": "Identity and anti-money-laundering checks on new clients through a provider.", "section": "intake", "from": "legal" }, { "key": "diary-reminders", "text": "The matter diary, reminders and escalation when a deadline approaches.", "section": "deadlines", "from": "legal" }, { "key": "client-ledger", "text": "The client account ledger and three-way reconciliation the SRA Accounts Rules require.", "section": "client-money", "from": "legal" }, { "key": "document-management", "text": "Matter documents, templates and precedents, and e-signature.", "section": null, "from": "legal" }, { "key": "fx-rate-source", "text": "Where exchange rates come from: money.convert takes a rate you supply; fetching and storing daily rates (ECB, a provider's API) is yours.", "section": null, "from": "money-basics" }, { "key": "money-storage", "text": "Storing amounts: the database columns (integer minor units plus a currency code) and their migrations are yours.", "section": null, "from": "money-basics" }, { "key": "time-zones", "text": "Time zones and daylight saving: caps works in ISO dates, UTC and wall-clock times; converting with the IANA tz rules is yours.", "section": null, "from": "dates-basics" }, { "key": "locale-formatting", "text": "Showing dates in a user's language and format (\"3 octobre 2026\"): caps returns ISO dates, not localised text.", "section": null, "from": "dates-basics" }, { "key": "non-uk-holidays", "text": "Public holidays outside the UK: dates.bank-holidays is UK only; pass another country's list to the working-day functions yourself.", "section": null, "from": "dates-basics" }, { "key": "mtd-submission", "text": "Making Tax Digital: submitting the return to HMRC's VAT API (OAuth, fraud-prevention headers, obligations) is yours; caps gives the nine boxes.", "section": null, "from": "uk-tax" }, { "key": "corporation-tax", "text": "Corporation tax and self-assessment income tax computations are not in caps.", "section": null, "from": "uk-tax" }, { "key": "vat-number-lookup", "text": "Checking that a VAT number is registered (HMRC's lookup API) is network work; caps checks the checksum only.", "section": null, "from": "uk-tax" }, { "key": "address-lookup", "text": "Turning a postcode into a list of addresses (Royal Mail PAF or a lookup API) is network work and not in caps.", "section": null, "from": "validation-basics" }, { "key": "email-deliverability", "text": "Whether a mailbox exists (MX lookups, a confirmation email): validation.email checks the syntax only.", "section": null, "from": "validation-basics" }, { "key": "vocalink-data", "text": "The Vocalink modulus tables themselves: download them from Pay.UK under its terms; caps parses them but does not ship them.", "section": null, "from": "validation-basics" } ], "counts": { "members": 71, "core": 34, "optional": 37, "unreviewed": 13, "deprecated": [], "unavailable": [], "missing": [], "gaps": 15 }, "warnings": [ "9 core capabilities are unreviewed - they pass their tests but await an expert's sign-off; tell the user before relying on them, and never use one silently for tax, payroll, legal, clinical or other regulated rules: legal.conflict-name-match, legal.limitation-date, legal.court-deadline, legal.time-billing, legal.retainer-drawdown, legal.disbursements-vat, finance.tax.vat-rate, finance.tax.add-vat, finance.tax.remove-vat", "4 optional capabilities are unreviewed too: legal.court-fee, legal.statutory-interest, finance.tax.vat-return, finance.tax.vat-flat-rate", "England and Wales: limitation periods, CPR deadlines, court fees and statutory interest follow its rules. Not legal advice; a qualified lawyer must check every deadline the app computes.", "Calculates tax from published rules; it is not tax advice. Have an accountant check how the app uses it before anyone files a return." ], "url": "http://www.functionalweave.com/suites/legal", "owner": null }