regis

<back to all web services

FinanceAccountLateChargeJobResultRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/AccountLate/{reporting_term}/Jobs/Result
"use strict";
export class FinanceAccountLateChargeOutcome {
    /** @param {{regent_id?:number,status?:string,charge_amount?:number,charge_status?:string,email_status?:string,message?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    regent_id;
    /** @type {string} */
    status;
    /** @type {?number} */
    charge_amount;
    /** @type {string} */
    charge_status;
    /** @type {string} */
    email_status;
    /** @type {string} */
    message;
}
export class FinanceAccountLateChargeJobResponse {
    /** @param {{responseStatus?:ResponseStatus,operation_id?:string,reporting_term?:string,calculation_date?:string,preview_only?:boolean,skip_exact_balance?:number,state?:string,total?:number,current_regent_id?:number,processed?:number,succeeded?:number,skipped?:number,failed?:number,created_utc?:string,updated_utc?:string,message?:string,report_available?:boolean,outcomes?:FinanceAccountLateChargeOutcome[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    operation_id;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    calculation_date;
    /** @type {boolean} */
    preview_only;
    /** @type {?number} */
    skip_exact_balance;
    /** @type {string} */
    state;
    /** @type {?number} */
    total;
    /** @type {?number} */
    current_regent_id;
    /** @type {number} */
    processed;
    /** @type {number} */
    succeeded;
    /** @type {number} */
    skipped;
    /** @type {number} */
    failed;
    /** @type {string} */
    created_utc;
    /** @type {string} */
    updated_utc;
    /** @type {string} */
    message;
    /** @type {boolean} */
    report_available;
    /** @type {FinanceAccountLateChargeOutcome[]} */
    outcomes;
}
export class FinanceAccountLateChargeResponse {
    /** @param {{responseStatus?:ResponseStatus,skip_reason?:string,charge_status?:string,email_status?:string,charge_error?:string,email_error?:string,regent_id?:number,first_name?:string,last_name?:string,uuid?:string,has_late_reg_fee?:boolean,amount_owing?:number,late_fee?:number,interest?:number,active_financial_restrictions?:string,new_financial_restriction?:string,last_registration_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    skip_reason;
    /** @type {string} */
    charge_status;
    /** @type {string} */
    email_status;
    /** @type {string} */
    charge_error;
    /** @type {string} */
    email_error;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    uuid;
    /** @type {boolean} */
    has_late_reg_fee;
    /** @type {number} */
    amount_owing;
    /** @type {number} */
    late_fee;
    /** @type {number} */
    interest;
    /** @type {string} */
    active_financial_restrictions;
    /** @type {string} */
    new_financial_restriction;
    /** @type {?string} */
    last_registration_date;
}
export class FinanceAccountLateChargeJobResultResponse {
    /** @param {{responseStatus?:ResponseStatus,job?:FinanceAccountLateChargeJobResponse,accounts?:FinanceAccountLateChargeResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {FinanceAccountLateChargeJobResponse} */
    job;
    /** @type {FinanceAccountLateChargeResponse[]} */
    accounts;
}
export class FinanceAccountLateChargeJobResultRequest {
    /** @param {{authorizing_uuid?:string,reporting_term?:string,operation_id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    authorizing_uuid;
    /** @type {string} */
    reporting_term;
    /** @type {string} */
    operation_id;
}

JavaScript FinanceAccountLateChargeJobResultRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Finance/AccountLate/{reporting_term}/Jobs/Result HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"authorizing_uuid":"String","reporting_term":"String","operation_id":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"job":{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"operation_id":"00000000000000000000000000000000","reporting_term":"String","calculation_date":"0001-01-01T00:00:00.0000000","preview_only":false,"skip_exact_balance":0,"state":"String","total":0,"current_regent_id":0,"processed":0,"succeeded":0,"skipped":0,"failed":0,"created_utc":"0001-01-01T00:00:00.0000000","updated_utc":"0001-01-01T00:00:00.0000000","message":"String","report_available":false,"outcomes":[{"regent_id":0,"status":"String","charge_amount":0,"charge_status":"String","email_status":"String","message":"String"}]},"accounts":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"skip_reason":"String","charge_status":"String","email_status":"String","charge_error":"String","email_error":"String","regent_id":0,"first_name":"String","last_name":"String","uuid":"String","has_late_reg_fee":false,"amount_owing":0,"late_fee":0,"interest":0,"active_financial_restrictions":"String","new_financial_restriction":"String","last_registration_date":"0001-01-01T00:00:00.0000000"}]}