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
RegistrationBillingAuditReportRequest Parameters:
NameParameterData TypeRequiredDescription
reporting_termbodystringNo
from_datebodyDateTimeNo
to_datebodyDateTimeNo
authorizing_uuidbodystringNo
RegistrationBillingAuditReportResponse Parameters:
NameParameterData TypeRequiredDescription
parityformList<RegistrationBillingParityAuditResponse>No
completenessformList<RegistrationBillingCompletenessAuditResponse>No
failuresformList<RegistrationBillingFailureAuditResponse>No
driftformList<RegistrationBillingDriftAuditResponse>No
RegistrationBillingParityAuditResponse Parameters:
NameParameterData TypeRequiredDescription
execution_idformlongNo
reporting_termformstringNo
timestampformDateTimeNo
workflowformstringNo
execution_modeformstringNo
regent_idformintNo
transaction_idformint?No
matchesformboolNo
legacy_succeededformbool?No
composed_succeededformbool?No
differencesformstringNo
request_summary_jsonformstringNo
legacy_summary_jsonformstringNo
composed_summary_jsonformstringNo
RegistrationBillingCompletenessAuditResponse Parameters:
NameParameterData TypeRequiredDescription
transaction_idformintNo
transaction_uuidformstringNo
reporting_termformstringNo
finished_datetimeformDateTimeNo
operationformstringNo
regent_idformintNo
student_uuidformstringNo
student_nameformstringNo
invoice_countformintNo
invoice_netformdecimalNo
item_netformdecimalNo
gp_success_countformintNo
gp_failure_countformintNo
calculation_statusformstringNo
calculation_findingsformstringNo
statusformstringNo
findingsformstringNo
resolved_datetimeformDateTime?No
resolved_by_uuidformstringNo
RegistrationBillingFailureAuditResponse Parameters:
NameParameterData TypeRequiredDescription
sourceformstringNo
reporting_termformstringNo
idformlongNo
timestampformDateTimeNo
workflowformstringNo
regent_idformintNo
transaction_idformint?No
invoice_idformstringNo
gp_document_numberformstringNo
amountformdecimal?No
errorformstringNo
RegistrationBillingDriftAuditResponse Parameters:
NameParameterData TypeRequiredDescription
transaction_idformintNo
reporting_termformstringNo
regent_idformintNo
workflowformstringNo
calculation_countformintNo
first_calculationformDateTimeNo
final_calculationformDateTimeNo
changedformboolNo
persistence_statusformstringNo
persistence_findingsformstringNo
first_summary_jsonformstringNo
final_summary_jsonformstringNo
section_course_codesformDictionary<int, string>No

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
			}
		}
	]
}