Skip to main content
Get Document Template List

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

The identifiers of the DocumentTemplate object

Response

OK

DocumentTemplateId
integer<int32>

Primary key

Name
string

The list item

Tooltip
string

Tooltip or other description

SaveInDb
integer<int32>

1 = save document records in DB; otherwise not.

Filename
string

Relative to TemplatePath

DefaultOref
string

Processed via tag substitution to give document reference

RecordType
enum<string>

1 = app, 2 = doc, 3 = email, 4 = fax, 5 = phone, 6 = todo - see EAppntRecordTypes

Available options:
Unknown,
Appointment,
Document,
Email,
Fax,
Phone,
Todo,
MergeDraft,
MergeFinal,
SavedReport
Deleted
integer<int32>

0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

Direction
enum<string>

1 = incoming, 2 = outgoing, see EAppntDirection

Available options:
Unknown,
Incoming,
Outgoing,
SaintAll
AutoeventId
integer<int32>

Which document plugin is responsible for the documents generated from this template

QuoteDocType
enum<string>

What type of quote document is this.

Available options:
None,
MailBody,
MainDocument,
QuoteLines,
ConfirmationMailBody,
ConfirmationLines
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.