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.*;

public class dtos
{

    public static class FinanceAdjustmentRequest
    {
        public String uuid = null;
        public String reporting_term = null;
        public Boolean is_financial_aid = null;
        public String authorizing_uuid = null;
        
        public String getUuid() { return uuid; }
        public FinanceAdjustmentRequest setUuid(String value) { this.uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinanceAdjustmentRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Boolean getIsFinancialAid() { return is_financial_aid; }
        public FinanceAdjustmentRequest setIsFinancialAid(Boolean value) { this.is_financial_aid = value; return this; }
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public FinanceAdjustmentRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
    }

    public static class FinanceAdjustmentResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String uuid = null;
        public String reporting_term = null;
        public Date openFiscalDate = null;
        public ArrayList<InvoiceItemBalanceResponse> invoiceItemBalances = null;
        public ArrayList<InvoiceItemAdminResponse> availableInvoiceItems = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinanceAdjustmentResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinanceAdjustmentResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public FinanceAdjustmentResponse setUuid(String value) { this.uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinanceAdjustmentResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Date getOpenFiscalDate() { return openFiscalDate; }
        public FinanceAdjustmentResponse setOpenFiscalDate(Date value) { this.openFiscalDate = value; return this; }
        public ArrayList<InvoiceItemBalanceResponse> getInvoiceItemBalances() { return invoiceItemBalances; }
        public FinanceAdjustmentResponse setInvoiceItemBalances(ArrayList<InvoiceItemBalanceResponse> value) { this.invoiceItemBalances = value; return this; }
        public ArrayList<InvoiceItemAdminResponse> getAvailableInvoiceItems() { return availableInvoiceItems; }
        public FinanceAdjustmentResponse setAvailableInvoiceItems(ArrayList<InvoiceItemAdminResponse> value) { this.availableInvoiceItems = value; return this; }
    }

    public static class InvoiceItemBalanceResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer rate_id = null;
        public String rate_code = null;
        public String rate_description = null;
        public BigDecimal balance_amount = null;
        public BigDecimal charge_amount = null;
        public BigDecimal credit_amount = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public InvoiceItemBalanceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRateId() { return rate_id; }
        public InvoiceItemBalanceResponse setRateId(Integer value) { this.rate_id = value; return this; }
        public String getRateCode() { return rate_code; }
        public InvoiceItemBalanceResponse setRateCode(String value) { this.rate_code = value; return this; }
        public String getRateDescription() { return rate_description; }
        public InvoiceItemBalanceResponse setRateDescription(String value) { this.rate_description = value; return this; }
        public BigDecimal getBalanceAmount() { return balance_amount; }
        public InvoiceItemBalanceResponse setBalanceAmount(BigDecimal value) { this.balance_amount = value; return this; }
        public BigDecimal getChargeAmount() { return charge_amount; }
        public InvoiceItemBalanceResponse setChargeAmount(BigDecimal value) { this.charge_amount = value; return this; }
        public BigDecimal getCreditAmount() { return credit_amount; }
        public InvoiceItemBalanceResponse setCreditAmount(BigDecimal value) { this.credit_amount = value; return this; }
    }

    public static class InvoiceItemAdminResponse
    {
        public ResponseStatus responseStatus = null;
        public String invoiceItemUUID = null;
        public Integer rate_id = null;
        public String rate_code = null;
        public String rate_description = null;
        public Boolean is_required = null;
        public Boolean is_optional = null;
        public BigDecimal charge = null;
        public BigDecimal credit = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public InvoiceItemAdminResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public String getInvoiceItemUUID() { return invoiceItemUUID; }
        public InvoiceItemAdminResponse setInvoiceItemUUID(String value) { this.invoiceItemUUID = value; return this; }
        public Integer getRateId() { return rate_id; }
        public InvoiceItemAdminResponse setRateId(Integer value) { this.rate_id = value; return this; }
        public String getRateCode() { return rate_code; }
        public InvoiceItemAdminResponse setRateCode(String value) { this.rate_code = value; return this; }
        public String getRateDescription() { return rate_description; }
        public InvoiceItemAdminResponse setRateDescription(String value) { this.rate_description = value; return this; }
        public Boolean getIsRequired() { return is_required; }
        public InvoiceItemAdminResponse setIsRequired(Boolean value) { this.is_required = value; return this; }
        public Boolean getIsOptional() { return is_optional; }
        public InvoiceItemAdminResponse setIsOptional(Boolean value) { this.is_optional = value; return this; }
        public BigDecimal getCharge() { return charge; }
        public InvoiceItemAdminResponse setCharge(BigDecimal value) { this.charge = value; return this; }
        public BigDecimal getCredit() { return credit; }
        public InvoiceItemAdminResponse setCredit(BigDecimal value) { this.credit = value; return this; }
    }

}

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