FinOpenPOS
API ReferenceClasses

AccessKey

@finopenpos/fiscal / AccessKey

Defined in: value-objects/access-key.ts:19

Immutable 44-digit NF-e/NFC-e access key with component extraction methods.

Constructors

Constructor

new AccessKey(key): AccessKey;

Defined in: value-objects/access-key.ts:22

Parameters

ParameterType
keystring

Returns

AccessKey

Methods

build()

static build(params): AccessKey;

Defined in: value-objects/access-key.ts:37

Build an access key from its component parts. Concatenates all parts, computes the mod-11 check digit, and returns an AccessKey.

Parameters

ParameterType
paramsAccessKeyParams

Returns

AccessKey


calculateMod11()

static calculateMod11(digits): string;

Defined in: value-objects/access-key.ts:60

Calculate modulo 11 check digit. Weights cycle from 2 to 9 right-to-left. Result: if remainder < 2 then digit 0; else 11 - remainder.

Parameters

ParameterType
digitsstring

Returns

string


checkDigit()

checkDigit(): string;

Defined in: value-objects/access-key.ts:115

Returns

string


emissionType()

emissionType(): number;

Defined in: value-objects/access-key.ts:105

Returns

number


model()

model(): number;

Defined in: value-objects/access-key.ts:90

Returns

number


number()

number(): number;

Defined in: value-objects/access-key.ts:100

Returns

number


numericCode()

numericCode(): string;

Defined in: value-objects/access-key.ts:110

Returns

string


series()

series(): number;

Defined in: value-objects/access-key.ts:95

Returns

number


stateCode()

stateCode(): string;

Defined in: value-objects/access-key.ts:75

Returns

string


taxId()

taxId(): string;

Defined in: value-objects/access-key.ts:85

Returns

string


toString()

toString(): string;

Defined in: value-objects/access-key.ts:120

Returns

string


yearMonth()

yearMonth(): string;

Defined in: value-objects/access-key.ts:80

Returns

string

On this page