API Documentation

Request parameters:

• long organisationId - organisation id
• long documentId - document id

Request parameters:

• Int64 organisationId - organisation id
• Int64 documentId - document id

Request parameters:

• Long organisationId - organisation id
• Long documentId - document id

This method returns result of type 'SAOP.API.Models.Document.Document'.

    /// Document details.
    public class Document
    {
        // Document id.
        // Mandatory field. Ignored on create request.
        public long DocumentId { get; set; }
        // Document date.
        // Mandatory field.
        public DateTime DocumentDate { get; set; }
        // Customer.
        public mMApiFkField Customer { get; set; }
        // Employee.
        public mMApiFkField Employee { get; set; }
        // Document description.
        // Max length: 255
        public string Description { get; set; }
        // Document attachments.
        public List<AttachmentLink> Attachments { get; set; }
        public DateTime RecordDtModified { get; set; }
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public string RowVersion { get; set; }
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public long? ID { get; set; }
            // Record name.
            public string Name { get; private set; }
            // Url to full record details.
            public string ResourceUrl { get; private set; }
        
        }
        /// Attachment list item.
        public class AttachmentLink
        {
            // Document attachment id.
            // Mandatory field. Ignored on create request.
            public long DocumentAttachmentId { get; set; }
            // Attachment description.
            // Mandatory field. Max length: 8000
            public string Description { get; set; }
            // Attachment name for file.
            // Max length: 250
            public string FileName { get; set; }
            // Attachment mime type.
            // Max length: 250
            public string MimeType { get; set; }
            // Entry date.
            public DateTime EntryDate { get; private set; }
        
        }

This method returns result of type 'SAOP.API.Models.Document.Document'.

    /// Document details.
    class Document
    {
        // Document id.
        // Mandatory field. Ignored on create request.
        public $DocumentId;
        // Document date.
        // Mandatory field.
        public $DocumentDate;
        // Customer.
        public $Customer;
        // Employee.
        public $Employee;
        // Document description.
        // Max length: 255
        public $Description;
        // Document attachments.
        public $Attachments;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public $RowVersion;
    
    }

        /// Link with id, name and url to related data.
        class mMApiFkField
        {
            // Record id.
            public $ID;
            // Record name.
            public $Name;
            // Url to full record details.
            public $ResourceUrl;
        
        }
        /// Attachment list item.
        class AttachmentLink
        {
            // Document attachment id.
            // Mandatory field. Ignored on create request.
            public $DocumentAttachmentId;
            // Attachment description.
            // Mandatory field. Max length: 8000
            public $Description;
            // Attachment name for file.
            // Max length: 250
            public $FileName;
            // Attachment mime type.
            // Max length: 250
            public $MimeType;
            // Entry date.
            public $EntryDate;
        
        }

This method returns result of type 'SAOP.API.Models.Document.Document'.

    /// Document details.
    public class Document
    {
        // Document id.
        // Mandatory field. Ignored on create request.
        public Long DocumentId;
        // Document date.
        // Mandatory field.
        public Date DocumentDate;
        // Customer.
        public mMApiFkField Customer;
        // Employee.
        public mMApiFkField Employee;
        // Document description.
        // Max length: 255
        public String Description;
        // Document attachments.
        public List<AttachmentLink> Attachments;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public String RowVersion;
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public Long ID;
            // Record name.
            public String Name;
            // Url to full record details.
            public String ResourceUrl;
        
        }
        /// Attachment list item.
        public class AttachmentLink
        {
            // Document attachment id.
            // Mandatory field. Ignored on create request.
            public Long DocumentAttachmentId;
            // Attachment description.
            // Mandatory field. Max length: 8000
            public String Description;
            // Attachment name for file.
            // Max length: 250
            public String FileName;
            // Attachment mime type.
            // Max length: 250
            public String MimeType;
            // Entry date.
            public Date EntryDate;
        
        }