regis

FinanceAdjustmentRequest

**Requires Authentication**
Required role:	REGISUserRole

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


export class InvoiceItemBalanceResponse
{
    public responseStatus: ResponseStatus;
    public rate_id: number;
    public rate_code: string;
    public rate_description: string;
    public balance_amount: number;
    public charge_amount: number;
    public credit_amount: number;

    public constructor(init?: Partial<InvoiceItemBalanceResponse>) { (Object as any).assign(this, init); }
}

export class InvoiceItemAdminResponse
{
    public responseStatus: ResponseStatus;
    public invoiceItemUUID: string;
    public rate_id: number;
    public rate_code: string;
    public rate_description: string;
    public is_required: boolean;
    public is_optional: boolean;
    public charge?: number;
    public credit?: number;

    public constructor(init?: Partial<InvoiceItemAdminResponse>) { (Object as any).assign(this, init); }
}

export class FinanceAdjustmentResponse
{
    public responseStatus: ResponseStatus;
    public regent_id: number;
    public uuid: string;
    public reporting_term: string;
    public openFiscalDate?: string;
    public invoiceItemBalances: InvoiceItemBalanceResponse[];
    public availableInvoiceItems: InvoiceItemAdminResponse[];

    public constructor(init?: Partial<FinanceAdjustmentResponse>) { (Object as any).assign(this, init); }
}

export class FinanceAdjustmentRequest
{
    public uuid: string;
    public reporting_term: string;
    public is_financial_aid: boolean;
    public authorizing_uuid: string;

    public constructor(init?: Partial<FinanceAdjustmentRequest>) { (Object as any).assign(this, init); }
}

TypeScript FinanceAdjustmentRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String,
	reporting_term: String,
	is_financial_aid: False,
	authorizing_uuid: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
	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
		}
	]
}