Skip to content

verifactu-sdk API


verifactu-sdk API / VerifactuClientOptions

Interface: VerifactuClientOptions

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

Constructor options for VerifactuClient.

Properties

environment

readonly environment: Environment

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

Target AEAT environment.


mode

readonly mode: Mode

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

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


certificate

readonly certificate: ClientCertificate

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

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


taxpayer

readonly taxpayer: Taxpayer

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

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


representative?

readonly optional representative?: Taxpayer

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

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


billingSystem

readonly billingSystem: BillingSystem

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

Producer-software descriptor; appended to every record.


hashStore?

readonly optional hashStore?: HashStore

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

Pluggable hash-chain store. Defaults to InMemoryHashStore.


endpoint?

readonly optional endpoint?: string

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

Override the high-watermark SistemaInformatico endpoint (rare).


withSeal?

readonly optional withSeal?: boolean

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

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


flowControl?

readonly optional flowControl?: FlowControllerOptions

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

Flow-control tuning.


timeoutMs?

readonly optional timeoutMs?: number

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

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


requirementReference?

readonly optional requirementReference?: string

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

AEAT RefRequerimiento (mandatory for on-request mode).


idVersion?

readonly optional idVersion?: "1.0"

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

Cabecera.IDVersion value. Defaults to '1.0'.

Released under the MIT license.