API Documentation

  • Home
  • ChangeLog
  • Terms of use
  • Swagger UI
  • Account
  • Address
  • Analytic
  • BankAccount
  • Contact
  • Country
  • Currency
  • Customer
  • Dashboard
  • Document
  • DocumentNumbering
  • Employee
  • ExchangeRate
  • Inbox
  • IssuedInvoice
  • IssuedInvoicePosting
  • Item
  • Journal
  • JournalType
  • Order
  • Organisation
  • Outbox
  • PaymentMethod
  • PayrollSettings
  • PostalCode
  • ProductGroup
  • PurposeCode
  • ReceivedInvoice
  • ReportTemplate
  • Stock
  • StockEntry
  • User
  • VatAccountingType
  • VatRate
  • Warehouse

Document -> GetDocument

Returns a document.

Request

Relative request path: api/orgs/{organisationId}/documents/{documentId}

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
documentIddocument id

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

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
DocumentIdDocument id.
DocumentDateDocument date.
Customerclass Customer. Customer.
Employeeclass Employee. Employee.
DescriptionDocument description.
AttachmentsDocument attachments. List of AttachmentLink.
RecordDtModified
RowVersionRow version is used for concurrency check.

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

    /// Document details.
    public class Document
    {
        // Document id.
        // Ignored on create request.
        public long DocumentId { get; set; }
        // Document date.
        public DateTime DocumentDate { get; set; }
        // Customer.
        public mMApiFkField Customer { get; set; }
        // Employee.
        public mMApiFkField Employee { get; set; }
        // Document description.
        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.
        // 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.
            // Ignored on create request.
            public long DocumentAttachmentId { get; set; }
            // Attachment description.
            public string Description { get; set; }
            // Attachment name for file.
            public string FileName { get; set; }
            // Attachment mime type.
            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.
        // Ignored on create request.
        public $DocumentId;
        // Document date.
        public $DocumentDate;
        // Customer.
        public $Customer;
        // Employee.
        public $Employee;
        // Document description.
        public $Description;
        // Document attachments.
        public $Attachments;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // 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.
            // Ignored on create request.
            public $DocumentAttachmentId;
            // Attachment description.
            public $Description;
            // Attachment name for file.
            public $FileName;
            // Attachment mime type.
            public $MimeType;
            // Entry date.
            public $EntryDate;
        
        }

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

    /// Document details.
    public class Document
    {
        // Document id.
        // Ignored on create request.
        public Long DocumentId;
        // Document date.
        public Date DocumentDate;
        // Customer.
        public mMApiFkField Customer;
        // Employee.
        public mMApiFkField Employee;
        // Document description.
        public String Description;
        // Document attachments.
        public List<AttachmentLink> Attachments;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // 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.
            // Ignored on create request.
            public Long DocumentAttachmentId;
            // Attachment description.
            public String Description;
            // Attachment name for file.
            public String FileName;
            // Attachment mime type.
            public String MimeType;
            // Entry date.
            public Date EntryDate;
        
        }

 
Authorization endpoint : https://moj.minimax.si/SI/AUT/OAuth20
Token endpoint           : https://moj.minimax.si/SI/AUT/OAuth20/Token
Return url                   : https://moj.minimax.si/SI/API/Help/TestClientDialogsAuth
 
URI parameters
=
Headers | Add custom header
: Delete
Body
Samples:
Status
Headers
            
        
Body