regis

FinanceBalanceRequest

**Requires Authentication**
Required permission:	ReadAccountBalance

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

"use strict";
export class FinanceBalanceResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,first_name?:string,last_name?:string,email?:string,current_program?:string,first_regent_term?:string,first_registered_date?:string,last_registered_date?:string,uuid?:string,total_payments?:number,total_charges?:number,balance?:number,gp_raw_balance?:number,is_vendor?:boolean,is_customer?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {string} */
    current_program;
    /** @type {string} */
    first_regent_term;
    /** @type {?string} */
    first_registered_date;
    /** @type {?string} */
    last_registered_date;
    /** @type {string} */
    uuid;
    /** @type {number} */
    total_payments;
    /** @type {number} */
    total_charges;
    /** @type {number} */
    balance;
    /** @type {number} */
    gp_raw_balance;
    /** @type {boolean} */
    is_vendor;
    /** @type {boolean} */
    is_customer;
}
export class FinanceBalanceRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript FinanceBalanceRequest DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","last_registered_date":"0001-01-01T00:00:00.0000000","uuid":"String","total_payments":0,"total_charges":0,"balance":0,"gp_raw_balance":0,"is_vendor":false,"is_customer":false}