regis

FinanceOverallBalanceRequest

**Requires Authentication**
Required permission:	ReadAccountBalance

The following routes are available for this service:
POST	/Finance/Balance/Overall

"use strict";
export class FinanceOverallBalanceResponse {
    /** @param {{responseStatus?:ResponseStatus,balance?:number,posted_sales?:number,unposted_sales?:number,payments?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    balance;
    /** @type {number} */
    posted_sales;
    /** @type {number} */
    unposted_sales;
    /** @type {number} */
    payments;
}
export class FinanceOverallBalanceRequest {
    constructor(init) { Object.assign(this, init) }
}

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