regis

FinancePaymentsRequest

**Requires Authentication**
Required permission:	ReadAccountReport

The following routes are available for this service:
POST	/Finance/Payments

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports regis.ClassLibrary.Requests
Imports regis.ClassLibrary.Responses

Namespace Global

    Namespace regis.ClassLibrary.Requests

        Public Partial Class FinancePaymentsRequest
            Public Overridable Property from_date As Nullable(Of Date)
            Public Overridable Property to_date As Nullable(Of Date)
        End Class
    End Namespace

    Namespace regis.ClassLibrary.Responses

        Public Partial Class FinancePaymentResponse
            Public Overridable Property paymentUUID As String
            Public Overridable Property order_id As String
            Public Overridable Property external_payment_id As Integer
            Public Overridable Property added_date As Date
            Public Overridable Property regent_id As Integer
            Public Overridable Property uuid As String
            Public Overridable Property amount As Decimal
            Public Overridable Property payment_type As String
            Public Overridable Property is_pushed_to_gl As Boolean
            Public Overridable Property current_status As String
            Public Overridable Property current_status_date As Nullable(Of Date)
        End Class

        Public Partial Class FinancePaymentsResponse
            Public Sub New()
                payments = New List(Of FinancePaymentResponse)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property payments As List(Of FinancePaymentResponse)
            Public Overridable Property from_date As Date
            Public Overridable Property to_date As Date
        End Class
    End Namespace
End Namespace

VB.NET 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
}