regis

RegistrationBillingAuditReportRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/registration/billing-audit-reports

"use strict";
export class RegistrationBillingParityAuditResponse {
    /** @param {{execution_id?:number,reporting_term?:string,timestamp?:string,workflow?:string,execution_mode?:string,regent_id?:number,transaction_id?:number,matches?:boolean,legacy_succeeded?:boolean,composed_succeeded?:boolean,differences?:string,request_summary_json?:string,legacy_summary_json?:string,composed_summary_json?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    execution_id;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    timestamp;
    /** @type {string} */
    workflow;
    /** @type {string} */
    execution_mode;
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    transaction_id;
    /** @type {boolean} */
    matches;
    /** @type {?boolean} */
    legacy_succeeded;
    /** @type {?boolean} */
    composed_succeeded;
    /** @type {string} */
    differences;
    /** @type {string} */
    request_summary_json;
    /** @type {string} */
    legacy_summary_json;
    /** @type {string} */
    composed_summary_json;
}
export class RegistrationBillingCompletenessAuditResponse {
    /** @param {{transaction_id?:number,transaction_uuid?:string,reporting_term?:string,finished_datetime?:string,operation?:string,regent_id?:number,student_uuid?:string,student_name?:string,invoice_count?:number,invoice_net?:number,item_net?:number,gp_success_count?:number,gp_failure_count?:number,calculation_status?:string,calculation_findings?:string,status?:string,findings?:string,resolved_datetime?:string,resolved_by_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    transaction_id;
    /** @type {string} */
    transaction_uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    finished_datetime;
    /** @type {string} */
    operation;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    student_uuid;
    /** @type {string} */
    student_name;
    /** @type {number} */
    invoice_count;
    /** @type {number} */
    invoice_net;
    /** @type {number} */
    item_net;
    /** @type {number} */
    gp_success_count;
    /** @type {number} */
    gp_failure_count;
    /** @type {string} */
    calculation_status;
    /** @type {string} */
    calculation_findings;
    /** @type {string} */
    status;
    /** @type {string} */
    findings;
    /** @type {?string} */
    resolved_datetime;
    /** @type {string} */
    resolved_by_uuid;
}
export class RegistrationBillingFailureAuditResponse {
    /** @param {{source?:string,reporting_term?:string,id?:number,timestamp?:string,workflow?:string,regent_id?:number,transaction_id?:number,invoice_id?:string,gp_document_number?:string,amount?:number,error?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    source;
    /** @type {string} */
    reporting_term;
    /** @type {number} */
    id;
    /** @type {string} */
    timestamp;
    /** @type {string} */
    workflow;
    /** @type {number} */
    regent_id;
    /** @type {?number} */
    transaction_id;
    /** @type {string} */
    invoice_id;
    /** @type {string} */
    gp_document_number;
    /** @type {?number} */
    amount;
    /** @type {string} */
    error;
}
export class RegistrationBillingDriftAuditResponse {
    /** @param {{transaction_id?:number,reporting_term?:string,regent_id?:number,workflow?:string,calculation_count?:number,first_calculation?:string,final_calculation?:string,changed?:boolean,persistence_status?:string,persistence_findings?:string,first_summary_json?:string,final_summary_json?:string,section_course_codes?:{ [index: number]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    transaction_id;
    /** @type {string} */
    reporting_term;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    workflow;
    /** @type {number} */
    calculation_count;
    /** @type {string} */
    first_calculation;
    /** @type {string} */
    final_calculation;
    /** @type {boolean} */
    changed;
    /** @type {string} */
    persistence_status;
    /** @type {string} */
    persistence_findings;
    /** @type {string} */
    first_summary_json;
    /** @type {string} */
    final_summary_json;
    /** @type {{ [index: number]: string; }} */
    section_course_codes;
}
export class RegistrationBillingAuditReportResponse {
    /** @param {{parity?:RegistrationBillingParityAuditResponse[],completeness?:RegistrationBillingCompletenessAuditResponse[],failures?:RegistrationBillingFailureAuditResponse[],drift?:RegistrationBillingDriftAuditResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RegistrationBillingParityAuditResponse[]} */
    parity;
    /** @type {RegistrationBillingCompletenessAuditResponse[]} */
    completeness;
    /** @type {RegistrationBillingFailureAuditResponse[]} */
    failures;
    /** @type {RegistrationBillingDriftAuditResponse[]} */
    drift;
}
export class RegistrationBillingAuditReportRequest {
    /** @param {{reporting_term?:string,from_date?:string,to_date?:string,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    from_date;
    /** @type {string} */
    to_date;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript 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>