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

PurposeCode -> GetPurposeCodeByID

Returns a purpose code for its ID.

Request

Relative request path: api/orgs/{organisationId}/purpose-codes/{purposeCodeId}

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationId
purposeCodeIdpurpose code id

Request parameters:

  • long organisationId -
  • long purposeCodeId - purpose code id

Request parameters:

  • Int64 organisationId -
  • Int64 purposeCodeId - purpose code id

Request parameters:

  • Long organisationId -
  • Long purposeCodeId - purpose code id

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
PurposeCodeIdPurpose code id
CodeCode.
DescriptionPurpose code description.

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

    /// Purpose code details
    public class PurposeCode
    {
        // Purpose code id
        // Ignored on create request.
        public long PurposeCodeId { get; set; }
        // Code.
        public string Code { get; set; }
        // Purpose code description.
        public string Description { get; set; }
    
    }

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

    /// Purpose code details
    class PurposeCode
    {
        // Purpose code id
        // Ignored on create request.
        public $PurposeCodeId;
        // Code.
        public $Code;
        // Purpose code description.
        public $Description;
    
    }

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

    /// Purpose code details
    public class PurposeCode
    {
        // Purpose code id
        // Ignored on create request.
        public Long PurposeCodeId;
        // Code.
        public String Code;
        // Purpose code description.
        public String Description;
    
    }

 
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