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

Address -> GetAddress

Returns an address.

Request

Relative request path: api/orgs/{organisationId}/customers/{customerId}/addresses/{addressId}

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
customerIdcustomer id
addressIdaddress id

Request parameters:

  • long organisationId - organisation id
  • long customerId - customer id
  • long addressId - address id

Request parameters:

  • Int64 organisationId - organisation id
  • Int64 customerId - customer id
  • Int64 addressId - address id

Request parameters:

  • Long organisationId - organisation id
  • Long customerId - customer id
  • Long addressId - address id

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
AddressIdAddress id.
Customerclass Customer. Customer
TypePossible values: (N, P). Address type:
  • N=Addressee;
  • P=Recipient
NameName.
GLNGLN.
AddressAddress.
PostalCodePostal code.
CityCity.
Countryclass Country. Country.
CountryNameCountry name.
DefaultDefault address for given address type:
  • N – no,
  • D – yes.
RecordDtModified
RowVersionRow version is used for concurrency check.

This method returns result of type 'SAOP.API.Models.Address.AddressModel'.

    /// Address details.
    public class AddressModel
    {
        // Address id.
        // Ignored on create request.
        public long AddressId { get; set; }
        // Customer
        public mMApiFkField Customer { get; set; }
        // Address type:
        // <ul>
        //     <li>N=Addressee;</li>
        //     <li>P=Recipient</li>
        // </ul>
        //

        public string Type { get; set; }
        // Name.
        public string Name { get; set; }
        // GLN.
        public string GLN { get; set; }
        // Address.
        public string Address { get; set; }
        // Postal code.
        public string PostalCode { get; set; }
        // City.
        public string City { get; set; }
        // Country.
        public mMApiFkField Country { get; set; }
        // Country name.
        public string CountryName { get; set; }
        // Default address for given address type:
        // <ul>
        //     <li>N – no,</li>
        //     <li>D – yes.</li>
        // </ul>
        //

        public string Default { 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.Address.AddressModel'.

    /// Address details.
    class AddressModel
    {
        // Address id.
        // Ignored on create request.
        public $AddressId;
        // Customer
        public $Customer;
        // Address type:
        // <ul>
        //     <li>N=Addressee;</li>
        //     <li>P=Recipient</li>
        // </ul>
        //

        public $Type;
        // Name.
        public $Name;
        // GLN.
        public $GLN;
        // Address.
        public $Address;
        // Postal code.
        public $PostalCode;
        // City.
        public $City;
        // Country.
        public $Country;
        // Country name.
        public $CountryName;
        // Default address for given address type:
        // <ul>
        //     <li>N – no,</li>
        //     <li>D – yes.</li>
        // </ul>
        //

        public $Default;
        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.Address.AddressModel'.

    /// Address details.
    public class AddressModel
    {
        // Address id.
        // Ignored on create request.
        public Long AddressId;
        // Customer
        public mMApiFkField Customer;
        // Address type:
        // <ul>
        //     <li>N=Addressee;</li>
        //     <li>P=Recipient</li>
        // </ul>
        //

        public String Type;
        // Name.
        public String Name;
        // GLN.
        public String GLN;
        // Address.
        public String Address;
        // Postal code.
        public String PostalCode;
        // City.
        public String City;
        // Country.
        public mMApiFkField Country;
        // Country name.
        public String CountryName;
        // Default address for given address type:
        // <ul>
        //     <li>N – no,</li>
        //     <li>D – yes.</li>
        // </ul>
        //

        public String Default;
        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