API Documentation

Request parameters:

• long organisationId - organisation id

Request parameters:

• Int64 organisationId - organisation id

Request parameters:

• Long organisationId - organisation id

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

    /// Dashboard details.
    public class Dashboard
    {
        public AgregateInvoice IssuedInvoicesSummary { get; set; }
        public AgregateInvoice ReceivedInvoicesSummary { get; set; }
        public AgregateInvoice IssuedInvoicesUnpaid { get; set; }
        public AgregateInvoice ReceivedInvoicesUnpaid { get; set; }
        public DashboardCustomer TopCustomers { get; set; }
        public DashboardCustomer TopDebtors { get; set; }
        public DashboardCustomer TopSuppliers { get; set; }
        public DashboardCustomer TopCreditors { get; set; }
        public DashboardMonth RevenuesExpenses { get; set; }
    
    }

        /// Agregated data for invoice.
        public class AgregateInvoice
        {
            // Invoice type.
            public string Type { get; set; }
            // Count.
            public long Count { get; set; }
            // Value.
            public Decimal Value { get; set; }
        
        }
        public class Chart<T>
        {
            public Boolean Visible { get; set; }
            public List<AgregateInvoice> Data { get; set; }
        
        }

            /// Agregated data for invoice.
            public class AgregateInvoice
            {
                // Invoice type.
                public string Type { get; set; }
                // Count.
                public long Count { get; set; }
                // Value.
                public Decimal Value { get; set; }
            
            }
        /// Customer data for dashboard.
        public class DashboardCustomer
        {
            // Position.
            public long Position { get; set; }
            // Customer name.
            public string Customer { get; set; }
            // Customer id.
            public long CustomerId { get; set; }
            // Value.
            public Decimal Value { get; set; }
        
        }
        /// Month data for dashboard.
        public class DashboardMonth
        {
            // Month.
            public long Month { get; set; }
            // Revenue.
            public Decimal Revenue { get; set; }
            // Expense.
            public Decimal Expense { get; set; }
        
        }

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

    /// Dashboard details.
    class Dashboard
    {
        public $IssuedInvoicesSummary;
        public $ReceivedInvoicesSummary;
        public $IssuedInvoicesUnpaid;
        public $ReceivedInvoicesUnpaid;
        public $TopCustomers;
        public $TopDebtors;
        public $TopSuppliers;
        public $TopCreditors;
        public $RevenuesExpenses;
    
    }

        /// Agregated data for invoice.
        class AgregateInvoice
        {
            // Invoice type.
            public $Type;
            // Count.
            public $Count;
            // Value.
            public $Value;
        
        }
        class Chart
        {
            public $Visible;
            public $Data;
        
        }

            /// Agregated data for invoice.
            class AgregateInvoice
            {
                // Invoice type.
                public $Type;
                // Count.
                public $Count;
                // Value.
                public $Value;
            
            }
        /// Customer data for dashboard.
        class DashboardCustomer
        {
            // Position.
            public $Position;
            // Customer name.
            public $Customer;
            // Customer id.
            public $CustomerId;
            // Value.
            public $Value;
        
        }
        /// Month data for dashboard.
        class DashboardMonth
        {
            // Month.
            public $Month;
            // Revenue.
            public $Revenue;
            // Expense.
            public $Expense;
        
        }

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

    /// Dashboard details.
    public class Dashboard
    {
        public AgregateInvoice IssuedInvoicesSummary;
        public AgregateInvoice ReceivedInvoicesSummary;
        public AgregateInvoice IssuedInvoicesUnpaid;
        public AgregateInvoice ReceivedInvoicesUnpaid;
        public DashboardCustomer TopCustomers;
        public DashboardCustomer TopDebtors;
        public DashboardCustomer TopSuppliers;
        public DashboardCustomer TopCreditors;
        public DashboardMonth RevenuesExpenses;
    
    }

        /// Agregated data for invoice.
        public class AgregateInvoice
        {
            // Invoice type.
            public String Type;
            // Count.
            public Long Count;
            // Value.
            public Double Value;
        
        }
        public class ChartT
        {
            public Boolean Visible;
            public List<AgregateInvoice> Data;
        
        }

            /// Agregated data for invoice.
            public class AgregateInvoice
            {
                // Invoice type.
                public String Type;
                // Count.
                public Long Count;
                // Value.
                public Double Value;
            
            }
        /// Customer data for dashboard.
        public class DashboardCustomer
        {
            // Position.
            public Long Position;
            // Customer name.
            public String Customer;
            // Customer id.
            public Long CustomerId;
            // Value.
            public Double Value;
        
        }
        /// Month data for dashboard.
        public class DashboardMonth
        {
            // Month.
            public Long Month;
            // Revenue.
            public Double Revenue;
            // Expense.
            public Double Expense;
        
        }