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

Inbox -> GetInboxItems

Returns all inbox Items for a given organization.

Request

Relative request path: api/orgs/{organisationId}/inbox

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationId
InboxTypeInbox type.
InboxImportStatusInbox import status
InboxDateFromInbox date from.
InboxDateToInbox date to.
CurrentPageCurrent page index starting with 1 for first page.
PageSizePage size defines number of records returned per page.
SortFieldField name that is used for sorting/ordering result rows.
OrderSort order: A - ascending; D - descending

Filter options:

    /// Inbox search filter.
    public class InboxSearchFilter
    {
        // Inbox type.
        public string InboxType { get; set; }
        // Inbox import status
        public Boolean InboxImportStatus { get; set; }
        // Inbox date from.
        public DateTime? InboxDateFrom { get; set; }
        // Inbox date to.
        public DateTime? InboxDateTo { get; set; }
        // Current page index starting with 1 for first page.
        public int CurrentPage { get; set; }
        // Page size defines number of records returned per page.
        public int PageSize { get; set; }
        // Field name that is used for sorting/ordering result rows.
        public string SortField { get; set; }
        // Sort order: A - ascending; D - descending
        public string Order { get; set; }
    
    }

Request parameters:

  • long organisationId -

Filter options:

    /// Inbox search filter.
    class InboxSearchFilter
    {
        // Inbox type.
        public $InboxType;
        // Inbox import status
        public $InboxImportStatus;
        // Inbox date from.
        public $InboxDateFrom;
        // Inbox date to.
        public $InboxDateTo;
        // Current page index starting with 1 for first page.
        public $CurrentPage;
        // Page size defines number of records returned per page.
        public $PageSize;
        // Field name that is used for sorting/ordering result rows.
        public $SortField;
        // Sort order: A - ascending; D - descending
        public $Order;
    
    }

Request parameters:

  • Int64 organisationId -

Filter options:

    /// Inbox search filter.
    public class InboxSearchFilter
    {
        // Inbox type.
        public String InboxType;
        // Inbox import status
        public Boolean InboxImportStatus;
        // Inbox date from.
        public Date InboxDateFrom;
        // Inbox date to.
        public Date InboxDateTo;
        // Current page index starting with 1 for first page.
        public Integer CurrentPage;
        // Page size defines number of records returned per page.
        public Integer PageSize;
        // Field name that is used for sorting/ordering result rows.
        public String SortField;
        // Sort order: A - ascending; D - descending
        public String Order;
    
    }

Request parameters:

  • Long organisationId -

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
RowsReturned rows. List of Inbox.
TotalRowsNumber of rows matching search condition.
CurrentPageNumberCurrent page number. Result rows are returned in pages.
PageSizeNumbers of rows returned per page.

This method returns result of type 'SAOP.API.Models.SearchResult`1'.

    /// SearchResult is default return type for all search api methods.
    public class SearchResult<T>
    {
        // Returned rows.
        public T Rows { get; set; }
        // Number of rows matching search condition.
        public long TotalRows { get; set; }
        // Current page number. Result rows are returned in pages.
        public long CurrentPageNumber { get; set; }
        // Numbers of rows returned per page.
        public long PageSize { get; set; }
    
    }

        public class Inbox
        {
            // Ignored on create request.
            public long InboxId { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Employee.
            public mMApiFkField Employee { get; set; }
            // Inbox date.
            // Ignored on create request.
            public DateTime InboxDate { get; set; }
            // Inbox type:
            // <ul>
            //     <li>PR - for received invoice</li>
            //     <li>IZP - for bank statements</li>
            //     <li>Ostalo - for other types</li>
            //     <li>Neznano - for unknown types</li>
            // </ul>

            public string InboxType { get; set; }
            // Description
            public string Description { get; set; }
            // Status  of recived invoice:
            // <ul>
            //     <li>Zavrnjen – Rejected</li>
            //     <li>Storniran – Revoked</li>
            //     <li>Odobren – Approved</li>
            //     <li>Preklican – Canceled </li>
            // </ul>

            // Ignored on create request.
            public string StatusOfReceivedInvoice { get; set; }
            // Defines if received invoice has allowed bookkepping even though it is not Approved.
            // Ignored on create request.
            public string BookkeepingAllowed { get; set; }
            // Provider of the electronic route.
            // Ignored on create request.
            public string EProvider { get; set; }
            // Inbox attachments.
            public List<InboxAttachment> 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; }
            
            }
            public class InboxAttachment
            {
                // Ignored on create request.
                public long InboxAttachmentId { get; set; }
                // Inbox.
                public mMApiFkField Inbox { get; set; }
                // Attachment data.
                public string AttachmentData { get; set; }
                // Attachment entry date.
                // Ignored on create request.
                public DateTime AttachmentDate { get; set; }
                // Attachment name for file.
                public string AttachmentFileName { get; set; }
                // Attachment mime type.
                public string AttachmentMimeType { 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; }
                
                }

This method returns result of type 'SAOP.API.Models.SearchResult`1'.

    /// SearchResult is default return type for all search api methods.
    class SearchResult
    {
        // Returned rows.
        public $Rows;
        // Number of rows matching search condition.
        public $TotalRows;
        // Current page number. Result rows are returned in pages.
        public $CurrentPageNumber;
        // Numbers of rows returned per page.
        public $PageSize;
    
    }

        class Inbox
        {
            // Ignored on create request.
            public $InboxId;
            // Customer.
            public $Customer;
            // Employee.
            public $Employee;
            // Inbox date.
            // Ignored on create request.
            public $InboxDate;
            // Inbox type:
            // <ul>
            //     <li>PR - for received invoice</li>
            //     <li>IZP - for bank statements</li>
            //     <li>Ostalo - for other types</li>
            //     <li>Neznano - for unknown types</li>
            // </ul>

            public $InboxType;
            // Description
            public $Description;
            // Status  of recived invoice:
            // <ul>
            //     <li>Zavrnjen – Rejected</li>
            //     <li>Storniran – Revoked</li>
            //     <li>Odobren – Approved</li>
            //     <li>Preklican – Canceled </li>
            // </ul>

            // Ignored on create request.
            public $StatusOfReceivedInvoice;
            // Defines if received invoice has allowed bookkepping even though it is not Approved.
            // Ignored on create request.
            public $BookkeepingAllowed;
            // Provider of the electronic route.
            // Ignored on create request.
            public $EProvider;
            // Inbox 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;
            
            }
            class InboxAttachment
            {
                // Ignored on create request.
                public $InboxAttachmentId;
                // Inbox.
                public $Inbox;
                // Attachment data.
                public $AttachmentData;
                // Attachment entry date.
                // Ignored on create request.
                public $AttachmentDate;
                // Attachment name for file.
                public $AttachmentFileName;
                // Attachment mime type.
                public $AttachmentMimeType;
                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;
                
                }

This method returns result of type 'SAOP.API.Models.SearchResult`1'.

    /// SearchResult is default return type for all search api methods.
    public class SearchResultT
    {
        // Returned rows.
        public T Rows;
        // Number of rows matching search condition.
        public Long TotalRows;
        // Current page number. Result rows are returned in pages.
        public Long CurrentPageNumber;
        // Numbers of rows returned per page.
        public Long PageSize;
    
    }

        public class Inbox
        {
            // Ignored on create request.
            public Long InboxId;
            // Customer.
            public mMApiFkField Customer;
            // Employee.
            public mMApiFkField Employee;
            // Inbox date.
            // Ignored on create request.
            public Date InboxDate;
            // Inbox type:
            // <ul>
            //     <li>PR - for received invoice</li>
            //     <li>IZP - for bank statements</li>
            //     <li>Ostalo - for other types</li>
            //     <li>Neznano - for unknown types</li>
            // </ul>

            public String InboxType;
            // Description
            public String Description;
            // Status  of recived invoice:
            // <ul>
            //     <li>Zavrnjen – Rejected</li>
            //     <li>Storniran – Revoked</li>
            //     <li>Odobren – Approved</li>
            //     <li>Preklican – Canceled </li>
            // </ul>

            // Ignored on create request.
            public String StatusOfReceivedInvoice;
            // Defines if received invoice has allowed bookkepping even though it is not Approved.
            // Ignored on create request.
            public String BookkeepingAllowed;
            // Provider of the electronic route.
            // Ignored on create request.
            public String EProvider;
            // Inbox attachments.
            public List<InboxAttachment> 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;
            
            }
            public class InboxAttachment
            {
                // Ignored on create request.
                public Long InboxAttachmentId;
                // Inbox.
                public mMApiFkField Inbox;
                // Attachment data.
                public String AttachmentData;
                // Attachment entry date.
                // Ignored on create request.
                public Date AttachmentDate;
                // Attachment name for file.
                public String AttachmentFileName;
                // Attachment mime type.
                public String AttachmentMimeType;
                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;
                
                }

 
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