Type Alias InvoiceServiceOptions

An array of supplementary attachments.

Set to invoice description if invoice should be embedded.

The invoice format like XRECHNUNG-UBL or Factur-X-Extended.

A language identifier like "fr-ca".

Path to LibreOffice executable.

Shut up warnings.

A PDF version of the invoice. For Factur-X, either data or pdf must be present.

Callback function invoked before the XML is rendered. This allows fine-tuning the output XML, for example by adding currently unsupported CII elements. Another use case is applying fixes for open bugs.

The data argument is a plain JavaScript object where all nodes are either an Array or another object, and all leaves are strings. The type ExpandObject is defined in xmlbuilder2.

UBL example:

const defaultNotes = [
	'We only use organic ingredients (no GMO)!',
	'We work exclusively with regional suppliers.',
];

invoiceServiceOptions.postProcessor = async (data: ExpandObject) => {
	const document = data['Invoice'] ?? data['CreditNote'];
	const notes = document['cbc:Note'];

	if (notes) {
		notes.push(...defaultNotes);
	} else {
		document['cbc:Note'] = [...defaultNotes];
	}
Copy

CII example:

const defaultNotes = [
	'We only use organic ingredients (no GMO)!',
	'We work exclusively with regional suppliers.',
];

const postProcessor = async (data: ExpandObject) => {
	if (
		data['rsm:CrossIndustryInvoice']['rsm:ExchangedDocument']![
			'ram:IncludedNote'
		]
	) {
		if (
			!Array.isArray(
				data['rsm:CrossIndustryInvoice']['rsm:ExchangedDocument']![
					'ram:IncludedNote'
				],
			)
		) {
			data['rsm:CrossIndustryInvoice']['rsm:ExchangedDocument']![
				'ram:IncludedNote'
			] = [
				data['rsm:CrossIndustryInvoice']['rsm:ExchangedDocument']![
					'ram:IncludedNote'
				],
			];
		}
	} else {
		data['rsm:CrossIndustryInvoice']['rsm:ExchangedDocument']![
			'ram:IncludedNote'
		] = [];
	}
	const notes =
		data['rsm:CrossIndustryInvoice']['rsm:ExchangedDocument'][
			'ram:IncludedNote'
		];
	for (const note of defaultNotes) {
		notes.push({ 'ram:Content': note });
	}
};
Copy

The spreadsheet data.