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

Stock -> GetStocks

Returns all items in stock for the given organization.

Request

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

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
ItemIDItem ID.
ItemTitleItem Title.
ItemIdentifierItem Identifier.
ItemEANCodeItem EANCode.
ItemTypeItem Type.
WarehouseIdWarehouse ID.
BatchNumberBatch Number.
DateDate.
ResultsByBatchNumberResultsByBatchNumber.
ModeIf parameter is set to 1 the function returns all items including the items that are not in stock but were in stock at some other time.
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:

    public class StockListSearchFilter
    {
        // Item ID.
        public long? ItemID { get; set; }
        // Item Title.
        public string ItemTitle { get; set; }
        // Item Identifier.
        public string ItemIdentifier { get; set; }
        // Item EANCode.
        public string ItemEANCode { get; set; }
        // Item Type.
        public string ItemType { get; set; }
        // Warehouse ID.
        public long? WarehouseId { get; set; }
        // Batch Number.
        public string BatchNumber { get; set; }
        // Date.
        public DateTime? Date { get; set; }
        // ResultsByBatchNumber.
        public string ResultsByBatchNumber { get; set; }
        // If parameter is set to 1 the function returns all items including the items that are not in stock but were in stock at some other time.
        public long? Mode { 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 - organisation id

Filter options:

    class StockListSearchFilter
    {
        // Item ID.
        public $ItemID;
        // Item Title.
        public $ItemTitle;
        // Item Identifier.
        public $ItemIdentifier;
        // Item EANCode.
        public $ItemEANCode;
        // Item Type.
        public $ItemType;
        // Warehouse ID.
        public $WarehouseId;
        // Batch Number.
        public $BatchNumber;
        // Date.
        public $Date;
        // ResultsByBatchNumber.
        public $ResultsByBatchNumber;
        // If parameter is set to 1 the function returns all items including the items that are not in stock but were in stock at some other time.
        public $Mode;
        // 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 - organisation id

Filter options:

    public class StockListSearchFilter
    {
        // Item ID.
        public Long ItemID;
        // Item Title.
        public String ItemTitle;
        // Item Identifier.
        public String ItemIdentifier;
        // Item EANCode.
        public String ItemEANCode;
        // Item Type.
        public String ItemType;
        // Warehouse ID.
        public Long WarehouseId;
        // Batch Number.
        public String BatchNumber;
        // Date.
        public Date Date;
        // ResultsByBatchNumber.
        public String ResultsByBatchNumber;
        // If parameter is set to 1 the function returns all items including the items that are not in stock but were in stock at some other time.
        public Long Mode;
        // 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 - organisation id

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
RowsReturned rows. List of StockListItem.
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; }
    
    }

        /// Stock list item details.
        public class StockListItem
        {
            // Item.
            public mMApiFkField Item { get; set; }
            // Item name.
            public string ItemName { get; set; }
            // Item code.
            public string ItemCode { get; set; }
            // Item EAN Code.
            public string ItemEANCode { get; set; }
            // Item unit of measurement.
            public string UnitOfMeasurement { get; set; }
            // Item average purchase price.
            public Decimal? AveragePurchasePrice { get; set; }
            // Item selling price.
            public Decimal? SellingPrice { get; set; }
            // Item quantity.
            public Decimal? Quantity { get; set; }
            // Item value.
            public Decimal? Value { get; set; }
            // Item batch number; present, if results are reported divided by batch number.
            public string BatchNumber { get; set; }
            // Currency.
            public mMApiFkField Currency { 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;
    
    }

        /// Stock list item details.
        class StockListItem
        {
            // Item.
            public $Item;
            // Item name.
            public $ItemName;
            // Item code.
            public $ItemCode;
            // Item EAN Code.
            public $ItemEANCode;
            // Item unit of measurement.
            public $UnitOfMeasurement;
            // Item average purchase price.
            public $AveragePurchasePrice;
            // Item selling price.
            public $SellingPrice;
            // Item quantity.
            public $Quantity;
            // Item value.
            public $Value;
            // Item batch number; present, if results are reported divided by batch number.
            public $BatchNumber;
            // Currency.
            public $Currency;
        
        }

            /// 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;
    
    }

        /// Stock list item details.
        public class StockListItem
        {
            // Item.
            public mMApiFkField Item;
            // Item name.
            public String ItemName;
            // Item code.
            public String ItemCode;
            // Item EAN Code.
            public String ItemEANCode;
            // Item unit of measurement.
            public String UnitOfMeasurement;
            // Item average purchase price.
            public Double AveragePurchasePrice;
            // Item selling price.
            public Double SellingPrice;
            // Item quantity.
            public Double Quantity;
            // Item value.
            public Double Value;
            // Item batch number; present, if results are reported divided by batch number.
            public String BatchNumber;
            // Currency.
            public mMApiFkField Currency;
        
        }

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