regis

FinanceBalanceRequest

**Requires Authentication**
Required permission:	ReadAccountBalance

The following routes are available for this service:
POST	/Finance/Balance/{uuid}


export class FinanceBalanceResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public first_name: string;
    public last_name: string;
    public email: string;
    public current_program: string;
    public first_regent_term: string;
    public first_registered_date?: string;
    public last_registered_date?: string;
    public uuid: string;
    public total_payments: number;
    public total_charges: number;
    public balance: number;
    public gp_raw_balance: number;
    public is_vendor: boolean;
    public is_customer: boolean;

    public constructor(init?: Partial<FinanceBalanceResponse>) { (Object as any).assign(this, init); }
}

export class FinanceBalanceRequest
{
    public uuid: string;

    public constructor(init?: Partial<FinanceBalanceRequest>) { (Object as any).assign(this, init); }
}

TypeScript FinanceBalanceRequest 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/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}

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
		}
	},
	regent_id: 0,
	first_name: String,
	last_name: String,
	email: String,
	current_program: String,
	first_regent_term: String,
	first_registered_date: 0001-01-01,
	last_registered_date: 0001-01-01,
	uuid: String,
	total_payments: 0,
	total_charges: 0,
	balance: 0,
	gp_raw_balance: 0,
	is_vendor: False,
	is_customer: False
}