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


open class FinancePaymentsRequest
{
    var from_date:Date? = null
    var to_date:Date? = null
}

open class FinancePaymentsResponse
{
    var responseStatus:ResponseStatus? = null
    var payments:ArrayList<FinancePaymentResponse> = ArrayList<FinancePaymentResponse>()
    var from_date:Date? = null
    var to_date:Date? = null
}

open class FinancePaymentResponse
{
    var paymentUUID:String? = null
    var order_id:String? = null
    var external_payment_id:Int? = null
    var added_date:Date? = null
    var regent_id:Int? = null
    var uuid:String? = null
    var amount:BigDecimal? = null
    var payment_type:String? = null
    var is_pushed_to_gl:Boolean? = null
    var current_status:String? = null
    var current_status_date:Date? = null
}

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