NBS

Check if an NBS (Nomenclatura Brasileira de Serviços, Intangíveis e Outras Operações que Produzam Variações no Patrimônio) code exists in the official NBS 2.0 table, the code the national NFS-e carries in cNBS.

• A code has 9 digits, printed as N.NNNN.NN.NN: the digit 1, the chapter, the position, the two subposition levels, the item and the subitem.
• Accepts a string with the 9 digits or with the mask, with any run of separators (space, ., - or /) between the groups and optional surrounding whitespace, or a non-negative safe integer. Any other string is rejected instead of having its digits picked out.
• Only complete codes are valid: the chapter (1.01), position (1.0101) and subposition (1.0101.1) headings classify nothing by themselves.
• The ANEXO B of the Sistema Nacional NFS-e lists the same 920 codes except three (1.0402.29.00, 1.0403.29.00 and 1.0904.40.00), so a code valid here can still be refused by the NFS-e.

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

isValidNbs('1.0101.11.00'); // true
isValidNbs('101011100'); // true
isValidNbs(101011100); // true
isValidNbs('1.0101'); // false (a position heading, not a complete code)
isValidNbs('1.9999.99.99'); // false
isValidNbs('1.0101abc11.00'); // false (not a documented form)

Format an NBS (Nomenclatura Brasileira de Serviços) code into the N.NNNN.NN.NN mask the nomenclature prints. Only the structure changes; use isValidNbs to check a code against the table.

• Options (FormatNbsOptions): pad (default false) first left pads the value with zeros to the 9 digits of a complete code (every NBS code starts with 1, so it only serves a fixed width). An empty value, or one without digits, gives '' even with pad.
• Same rules as formatCnae otherwise: the mask is applied as far as the value goes, characters outside it are dropped, and a number is read as the string of its digits only when it is a non-negative safe integer; any other number returns ''.

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

formatNbs('101011100'); // 1.0101.11.00
formatNbs(101011100); // 1.0101.11.00
formatNbs('10101'); // 1.0101 (masked as far as it goes)
formatNbs('1', { pad: true }); // 0.0000.00.01 (padded to 9 digits first)
formatNbs('abc101011100'); // 1.0101.11.00 (only the digits are read)
formatNbs(-101011100); // '' (not a non-negative safe integer)

Remove NBS (Nomenclatura Brasileira de Serviços) formatting, keep only digits, and cap the result to the 9 digits of a complete code.

• Same rules as parseCbo: nothing is left padded here.

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

parseNbs('1.0101.11.00'); // '101011100'

Look an NBS (Nomenclatura Brasileira de Serviços) code up and get its official description. The result is an Nbs record: { code, description }.

• Same rules as isValidNbs. code is the 9 digits, without the mask. Returns null when the code is unknown or the value is not in a documented form.

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

getNbs('1.0101.11.00');
// { code: '101011100', description: 'Serviços de construção de edificações residenciais de um e dois pavimentos' }

getNbs(126050000); // { code: '126050000', description: 'Serviços domésticos' }
getNbs('1.0101'); // null (a position heading, not a complete code)
getNbs('1.9999.99.99'); // null

Source: NBS 2.0 table published by the MDIC, approved by the Portaria Conjunta RFB/SCS 1.429/2018 and amended by the Portaria Conjunta RFB/SCS 2.000/2018.