regis

<back to all web services

FinanceAccountLateChargeJobStartRequest

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

public class dtos
{

    public static class FinanceAccountLateChargeJobStartRequest
    {
        public String authorizing_uuid = null;
        public String reporting_term = null;
        public UUID operation_id = null;
        public Date calculation_date = null;
        public Boolean preview_only = null;
        public BigDecimal skip_exact_balance = null;
        public Boolean send_emails = null;
        
        public String getAuthorizingUuid() { return authorizing_uuid; }
        public FinanceAccountLateChargeJobStartRequest setAuthorizingUuid(String value) { this.authorizing_uuid = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinanceAccountLateChargeJobStartRequest setReportingTerm(String value) { this.reporting_term = value; return this; }
        public UUID getOperationId() { return operation_id; }
        public FinanceAccountLateChargeJobStartRequest setOperationId(UUID value) { this.operation_id = value; return this; }
        public Date getCalculationDate() { return calculation_date; }
        public FinanceAccountLateChargeJobStartRequest setCalculationDate(Date value) { this.calculation_date = value; return this; }
        public Boolean isPreviewOnly() { return preview_only; }
        public FinanceAccountLateChargeJobStartRequest setPreviewOnly(Boolean value) { this.preview_only = value; return this; }
        public BigDecimal getSkipExactBalance() { return skip_exact_balance; }
        public FinanceAccountLateChargeJobStartRequest setSkipExactBalance(BigDecimal value) { this.skip_exact_balance = value; return this; }
        public Boolean isSendEmails() { return send_emails; }
        public FinanceAccountLateChargeJobStartRequest setSendEmails(Boolean value) { this.send_emails = value; return this; }
    }

    public static class FinanceAccountLateChargeJobResponse
    {
        public ResponseStatus responseStatus = null;
        public UUID operation_id = null;
        public String reporting_term = null;
        public Date calculation_date = null;
        public Boolean preview_only = null;
        public BigDecimal skip_exact_balance = null;
        public String state = null;
        public Integer total = null;
        public Integer current_regent_id = null;
        public Integer processed = null;
        public Integer succeeded = null;
        public Integer skipped = null;
        public Integer failed = null;
        public Date created_utc = null;
        public Date updated_utc = null;
        public String message = null;
        public Boolean report_available = null;
        public ArrayList<FinanceAccountLateChargeOutcome> outcomes = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinanceAccountLateChargeJobResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public UUID getOperationId() { return operation_id; }
        public FinanceAccountLateChargeJobResponse setOperationId(UUID value) { this.operation_id = value; return this; }
        public String getReportingTerm() { return reporting_term; }
        public FinanceAccountLateChargeJobResponse setReportingTerm(String value) { this.reporting_term = value; return this; }
        public Date getCalculationDate() { return calculation_date; }
        public FinanceAccountLateChargeJobResponse setCalculationDate(Date value) { this.calculation_date = value; return this; }
        public Boolean isPreviewOnly() { return preview_only; }
        public FinanceAccountLateChargeJobResponse setPreviewOnly(Boolean value) { this.preview_only = value; return this; }
        public BigDecimal getSkipExactBalance() { return skip_exact_balance; }
        public FinanceAccountLateChargeJobResponse setSkipExactBalance(BigDecimal value) { this.skip_exact_balance = value; return this; }
        public String getState() { return state; }
        public FinanceAccountLateChargeJobResponse setState(String value) { this.state = value; return this; }
        public Integer getTotal() { return total; }
        public FinanceAccountLateChargeJobResponse setTotal(Integer value) { this.total = value; return this; }
        public Integer getCurrentRegentId() { return current_regent_id; }
        public FinanceAccountLateChargeJobResponse setCurrentRegentId(Integer value) { this.current_regent_id = value; return this; }
        public Integer getProcessed() { return processed; }
        public FinanceAccountLateChargeJobResponse setProcessed(Integer value) { this.processed = value; return this; }
        public Integer getSucceeded() { return succeeded; }
        public FinanceAccountLateChargeJobResponse setSucceeded(Integer value) { this.succeeded = value; return this; }
        public Integer getSkipped() { return skipped; }
        public FinanceAccountLateChargeJobResponse setSkipped(Integer value) { this.skipped = value; return this; }
        public Integer getFailed() { return failed; }
        public FinanceAccountLateChargeJobResponse setFailed(Integer value) { this.failed = value; return this; }
        public Date getCreatedUtc() { return created_utc; }
        public FinanceAccountLateChargeJobResponse setCreatedUtc(Date value) { this.created_utc = value; return this; }
        public Date getUpdatedUtc() { return updated_utc; }
        public FinanceAccountLateChargeJobResponse setUpdatedUtc(Date value) { this.updated_utc = value; return this; }
        public String getMessage() { return message; }
        public FinanceAccountLateChargeJobResponse setMessage(String value) { this.message = value; return this; }
        public Boolean isReportAvailable() { return report_available; }
        public FinanceAccountLateChargeJobResponse setReportAvailable(Boolean value) { this.report_available = value; return this; }
        public ArrayList<FinanceAccountLateChargeOutcome> getOutcomes() { return outcomes; }
        public FinanceAccountLateChargeJobResponse setOutcomes(ArrayList<FinanceAccountLateChargeOutcome> value) { this.outcomes = value; return this; }
    }

    public static class FinanceAccountLateChargeOutcome
    {
        public Integer regent_id = null;
        public String status = null;
        public BigDecimal charge_amount = null;
        public String charge_status = null;
        public String email_status = null;
        public String message = null;
        
        public Integer getRegentId() { return regent_id; }
        public FinanceAccountLateChargeOutcome setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getStatus() { return status; }
        public FinanceAccountLateChargeOutcome setStatus(String value) { this.status = value; return this; }
        public BigDecimal getChargeAmount() { return charge_amount; }
        public FinanceAccountLateChargeOutcome setChargeAmount(BigDecimal value) { this.charge_amount = value; return this; }
        public String getChargeStatus() { return charge_status; }
        public FinanceAccountLateChargeOutcome setChargeStatus(String value) { this.charge_status = value; return this; }
        public String getEmailStatus() { return email_status; }
        public FinanceAccountLateChargeOutcome setEmailStatus(String value) { this.email_status = value; return this; }
        public String getMessage() { return message; }
        public FinanceAccountLateChargeOutcome setMessage(String value) { this.message = value; return this; }
    }

}

Java FinanceAccountLateChargeJobStartRequest 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/AccountLate/{reporting_term}/Jobs HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	authorizing_uuid: String,
	reporting_term: String,
	operation_id: 00000000000000000000000000000000,
	calculation_date: 0001-01-01,
	preview_only: False,
	skip_exact_balance: 0,
	send_emails: False
}
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
		}
	},
	operation_id: 00000000000000000000000000000000,
	reporting_term: String,
	calculation_date: 0001-01-01,
	preview_only: False,
	skip_exact_balance: 0,
	state: String,
	total: 0,
	current_regent_id: 0,
	processed: 0,
	succeeded: 0,
	skipped: 0,
	failed: 0,
	created_utc: 0001-01-01,
	updated_utc: 0001-01-01,
	message: String,
	report_available: False,
	outcomes: 
	[
		{
			regent_id: 0,
			status: String,
			charge_amount: 0,
			charge_status: String,
			email_status: String,
			message: String
		}
	]
}