API Documentation

Filter options:

    /// GetItemsData search filter.
    public class ItemsDataFilter
    {
        // WarehouseId
        public long? WarehouseId { get; set; }
        // CustomerId
        public long? CustomerId { get; set; }
        // ItemId
        public long? ItemId { get; set; }
    
    }

Request parameters:

• long organisationId - organisation id

Filter options:

    /// GetItemsData search filter.
    class ItemsDataFilter
    {
        // WarehouseId
        public $WarehouseId;
        // CustomerId
        public $CustomerId;
        // ItemId
        public $ItemId;
    
    }

Request parameters:

• Int64 organisationId - organisation id

Filter options:

    /// GetItemsData search filter.
    public class ItemsDataFilter
    {
        // WarehouseId
        public Long WarehouseId;
        // CustomerId
        public Long CustomerId;
        // ItemId
        public Long ItemId;
    
    }

Request parameters:

• Long organisationId - organisation id

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

    /// ListResult is the return type for all list api methods.
    public class ListResult<T>
    {
        // Returned rows.
        public T Rows { get; set; }
        // Validation messages.
        public List<mMApiValidationMessage> ValidationMessages { get; set; }
    
    }

        /// Returns items title, code, price and unit of measurement for the given item
        public class ItemData
        {
            // Item title.
            public string Title { get; set; }
            // Item code.
            public string Code { get; set; }
            // Item selling price.
            public Decimal Price { get; set; }
            // Item unit of measurement.
            public string UnitOfMeasurement { get; set; }
            // Item id.
            public mMApiFkField Item { get; set; }
            // Warehouse id.
            public mMApiFkField Warehouse { get; set; }
            // Customer id.
            public mMApiFkField Customer { 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 mMApiValidationMessage
        {
            public string Message { get; set; }
            public string PropertyName { get; set; }
        
        }

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

    /// ListResult is the return type for all list api methods.
    class ListResult
    {
        // Returned rows.
        public $Rows;
        // Validation messages.
        public $ValidationMessages;
    
    }

        /// Returns items title, code, price and unit of measurement for the given item
        class ItemData
        {
            // Item title.
            public $Title;
            // Item code.
            public $Code;
            // Item selling price.
            public $Price;
            // Item unit of measurement.
            public $UnitOfMeasurement;
            // Item id.
            public $Item;
            // Warehouse id.
            public $Warehouse;
            // Customer id.
            public $Customer;
        
        }

            /// 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 mMApiValidationMessage
        {
            public $Message;
            public $PropertyName;
        
        }

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

    /// ListResult is the return type for all list api methods.
    public class ListResultT
    {
        // Returned rows.
        public T Rows;
        // Validation messages.
        public List<mMApiValidationMessage> ValidationMessages;
    
    }

        /// Returns items title, code, price and unit of measurement for the given item
        public class ItemData
        {
            // Item title.
            public String Title;
            // Item code.
            public String Code;
            // Item selling price.
            public Double Price;
            // Item unit of measurement.
            public String UnitOfMeasurement;
            // Item id.
            public mMApiFkField Item;
            // Warehouse id.
            public mMApiFkField Warehouse;
            // Customer id.
            public mMApiFkField Customer;
        
        }

            /// 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 mMApiValidationMessage
        {
            public String Message;
            public String PropertyName;
        
        }