regis

<back to all web services

FinanceAccountLateChargeJobResultRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs/Result

export class FinanceAccountLateChargeOutcome
{
    public regent_id: number;
    public status: string;
    public charge_amount?: number;
    public charge_status: string;
    public email_status: string;
    public message: string;

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

export class FinanceAccountLateChargeJobResponse
{
    public responseStatus: ResponseStatus;
    public operation_id: string;
    public reporting_term: string;
    public calculation_date: string;
    public preview_only: boolean;
    public skip_exact_balance?: number;
    public state: string;
    public total?: number;
    public current_regent_id?: number;
    public processed: number;
    public succeeded: number;
    public skipped: number;
    public failed: number;
    public created_utc: string;
    public updated_utc: string;
    public message: string;
    public report_available: boolean;
    public outcomes: FinanceAccountLateChargeOutcome[];

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

export class FinanceAccountLateChargeResponse
{
    public responseStatus: ResponseStatus;
    public skip_reason: string;
    public charge_status: string;
    public email_status: string;
    public charge_error: string;
    public email_error: string;
    public regent_id: number;
    public first_name: string;
    public last_name: string;
    public uuid: string;
    public has_late_reg_fee: boolean;
    public amount_owing: number;
    public late_fee: number;
    public interest: number;
    public active_financial_restrictions: string;
    public new_financial_restriction: string;
    public last_registration_date?: string;

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

export class FinanceAccountLateChargeJobResultResponse
{
    public responseStatus: ResponseStatus;
    public job: FinanceAccountLateChargeJobResponse;
    public accounts: FinanceAccountLateChargeResponse[];

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

export class FinanceAccountLateChargeJobResultRequest
{
    public authorizing_uuid: string;
    public reporting_term: string;
    public operation_id: string;

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

TypeScript FinanceAccountLateChargeJobResultRequest 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/Result 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
}
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
		}
	},
	job: 
	{
		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
			}
		]
	},
	accounts: 
	[
		{
			responseStatus: 
			{
				errorCode: String,
				message: String,
				stackTrace: String,
				errors: 
				[
					{
						errorCode: String,
						fieldName: String,
						message: String,
						meta: 
						{
							String: String
						}
					}
				],
				meta: 
				{
					String: String
				}
			},
			skip_reason: String,
			charge_status: String,
			email_status: String,
			charge_error: String,
			email_error: String,
			regent_id: 0,
			first_name: String,
			last_name: String,
			uuid: String,
			has_late_reg_fee: False,
			amount_owing: 0,
			late_fee: 0,
			interest: 0,
			active_financial_restrictions: String,
			new_financial_restriction: String,
			last_registration_date: 0001-01-01
		}
	]
}