regis

<back to all web services

FinancePaymentsRequest

Requires Authentication
Required permission:ReadAccountReport
The following routes are available for this service:
POST/Finance/Payments
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FinancePaymentResponse() = 
        member val paymentUUID:String = null with get,set
        member val order_id:String = null with get,set
        member val external_payment_id:Int32 = new Int32() with get,set
        member val added_date:DateTime = new DateTime() with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val uuid:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val payment_type:String = null with get,set
        member val is_pushed_to_gl:Boolean = new Boolean() with get,set
        member val current_status:String = null with get,set
        member val current_status_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type FinancePaymentsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val payments:ResizeArray<FinancePaymentResponse> = new ResizeArray<FinancePaymentResponse>() with get,set
        member val from_date:DateTime = new DateTime() with get,set
        member val to_date:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type FinancePaymentsRequest() = 
        member val from_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val to_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# 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
}