verifactu-sdk API

---

verifactu-sdk API / VerifactuClientOptions

Interface: VerifactuClientOptions

Defined in: src/client/VerifactuClient.ts:90

Constructor options for VerifactuClient.

Properties

environment

readonly environment: Environment

Defined in: src/client/VerifactuClient.ts:92

Target AEAT environment.

---

mode

readonly mode: Mode

Defined in: src/client/VerifactuClient.ts:94

Submission mode — voluntary VERI*FACTU or on-request.

---

certificate

readonly certificate: ClientCertificate

Defined in: src/client/VerifactuClient.ts:96

Client certificate used for mTLS (and XAdES signing in on-request mode).

---

taxpayer

readonly taxpayer: Taxpayer

Defined in: src/client/VerifactuClient.ts:98

Tax-obligated party identification (NIF + legal name).

---

representative?

readonly optional representative?: Taxpayer

Defined in: src/client/VerifactuClient.ts:100

Optional representative (advisor/agent) acting on behalf of the taxpayer.

---

billingSystem

readonly billingSystem: BillingSystem

Defined in: src/client/VerifactuClient.ts:102

Producer-software descriptor; used for every record that does not carry its own.

---

hashStore

readonly hashStore: HashStore

Defined in: src/client/VerifactuClient.ts:109

Pluggable hash-chain store. No default -- the chain's durability is a compliance requirement, not something the SDK can safely guess at. Use one of the bundled adapters (verifactu-sdk/store/{bun-sql,sqlite,pg,mysql,redis,drizzle}) or implement HashStore directly.

---

endpoint?

readonly optional endpoint?: string

Defined in: src/client/VerifactuClient.ts:111

Override the high-watermark SistemaInformatico endpoint (rare).

---

withSeal?

readonly optional withSeal?: boolean

Defined in: src/client/VerifactuClient.ts:113

Use the AEAT "with seal" mirror endpoints (www10 / prewww10).

---

flowControl?

readonly optional flowControl?: FlowControllerOptions

Defined in: src/client/VerifactuClient.ts:115

Flow-control tuning.

---

timeoutMs?

readonly optional timeoutMs?: number

Defined in: src/client/VerifactuClient.ts:117

Wall-clock timeout for SOAP calls. Defaults to 60 s.

---

requirementReference?

readonly optional requirementReference?: string

Defined in: src/client/VerifactuClient.ts:119

AEAT RefRequerimiento (mandatory for on-request mode).

---

idVersion?

readonly optional idVersion?: "1.0"

Defined in: src/client/VerifactuClient.ts:121

Cabecera.IDVersion value. Defaults to '1.0'.