Layouts

Items uit het domein “layouts” stellen een layout voor. Een layout wordt toegekend aan een document en bepaald de look-and-feel van een afgedrukt document.

Opbouw URL’s:

  • https://eenvoudigfactureren.be/api/v1/layouts: Layouts
  • https://eenvoudigfactureren.be/api/v1/layouts/8001: Layout met ID 8001

Domein : layouts

Veldnaam Type Omschrijving Voorbeeld
layout_id int Unieke ID van de layout. Gegenereerd door het systeem. Op te geven in URL. 8001
name text Naam van de layout. Verplicht veld. Maximaal 50 karakters lang. Mijn layout
version text Type generator van de layout. Kan de waarde “predefined”, “dompdf1” of “custom_dompdf” bevatten. dompdf1
settings list Variabelen die worden gebruikt door de generator om de layout op te bouwen. Afhankelijk van de gebruikte generator. –
template text HTML-template van de layout. Op basis van de template wordt een afgedrukt document aangemaakt –
active text Beschrijft of de layout actief is. Kan waarde ‘yes’ of ‘no’ hebben. yes

Voorbeeld in XML van een layout:

<layout>
	<layout_id>8001</layout_id>
	<name>Mijn layout</name>
	<version>dompdf1</version>
	<settings>
		<value1>value</value1>
	</settings>
	<template><html>Mijn template</html></template>
	<active>yes</active>
</layout>