regis

<back to all web services

FinanceOverallBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/Overall
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinanceOverallBalanceRequest
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinanceOverallBalanceResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property balance As Decimal
            Public Overridable Property posted_sales As Decimal
            Public Overridable Property unposted_sales As Decimal
            Public Overridable Property payments As Decimal
        End Class
    End Namespace
End Namespace

VB.NET FinanceOverallBalanceRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/Balance/Overall HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	balance: 0,
	posted_sales: 0,
	unposted_sales: 0,
	payments: 0
}