regis

FinanceAdjustmentRequest

**Requires Authentication**
Required role:	REGISUserRole

The following routes are available for this service:
POST	/Finance/{uuid}/Adjustment/{reporting_term}

"use strict";
export class InvoiceItemBalanceResponse {
    /** @param {{responseStatus?:ResponseStatus,rate_id?:number,rate_code?:string,rate_description?:string,balance_amount?:number,charge_amount?:number,credit_amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    rate_id;
    /** @type {string} */
    rate_code;
    /** @type {string} */
    rate_description;
    /** @type {number} */
    balance_amount;
    /** @type {number} */
    charge_amount;
    /** @type {number} */
    credit_amount;
}
export class InvoiceItemAdminResponse {
    /** @param {{responseStatus?:ResponseStatus,invoiceItemUUID?:string,rate_id?:number,rate_code?:string,rate_description?:string,is_required?:boolean,is_optional?:boolean,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 {boolean} */
    is_required;
    /** @type {boolean} */
    is_optional;
    /** @type {?number} */
    charge;
    /** @type {?number} */
    credit;
}
export class FinanceAdjustmentResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,uuid?:string,reporting_term?:string,openFiscalDate?:string,invoiceItemBalances?:InvoiceItemBalanceResponse[],availableInvoiceItems?:InvoiceItemAdminResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {?string} */
    openFiscalDate;
    /** @type {InvoiceItemBalanceResponse[]} */
    invoiceItemBalances;
    /** @type {InvoiceItemAdminResponse[]} */
    availableInvoiceItems;
}
export class FinanceAdjustmentRequest {
    /** @param {{uuid?:string,reporting_term?:string,is_financial_aid?:boolean,authorizing_uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
    /** @type {string} */
    reporting_term;
    /** @type {boolean} */
    is_financial_aid;
    /** @type {string} */
    authorizing_uuid;
}

JavaScript FinanceAdjustmentRequest 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/{uuid}/Adjustment/{reporting_term} HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"uuid":"String","reporting_term":"String","is_financial_aid":false,"authorizing_uuid":"String"}

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"}},"regent_id":0,"uuid":"String","reporting_term":"String","openFiscalDate":"0001-01-01T00:00:00.0000000","invoiceItemBalances":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"rate_id":0,"rate_code":"String","rate_description":"String","balance_amount":0,"charge_amount":0,"credit_amount":0}],"availableInvoiceItems":[{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"invoiceItemUUID":"String","rate_id":0,"rate_code":"String","rate_description":"String","is_required":false,"is_optional":false,"charge":0,"credit":0}]}