regis

FinancePaymentsRequest

**Requires Authentication**
Required permission:	ReadAccountReport

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

"use strict";
export class FinancePaymentResponse {
    /** @param {{paymentUUID?:string,order_id?:string,external_payment_id?:number,added_date?:string,regent_id?:number,uuid?:string,amount?:number,payment_type?:string,is_pushed_to_gl?:boolean,current_status?:string,current_status_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    paymentUUID;
    /** @type {string} */
    order_id;
    /** @type {number} */
    external_payment_id;
    /** @type {string} */
    added_date;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    uuid;
    /** @type {number} */
    amount;
    /** @type {string} */
    payment_type;
    /** @type {boolean} */
    is_pushed_to_gl;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    current_status_date;
}
export class FinancePaymentsResponse {
    /** @param {{responseStatus?:ResponseStatus,payments?:FinancePaymentResponse[],from_date?:string,to_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {FinancePaymentResponse[]} */
    payments;
    /** @type {string} */
    from_date;
    /** @type {string} */
    to_date;
}
export class FinancePaymentsRequest {
    /** @param {{from_date?:string,to_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    from_date;
    /** @type {?string} */
    to_date;
}

JavaScript FinancePaymentsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","regent_id":0,"uuid":"String","amount":0,"payment_type":"String","is_pushed_to_gl":false,"current_status":"String","current_status_date":"0001-01-01T00:00:00.0000000"}],"from_date":"0001-01-01T00:00:00.0000000","to_date":"0001-01-01T00:00:00.0000000"}