| Required permission: | ReadAccountReport |
| POST | /Finance/AccountReport/{uuid} |
|---|
"use strict";
export class InvoiceItemResponse {
/** @param {{responseStatus?:ResponseStatus,invoiceItemUUID?:string,rate_id?:number,rate_code?:string,rate_description?:string,charge?:number,credit?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
invoiceItemUUID;
/** @type {number} */
rate_id;
/** @type {string} */
rate_code;
/** @type {string} */
rate_description;
/** @type {?number} */
charge;
/** @type {?number} */
credit;
}
export class InstructorResponse {
/** @param {{responseStatus?:ResponseStatus,regent_id?:number,regent_login?:string,preferred_name?:string,first_name?:string,last_name?:string,full_name?:string,email?:string,image_base64?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {number} */
regent_id;
/** @type {string} */
regent_login;
/** @type {string} */
preferred_name;
/** @type {string} */
first_name;
/** @type {string} */
last_name;
/** @type {string} */
full_name;
/** @type {string} */
email;
/** @type {string} */
image_base64;
}
export class DocumentResponse {
/** @param {{code?:string,document_name?:string,document_description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
code;
/** @type {string} */
document_name;
/** @type {string} */
document_description;
}
export class SectionResponse {
/** @param {{responseStatus?:ResponseStatus,secUUID?:string,course_name?:string,section_code?:string,course_title?:string,course_short_title?:string,course_description?:string,crosslist_description?:string,crosslist_course_name?:string,location_long_name?:string,room?:string,instructors?:InstructorResponse[],required_documents?:DocumentResponse[],start_date?:string,end_date?:string,first_meeting_date?:string,last_meeting_date?:string,meeting_days?:string,start_times?:string[],end_times?:string[],is_online_only?:boolean,is_weekend?:boolean,is_weekday?:boolean,is_evening?:boolean,is_waitlist?:boolean,has_special_requirements?:boolean,special_requirements?:string,is_unlisted?:boolean,credit_amounts?:number[],audit_amounts?:number[],audits_short_name?:string,audits_long_name?:string,credits_short_name?:string,credits_long_name?:string,distance_ed_materials?:string,prerequisites?:string,corequisites?:string,capacity?:number,flat_fee_amount?:number,additional_fee_amount?:number,registered_students?:number,three_credit_plus?:number,two_credit?:number,one_credit?:number,three_audit_plus?:number,two_audit?:number,one_audit?:number,crosslist_registered_students?:number,grades_received?:number,crosslist_grades_received?:number,registration_start_date?:string,registration_end_date?:string,add_start_date?:string,add_end_date?:string,drop_start_date?:string,drop_end_date?:string,grading_end_date?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,timestamp?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
secUUID;
/** @type {string} */
course_name;
/** @type {string} */
section_code;
/** @type {string} */
course_title;
/** @type {string} */
course_short_title;
/** @type {string} */
course_description;
/** @type {string} */
crosslist_description;
/** @type {string} */
crosslist_course_name;
/** @type {string} */
location_long_name;
/** @type {string} */
room;
/** @type {InstructorResponse[]} */
instructors;
/** @type {DocumentResponse[]} */
required_documents;
/** @type {?string} */
start_date;
/** @type {?string} */
end_date;
/** @type {?string} */
first_meeting_date;
/** @type {?string} */
last_meeting_date;
/** @type {string} */
meeting_days;
/** @type {string[]} */
start_times;
/** @type {string[]} */
end_times;
/** @type {boolean} */
is_online_only;
/** @type {boolean} */
is_weekend;
/** @type {boolean} */
is_weekday;
/** @type {boolean} */
is_evening;
/** @type {boolean} */
is_waitlist;
/** @type {boolean} */
has_special_requirements;
/** @type {string} */
special_requirements;
/** @type {boolean} */
is_unlisted;
/** @type {number[]} */
credit_amounts;
/** @type {number[]} */
audit_amounts;
/** @type {string} */
audits_short_name;
/** @type {string} */
audits_long_name;
/** @type {string} */
credits_short_name;
/** @type {string} */
credits_long_name;
/** @type {string} */
distance_ed_materials;
/** @type {string} */
prerequisites;
/** @type {string} */
corequisites;
/** @type {?number} */
capacity;
/** @type {?number} */
flat_fee_amount;
/** @type {?number} */
additional_fee_amount;
/** @type {number} */
registered_students;
/** @type {number} */
three_credit_plus;
/** @type {number} */
two_credit;
/** @type {number} */
one_credit;
/** @type {number} */
three_audit_plus;
/** @type {number} */
two_audit;
/** @type {number} */
one_audit;
/** @type {number} */
crosslist_registered_students;
/** @type {number} */
grades_received;
/** @type {number} */
crosslist_grades_received;
/** @type {?string} */
registration_start_date;
/** @type {?string} */
registration_end_date;
/** @type {?string} */
add_start_date;
/** @type {?string} */
add_end_date;
/** @type {?string} */
drop_start_date;
/** @type {?string} */
drop_end_date;
/** @type {?string} */
grading_end_date;
/** @type {string} */
term;
/** @type {string} */
reporting_term;
/** @type {number} */
reporting_year;
/** @type {string} */
current_status;
/** @type {string} */
added_by;
/** @type {?string} */
added_date;
/** @type {string} */
changed_by;
/** @type {?string} */
changed_date;
/** @type {string} */
timestamp;
}
export class StudentSectionResponse extends SectionResponse {
/** @param {{studentSectionUUID?:string,registered_amount?:number,is_provisional?:boolean,is_audit?:boolean,responseStatus?:ResponseStatus,secUUID?:string,course_name?:string,section_code?:string,course_title?:string,course_short_title?:string,course_description?:string,crosslist_description?:string,crosslist_course_name?:string,location_long_name?:string,room?:string,instructors?:InstructorResponse[],required_documents?:DocumentResponse[],start_date?:string,end_date?:string,first_meeting_date?:string,last_meeting_date?:string,meeting_days?:string,start_times?:string[],end_times?:string[],is_online_only?:boolean,is_weekend?:boolean,is_weekday?:boolean,is_evening?:boolean,is_waitlist?:boolean,has_special_requirements?:boolean,special_requirements?:string,is_unlisted?:boolean,credit_amounts?:number[],audit_amounts?:number[],audits_short_name?:string,audits_long_name?:string,credits_short_name?:string,credits_long_name?:string,distance_ed_materials?:string,prerequisites?:string,corequisites?:string,capacity?:number,flat_fee_amount?:number,additional_fee_amount?:number,registered_students?:number,three_credit_plus?:number,two_credit?:number,one_credit?:number,three_audit_plus?:number,two_audit?:number,one_audit?:number,crosslist_registered_students?:number,grades_received?:number,crosslist_grades_received?:number,registration_start_date?:string,registration_end_date?:string,add_start_date?:string,add_end_date?:string,drop_start_date?:string,drop_end_date?:string,grading_end_date?:string,term?:string,reporting_term?:string,reporting_year?:number,current_status?:string,added_by?:string,added_date?:string,changed_by?:string,changed_date?:string,timestamp?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
studentSectionUUID;
/** @type {number} */
registered_amount;
/** @type {boolean} */
is_provisional;
/** @type {boolean} */
is_audit;
}
export class StudentSectionInvoiceItemResponse extends InvoiceItemResponse {
/** @param {{studentSection?:StudentSectionResponse,responseStatus?:ResponseStatus,invoiceItemUUID?:string,rate_id?:number,rate_code?:string,rate_description?:string,charge?:number,credit?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {StudentSectionResponse} */
studentSection;
}
export class FinanceInvoiceAndCashReceiptsResponse {
/** @param {{invoiceUUID?:string,document_id?:string,document_description?:string,document_date?:string,regent_id?:number,uuid?:string,reporting_term?:string,total_charges?:number,total_credits?:number,current_status?:string,timestamp?:string,studentSectionInvoiceItems?:StudentSectionInvoiceItemResponse[],otherInvoiceItems?:InvoiceItemResponse[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
invoiceUUID;
/** @type {string} */
document_id;
/** @type {string} */
document_description;
/** @type {string} */
document_date;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {string} */
reporting_term;
/** @type {?number} */
total_charges;
/** @type {?number} */
total_credits;
/** @type {string} */
current_status;
/** @type {string} */
timestamp;
/** @type {StudentSectionInvoiceItemResponse[]} */
studentSectionInvoiceItems;
/** @type {InvoiceItemResponse[]} */
otherInvoiceItems;
}
export class FinanceAccountReportResponse {
/** @param {{responseStatus?:ResponseStatus,first_name?:string,last_name?:string,name?:string,academic_program?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,regent_id?:number,uuid?:string,balance?:number,invoices_and_cash_receipts?:FinanceInvoiceAndCashReceiptsResponse[],previous_balance?:number,future_balance?:number,from_date?:string,to_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
responseStatus;
/** @type {string} */
first_name;
/** @type {string} */
last_name;
/** @type {string} */
name;
/** @type {string} */
academic_program;
/** @type {string} */
addr1;
/** @type {string} */
addr2;
/** @type {string} */
city;
/** @type {string} */
state;
/** @type {string} */
country;
/** @type {string} */
code;
/** @type {number} */
regent_id;
/** @type {string} */
uuid;
/** @type {number} */
balance;
/** @type {FinanceInvoiceAndCashReceiptsResponse[]} */
invoices_and_cash_receipts;
/** @type {number} */
previous_balance;
/** @type {number} */
future_balance;
/** @type {string} */
from_date;
/** @type {string} */
to_date;
}
export class FinanceAccountReportRequest {
/** @param {{uuid?:string,from_date?:string,to_date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
uuid;
/** @type {?string} */
from_date;
/** @type {?string} */
to_date;
}
JavaScript FinanceAccountReportRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/AccountReport/{uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FinanceAccountReportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
<from_date>0001-01-01T00:00:00</from_date>
<to_date>0001-01-01T00:00:00</to_date>
<uuid>String</uuid>
</FinanceAccountReportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FinanceAccountReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<academic_program>String</academic_program>
<addr1>String</addr1>
<addr2>String</addr2>
<balance>0</balance>
<city>String</city>
<code>String</code>
<country>String</country>
<first_name>String</first_name>
<from_date>0001-01-01T00:00:00</from_date>
<future_balance>0</future_balance>
<invoices_and_cash_receipts>
<FinanceInvoiceAndCashReceiptsResponse>
<current_status>String</current_status>
<document_date>0001-01-01T00:00:00</document_date>
<document_description>String</document_description>
<document_id>String</document_id>
<invoiceUUID>String</invoiceUUID>
<otherInvoiceItems>
<InvoiceItemResponse>
<ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types">
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:Message>String</d6p1:Message>
<d6p1:StackTrace>String</d6p1:StackTrace>
<d6p1:Errors>
<d6p1:ResponseError>
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:FieldName>String</d6p1:FieldName>
<d6p1:Message>String</d6p1:Message>
<d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d9p1:KeyValueOfstringstring>
<d9p1:Key>String</d9p1:Key>
<d9p1:Value>String</d9p1:Value>
</d9p1:KeyValueOfstringstring>
</d6p1:Meta>
</d6p1:ResponseError>
</d6p1:Errors>
<d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d6p1:Meta>
</ResponseStatus>
<charge>0</charge>
<credit>0</credit>
<invoiceItemUUID>String</invoiceItemUUID>
<rate_code>String</rate_code>
<rate_description>String</rate_description>
<rate_id>0</rate_id>
</InvoiceItemResponse>
</otherInvoiceItems>
<regent_id>0</regent_id>
<reporting_term>String</reporting_term>
<studentSectionInvoiceItems>
<StudentSectionInvoiceItemResponse>
<ResponseStatus xmlns:d6p1="http://schemas.servicestack.net/types">
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:Message>String</d6p1:Message>
<d6p1:StackTrace>String</d6p1:StackTrace>
<d6p1:Errors>
<d6p1:ResponseError>
<d6p1:ErrorCode>String</d6p1:ErrorCode>
<d6p1:FieldName>String</d6p1:FieldName>
<d6p1:Message>String</d6p1:Message>
<d6p1:Meta xmlns:d9p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d9p1:KeyValueOfstringstring>
<d9p1:Key>String</d9p1:Key>
<d9p1:Value>String</d9p1:Value>
</d9p1:KeyValueOfstringstring>
</d6p1:Meta>
</d6p1:ResponseError>
</d6p1:Errors>
<d6p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d6p1:Meta>
</ResponseStatus>
<charge>0</charge>
<credit>0</credit>
<invoiceItemUUID>String</invoiceItemUUID>
<rate_code>String</rate_code>
<rate_description>String</rate_description>
<rate_id>0</rate_id>
<studentSection>
<ResponseStatus xmlns:d7p1="http://schemas.servicestack.net/types">
<d7p1:ErrorCode>String</d7p1:ErrorCode>
<d7p1:Message>String</d7p1:Message>
<d7p1:StackTrace>String</d7p1:StackTrace>
<d7p1:Errors>
<d7p1:ResponseError>
<d7p1:ErrorCode>String</d7p1:ErrorCode>
<d7p1:FieldName>String</d7p1:FieldName>
<d7p1:Message>String</d7p1:Message>
<d7p1:Meta xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d10p1:KeyValueOfstringstring>
<d10p1:Key>String</d10p1:Key>
<d10p1:Value>String</d10p1:Value>
</d10p1:KeyValueOfstringstring>
</d7p1:Meta>
</d7p1:ResponseError>
</d7p1:Errors>
<d7p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d8p1:KeyValueOfstringstring>
<d8p1:Key>String</d8p1:Key>
<d8p1:Value>String</d8p1:Value>
</d8p1:KeyValueOfstringstring>
</d7p1:Meta>
</ResponseStatus>
<add_end_date>0001-01-01T00:00:00</add_end_date>
<add_start_date>0001-01-01T00:00:00</add_start_date>
<added_by>String</added_by>
<added_date>0001-01-01T00:00:00</added_date>
<additional_fee_amount>0</additional_fee_amount>
<audit_amounts xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:decimal>0</d7p1:decimal>
</audit_amounts>
<audits_long_name>String</audits_long_name>
<audits_short_name>String</audits_short_name>
<capacity>0</capacity>
<changed_by>String</changed_by>
<changed_date>0001-01-01T00:00:00</changed_date>
<corequisites>String</corequisites>
<course_description>String</course_description>
<course_name>String</course_name>
<course_short_title>String</course_short_title>
<course_title>String</course_title>
<credit_amounts xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:decimal>0</d7p1:decimal>
</credit_amounts>
<credits_long_name>String</credits_long_name>
<credits_short_name>String</credits_short_name>
<crosslist_course_name>String</crosslist_course_name>
<crosslist_description>String</crosslist_description>
<crosslist_grades_received>0</crosslist_grades_received>
<crosslist_registered_students>0</crosslist_registered_students>
<current_status>String</current_status>
<distance_ed_materials>String</distance_ed_materials>
<drop_end_date>0001-01-01T00:00:00</drop_end_date>
<drop_start_date>0001-01-01T00:00:00</drop_start_date>
<end_date>0001-01-01T00:00:00</end_date>
<end_times xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</end_times>
<first_meeting_date>0001-01-01T00:00:00</first_meeting_date>
<flat_fee_amount>0</flat_fee_amount>
<grades_received>0</grades_received>
<grading_end_date>0001-01-01T00:00:00</grading_end_date>
<has_special_requirements>false</has_special_requirements>
<instructors>
<InstructorResponse>
<ResponseStatus xmlns:d9p1="http://schemas.servicestack.net/types">
<d9p1:ErrorCode>String</d9p1:ErrorCode>
<d9p1:Message>String</d9p1:Message>
<d9p1:StackTrace>String</d9p1:StackTrace>
<d9p1:Errors>
<d9p1:ResponseError>
<d9p1:ErrorCode>String</d9p1:ErrorCode>
<d9p1:FieldName>String</d9p1:FieldName>
<d9p1:Message>String</d9p1:Message>
<d9p1:Meta xmlns:d12p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d12p1:KeyValueOfstringstring>
<d12p1:Key>String</d12p1:Key>
<d12p1:Value>String</d12p1:Value>
</d12p1:KeyValueOfstringstring>
</d9p1:Meta>
</d9p1:ResponseError>
</d9p1:Errors>
<d9p1:Meta xmlns:d10p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d10p1:KeyValueOfstringstring>
<d10p1:Key>String</d10p1:Key>
<d10p1:Value>String</d10p1:Value>
</d10p1:KeyValueOfstringstring>
</d9p1:Meta>
</ResponseStatus>
<email>String</email>
<first_name>String</first_name>
<full_name>String</full_name>
<image_base64>String</image_base64>
<last_name>String</last_name>
<preferred_name>String</preferred_name>
<regent_id>0</regent_id>
<regent_login>String</regent_login>
</InstructorResponse>
</instructors>
<is_evening>false</is_evening>
<is_online_only>false</is_online_only>
<is_unlisted>false</is_unlisted>
<is_waitlist>false</is_waitlist>
<is_weekday>false</is_weekday>
<is_weekend>false</is_weekend>
<last_meeting_date>0001-01-01T00:00:00</last_meeting_date>
<location_long_name>String</location_long_name>
<meeting_days>String</meeting_days>
<one_audit>0</one_audit>
<one_credit>0</one_credit>
<prerequisites>String</prerequisites>
<registered_students>0</registered_students>
<registration_end_date>0001-01-01T00:00:00</registration_end_date>
<registration_start_date>0001-01-01T00:00:00</registration_start_date>
<reporting_term>String</reporting_term>
<reporting_year>0</reporting_year>
<required_documents>
<DocumentResponse>
<code>String</code>
<document_description>String</document_description>
<document_name>String</document_name>
</DocumentResponse>
</required_documents>
<room>String</room>
<secUUID>String</secUUID>
<section_code>String</section_code>
<special_requirements>String</special_requirements>
<start_date>0001-01-01T00:00:00</start_date>
<start_times xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</start_times>
<term>String</term>
<three_audit_plus>0</three_audit_plus>
<three_credit_plus>0</three_credit_plus>
<timestamp>0001-01-01T00:00:00</timestamp>
<two_audit>0</two_audit>
<two_credit>0</two_credit>
<is_audit>false</is_audit>
<is_provisional>false</is_provisional>
<registered_amount>0</registered_amount>
<studentSectionUUID>String</studentSectionUUID>
</studentSection>
</StudentSectionInvoiceItemResponse>
</studentSectionInvoiceItems>
<timestamp>0001-01-01T00:00:00</timestamp>
<total_charges>0</total_charges>
<total_credits>0</total_credits>
<uuid>String</uuid>
</FinanceInvoiceAndCashReceiptsResponse>
</invoices_and_cash_receipts>
<last_name>String</last_name>
<name>String</name>
<previous_balance>0</previous_balance>
<regent_id>0</regent_id>
<state>String</state>
<to_date>0001-01-01T00:00:00</to_date>
<uuid>String</uuid>
</FinanceAccountReportResponse>