regis

FinanceAccountLateChargeJobStartRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/AccountLate/{reporting_term}/Jobs

"use strict";
export class FinanceAccountLateChargeOutcome {
    /** @param {{regent_id?:number,status?:string,charge_amount?:number,charge_status?:string,email_status?:string,message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {string} */
    status;
    /** @type {?number} */
    charge_amount;
    /** @type {string} */
    charge_status;
    /** @type {string} */
    email_status;
    /** @type {string} */
    message;
}
export class FinanceAccountLateChargeJobResponse {
    /** @param {{responseStatus?:ResponseStatus,operation_id?:string,reporting_term?:string,calculation_date?:string,preview_only?:boolean,skip_exact_balance?:number,state?:string,total?:number,current_regent_id?:number,processed?:number,succeeded?:number,skipped?:number,failed?:number,created_utc?:string,updated_utc?:string,message?:string,report_available?:boolean,outcomes?:FinanceAccountLateChargeOutcome[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    operation_id;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    calculation_date;
    /** @type {boolean} */
    preview_only;
    /** @type {?number} */
    skip_exact_balance;
    /** @type {string} */
    state;
    /** @type {?number} */
    total;
    /** @type {?number} */
    current_regent_id;
    /** @type {number} */
    processed;
    /** @type {number} */
    succeeded;
    /** @type {number} */
    skipped;
    /** @type {number} */
    failed;
    /** @type {string} */
    created_utc;
    /** @type {string} */
    updated_utc;
    /** @type {string} */
    message;
    /** @type {boolean} */
    report_available;
    /** @type {FinanceAccountLateChargeOutcome[]} */
    outcomes;
}
export class FinanceAccountLateChargeJobStartRequest {
    /** @param {{authorizing_uuid?:string,reporting_term?:string,operation_id?:string,calculation_date?:string,preview_only?:boolean,skip_exact_balance?:number,send_emails?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    authorizing_uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    operation_id;
    /** @type {string} */
    calculation_date;
    /** @type {boolean} */
    preview_only;
    /** @type {?number} */
    skip_exact_balance;
    /** @type {boolean} */
    send_emails;
}

JavaScript FinanceAccountLateChargeJobStartRequest 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/AccountLate/{reporting_term}/Jobs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	reporting_term: String,
	operation_id: 00000000000000000000000000000000,
	calculation_date: 0001-01-01,
	preview_only: False,
	skip_exact_balance: 0,
	send_emails: False
}

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
		}
	},
	operation_id: 00000000000000000000000000000000,
	reporting_term: String,
	calculation_date: 0001-01-01,
	preview_only: False,
	skip_exact_balance: 0,
	state: String,
	total: 0,
	current_regent_id: 0,
	processed: 0,
	succeeded: 0,
	skipped: 0,
	failed: 0,
	created_utc: 0001-01-01,
	updated_utc: 0001-01-01,
	message: String,
	report_available: False,
	outcomes: 
	[
		{
			regent_id: 0,
			status: String,
			charge_amount: 0,
			charge_status: String,
			email_status: String,
			message: String
		}
	]
}