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

ReceivedInvoice -> UpdateReceivedInvoice

Updates received invoice.

Request

Relative request path: api/orgs/{organisationId}/receivedinvoices/{receivedInvoiceId}

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
receivedInvoiceIdreceived Invoice id
receivedInvoiceNew receivedInvoice data.

Request parameters:

  • long organisationId - organisation id
  • long receivedInvoiceId - received Invoice id
  • ReceivedInvoice receivedInvoice - New receivedInvoice data.

    public class ReceivedInvoice
    {
        // Received Invoice Id
        // Ignored on create request.
        public long ReceivedInvoiceId { get; set; }
        // Invoice year.
        public int? Year { get; set; }
        // Invoice number.
        public long? InvoiceNumber { get; set; }
        // Document numbering.
        public mMApiFkField DocumentNumbering { get; set; }
        // Document reference
        public string DocumentReference { get; set; }
        // Customer.
        public mMApiFkField Customer { get; set; }
        // Employee.
        public mMApiFkField Employee { get; set; }
        // Analytic.
        public mMApiFkField Analytic { get; set; }
        // Currency.
        public mMApiFkField Currency { get; set; }
        // Invoice date
        public DateTime? DateIssued { get; set; }
        // Date of transaction
        public DateTime? DateTransaction { get; set; }
        // Invoice due date
        public DateTime? DateDue { get; set; }
        // Received date
        public DateTime? DateReceived { get; set; }
        // Amount of invoice
        public Decimal InvoiceAmount { get; set; }
        // Amount of invoice in domestic currency
        public Decimal InvoiceAmountDomesticCurrency { get; set; }
        // Received invoice status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z - Rejected,</li>
        // </ul>

        public string Status { get; set; }
        // Customer Bank Account
        public mMApiFkField BankAccount { get; set; }
        // Payment Reference Type:
        // <ul>
        //     <li>SI,</li>
        //     <li>RF,</li>
        // </ul>

        public string PaymentReferenceType { get; set; }
        // Payment reference model
        public string PaymentReferenceModel { get; set; }
        // Payment reference number
        public string PaymentReferenceNumber { get; set; }
        // Notes
        public string Notes { get; set; }
        // Payment type:
        // <ul>
        //     <li>D – Payment order,</li>
        //     <li>N – No payment order,</li>
        //     <li>Z – Paid by private undertaking,</li>
        //     <li>P – Paid by employee,</li>
        //     <li>R – Using another account,</li>
        //     <li>B – Cash book,</li>
        // </ul>

        public string PaymentType { get; set; }
        // Expense when paid by cash book
        public mMApiFkField RevenueExpense { get; set; }
        // Cash register when paid by cash book
        public mMApiFkField CashRegister { get; set; }
        // Date of expense when paid by cash book
        public DateTime? DateExpense { get; set; }
        // Recurring Invoice:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no,</li>
        // </ul>

        public string RecurringInvoice { get; set; }
        // Payment status:
        // <ul>
        //     <li>Placan – Paid,</li>
        //     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
        //     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
        //     <li>NeplacanZapadel – Unpaid, Overdue,</li>
        //     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
        //     <li>Osnutek – Draft,</li>
        //     <li>Avans – Advance payment</li>
        // </ul>

        public string PaymentStatus { get; set; }
        // Invoice value
        public Decimal InvoiceValue { get; set; }
        // Paid value
        public Decimal PaidValue { 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; }
        
        }

Request parameters:

  • Int64 organisationId - organisation id
  • Int64 receivedInvoiceId - received Invoice id
  • ReceivedInvoice receivedInvoice - New receivedInvoice data.

    class ReceivedInvoice
    {
        // Received Invoice Id
        // Ignored on create request.
        public $ReceivedInvoiceId;
        // Invoice year.
        public $Year;
        // Invoice number.
        public $InvoiceNumber;
        // Document numbering.
        public $DocumentNumbering;
        // Document reference
        public $DocumentReference;
        // Customer.
        public $Customer;
        // Employee.
        public $Employee;
        // Analytic.
        public $Analytic;
        // Currency.
        public $Currency;
        // Invoice date
        public $DateIssued;
        // Date of transaction
        public $DateTransaction;
        // Invoice due date
        public $DateDue;
        // Received date
        public $DateReceived;
        // Amount of invoice
        public $InvoiceAmount;
        // Amount of invoice in domestic currency
        public $InvoiceAmountDomesticCurrency;
        // Received invoice status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z - Rejected,</li>
        // </ul>

        public $Status;
        // Customer Bank Account
        public $BankAccount;
        // Payment Reference Type:
        // <ul>
        //     <li>SI,</li>
        //     <li>RF,</li>
        // </ul>

        public $PaymentReferenceType;
        // Payment reference model
        public $PaymentReferenceModel;
        // Payment reference number
        public $PaymentReferenceNumber;
        // Notes
        public $Notes;
        // Payment type:
        // <ul>
        //     <li>D – Payment order,</li>
        //     <li>N – No payment order,</li>
        //     <li>Z – Paid by private undertaking,</li>
        //     <li>P – Paid by employee,</li>
        //     <li>R – Using another account,</li>
        //     <li>B – Cash book,</li>
        // </ul>

        public $PaymentType;
        // Expense when paid by cash book
        public $RevenueExpense;
        // Cash register when paid by cash book
        public $CashRegister;
        // Date of expense when paid by cash book
        public $DateExpense;
        // Recurring Invoice:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no,</li>
        // </ul>

        public $RecurringInvoice;
        // Payment status:
        // <ul>
        //     <li>Placan – Paid,</li>
        //     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
        //     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
        //     <li>NeplacanZapadel – Unpaid, Overdue,</li>
        //     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
        //     <li>Osnutek – Draft,</li>
        //     <li>Avans – Advance payment</li>
        // </ul>

        public $PaymentStatus;
        // Invoice value
        public $InvoiceValue;
        // Paid value
        public $PaidValue;
        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;
        
        }

Request parameters:

  • Long organisationId - organisation id
  • Long receivedInvoiceId - received Invoice id
  • ReceivedInvoice receivedInvoice - New receivedInvoice data.

    public class ReceivedInvoice
    {
        // Received Invoice Id
        // Ignored on create request.
        public Long ReceivedInvoiceId;
        // Invoice year.
        public Integer Year;
        // Invoice number.
        public Long InvoiceNumber;
        // Document numbering.
        public mMApiFkField DocumentNumbering;
        // Document reference
        public String DocumentReference;
        // Customer.
        public mMApiFkField Customer;
        // Employee.
        public mMApiFkField Employee;
        // Analytic.
        public mMApiFkField Analytic;
        // Currency.
        public mMApiFkField Currency;
        // Invoice date
        public Date DateIssued;
        // Date of transaction
        public Date DateTransaction;
        // Invoice due date
        public Date DateDue;
        // Received date
        public Date DateReceived;
        // Amount of invoice
        public Double InvoiceAmount;
        // Amount of invoice in domestic currency
        public Double InvoiceAmountDomesticCurrency;
        // Received invoice status:
        // <ul>
        //     <li>P – Confirmed,</li>
        //     <li>O – Draft,</li>
        //     <li>Z - Rejected,</li>
        // </ul>

        public String Status;
        // Customer Bank Account
        public mMApiFkField BankAccount;
        // Payment Reference Type:
        // <ul>
        //     <li>SI,</li>
        //     <li>RF,</li>
        // </ul>

        public String PaymentReferenceType;
        // Payment reference model
        public String PaymentReferenceModel;
        // Payment reference number
        public String PaymentReferenceNumber;
        // Notes
        public String Notes;
        // Payment type:
        // <ul>
        //     <li>D – Payment order,</li>
        //     <li>N – No payment order,</li>
        //     <li>Z – Paid by private undertaking,</li>
        //     <li>P – Paid by employee,</li>
        //     <li>R – Using another account,</li>
        //     <li>B – Cash book,</li>
        // </ul>

        public String PaymentType;
        // Expense when paid by cash book
        public mMApiFkField RevenueExpense;
        // Cash register when paid by cash book
        public mMApiFkField CashRegister;
        // Date of expense when paid by cash book
        public Date DateExpense;
        // Recurring Invoice:
        // <ul>
        //     <li>D – yes,</li>
        //     <li>N – no,</li>
        // </ul>

        public String RecurringInvoice;
        // Payment status:
        // <ul>
        //     <li>Placan – Paid,</li>
        //     <li>DelnoPlacanZapadel – Partially paid, Overdue</li>
        //     <li>DelnoPlacanNezapadel – Partially paid, Not yet due</li>
        //     <li>NeplacanZapadel – Unpaid, Overdue,</li>
        //     <li>NeplacanNezapadel – Unpaid, Not yet due</li>
        //     <li>Osnutek – Draft,</li>
        //     <li>Avans – Advance payment</li>
        // </ul>

        public String PaymentStatus;
        // Invoice value
        public Double InvoiceValue;
        // Paid value
        public Double PaidValue;
        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;
        
        }

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