regis

<back to all web services

FinancePaymentsRequest

Requires Authentication
Required permission:ReadAccountReport
The following routes are available for this service:
POST/Finance/Payments
import Foundation
import ServiceStack

public class FinancePaymentsRequest : Codable
{
    public var from_date:Date?
    public var to_date:Date?

    required public init(){}
}

public class FinancePaymentsResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var payments:[FinancePaymentResponse] = []
    public var from_date:Date
    public var to_date:Date

    required public init(){}
}

public class FinancePaymentResponse : Codable
{
    public var paymentUUID:String
    public var order_id:String
    public var external_payment_id:Int
    public var added_date:Date
    public var regent_id:Int
    public var uuid:String
    public var amount:Double
    public var payment_type:String
    public var is_pushed_to_gl:Bool
    public var current_status:String
    public var current_status_date:Date?

    required public init(){}
}


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