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

Journal -> GetVATEntry

Returns a VAT entry.

Request

Relative request path: api/orgs/{organisationId}/journals/{journalId}/vat/{vatId}

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
journalIdjournal id
vatId

Request parameters:

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

Request parameters:

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

Request parameters:

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

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
VatEntryIdVAT entry id.
Journalclass Journal. Journal.
VatDateVAT date.
VatBookPossible values: (IR, PR). VAT book:
  • PR - Received invoices book,
  • IR - Issued invoices book
VatAccountingTypeVAT accounting type.
VatEntryDateVAT entry date.
Customerclass Customer. Customer.
DocumentDocument.
DocumentDateDocument date.
ReceivedDateReceived date.
PaymentDatePayment date.
TransactionDateTransaction date.
SelfTaxingSelf-taxing:
  • D – yes,
  • N – no.
JournalEntryclass JournalEntry. Journal entry.
JournalEntryExternalIdJournal entry external ID.
NotesNotes.
AdvancePaymentAdvance payment:
  • D – yes,
  • N – no.
Analyticclass Analytic. Analytic.
VatEntryRowsVAT entry rows. List of VATEntryRow.
RecordDtModified
RowVersionRow version is used for concurrency check.

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

    /// 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; }
        // Transaction date.
        public DateTime? TransactionDate { 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.VATEntry'.

    /// 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;
        // Transaction date.
        public $TransactionDate;
        // 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.VATEntry'.

    /// 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;
        // Transaction date.
        public Date TransactionDate;
        // 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;
            
            }

 
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