regis

<back to all web services

FinanceAdjustmentRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/Finance/{uuid}/Adjustment/{reporting_term}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class FinanceAdjustmentRequest
{
    var uuid:String? = null
    var reporting_term:String? = null
    var is_financial_aid:Boolean? = null
    var authorizing_uuid:String? = null
}

open class FinanceAdjustmentResponse
{
    var responseStatus:ResponseStatus? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var reporting_term:String? = null
    var openFiscalDate:Date? = null
    var invoiceItemBalances:ArrayList<InvoiceItemBalanceResponse> = ArrayList<InvoiceItemBalanceResponse>()
    var availableInvoiceItems:ArrayList<InvoiceItemAdminResponse> = ArrayList<InvoiceItemAdminResponse>()
}

open class InvoiceItemBalanceResponse
{
    var responseStatus:ResponseStatus? = null
    var rate_id:Int? = null
    var rate_code:String? = null
    var rate_description:String? = null
    var balance_amount:BigDecimal? = null
    var charge_amount:BigDecimal? = null
    var credit_amount:BigDecimal? = null
}

open class InvoiceItemAdminResponse
{
    var responseStatus:ResponseStatus? = null
    var invoiceItemUUID:String? = null
    var rate_id:Int? = null
    var rate_code:String? = null
    var rate_description:String? = null
    var is_required:Boolean? = null
    var is_optional:Boolean? = null
    var charge:BigDecimal? = null
    var credit:BigDecimal? = null
}

Kotlin 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
		}
	]
}