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

DocumentNumbering -> GetDocumentNumbering

Returns a document numbering for given id.

Request

Relative request path: api/orgs/{organisationId}/document-numbering/{documentNumberingId}

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
organisationIdorganisation id
documentNumberingIddocument id

Request parameters:

  • long organisationId - organisation id
  • long documentNumberingId - document id

Request parameters:

  • Int64 organisationId - organisation id
  • Int64 documentNumberingId - document id

Request parameters:

  • Long organisationId - organisation id
  • Long documentNumberingId - document id

Response

  • Description
  • CS
  • PHP
  • Java

PropertyDescription
DocumentNumberingIdDocumentNumbering id.
DocumentPossible values: (IR, PD, PR). Document numbering codes.
  • IR – Issued invoice
  • PD – Proforma invoice
  • PR – Received invoice
CodeCode.
NameName.
DefaultPossible values: (D, N). Default:
  • D - Yes
  • N - No
ReferenceNumberReference number used on invoices.
PackagingDepositReturnIncludedInPricePossible values: (D, N). Usage:
  • D - Yes
  • N - No
UsagePossible values: (D, N). Usage:
  • D - Yes
  • N - No
RecordDtModified
RowVersionRow version is used for concurrency check.

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

    /// DocumentNumbering details.
    public class DocumentNumbering
    {
        // DocumentNumbering id.
        // Ignored on create request.
        public long DocumentNumberingId { get; set; }
        // Document numbering codes.<br/>
        // <ul>
        //     <li>IR – Issued invoice</li>
        //     <li>PD – Proforma invoice</li>
        //     <li>PR – Received invoice</li>
        // </ul>
        //
        public string Document { get; set; }
        // Code.
        public string Code { get; set; }
        // Name.
        public string Name { get; set; }
        // Default:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public string Default { get; set; }
        // Reference number used on invoices.
        public string ReferenceNumber { get; set; }
        // Usage:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public string PackagingDepositReturnIncludedInPrice { get; set; }
        // Usage:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public string Usage { get; set; }
        public DateTime RecordDtModified { get; set; }
        // Row version is used for concurrency check.
        // Ignored on create request.
        public string RowVersion { get; set; }
    
    }

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

    /// DocumentNumbering details.
    class DocumentNumbering
    {
        // DocumentNumbering id.
        // Ignored on create request.
        public $DocumentNumberingId;
        // Document numbering codes.<br/>
        // <ul>
        //     <li>IR – Issued invoice</li>
        //     <li>PD – Proforma invoice</li>
        //     <li>PR – Received invoice</li>
        // </ul>
        //
        public $Document;
        // Code.
        public $Code;
        // Name.
        public $Name;
        // Default:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public $Default;
        // Reference number used on invoices.
        public $ReferenceNumber;
        // Usage:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public $PackagingDepositReturnIncludedInPrice;
        // Usage:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public $Usage;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // Ignored on create request.
        public $RowVersion;
    
    }

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

    /// DocumentNumbering details.
    public class DocumentNumbering
    {
        // DocumentNumbering id.
        // Ignored on create request.
        public Long DocumentNumberingId;
        // Document numbering codes.<br/>
        // <ul>
        //     <li>IR – Issued invoice</li>
        //     <li>PD – Proforma invoice</li>
        //     <li>PR – Received invoice</li>
        // </ul>
        //
        public String Document;
        // Code.
        public String Code;
        // Name.
        public String Name;
        // Default:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public String Default;
        // Reference number used on invoices.
        public String ReferenceNumber;
        // Usage:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public String PackagingDepositReturnIncludedInPrice;
        // Usage:
        // <ul>
        //     <li>D - Yes</li>
        //     <li>N - No</li>
        // </ul>
        //
        public String Usage;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // Ignored on create request.
        public String RowVersion;
    
    }

 
Authorization endpoint : https://moj.minimax.hr/HR/AUT/OAuth20
Token endpoint           : https://moj.minimax.hr/HR/AUT/OAuth20/Token
Return url                   : https://moj.minimax.hr/HR/API/Help/TestClientDialogsAuth
 
URI parameters
=
Headers | Add custom header
: Delete
Body
Samples:
Status
Headers
Body