happypdf / EmbedFacturXOptions

Interface: EmbedFacturXOptions

Defined in: src/api/pdfa/facturx.ts:38

Options for [[embedFacturX]].

Properties

afRelationship?

optional afRelationship?: AFRelationship;

Defined in: src/api/pdfa/facturx.ts:69

Associated-file relationship. Defaults to [[AFRelationship.Alternative]], which is what Factur-X / ZUGFeRD expect for the embedded invoice XML.

---

conformanceLevel?

optional conformanceLevel?: FacturXConformanceLevel;

Defined in: src/api/pdfa/facturx.ts:58

Factur-X / ZUGFeRD profile. Defaults to 'EN 16931'.

---

creationDate?

optional creationDate?: Date;

Defined in: src/api/pdfa/facturx.ts:74

Attachment creation / modification dates (forwarded to [[PDFDocument.attach]]).

---

description?

optional description?: string;

Defined in: src/api/pdfa/facturx.ts:63

Human-readable description of the attached file.

---

documentType?

optional documentType?: string;

Defined in: src/api/pdfa/facturx.ts:53

Hybrid document type in capital letters. Defaults to 'INVOICE'.

---

fileName?

optional fileName?: string;

Defined in: src/api/pdfa/facturx.ts:43

Filename of the embedded XML invoice. Defaults to 'factur-x.xml'. Must match fx:DocumentFileName (set automatically from this value).

---

modificationDate?

optional modificationDate?: Date;

Defined in: src/api/pdfa/facturx.ts:75

---

version?

optional version?: string;

Defined in: src/api/pdfa/facturx.ts:48

Factur-X XML schema version advertised in XMP. Defaults to '1.0'.