Document

A single document.

More info: see the get operation and the documents endpoint.

Fields

FieldDescription
id
int 
(required)

Unique ID

Example value:123
typeid
int 
(required)

Type ID

Example value:10001
name
mlstring 
(required)

Name of the document

Example value:"Invoice"
css
string 
(required)

Css content for the document template

Example value:"@page { padding: 0; margin: 0pt 0pt 0pt 0pt; size: 152mm 82mm; }"
description
mlstring 
(required)

Description of the document

Example value:"Invoice document"
enabled
bool 
(required)

Translations for the document template

Example value:true
htmltemplate
string 
(required)

HTML content for the document template

Example value:"<html><head><meta charset="UTF-8"><\/head><body><\/body><\/html>"
options
DocumentOptions 
(required)

Key-value array of options. Can contain: nbrperpage

Example value:{ "nbrperpage": 4 }
translations
map<string, string> 
(required)

Translations for the document template

Example value:{ "en": "...", "nl": "..." }
createdts
timestamp 
(required)

Created timestamp

Example value:"2014-09-26 15:24:36"
lastupdatets
timestamp 
(required)

Last updated timestamp

Example value:"2014-09-26 15:24:36"

Example

 1{
 2    "id": 123,
 3    "typeid": 10001,
 4    "name": "Invoice",
 5    "css": "@page {
 6    padding: 0;
 7    margin: 0pt 0pt 0pt 0pt;
 8    size: 152mm 82mm;
 9}",
10    "description": "Invoice document",
11    "enabled": true,
12    "htmltemplate": "<html><head><meta charset="UTF-8"><\/head><body><\/body><\/html>",
13    "options": {
14        "nbrperpage": 4
15    },
16    "translations": {
17        "en": "...",
18        "nl": "..."
19    },
20    "createdts": "2014-09-26 15:24:36",
21    "lastupdatets": "2014-09-26 15:24:36"
22}