API Documentation

  • Home
  • ChangeLog
  • Terms of use
  • 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

Order -> AddOrder

Adds a new order.

Request

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

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
orderorder

Request parameters:

  • long organisationId - organisation id
  • Order order - order

    /// Order details.
    public class Order
    {
        // Order id.
        public long? OrderId { get; set; }
        // Order type:
        // <ul>
        //     <li>I – issued order,</li>
        //     <li>P – recieved order.</li>
        // </ul>

        // Mandatory field. Max length: 1
        public string ReceivedIssued { get; set; }
        // Order year.
        // Mandatory field.
        public int Year { get; set; }
        // Order number.
        // Mandatory field.
        public int? Number { get; set; }
        // Order date.
        // Mandatory field.
        public DateTime? Date { get; set; }
        // Customer.
        public mMApiFkField Customer { get; set; }
        // Customer name.
        // Max length: 100
        public string CustomerName { get; set; }
        // Customer address.
        // Max length: 50
        public string CustomerAddress { get; set; }
        // Customer postal code.
        // Max length: 30
        public string CustomerPostalCode { get; set; }
        // Customer city.
        // Max length: 250
        public string CustomerCity { get; set; }
        // Customer country.
        public mMApiFkField CustomerCountry { get; set; }
        // Customer country name.
        // Max length: 250
        public string CustomerCountryName { get; set; }
        // Recipient name.
        // Max length: 250
        public string RecipientName { get; set; }
        // Recipient address.
        // Max length: 250
        public string RecipientAddress { get; set; }
        // Recipient postal code.
        // Max length: 30
        public string RecipientPostalCode { get; set; }
        // Recipient city.
        // Max length: 250
        public string RecipientCity { get; set; }
        // Recipient country name. Prohibited use when RecipientCountry is set as home country.
        // Max length: 250
        public string RecipientCountryName { get; set; }
        // Recipient country.
        public mMApiFkField RecipientCountry { get; set; }
        // Analytic.
        public mMApiFkField Analytic { get; set; }
        // Due date.
        public DateTime? DueDate { get; set; }
        // Reference.
        public string Reference { get; set; }
        // Currency.
        public mMApiFkField Currency { get; set; }
        // Notes.
        // Max length: 1000
        public string Notes { get; set; }
        // Order confirmation date.
        public DateTime? DateConfirmed { get; set; }
        // Order termination date.
        public DateTime? DateCompleted { get; set; }
        // Order Invalidation date.
        public DateTime? DateCanceled { get; set; }
        // Order status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z – Terminated,</li>
        //     <li>R - Invalidated</li>
        // </ul>

        // Mandatory field. Max length: 1
        public string Status { get; set; }
        // The description that appears on order print above.
        // Max length: 8000
        public string DescriptionAbove { get; set; }
        // The description that appears on order print below.
        // Max length: 8000
        public string DescriptionBelow { get; set; }
        // Report settings for orders:
        // <ul>
        //     <li>IN – for issued orders,</li>
        //     <li>PN – for received orders</li>
        // </ul>

        public mMApiFkField ReportTemplate { get; set; }
        // Order rows.
        public List<OrderRow> OrderRows { get; set; }
        public DateTime RecordDtModified { get; set; }
        // Row version is used for concurrency check.
        // Mandatory field. 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; }
        
        }
        /// Order row details.
        public class OrderRow
        {
            // Order row id.
            public long? OrderRowId { get; set; }
            // Order.
            public mMApiFkField Order { get; set; }
            // Item.
            public mMApiFkField Item { get; set; }
            //   Warehouse.<br/>
            // Input allowed if inventory discharge is enabled. (Company's settings).

            public mMApiFkField Warehouse { get; set; }
            // Item name.
            // Max length: 250
            public string ItemName { get; set; }
            // Item code.
            // Max length: 30
            public string ItemCode { get; set; }
            // Item description.
            // Max length: 8000
            public string Description { get; set; }
            // Quantity.
            // Mandatory field.
            public Decimal Quantity { get; set; }
            // Discount value in percent.
            // Mandatory field.
            public Decimal DiscountPercent { get; set; }
            // Price.
            // Mandatory field.
            public Decimal Price { get; set; }
            // Item unit of measurement.
            // Max length: 3
            public string UnitOfMeasurement { get; set; }
            public DateTime RecordDtModified { get; set; }
            // Row version is used for concurrency check.
            // Mandatory field. 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
  • Order order - order

    /// Order details.
    class Order
    {
        // Order id.
        public $OrderId;
        // Order type:
        // <ul>
        //     <li>I – issued order,</li>
        //     <li>P – recieved order.</li>
        // </ul>

        // Mandatory field. Max length: 1
        public $ReceivedIssued;
        // Order year.
        // Mandatory field.
        public $Year;
        // Order number.
        // Mandatory field.
        public $Number;
        // Order date.
        // Mandatory field.
        public $Date;
        // Customer.
        public $Customer;
        // Customer name.
        // Max length: 100
        public $CustomerName;
        // Customer address.
        // Max length: 50
        public $CustomerAddress;
        // Customer postal code.
        // Max length: 30
        public $CustomerPostalCode;
        // Customer city.
        // Max length: 250
        public $CustomerCity;
        // Customer country.
        public $CustomerCountry;
        // Customer country name.
        // Max length: 250
        public $CustomerCountryName;
        // Recipient name.
        // Max length: 250
        public $RecipientName;
        // Recipient address.
        // Max length: 250
        public $RecipientAddress;
        // Recipient postal code.
        // Max length: 30
        public $RecipientPostalCode;
        // Recipient city.
        // Max length: 250
        public $RecipientCity;
        // Recipient country name. Prohibited use when RecipientCountry is set as home country.
        // Max length: 250
        public $RecipientCountryName;
        // Recipient country.
        public $RecipientCountry;
        // Analytic.
        public $Analytic;
        // Due date.
        public $DueDate;
        // Reference.
        public $Reference;
        // Currency.
        public $Currency;
        // Notes.
        // Max length: 1000
        public $Notes;
        // Order confirmation date.
        public $DateConfirmed;
        // Order termination date.
        public $DateCompleted;
        // Order Invalidation date.
        public $DateCanceled;
        // Order status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z – Terminated,</li>
        //     <li>R - Invalidated</li>
        // </ul>

        // Mandatory field. Max length: 1
        public $Status;
        // The description that appears on order print above.
        // Max length: 8000
        public $DescriptionAbove;
        // The description that appears on order print below.
        // Max length: 8000
        public $DescriptionBelow;
        // Report settings for orders:
        // <ul>
        //     <li>IN – for issued orders,</li>
        //     <li>PN – for received orders</li>
        // </ul>

        public $ReportTemplate;
        // Order rows.
        public $OrderRows;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. 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;
        
        }
        /// Order row details.
        class OrderRow
        {
            // Order row id.
            public $OrderRowId;
            // Order.
            public $Order;
            // Item.
            public $Item;
            //   Warehouse.<br/>
            // Input allowed if inventory discharge is enabled. (Company's settings).

            public $Warehouse;
            // Item name.
            // Max length: 250
            public $ItemName;
            // Item code.
            // Max length: 30
            public $ItemCode;
            // Item description.
            // Max length: 8000
            public $Description;
            // Quantity.
            // Mandatory field.
            public $Quantity;
            // Discount value in percent.
            // Mandatory field.
            public $DiscountPercent;
            // Price.
            // Mandatory field.
            public $Price;
            // Item unit of measurement.
            // Max length: 3
            public $UnitOfMeasurement;
            public $RecordDtModified;
            // Row version is used for concurrency check.
            // Mandatory field. 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
  • Order order - order

    /// Order details.
    public class Order
    {
        // Order id.
        public Long OrderId;
        // Order type:
        // <ul>
        //     <li>I – issued order,</li>
        //     <li>P – recieved order.</li>
        // </ul>

        // Mandatory field. Max length: 1
        public String ReceivedIssued;
        // Order year.
        // Mandatory field.
        public Integer Year;
        // Order number.
        // Mandatory field.
        public Integer Number;
        // Order date.
        // Mandatory field.
        public Date Date;
        // Customer.
        public mMApiFkField Customer;
        // Customer name.
        // Max length: 100
        public String CustomerName;
        // Customer address.
        // Max length: 50
        public String CustomerAddress;
        // Customer postal code.
        // Max length: 30
        public String CustomerPostalCode;
        // Customer city.
        // Max length: 250
        public String CustomerCity;
        // Customer country.
        public mMApiFkField CustomerCountry;
        // Customer country name.
        // Max length: 250
        public String CustomerCountryName;
        // Recipient name.
        // Max length: 250
        public String RecipientName;
        // Recipient address.
        // Max length: 250
        public String RecipientAddress;
        // Recipient postal code.
        // Max length: 30
        public String RecipientPostalCode;
        // Recipient city.
        // Max length: 250
        public String RecipientCity;
        // Recipient country name. Prohibited use when RecipientCountry is set as home country.
        // Max length: 250
        public String RecipientCountryName;
        // Recipient country.
        public mMApiFkField RecipientCountry;
        // Analytic.
        public mMApiFkField Analytic;
        // Due date.
        public Date DueDate;
        // Reference.
        public String Reference;
        // Currency.
        public mMApiFkField Currency;
        // Notes.
        // Max length: 1000
        public String Notes;
        // Order confirmation date.
        public Date DateConfirmed;
        // Order termination date.
        public Date DateCompleted;
        // Order Invalidation date.
        public Date DateCanceled;
        // Order status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z – Terminated,</li>
        //     <li>R - Invalidated</li>
        // </ul>

        // Mandatory field. Max length: 1
        public String Status;
        // The description that appears on order print above.
        // Max length: 8000
        public String DescriptionAbove;
        // The description that appears on order print below.
        // Max length: 8000
        public String DescriptionBelow;
        // Report settings for orders:
        // <ul>
        //     <li>IN – for issued orders,</li>
        //     <li>PN – for received orders</li>
        // </ul>

        public mMApiFkField ReportTemplate;
        // Order rows.
        public List<OrderRow> OrderRows;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. 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;
        
        }
        /// Order row details.
        public class OrderRow
        {
            // Order row id.
            public Long OrderRowId;
            // Order.
            public mMApiFkField Order;
            // Item.
            public mMApiFkField Item;
            //   Warehouse.<br/>
            // Input allowed if inventory discharge is enabled. (Company's settings).

            public mMApiFkField Warehouse;
            // Item name.
            // Max length: 250
            public String ItemName;
            // Item code.
            // Max length: 30
            public String ItemCode;
            // Item description.
            // Max length: 8000
            public String Description;
            // Quantity.
            // Mandatory field.
            public Double Quantity;
            // Discount value in percent.
            // Mandatory field.
            public Double DiscountPercent;
            // Price.
            // Mandatory field.
            public Double Price;
            // Item unit of measurement.
            // Max length: 3
            public String UnitOfMeasurement;
            public Date RecordDtModified;
            // Row version is used for concurrency check.
            // Mandatory field. 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