Skip to main content
Get Document

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

documentId
integer<int32>
required

The identifier of the Document object

$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.

Response

OK

Carrier object for Document. Services for the Document Carrier is available from the Document Agent.

DocumentId
integer<int32>

Primary key

Attention
string

Attention/salutation

Header
string

Visible document name

Name
string

File name

OurRef
string

Our reference, searchable field from freetext search

YourRef
string

Your reference

Description
string

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

DocumentTemplate
string
IsPublished
boolean

True if document have an entry in published table

PersonId
integer<int32>

Person ID of person the appointment is with, may be 0

PersonFullName
string

The full name of the person this document belongs to.

AssociateFullName
string

The associate's culture formatted fullname (firstname, middleName and lastname)

ContactId
integer<int32>

Contact ID of owning contact, may be 0

ContactName
string

Contact name

ProjectId
integer<int32>

ID of project referred to, may be 0

ProjectName
string

Project name

AssociateId
integer<int32>

ID of associate whose diary the appointment is in, REQUIRED

Snum
integer<int32>

The sequence number allocated from refcount on used template when creating the document

SaleId
integer<int32>

Owning sale, if any (may be 0)

SaleName
string

Heading of Owning sale, if any. (may be blank)

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.