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

Journal -> AddJournal

Adds a new journal.

Request

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

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
journaljournal id

Request parameters:

  • long organisationId - organisation id
  • Journal journal - journal id

    /// Journal details.
    public class Journal
    {
        // Journal id.
        // Mandatory field. Ignored on create request.
        public long JournalId { get; set; }
        // Journal type.
        public mMApiFkField JournalType { get; set; }
        // Journal date.
        // Mandatory field.
        public DateTime JournalDate { get; set; }
        // Journal description.
        // Max length: 250
        public string Description { get; set; }
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>

        // Mandatory field. Max length: 1
        public string Status { get; set; }
        // Journal entries.
        public List<JournalEntry> JournalEntries { get; set; }
        // Vat entries.
        public List<VATEntry> VatEntries { 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; }
        
        }
        /// Journal entry details.
        public class JournalEntry
        {
            // Journal entry external id.
            public string ExternalId { get; set; }
            // Journal entry id.
            // Mandatory field. Ignored on create request.
            public long? JournalEntryId { get; set; }
            // Journal.
            public mMApiFkField Journal { get; set; }
            // Journal entry date.
            // Mandatory field.
            public DateTime? JournalEntryDate { get; set; }
            // Due date.
            public DateTime? DueDate { get; set; }
            // Transaction date.
            public DateTime? TransactionDate { get; set; }
            // Account.
            public mMApiFkField Account { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Analytic.
            public mMApiFkField Analytic { get; set; }
            // Employee.
            public mMApiFkField Employee { get; set; }
            // Currency.
            public mMApiFkField Currency { get; set; }
            // Entry description.
            // Max length: 250
            public string Description { get; set; }
            // Payment reference.
            // Max length: 30
            public string PaymentReference { get; set; }
            // Debit.
            // Mandatory field.
            public Decimal Debit { get; set; }
            // Credit.
            // Mandatory field.
            public Decimal Credit { get; set; }
            // Debit in domestic currency.
            // Mandatory field.
            public Decimal DebitInDomesticCurrency { get; set; }
            // Credit in domestic currency.
            // Mandatory field.
            public Decimal CreditInDomesticCurrency { get; set; }
            // Submission of a special VAT return for the special regulation of the Union – ONE STOP SHOP.
            public string SubmissionSpecialVATReturn { get; set; }
            // VAT date
            // Valid and required for Submission of a special VAT return tax types.

            public DateTime? VatDate { get; set; }
            // VAT subject type:
            // <ul>
            //     <li>Blago - goods</li>
            //     <li>Storitev - services</li>
            // </ul>
            // Valid and required for Submission of a special VAT return tax types.

            public string VatType { get; set; }
            // Vat rate percentage identifier
            public mMApiFkField VatRatePercentage { get; set; }
            // VAT base in domestic currency
            // Valid and required for Submission of a special VAT return tax types.

            public Decimal VatBaseInDomesticCurrency { get; set; }
            // VAT base
            // Valid and required for Submission of a special VAT return tax types.

            public Decimal VatBase { 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; }
            
            }
        /// VAT entry details.
        public class VATEntry
        {
            // VAT entry id.
            // Ignored on create request.
            public long? VatEntryId { get; set; }
            // Journal.
            public mMApiFkField Journal { get; set; }
            // VAT date.
            // Mandatory field.
            public DateTime? VatDate { get; set; }
            // VAT book:
            // <ul>
            //     <li>PR - Received invoices book,</li>
            //     <li>IR - Issued invoices book </li>
            // </ul>

            // Max length: 10
            public string VatBook { get; set; }
            // VAT accounting type.
            // Max length: 5
            public string VatAccountingType { get; set; }
            // VAT entry date.
            public DateTime? VatEntryDate { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Document.
            // Max length: 30
            public string Document { get; set; }
            // Document date.
            public DateTime? DocumentDate { get; set; }
            // Received date.
            public DateTime? ReceivedDate { get; set; }
            // Payment date.
            public DateTime? PaymentDate { get; set; }
            // Self-taxing:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>

            // Max length: 1
            public string SelfTaxing { get; set; }
            // Journal entry.
            public mMApiFkField JournalEntry { get; set; }
            // Journal entry external ID.
            public string JournalEntryExternalId { get; set; }
            // Notes.
            // Max length: 100
            public string Notes { get; set; }
            // Advance payment:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>

            // Max length: 1
            public string AdvancePayment { get; set; }
            // Analytic.
            public mMApiFkField Analytic { get; set; }
            // VAT entry rows.
            public List<VATEntryRow> VatEntryRows { 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; }
            
            }
            /// VAT entry row details.
            public class VATEntryRow
            {
                // Vat entry row id.
                // Mandatory field. Ignored on create request.
                public long? VatEntryRowId { get; set; }
                // VAT entry.
                public mMApiFkField VatEntry { get; set; }
                // VAT rate.
                public mMApiFkField VatRate { get; set; }
                // VAT base.
                // Mandatory field.
                public Decimal VatBase { get; set; }
                // VAT.
                // Mandatory field.
                public Decimal Vat { get; set; }
                // Non-deductible VAT base.
                // Mandatory field.
                public Decimal NonDeductibleVatBase { get; set; }
                // Non-deductible VAT.
                // Mandatory field.
                public Decimal NonDeductibleVat { get; set; }
                // VAT base(services).
                // Mandatory field.
                public Decimal ServicesVatBase { get; set; }
                // VAT value(services).
                // Mandatory field.
                public Decimal ServicesVat { get; set; }
                // Non-deducted services VAT base.
                // Mandatory field.
                public Decimal ServicesNonDeductibleVatBase { get; set; }
                // Non-deducted services VAT.
                // Mandatory field.
                public Decimal ServicesNonDeductibleVat { 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
  • Journal journal - journal id

    /// Journal details.
    class Journal
    {
        // Journal id.
        // Mandatory field. Ignored on create request.
        public $JournalId;
        // Journal type.
        public $JournalType;
        // Journal date.
        // Mandatory field.
        public $JournalDate;
        // Journal description.
        // Max length: 250
        public $Description;
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>

        // Mandatory field. Max length: 1
        public $Status;
        // Journal entries.
        public $JournalEntries;
        // Vat entries.
        public $VatEntries;
        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;
        
        }
        /// Journal entry details.
        class JournalEntry
        {
            // Journal entry external id.
            public $ExternalId;
            // Journal entry id.
            // Mandatory field. Ignored on create request.
            public $JournalEntryId;
            // Journal.
            public $Journal;
            // Journal entry date.
            // Mandatory field.
            public $JournalEntryDate;
            // Due date.
            public $DueDate;
            // Transaction date.
            public $TransactionDate;
            // Account.
            public $Account;
            // Customer.
            public $Customer;
            // Analytic.
            public $Analytic;
            // Employee.
            public $Employee;
            // Currency.
            public $Currency;
            // Entry description.
            // Max length: 250
            public $Description;
            // Payment reference.
            // Max length: 30
            public $PaymentReference;
            // Debit.
            // Mandatory field.
            public $Debit;
            // Credit.
            // Mandatory field.
            public $Credit;
            // Debit in domestic currency.
            // Mandatory field.
            public $DebitInDomesticCurrency;
            // Credit in domestic currency.
            // Mandatory field.
            public $CreditInDomesticCurrency;
            // Submission of a special VAT return for the special regulation of the Union – ONE STOP SHOP.
            public $SubmissionSpecialVATReturn;
            // VAT date
            // Valid and required for Submission of a special VAT return tax types.

            public $VatDate;
            // VAT subject type:
            // <ul>
            //     <li>Blago - goods</li>
            //     <li>Storitev - services</li>
            // </ul>
            // Valid and required for Submission of a special VAT return tax types.

            public $VatType;
            // Vat rate percentage identifier
            public $VatRatePercentage;
            // VAT base in domestic currency
            // Valid and required for Submission of a special VAT return tax types.

            public $VatBaseInDomesticCurrency;
            // VAT base
            // Valid and required for Submission of a special VAT return tax types.

            public $VatBase;
            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;
            
            }
        /// VAT entry details.
        class VATEntry
        {
            // VAT entry id.
            // Ignored on create request.
            public $VatEntryId;
            // Journal.
            public $Journal;
            // VAT date.
            // Mandatory field.
            public $VatDate;
            // VAT book:
            // <ul>
            //     <li>PR - Received invoices book,</li>
            //     <li>IR - Issued invoices book </li>
            // </ul>

            // Max length: 10
            public $VatBook;
            // VAT accounting type.
            // Max length: 5
            public $VatAccountingType;
            // VAT entry date.
            public $VatEntryDate;
            // Customer.
            public $Customer;
            // Document.
            // Max length: 30
            public $Document;
            // Document date.
            public $DocumentDate;
            // Received date.
            public $ReceivedDate;
            // Payment date.
            public $PaymentDate;
            // Self-taxing:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>

            // Max length: 1
            public $SelfTaxing;
            // Journal entry.
            public $JournalEntry;
            // Journal entry external ID.
            public $JournalEntryExternalId;
            // Notes.
            // Max length: 100
            public $Notes;
            // Advance payment:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>

            // Max length: 1
            public $AdvancePayment;
            // Analytic.
            public $Analytic;
            // VAT entry rows.
            public $VatEntryRows;
            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;
            
            }
            /// VAT entry row details.
            class VATEntryRow
            {
                // Vat entry row id.
                // Mandatory field. Ignored on create request.
                public $VatEntryRowId;
                // VAT entry.
                public $VatEntry;
                // VAT rate.
                public $VatRate;
                // VAT base.
                // Mandatory field.
                public $VatBase;
                // VAT.
                // Mandatory field.
                public $Vat;
                // Non-deductible VAT base.
                // Mandatory field.
                public $NonDeductibleVatBase;
                // Non-deductible VAT.
                // Mandatory field.
                public $NonDeductibleVat;
                // VAT base(services).
                // Mandatory field.
                public $ServicesVatBase;
                // VAT value(services).
                // Mandatory field.
                public $ServicesVat;
                // Non-deducted services VAT base.
                // Mandatory field.
                public $ServicesNonDeductibleVatBase;
                // Non-deducted services VAT.
                // Mandatory field.
                public $ServicesNonDeductibleVat;
                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
  • Journal journal - journal id

    /// Journal details.
    public class Journal
    {
        // Journal id.
        // Mandatory field. Ignored on create request.
        public Long JournalId;
        // Journal type.
        public mMApiFkField JournalType;
        // Journal date.
        // Mandatory field.
        public Date JournalDate;
        // Journal description.
        // Max length: 250
        public String Description;
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>

        // Mandatory field. Max length: 1
        public String Status;
        // Journal entries.
        public List<JournalEntry> JournalEntries;
        // Vat entries.
        public List<VATEntry> VatEntries;
        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;
        
        }
        /// Journal entry details.
        public class JournalEntry
        {
            // Journal entry external id.
            public String ExternalId;
            // Journal entry id.
            // Mandatory field. Ignored on create request.
            public Long JournalEntryId;
            // Journal.
            public mMApiFkField Journal;
            // Journal entry date.
            // Mandatory field.
            public Date JournalEntryDate;
            // Due date.
            public Date DueDate;
            // Transaction date.
            public Date TransactionDate;
            // Account.
            public mMApiFkField Account;
            // Customer.
            public mMApiFkField Customer;
            // Analytic.
            public mMApiFkField Analytic;
            // Employee.
            public mMApiFkField Employee;
            // Currency.
            public mMApiFkField Currency;
            // Entry description.
            // Max length: 250
            public String Description;
            // Payment reference.
            // Max length: 30
            public String PaymentReference;
            // Debit.
            // Mandatory field.
            public Double Debit;
            // Credit.
            // Mandatory field.
            public Double Credit;
            // Debit in domestic currency.
            // Mandatory field.
            public Double DebitInDomesticCurrency;
            // Credit in domestic currency.
            // Mandatory field.
            public Double CreditInDomesticCurrency;
            // Submission of a special VAT return for the special regulation of the Union – ONE STOP SHOP.
            public String SubmissionSpecialVATReturn;
            // VAT date
            // Valid and required for Submission of a special VAT return tax types.

            public Date VatDate;
            // VAT subject type:
            // <ul>
            //     <li>Blago - goods</li>
            //     <li>Storitev - services</li>
            // </ul>
            // Valid and required for Submission of a special VAT return tax types.

            public String VatType;
            // Vat rate percentage identifier
            public mMApiFkField VatRatePercentage;
            // VAT base in domestic currency
            // Valid and required for Submission of a special VAT return tax types.

            public Double VatBaseInDomesticCurrency;
            // VAT base
            // Valid and required for Submission of a special VAT return tax types.

            public Double VatBase;
            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;
            
            }
        /// VAT entry details.
        public class VATEntry
        {
            // VAT entry id.
            // Ignored on create request.
            public Long VatEntryId;
            // Journal.
            public mMApiFkField Journal;
            // VAT date.
            // Mandatory field.
            public Date VatDate;
            // VAT book:
            // <ul>
            //     <li>PR - Received invoices book,</li>
            //     <li>IR - Issued invoices book </li>
            // </ul>

            // Max length: 10
            public String VatBook;
            // VAT accounting type.
            // Max length: 5
            public String VatAccountingType;
            // VAT entry date.
            public Date VatEntryDate;
            // Customer.
            public mMApiFkField Customer;
            // Document.
            // Max length: 30
            public String Document;
            // Document date.
            public Date DocumentDate;
            // Received date.
            public Date ReceivedDate;
            // Payment date.
            public Date PaymentDate;
            // Self-taxing:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>

            // Max length: 1
            public String SelfTaxing;
            // Journal entry.
            public mMApiFkField JournalEntry;
            // Journal entry external ID.
            public String JournalEntryExternalId;
            // Notes.
            // Max length: 100
            public String Notes;
            // Advance payment:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>

            // Max length: 1
            public String AdvancePayment;
            // Analytic.
            public mMApiFkField Analytic;
            // VAT entry rows.
            public List<VATEntryRow> VatEntryRows;
            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;
            
            }
            /// VAT entry row details.
            public class VATEntryRow
            {
                // Vat entry row id.
                // Mandatory field. Ignored on create request.
                public Long VatEntryRowId;
                // VAT entry.
                public mMApiFkField VatEntry;
                // VAT rate.
                public mMApiFkField VatRate;
                // VAT base.
                // Mandatory field.
                public Double VatBase;
                // VAT.
                // Mandatory field.
                public Double Vat;
                // Non-deductible VAT base.
                // Mandatory field.
                public Double NonDeductibleVatBase;
                // Non-deductible VAT.
                // Mandatory field.
                public Double NonDeductibleVat;
                // VAT base(services).
                // Mandatory field.
                public Double ServicesVatBase;
                // VAT value(services).
                // Mandatory field.
                public Double ServicesVat;
                // Non-deducted services VAT base.
                // Mandatory field.
                public Double ServicesNonDeductibleVatBase;
                // Non-deducted services VAT.
                // Mandatory field.
                public Double ServicesNonDeductibleVat;
                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