regis

<back to all web services

FinanceAdjustmentSubmitRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/{uuid}/Adjustment/{reporting_term}/Submit
"use strict";
export class FinanceAdjustmentRateSubmitRequest {
    /** @param {{rate_id?:number,description?:string,charge?:number,credit?:number,custom_gl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    rate_id;
    /** @type {string} */
    description;
    /** @type {number} */
    charge;
    /** @type {number} */
    credit;
    /** @type {string} */
    custom_gl;
}
export class FinanceAdjustmentSubmitRequest {
    /** @param {{uuid?:string,reporting_term?:string,rates?:FinanceAdjustmentRateSubmitRequest[],description?:string,authorizing_uuid?:string,is_financial_aid?:boolean,added_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {FinanceAdjustmentRateSubmitRequest[]} */
    rates;
    /** @type {string} */
    description;
    /** @type {string} */
    authorizing_uuid;
    /** @type {boolean} */
    is_financial_aid;
    /** @type {string} */
    added_date;
}

JavaScript FinanceAdjustmentSubmitRequest 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 /Finance/{uuid}/Adjustment/{reporting_term}/Submit HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String","reporting_term":"String","rates":[{"rate_id":0,"description":"String","charge":0,"credit":0,"custom_gl":"String"}],"description":"String","authorizing_uuid":"String","is_financial_aid":false,"added_date":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}