regis

<back to all web services

FinancePaymentsRequest

Requires Authentication
Required permission:ReadAccountReport
The following routes are available for this service:
POST/Finance/Payments
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinancePaymentsRequest
    {
        public Date from_date = null;
        public Date to_date = null;
        
        public Date getFromDate() { return from_date; }
        public FinancePaymentsRequest setFromDate(Date value) { this.from_date = value; return this; }
        public Date getToDate() { return to_date; }
        public FinancePaymentsRequest setToDate(Date value) { this.to_date = value; return this; }
    }

    public static class FinancePaymentsResponse
    {
        public ResponseStatus responseStatus = null;
        public ArrayList<FinancePaymentResponse> payments = null;
        public Date from_date = null;
        public Date to_date = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinancePaymentsResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public ArrayList<FinancePaymentResponse> getPayments() { return payments; }
        public FinancePaymentsResponse setPayments(ArrayList<FinancePaymentResponse> value) { this.payments = value; return this; }
        public Date getFromDate() { return from_date; }
        public FinancePaymentsResponse setFromDate(Date value) { this.from_date = value; return this; }
        public Date getToDate() { return to_date; }
        public FinancePaymentsResponse setToDate(Date value) { this.to_date = value; return this; }
    }

    public static class FinancePaymentResponse
    {
        public String paymentUUID = null;
        public String order_id = null;
        public Integer external_payment_id = null;
        public Date added_date = null;
        public Integer regent_id = null;
        public String uuid = null;
        public BigDecimal amount = null;
        public String payment_type = null;
        public Boolean is_pushed_to_gl = null;
        public String current_status = null;
        public Date current_status_date = null;
        
        public String getPaymentUUID() { return paymentUUID; }
        public FinancePaymentResponse setPaymentUUID(String value) { this.paymentUUID = value; return this; }
        public String getOrderId() { return order_id; }
        public FinancePaymentResponse setOrderId(String value) { this.order_id = value; return this; }
        public Integer getExternalPaymentId() { return external_payment_id; }
        public FinancePaymentResponse setExternalPaymentId(Integer value) { this.external_payment_id = value; return this; }
        public Date getAddedDate() { return added_date; }
        public FinancePaymentResponse setAddedDate(Date value) { this.added_date = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinancePaymentResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getUuid() { return uuid; }
        public FinancePaymentResponse setUuid(String value) { this.uuid = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public FinancePaymentResponse setAmount(BigDecimal value) { this.amount = value; return this; }
        public String getPaymentType() { return payment_type; }
        public FinancePaymentResponse setPaymentType(String value) { this.payment_type = value; return this; }
        public Boolean getIsPushedToGl() { return is_pushed_to_gl; }
        public FinancePaymentResponse setIsPushedToGl(Boolean value) { this.is_pushed_to_gl = value; return this; }
        public String getCurrentStatus() { return current_status; }
        public FinancePaymentResponse setCurrentStatus(String value) { this.current_status = value; return this; }
        public Date getCurrentStatusDate() { return current_status_date; }
        public FinancePaymentResponse setCurrentStatusDate(Date value) { this.current_status_date = value; return this; }
    }

}

Java FinancePaymentsRequest 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/Payments HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	from_date: 0001-01-01,
	to_date: 0001-01-01
}
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
		}
	},
	payments: 
	[
		{
			paymentUUID: String,
			order_id: String,
			external_payment_id: 0,
			added_date: 0001-01-01,
			regent_id: 0,
			uuid: String,
			amount: 0,
			payment_type: String,
			is_pushed_to_gl: False,
			current_status: String,
			current_status_date: 0001-01-01
		}
	],
	from_date: 0001-01-01,
	to_date: 0001-01-01
}