regis

<back to all web services

RegistrationBillingAuditReportRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/registration/billing-audit-reports

export class RegistrationBillingParityAuditResponse
{
    public execution_id: number;
    public reporting_term: string;
    public timestamp: string;
    public workflow: string;
    public execution_mode: string;
    public regent_id: number;
    public transaction_id?: number;
    public matches: boolean;
    public legacy_succeeded?: boolean;
    public composed_succeeded?: boolean;
    public differences: string;
    public request_summary_json: string;
    public legacy_summary_json: string;
    public composed_summary_json: string;

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

export class RegistrationBillingCompletenessAuditResponse
{
    public transaction_id: number;
    public transaction_uuid: string;
    public reporting_term: string;
    public finished_datetime: string;
    public operation: string;
    public regent_id: number;
    public student_uuid: string;
    public student_name: string;
    public invoice_count: number;
    public invoice_net: number;
    public item_net: number;
    public gp_success_count: number;
    public gp_failure_count: number;
    public calculation_status: string;
    public calculation_findings: string;
    public status: string;
    public findings: string;
    public resolved_datetime?: string;
    public resolved_by_uuid: string;

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

export class RegistrationBillingFailureAuditResponse
{
    public source: string;
    public reporting_term: string;
    public id: number;
    public timestamp: string;
    public workflow: string;
    public regent_id: number;
    public transaction_id?: number;
    public invoice_id: string;
    public gp_document_number: string;
    public amount?: number;
    public error: string;

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

export class RegistrationBillingDriftAuditResponse
{
    public transaction_id: number;
    public reporting_term: string;
    public regent_id: number;
    public workflow: string;
    public calculation_count: number;
    public first_calculation: string;
    public final_calculation: string;
    public changed: boolean;
    public persistence_status: string;
    public persistence_findings: string;
    public first_summary_json: string;
    public final_summary_json: string;
    public section_course_codes: { [index: number]: string; };

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

export class RegistrationBillingAuditReportResponse
{
    public parity: RegistrationBillingParityAuditResponse[];
    public completeness: RegistrationBillingCompletenessAuditResponse[];
    public failures: RegistrationBillingFailureAuditResponse[];
    public drift: RegistrationBillingDriftAuditResponse[];

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

export class RegistrationBillingAuditReportRequest
{
    public reporting_term: string;
    public from_date: string;
    public to_date: string;
    public authorizing_uuid: string;

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

TypeScript RegistrationBillingAuditReportRequest 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 /registration/billing-audit-reports HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	reporting_term: String,
	from_date: 0001-01-01,
	to_date: 0001-01-01,
	authorizing_uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	parity: 
	[
		{
			execution_id: 0,
			reporting_term: String,
			timestamp: 0001-01-01,
			workflow: String,
			execution_mode: String,
			regent_id: 0,
			transaction_id: 0,
			matches: False,
			legacy_succeeded: False,
			composed_succeeded: False,
			differences: String,
			request_summary_json: String,
			legacy_summary_json: String,
			composed_summary_json: String
		}
	],
	completeness: 
	[
		{
			transaction_id: 0,
			transaction_uuid: String,
			reporting_term: String,
			finished_datetime: 0001-01-01,
			operation: String,
			regent_id: 0,
			student_uuid: String,
			student_name: String,
			invoice_count: 0,
			invoice_net: 0,
			item_net: 0,
			gp_success_count: 0,
			gp_failure_count: 0,
			calculation_status: String,
			calculation_findings: String,
			status: String,
			findings: String,
			resolved_datetime: 0001-01-01,
			resolved_by_uuid: String
		}
	],
	failures: 
	[
		{
			source: String,
			reporting_term: String,
			id: 0,
			timestamp: 0001-01-01,
			workflow: String,
			regent_id: 0,
			transaction_id: 0,
			invoice_id: String,
			gp_document_number: String,
			amount: 0,
			error: String
		}
	],
	drift: 
	[
		{
			transaction_id: 0,
			reporting_term: String,
			regent_id: 0,
			workflow: String,
			calculation_count: 0,
			first_calculation: 0001-01-01,
			final_calculation: 0001-01-01,
			changed: False,
			persistence_status: String,
			persistence_findings: String,
			first_summary_json: String,
			final_summary_json: String,
			section_course_codes: 
			{
				0: String
			}
		}
	]
}