Create Default Document Entity From Suggestion

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"SuggestedDocumentId\": 123\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({SuggestedDocumentId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'SuggestedDocumentId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion"

payload = { "SuggestedDocumentId": 123 }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({SuggestedDocumentId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "DocumentId": 123,
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Attention": "<string>",
  "Header": "<string>",
  "Name": "<string>",
  "OurRef": "<string>",
  "YourRef": "<string>",
  "CreatedDate": "2023-11-07T05:31:56Z",
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Description": "<string>",
  "DocumentTemplate": {
    "DocumentTemplateId": 123,
    "Name": "<string>",
    "Tooltip": "<string>",
    "SaveInDb": 123,
    "Filename": "<string>",
    "DefaultOref": "<string>",
    "RecordType": "Unknown",
    "Deleted": 123,
    "Direction": "Unknown",
    "AutoeventId": 123,
    "QuoteDocType": "None",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Associate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Date": "2023-11-07T05:31:56Z",
  "ExternalRef": "<string>",
  "Completed": "Unknown",
  "ActiveLinks": 123,
  "Type": "Unknown",
  "Links": [
    {
      "EntityName": "<string>",
      "Id": 123,
      "Description": "<string>",
      "ExtraInfo": "<string>",
      "LinkId": 123,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "LockSemantics": "None",
  "Sale": {
    "ContactName": "<string>",
    "SaleDate": "2023-11-07T05:31:56Z",
    "SaleId": 123,
    "Probability": 123,
    "Title": "<string>",
    "Amount": 123,
    "Currency": "<string>",
    "ProjectName": "<string>",
    "AssociateFullName": "<string>",
    "Description": "<string>",
    "Status": "Unknown",
    "WeightedAmount": 123,
    "ProjectId": 123,
    "EarningPercent": 123,
    "Earning": 123,
    "ContactId": 123,
    "AssociateId": 123,
    "PersonId": 123,
    "SaleTypeId": 123,
    "SaleTypeName": "<string>",
    "PersonFullName": "<string>",
    "Completed": "Unknown",
    "ActiveErpLinks": 123,
    "NextDueDate": "2023-11-07T05:31:56Z",
    "Number": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SuggestedDocumentId": 123,
  "Snum": 123,
  "UserDefinedFields": {},
  "ExtraFields": {},
  "CustomFields": {},
  "PublishEventDate": "2023-11-07T05:31:56Z",
  "PublishTo": "2023-11-07T05:31:56Z",
  "PublishFrom": "2023-11-07T05:31:56Z",
  "IsPublished": true,
  "VisibleFor": [
    {
      "VisibleId": 123,
      "Visibility": "All",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Create Default Document Entity From Suggestion

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"SuggestedDocumentId\": 123\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({SuggestedDocumentId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'SuggestedDocumentId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion"

payload = { "SuggestedDocumentId": 123 }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({SuggestedDocumentId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Document/CreateDefaultDocumentEntityFromSuggestion', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "DocumentId": 123,
  "UpdatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "CreatedBy": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Attention": "<string>",
  "Header": "<string>",
  "Name": "<string>",
  "OurRef": "<string>",
  "YourRef": "<string>",
  "CreatedDate": "2023-11-07T05:31:56Z",
  "UpdatedDate": "2023-11-07T05:31:56Z",
  "Description": "<string>",
  "DocumentTemplate": {
    "DocumentTemplateId": 123,
    "Name": "<string>",
    "Tooltip": "<string>",
    "SaveInDb": 123,
    "Filename": "<string>",
    "DefaultOref": "<string>",
    "RecordType": "Unknown",
    "Deleted": 123,
    "Direction": "Unknown",
    "AutoeventId": 123,
    "QuoteDocType": "None",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Person": {
    "Position": "<string>",
    "PersonId": 123,
    "Mrmrs": "<string>",
    "Firstname": "<string>",
    "Lastname": "<string>",
    "MiddleName": "<string>",
    "Title": "<string>",
    "Description": "<string>",
    "Email": "<string>",
    "FullName": "<string>",
    "DirectPhone": "<string>",
    "FormalName": "<string>",
    "CountryId": 123,
    "ContactId": 123,
    "ContactName": "<string>",
    "Retired": 123,
    "Rank": 123,
    "ActiveInterests": 123,
    "ContactDepartment": "<string>",
    "ContactCountryId": 123,
    "ContactOrgNr": "<string>",
    "FaxPhone": "<string>",
    "MobilePhone": "<string>",
    "ContactPhone": "<string>",
    "AssociateName": "<string>",
    "AssociateId": 123,
    "UsePersonAddress": true,
    "ContactFax": "<string>",
    "Kanafname": "<string>",
    "Kanalname": "<string>",
    "Post1": "<string>",
    "Post2": "<string>",
    "Post3": "<string>",
    "EmailName": "<string>",
    "ContactFullName": "<string>",
    "ActiveErpLinks": 123,
    "TicketPriorityId": 123,
    "SupportLanguageId": 123,
    "SupportAssociateId": 123,
    "CategoryName": "<string>",
    "PersonNumber": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Associate": {
    "AssociateId": 123,
    "Name": "<string>",
    "PersonId": 123,
    "Rank": 123,
    "Tooltip": "<string>",
    "Type": "Unknown",
    "GroupIdx": 123,
    "FullName": "<string>",
    "FormalName": "<string>",
    "Deleted": true,
    "EjUserId": 123,
    "UserName": "<string>",
    "ExtraFields": {},
    "CustomFields": {},
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Contact": {
    "ContactId": 123,
    "Name": "<string>",
    "OrgNr": "<string>",
    "Department": "<string>",
    "URL": "<string>",
    "City": "<string>",
    "DirectPhone": "<string>",
    "AssociateId": 123,
    "CountryId": 123,
    "EmailAddress": "<string>",
    "Kananame": "<string>",
    "EmailAddressName": "<string>",
    "URLName": "<string>",
    "AssociateFullName": "<string>",
    "BusinessName": "<string>",
    "CategoryName": "<string>",
    "CountryName": "<string>",
    "Address": {
      "Wgs84Latitude": 123,
      "Wgs84Longitude": 123,
      "LocalizedAddress": [
        [
          {
            "Name": "<string>",
            "Value": "<string>",
            "Tooltip": "<string>",
            "Label": "<string>",
            "ValueLength": 123,
            "AddressType": "<string>",
            "TableRight": {
              "Mask": "<string>",
              "Reason": "<string>"
            },
            "FieldProperties": {}
          }
        ]
      ],
      "Street": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Postal": {
        "AtypeIdx": "Unknown",
        "Address1": "<string>",
        "Address2": "<string>",
        "Address3": "<string>",
        "City": "<string>",
        "County": "<string>",
        "State": "<string>",
        "Zipcode": "<string>",
        "Formatted": "<string>"
      },
      "Formatted": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    },
    "FormattedAddress": "<string>",
    "FullName": "<string>",
    "IsOwnerContact": true,
    "ActiveErpLinks": 123,
    "Number1": "<string>",
    "Number2": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Project": {
    "ProjectId": 123,
    "Name": "<string>",
    "Description": "<string>",
    "URL": "<string>",
    "Type": "<string>",
    "AssociateId": 123,
    "AssociateFullName": "<string>",
    "TypeId": 123,
    "Updated": "2023-11-07T05:31:56Z",
    "StatusId": 123,
    "Status": "<string>",
    "TextId": 123,
    "PublishTo": "2023-11-07T05:31:56Z",
    "PublishFrom": "2023-11-07T05:31:56Z",
    "IsPublished": true,
    "URLName": "<string>",
    "ProjectNumber": "<string>",
    "ActiveErpLinks": 123,
    "EventId": 123,
    "StartDate": "2023-11-07T05:31:56Z",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Date": "2023-11-07T05:31:56Z",
  "ExternalRef": "<string>",
  "Completed": "Unknown",
  "ActiveLinks": 123,
  "Type": "Unknown",
  "Links": [
    {
      "EntityName": "<string>",
      "Id": 123,
      "Description": "<string>",
      "ExtraInfo": "<string>",
      "LinkId": 123,
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "LockSemantics": "None",
  "Sale": {
    "ContactName": "<string>",
    "SaleDate": "2023-11-07T05:31:56Z",
    "SaleId": 123,
    "Probability": 123,
    "Title": "<string>",
    "Amount": 123,
    "Currency": "<string>",
    "ProjectName": "<string>",
    "AssociateFullName": "<string>",
    "Description": "<string>",
    "Status": "Unknown",
    "WeightedAmount": 123,
    "ProjectId": 123,
    "EarningPercent": 123,
    "Earning": 123,
    "ContactId": 123,
    "AssociateId": 123,
    "PersonId": 123,
    "SaleTypeId": 123,
    "SaleTypeName": "<string>",
    "PersonFullName": "<string>",
    "Completed": "Unknown",
    "ActiveErpLinks": 123,
    "NextDueDate": "2023-11-07T05:31:56Z",
    "Number": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "SuggestedDocumentId": 123,
  "Snum": 123,
  "UserDefinedFields": {},
  "ExtraFields": {},
  "CustomFields": {},
  "PublishEventDate": "2023-11-07T05:31:56Z",
  "PublishTo": "2023-11-07T05:31:56Z",
  "PublishFrom": "2023-11-07T05:31:56Z",
  "IsPublished": true,
  "VisibleFor": [
    {
      "VisibleId": 123,
      "Visibility": "All",
      "DisplayValue": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

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

SuggestedDocumentId

CreateDefaultDocumentEntityFromSuggestion:

SuggestedDocumentId

integer<int32>

Response

Partial DocumentEntity class associating the generated DocumentEntity with an interface.

DocumentId

integer<int32>

Primary key

UpdatedBy

object

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

Show child attributes

CreatedBy

object

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

Show child attributes

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

CreatedDate

string<date-time>

Registered when in UTC.

UpdatedDate

string<date-time>

Last updated when in UTC.

Description

string

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

DocumentTemplate

object

The template a document is based on is stored in the SO_arc\template folder on the server. This will return the name as displayed in the GUI, and not the physical document name, of the template the document object is based on. Carrier object for DocumentTemplate. Services for the DocumentTemplate Carrier is available from the List Agent.

Show child attributes

Person

object

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

Show child attributes

Associate

object

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

Show child attributes

Contact

object

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

Show child attributes

Project

object

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

Show child attributes

Date

string<date-time>

date + start time planned

ExternalRef

string

External reference for document plugin to resolve document identity (Notes ID, e-mail message ID, whatever)

Completed

enum<string>

Document Completed state. This is the part of the Status property.

Available options:

Unknown,

NotStarted,

Started,

Completed

ActiveLinks

integer<int32>

Number of active links to sale, document, appointment.

Type

enum<string>

Is this a normal document or a mail-merge or report?

Available options:

Unknown,

inDiary,

inChecklist,

Note,

Document,

SavedReport,

BookingForDiary,

BookingForChecklist,

MergeDraft,

MergeFinal

Links

object[]

List of all elements linked to the document.

Show child attributes

LockSemantics

enum<string>

Available options:

None,

Locking,

Versioning

Sale

object

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

Show child attributes

SuggestedDocumentId

integer<int32>

Suggested guide item that this document is an instance of (Note: NOT valid for appointments, they have their own link)

Snum

integer<int32>

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

UserDefinedFields

object

Deprecated: Use {SuperOffice.CRM.Services.DocumentEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

Show child attributes

ExtraFields

object

Deprecated: Use {SuperOffice.CRM.Services.DocumentEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Show child attributes

CustomFields

object

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.DocumentEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.

Show child attributes

PublishEventDate

string<date-time>

Publish event date

PublishTo

string<date-time>

Publication valid to (inclusive)

PublishFrom

string<date-time>

Publication valid from (inclusive)

IsPublished

boolean

Publication is published

VisibleFor

object[]

The set of users or groups the record is visible for

Show child attributes

TableRight

object

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

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes