API Documentation

Request parameters:

• long organisationId - organisation id
• long journalId - journal id

Request parameters:

• Int64 organisationId - organisation id
• Int64 journalId - journal id

Request parameters:

• Long organisationId - organisation id
• Long journalId - journal id

This method returns result of type 'SAOP.API.Models.Journal.Journal'.

    /// Journal details.
    public class Journal
    {
        // Journal id.
        // Ignored on create request.
        public long JournalId { get; set; }
        // Journal type.
        public mMApiFkField JournalType { get; set; }
        // Journal date.
        public DateTime JournalDate { get; set; }
        // Journal description.
        public string Description { get; set; }
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>
        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.
        // 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.
            // Ignored on create request.
            public long? JournalEntryId { get; set; }
            // Journal.
            public mMApiFkField Journal { get; set; }
            // Journal entry date.
            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.
            public string Description { get; set; }
            // Payment reference.
            public string PaymentReference { get; set; }
            // Debit.
            public Decimal Debit { get; set; }
            // Credit.
            public Decimal Credit { get; set; }
            // Debit in domestic currency.
            public Decimal DebitInDomesticCurrency { get; set; }
            // Credit in domestic currency.
            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.
            // 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.
            public DateTime? VatDate { get; set; }
            // VAT book:
            // <ul>
            //     <li>PR - Received invoices book,</li>
            //     <li>IR - Issued invoices book </li>
            // </ul>
            public string VatBook { get; set; }
            // VAT accounting type.
            public string VatAccountingType { get; set; }
            // VAT entry date.
            public DateTime? VatEntryDate { get; set; }
            // Customer.
            public mMApiFkField Customer { get; set; }
            // Document.
            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>
            public string SelfTaxing { get; set; }
            // Journal entry.
            public mMApiFkField JournalEntry { get; set; }
            // Journal entry external ID.
            public string JournalEntryExternalId { get; set; }
            // Notes.
            public string Notes { get; set; }
            // Advance payment:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>
            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.
            // 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.
                // 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.
                public Decimal VatBase { get; set; }
                // VAT.
                public Decimal Vat { get; set; }
                // Non-deductible VAT base.
                public Decimal NonDeductibleVatBase { get; set; }
                // Non-deductible VAT.
                public Decimal NonDeductibleVat { get; set; }
                // VAT base(services).
                public Decimal ServicesVatBase { get; set; }
                // VAT value(services).
                public Decimal ServicesVat { get; set; }
                // Non-deducted services VAT base.
                public Decimal ServicesNonDeductibleVatBase { get; set; }
                // Non-deducted services VAT.
                public Decimal ServicesNonDeductibleVat { 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.Journal.Journal'.

    /// Journal details.
    class Journal
    {
        // Journal id.
        // Ignored on create request.
        public $JournalId;
        // Journal type.
        public $JournalType;
        // Journal date.
        public $JournalDate;
        // Journal description.
        public $Description;
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>
        public $Status;
        // Journal entries.
        public $JournalEntries;
        // Vat entries.
        public $VatEntries;
        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;
        
        }
        /// Journal entry details.
        class JournalEntry
        {
            // Journal entry external id.
            public $ExternalId;
            // Journal entry id.
            // Ignored on create request.
            public $JournalEntryId;
            // Journal.
            public $Journal;
            // Journal entry date.
            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.
            public $Description;
            // Payment reference.
            public $PaymentReference;
            // Debit.
            public $Debit;
            // Credit.
            public $Credit;
            // Debit in domestic currency.
            public $DebitInDomesticCurrency;
            // Credit in domestic currency.
            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.
            // 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.
            public $VatDate;
            // VAT book:
            // <ul>
            //     <li>PR - Received invoices book,</li>
            //     <li>IR - Issued invoices book </li>
            // </ul>
            public $VatBook;
            // VAT accounting type.
            public $VatAccountingType;
            // VAT entry date.
            public $VatEntryDate;
            // Customer.
            public $Customer;
            // Document.
            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>
            public $SelfTaxing;
            // Journal entry.
            public $JournalEntry;
            // Journal entry external ID.
            public $JournalEntryExternalId;
            // Notes.
            public $Notes;
            // Advance payment:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>
            public $AdvancePayment;
            // Analytic.
            public $Analytic;
            // VAT entry rows.
            public $VatEntryRows;
            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;
            
            }
            /// VAT entry row details.
            class VATEntryRow
            {
                // Vat entry row id.
                // Ignored on create request.
                public $VatEntryRowId;
                // VAT entry.
                public $VatEntry;
                // VAT rate.
                public $VatRate;
                // VAT base.
                public $VatBase;
                // VAT.
                public $Vat;
                // Non-deductible VAT base.
                public $NonDeductibleVatBase;
                // Non-deductible VAT.
                public $NonDeductibleVat;
                // VAT base(services).
                public $ServicesVatBase;
                // VAT value(services).
                public $ServicesVat;
                // Non-deducted services VAT base.
                public $ServicesNonDeductibleVatBase;
                // Non-deducted services VAT.
                public $ServicesNonDeductibleVat;
                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.Journal.Journal'.

    /// Journal details.
    public class Journal
    {
        // Journal id.
        // Ignored on create request.
        public Long JournalId;
        // Journal type.
        public mMApiFkField JournalType;
        // Journal date.
        public Date JournalDate;
        // Journal description.
        public String Description;
        // Journal status:
        // <ul>
        //     <li>O - Draft</li>
        //     <li>P - Confirmed</li>
        //     <li>A - Automatic</li>
        // </ul>
        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.
        // 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.
            // Ignored on create request.
            public Long JournalEntryId;
            // Journal.
            public mMApiFkField Journal;
            // Journal entry date.
            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.
            public String Description;
            // Payment reference.
            public String PaymentReference;
            // Debit.
            public Double Debit;
            // Credit.
            public Double Credit;
            // Debit in domestic currency.
            public Double DebitInDomesticCurrency;
            // Credit in domestic currency.
            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.
            // 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.
            public Date VatDate;
            // VAT book:
            // <ul>
            //     <li>PR - Received invoices book,</li>
            //     <li>IR - Issued invoices book </li>
            // </ul>
            public String VatBook;
            // VAT accounting type.
            public String VatAccountingType;
            // VAT entry date.
            public Date VatEntryDate;
            // Customer.
            public mMApiFkField Customer;
            // Document.
            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>
            public String SelfTaxing;
            // Journal entry.
            public mMApiFkField JournalEntry;
            // Journal entry external ID.
            public String JournalEntryExternalId;
            // Notes.
            public String Notes;
            // Advance payment:
            // <ul>
            //     <li>D – yes,</li>
            //     <li>N – no.</li>
            // </ul>
            public String AdvancePayment;
            // Analytic.
            public mMApiFkField Analytic;
            // VAT entry rows.
            public List<VATEntryRow> VatEntryRows;
            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;
            
            }
            /// VAT entry row details.
            public class VATEntryRow
            {
                // Vat entry row id.
                // Ignored on create request.
                public Long VatEntryRowId;
                // VAT entry.
                public mMApiFkField VatEntry;
                // VAT rate.
                public mMApiFkField VatRate;
                // VAT base.
                public Double VatBase;
                // VAT.
                public Double Vat;
                // Non-deductible VAT base.
                public Double NonDeductibleVatBase;
                // Non-deductible VAT.
                public Double NonDeductibleVat;
                // VAT base(services).
                public Double ServicesVatBase;
                // VAT value(services).
                public Double ServicesVat;
                // Non-deducted services VAT base.
                public Double ServicesNonDeductibleVatBase;
                // Non-deducted services VAT.
                public Double ServicesNonDeductibleVat;
                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;
                
                }