verifactu-sdk API

---

verifactu-sdk API / CancelInvoiceRequest

Interface: CancelInvoiceRequest

Defined in: src/types.ts:406

Cancellation input of VerifactuClient.cancelInvoice and VerifactuClient.registerBatch: a CancelInvoiceInput whose client-managed fields are optional. A full CancelInvoiceInput is still accepted.

Extends

• Omit<CancelInvoiceInput, "billingSystem" | "chainLink" | "hash">

Properties

cancelledInvoiceId

cancelledInvoiceId: InvoiceId

Defined in: src/types.ts:361

Identifier of the invoice to cancel.

Inherited from

CancelInvoiceInput.cancelledInvoiceId

---

externalReference?

optional externalReference?: string

Defined in: src/types.ts:363

Optional caller-supplied external reference.

Inherited from

CancelInvoiceInput.externalReference

---

withoutPriorRecord?

optional withoutPriorRecord?: YesNo

Defined in: src/types.ts:365

'S' when the invoice never existed in AEAT (rare; usually omitted).

Inherited from

CancelInvoiceInput.withoutPriorRecord

---

priorRejection?

optional priorRejection?: YesNo

Defined in: src/types.ts:367

Prior-rejection flag for the cancellation event.

Inherited from

CancelInvoiceInput.priorRejection

---

generatedBy?

optional generatedBy?: "T" | "D" | "E"

Defined in: src/types.ts:369

Who emits the cancellation: 'E' issuer, 'D' recipient, 'T' third party.

Inherited from

CancelInvoiceInput.generatedBy

---

generator?

optional generator?: Counterpart

Defined in: src/types.ts:371

Identifier of the cancellation generator (required when generatedBy is set).

Inherited from

CancelInvoiceInput.generator

---

generatedAt

generatedAt: string

Defined in: src/types.ts:380

ISO 8601 timestamp with timezone when the cancellation was generated. Part of the hash — reuse it on retries, as with Invoice.generatedAt.

Inherited from

CancelInvoiceInput.generatedAt

---

billingSystem?

optional billingSystem?: BillingSystem

Defined in: src/types.ts:409

Producer-software descriptor; defaults to the client's billingSystem option.

---

chainLink?

optional chainLink?: ChainLink

Defined in: src/types.ts:411

Ignored: the client chains the record to the tail of its HashStore.

---

hash?

optional hash?: string

Defined in: src/types.ts:413

Ignored: the client computes the hash.