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 -> UpdateDocumentAttachment

Updates document attachment.

Request

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

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
documentIddocument id
documentAttachmentIddocument attachment id
documentAttachmentNew documentAttachment data.

Request parameters:

  • long organisationId - organisation id
  • long documentId - document id
  • long documentAttachmentId - document attachment id
  • DocumentAttachment documentAttachment - New documentAttachment data.

    /// Document attachment details.
    public class DocumentAttachment
    {
        // Document attachment id.
        // Ignored on create request.
        public long DocumentAttachmentId { get; set; }
        // Document.
        public mMApiFkField Document { get; set; }
        // Attachment description.
        public string Description { get; set; }
        // Attachment data.
        public string AttachmentData { 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; 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; }
        
        }

Request parameters:

  • Int64 organisationId - organisation id
  • Int64 documentId - document id
  • Int64 documentAttachmentId - document attachment id
  • DocumentAttachment documentAttachment - New documentAttachment data.

    /// Document attachment details.
    class DocumentAttachment
    {
        // Document attachment id.
        // Ignored on create request.
        public $DocumentAttachmentId;
        // Document.
        public $Document;
        // Attachment description.
        public $Description;
        // Attachment data.
        public $AttachmentData;
        // Attachment name for file.
        public $FileName;
        // Attachment mime type.
        public $MimeType;
        // Entry date.
        public $EntryDate;
        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;
        
        }

Request parameters:

  • Long organisationId - organisation id
  • Long documentId - document id
  • Long documentAttachmentId - document attachment id
  • DocumentAttachment documentAttachment - New documentAttachment data.

    /// Document attachment details.
    public class DocumentAttachment
    {
        // Document attachment id.
        // Ignored on create request.
        public Long DocumentAttachmentId;
        // Document.
        public mMApiFkField Document;
        // Attachment description.
        public String Description;
        // Attachment data.
        public String AttachmentData;
        // Attachment name for file.
        public String FileName;
        // Attachment mime type.
        public String MimeType;
        // Entry date.
        public Date EntryDate;
        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;
        
        }

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
Version
Content
StatusCode
ReasonPhrase
Headers
RequestMessage
IsSuccessStatusCode

This method returns result of type 'HttpResponseMessage'.

This method returns result of type 'HttpResponseMessage'.

This method returns result of type 'HttpResponseMessage'.

 
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