regis

<back to all web services

FinanceOverallBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/Overall
import Foundation
import ServiceStack

public class FinanceOverallBalanceRequest : Codable
{
    required public init(){}
}

public class FinanceOverallBalanceResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var balance:Double
    public var posted_sales:Double
    public var unposted_sales:Double
    public var payments:Double

    required public init(){}
}


Swift 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
}