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
import Foundation
import ServiceStack

public class RegistrationBillingAuditReportRequest : Codable
{
    public var reporting_term:String
    public var from_date:Date
    public var to_date:Date
    public var authorizing_uuid:String

    required public init(){}
}

public class RegistrationBillingAuditReportResponse : Codable
{
    public var parity:[RegistrationBillingParityAuditResponse] = []
    public var completeness:[RegistrationBillingCompletenessAuditResponse] = []
    public var failures:[RegistrationBillingFailureAuditResponse] = []
    public var drift:[RegistrationBillingDriftAuditResponse] = []

    required public init(){}
}

public class RegistrationBillingParityAuditResponse : Codable
{
    public var execution_id:Int
    public var reporting_term:String
    public var timestamp:Date
    public var workflow:String
    public var execution_mode:String
    public var regent_id:Int
    public var transaction_id:Int?
    public var matches:Bool
    public var legacy_succeeded:Bool?
    public var composed_succeeded:Bool?
    public var differences:String
    public var request_summary_json:String
    public var legacy_summary_json:String
    public var composed_summary_json:String

    required public init(){}
}

public class RegistrationBillingCompletenessAuditResponse : Codable
{
    public var transaction_id:Int
    public var transaction_uuid:String
    public var reporting_term:String
    public var finished_datetime:Date
    public var operation:String
    public var regent_id:Int
    public var student_uuid:String
    public var student_name:String
    public var invoice_count:Int
    public var invoice_net:Double
    public var item_net:Double
    public var gp_success_count:Int
    public var gp_failure_count:Int
    public var calculation_status:String
    public var calculation_findings:String
    public var status:String
    public var findings:String
    public var resolved_datetime:Date?
    public var resolved_by_uuid:String

    required public init(){}
}

public class RegistrationBillingFailureAuditResponse : Codable
{
    public var source:String
    public var reporting_term:String
    public var id:Int
    public var timestamp:Date
    public var workflow:String
    public var regent_id:Int
    public var transaction_id:Int?
    public var invoice_id:String
    public var gp_document_number:String
    public var amount:Double?
    public var error:String

    required public init(){}
}

public class RegistrationBillingDriftAuditResponse : Codable
{
    public var transaction_id:Int
    public var reporting_term:String
    public var regent_id:Int
    public var workflow:String
    public var calculation_count:Int
    public var first_calculation:Date
    public var final_calculation:Date
    public var changed:Bool
    public var persistence_status:String
    public var persistence_findings:String
    public var first_summary_json:String
    public var final_summary_json:String
    public var section_course_codes:[Int:String] = [:]

    required public init(){}
}


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

{"reporting_term":"String","from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000","authorizing_uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"parity":[{"execution_id":0,"reporting_term":"String","timestamp":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","resolved_by_uuid":"String"}],"failures":[{"source":"String","reporting_term":"String","id":0,"timestamp":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","final_calculation":"0001-01-01T00:00:00.0000000","changed":false,"persistence_status":"String","persistence_findings":"String","first_summary_json":"String","final_summary_json":"String","section_course_codes":{"0":"String"}}]}