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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<RegistrationBillingAuditReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <authorizing_uuid>String</authorizing_uuid>
  <from_date>0001-01-01T00:00:00</from_date>
  <reporting_term>String</reporting_term>
  <to_date>0001-01-01T00:00:00</to_date>
</RegistrationBillingAuditReportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RegistrationBillingAuditReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <completeness>
    <RegistrationBillingCompletenessAuditResponse>
      <calculation_findings>String</calculation_findings>
      <calculation_status>String</calculation_status>
      <findings>String</findings>
      <finished_datetime>0001-01-01T00:00:00</finished_datetime>
      <gp_failure_count>0</gp_failure_count>
      <gp_success_count>0</gp_success_count>
      <invoice_count>0</invoice_count>
      <invoice_net>0</invoice_net>
      <item_net>0</item_net>
      <operation>String</operation>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <resolved_by_uuid>String</resolved_by_uuid>
      <resolved_datetime>0001-01-01T00:00:00</resolved_datetime>
      <status>String</status>
      <student_name>String</student_name>
      <student_uuid>String</student_uuid>
      <transaction_id>0</transaction_id>
      <transaction_uuid>String</transaction_uuid>
    </RegistrationBillingCompletenessAuditResponse>
  </completeness>
  <drift>
    <RegistrationBillingDriftAuditResponse>
      <calculation_count>0</calculation_count>
      <changed>false</changed>
      <final_calculation>0001-01-01T00:00:00</final_calculation>
      <final_summary_json>String</final_summary_json>
      <first_calculation>0001-01-01T00:00:00</first_calculation>
      <first_summary_json>String</first_summary_json>
      <persistence_findings>String</persistence_findings>
      <persistence_status>String</persistence_status>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <section_course_codes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfintstring>
          <d4p1:Key>0</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfintstring>
      </section_course_codes>
      <transaction_id>0</transaction_id>
      <workflow>String</workflow>
    </RegistrationBillingDriftAuditResponse>
  </drift>
  <failures>
    <RegistrationBillingFailureAuditResponse>
      <amount>0</amount>
      <error>String</error>
      <gp_document_number>String</gp_document_number>
      <id>0</id>
      <invoice_id>String</invoice_id>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <source>String</source>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <transaction_id>0</transaction_id>
      <workflow>String</workflow>
    </RegistrationBillingFailureAuditResponse>
  </failures>
  <parity>
    <RegistrationBillingParityAuditResponse>
      <composed_succeeded>false</composed_succeeded>
      <composed_summary_json>String</composed_summary_json>
      <differences>String</differences>
      <execution_id>0</execution_id>
      <execution_mode>String</execution_mode>
      <legacy_succeeded>false</legacy_succeeded>
      <legacy_summary_json>String</legacy_summary_json>
      <matches>false</matches>
      <regent_id>0</regent_id>
      <reporting_term>String</reporting_term>
      <request_summary_json>String</request_summary_json>
      <timestamp>0001-01-01T00:00:00</timestamp>
      <transaction_id>0</transaction_id>
      <workflow>String</workflow>
    </RegistrationBillingParityAuditResponse>
  </parity>
</RegistrationBillingAuditReportResponse>