regis

FinancePaymentsRequest

**Requires Authentication**
Required permission:	ReadAccountReport

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


export class FinancePaymentResponse
{
    public paymentUUID: string;
    public order_id: string;
    public external_payment_id: number;
    public added_date: string;
    public regent_id: number;
    public uuid: string;
    public amount: number;
    public payment_type: string;
    public is_pushed_to_gl: boolean;
    public current_status: string;
    public current_status_date?: string;

    public constructor(init?: Partial<FinancePaymentResponse>) { (Object as any).assign(this, init); }
}

export class FinancePaymentsResponse
{
    public responseStatus: ResponseStatus;
    public payments: FinancePaymentResponse[];
    public from_date: string;
    public to_date: string;

    public constructor(init?: Partial<FinancePaymentsResponse>) { (Object as any).assign(this, init); }
}

export class FinancePaymentsRequest
{
    public from_date?: string;
    public to_date?: string;

    public constructor(init?: Partial<FinancePaymentsRequest>) { (Object as any).assign(this, init); }
}

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