Legal nature

Validate

• JavaScript library
• Python library22 cases fail
• Go library13 cases fail
• Ruby library12 cases fail
• Rust library13 cases fail
• .NET library14 cases fail
• Erlang library

Checks whether a legal nature code exists in the IBGE/CONCLA Natureza Jurídica 2021 table.

• It accepts the 92 codes in force, plus the 8 codes that a past revision retired. legalNature.get tells them apart.
• Accepts the 4 digits, a safe non-negative integer or the NNN-N mask. The mask is accepted only after the third digit, with any run of separators (whitespace, ., - or /) between the third and the fourth digit: "206.2", "206--2" and "206 - 2" are valid. Surrounding whitespace is ignored.
• A separator anywhere else, or any other character, makes the value invalid: "2-0-6-2", "20.6.2", "2062a". Until 2.4.0 the separators were stripped from anywhere in the string, so "-2-0-6-2" was valid.
• A number is read only when it is a safe non-negative integer (2062 is valid). A negative, fractional, non-finite or unsafe number is invalid. Until 2.4.0 the function accepted only strings.
• Any value that is not a string or a number returns false.

import { isValidLegalNature } from '@brazilian-utils/brazilian-utils';

isValidLegalNature('2062'); // true
isValidLegalNature(2062); // true
isValidLegalNature('206-2'); // true
isValidLegalNature('2208'); // true (retired by a past revision, still accepted)
isValidLegalNature('9999'); // false
isValidLegalNature('2-0-6-2'); // false (a separator only fits after the third digit)

Format

• JavaScript library
• Python library
• Go library
• Ruby library7 cases fail
• Rust library
• .NET library
• Erlang library

Formats a legal nature code as NNN-N. Use legalNature.isValid to check the code.

• The digits are read from the value and the mask is applied as far as they go: "206" stays "206", "2062" becomes "206-2". options.pad first left-pads with zeros to 4 digits ("62" becomes "006-2").
• Digits after the 4th are ignored, and other characters are dropped. A number is treated as the string of its digits, so it is padded only with pad.
• A number is read only when it is a safe non-negative integer. A negative, fractional, non-finite or unsafe number gives an empty string (2.4.0 read the digits of any number, sign and decimal point dropped).
• Returns an empty string when there is nothing to format. Until 2.4.0 a value with no digits and pad: true returned "000-0".

import { formatLegalNature } from '@brazilian-utils/brazilian-utils';

formatLegalNature('2062'); // 206-2
formatLegalNature(2062); // 206-2
formatLegalNature('206'); // 206 (masked as far as it goes)
formatLegalNature('62', { pad: true }); // 006-2 (padded to 4 digits first)

Parse

• JavaScript library
• Python library
• Go library
• Ruby library1 case fails
• Rust library
• .NET library
• Erlang library

Removes legal nature formatting and keeps only digits, capped at 4 digits.

• It does not left-pad anything. Returns an empty string when there is no digit at all (null and undefined included).
• A number is read only when it is a safe non-negative integer. A negative, fractional, non-finite or unsafe number gives an empty string (2.4.0 read the digits of any number, sign and decimal point dropped).

import { parseLegalNature } from '@brazilian-utils/brazilian-utils';

parseLegalNature('206-2'); // '2062'

Generate

• JavaScript library
• Python library
• Go library
• Ruby library
• Rust library
• .NET library
• Erlang library

Generates a random valid legal nature code (4 digits). It picks only among the 92 codes in force, never a retired one.

import { generateLegalNature } from '@brazilian-utils/brazilian-utils';

generateLegalNature(); // '2062'

Look up

• JavaScript library
• Python library
• Go library5 cases fail
• Ruby library4 cases fail
• Rust library
• .NET library5 cases fail
• Erlang library

Looks up a legal nature code in the IBGE/CONCLA Natureza Jurídica 2021 table. Returns null for an unknown code.

• Same input rules as legalNature.isValid: the 4 digits, a safe non-negative integer or the NNN-N mask, with any run of separators (whitespace, ., - or /) between the third and the fourth digit. "206.2" finds 2062. Surrounding whitespace is ignored.
• A separator anywhere else ("2-0-6-2") or any other character ("2062a") returns null. Until 2.4.0 the separators were stripped from anywhere in the string.
• A number is read only when it is a safe non-negative integer. A negative, fractional, non-finite or unsafe number returns null. 2.4.0 stripped the sign and decimal point of a number too, so 206.2 found 2062.
• No code starts with zero (the first digit is the category, 1 to 5), so nothing is padded: a number and the string of the same digits read the same.
• The entry has the code, its description and its CONCLA category (given by the first digit): 1 Administração Pública, 2 Entidades Empresariais, 3 Entidades sem Fins Lucrativos, 4 Pessoas Físicas, 5 Organizações Internacionais e Outras Instituições Extraterritoriais.
• A code that a past revision retired comes back with legacy: true and the currentCode it corresponds to today, or null when the revision that retired it published no successor (2100, 3050 and 3123). The 92 codes in force have legacy: false and no currentCode.
• The retired codes and what each corresponds to today: 2076 to 2070, 2208 to 2275, 3042 to 3069, 3093 to 3999 and 5002 to 5010; 2100, 3050 and 3123 have no successor.
• It returns null exactly when legalNature.isValid returns false.

import { getLegalNature } from '@brazilian-utils/brazilian-utils';

getLegalNature('2062');
// {
//   code: '2062',
//   description: 'Sociedade Empresária Limitada',
//   category: { code: '2', description: 'Entidades Empresariais' },
//   legacy: false,
// }
getLegalNature('2208');
// {
//   code: '2208',
//   description: 'Entidade Binacional Itaipu',
//   category: { code: '2', description: 'Entidades Empresariais' },
//   legacy: true,
//   currentCode: '2275',
// }
getLegalNature('3123')?.currentCode; // null (retired without a successor)
getLegalNature('206-2')?.code; // '2062'
getLegalNature('206.2')?.category.description; // 'Entidades Empresariais'
getLegalNature(206.2); // null (a number is only read when it is a non-negative safe integer: write the dotted form as a string)
getLegalNature('0000'); // null

List

• JavaScript library
• Python library1 case fails
• Go library
• Ruby library1 case fails
• Rust library
• .NET library1 case fails
• Erlang library

Returns the legal nature table as a map from code to description.

• By default, it returns only the 92 codes in force (params.includeLegacy is false). The table is CONCLA's Natureza Jurídica 2021.
• params.includeLegacy: true adds the 8 codes a past revision retired, 100 in all. legalNature.isValid and legalNature.get accept those codes either way.
• It returns a fresh object on every call.

import { getLegalNatures } from '@brazilian-utils/brazilian-utils';

const legalNatures = getLegalNatures();

legalNatures['2062']; // 'Sociedade Empresária Limitada'
Object.keys(legalNatures).length; // 92
legalNatures['2208']; // undefined (retired by a past revision)
getLegalNatures({ includeLegacy: true })['2208']; // 'Entidade Binacional Itaipu'

Get description

• JavaScript library
• Python library
• Go library
• Ruby library
• Rust library
• .NET library
• Erlang library

Returns the description of a legal nature code.

List by category

• JavaScript library
• Python library
• Go library1 case fails
• Ruby library2 cases fail
• Rust library
• .NET library2 cases fail
• Erlang library

Returns every legal nature of a CONCLA category (the first digit of the code), sorted by code.

• Categories: 1 Administração Pública, 2 Entidades Empresariais, 3 Entidades sem Fins Lucrativos, 4 Pessoas Físicas, 5 Organizações Internacionais e Outras Instituições Extraterritoriais.
• category may be a string or a number: "2" and 2 return the same list. A prefix ("20"), a full code ("2062"), a padded value (" 2", "02") and a value outside 1 to 5 are not categories.
• Only the codes in force are listed by default (options.includeLegacy is false).
• options.includeLegacy: true adds the codes a past revision retired (2076, 2100 and 2208 in category 2, 3042, 3050, 3093 and 3123 in category 3, 5002 in category 5). They come back with legacy: true and the currentCode.
• The result is a fresh array of fresh entries on every call.
• Returns an empty list for an unknown category or a value that is not a string or a number.

import { getLegalNaturesByCategory } from '@brazilian-utils/brazilian-utils';

getLegalNaturesByCategory('4')[0];
// {
//   code: '4014',
//   description: 'Empresa Individual Imobiliária',
//   category: { code: '4', description: 'Pessoas Físicas' },
//   legacy: false,
// }
getLegalNaturesByCategory(4).length; // 6
getLegalNaturesByCategory('2').length; // 30
getLegalNaturesByCategory('2', { includeLegacy: true }).length; // 33
getLegalNaturesByCategory('9'); // []