LanguageValues and typesStandard typesTax and identity numbers
UkCompanyNumber
On this page
A UK company's number at Companies House: 00445790 or SC123456.
Use it to name a registered UK company. Its tax reference is a UkUtr and its VAT number a VatNumber.
Shape
One value, held as text in one set form, with no parts: SC123456.
Example
UkCompanyNumber("SC123456")UkCompanyNumber(raw) checks the text, and text that isn't one breaks the format rule.
text.parse(raw, as: UkCompanyNumber) reads one from text that comes from outside. Text that isn't one at all fails malformed, such as 445790, sc123456 or SC12345.
Good to know
- It is eight digits, or two capital letters and six digits. Leading zeros are kept, which is why it is text.
==tells you whether two are the same.<andlist.sort_bydon't take it.
In JSON
A string, in a request, a response or json.write:
"00445790""SC123456"
Details
Text form, storage, how it is shown, and operations
UkCompanyNumber is in the group Tax and identity numbers, and has been in Jadpo since 0.1.0.
Text form
text.from writes one standard text form, the same form text.parse reads back: 00445790 and SC123456.
How it is stored
It is stored in one column named for the field, of type text. SC123456 is stored as 'SC123456'.
How it is shown to people
text.format(value, locale:) shows it to people in their locale.
With locale: Locale.en_gb:
| Value | Shown |
|---|---|
00445790 |
00445790 |
SC123456 |
SC123456 |
Operations
It also takes text.parse, text.from, text.format, json.read, json.write and ==. How every standard type behaves says how they work.
Markdown for agents: /docs/types/type-uk-company-number.md.Built from Jadpo main at aee2e8f.