regis

<back to all web services

FinancePaymentLogRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/Payment/Log
"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 FinancePaymentLogRequest {
    /** @param {{process?:string,action?:string,note?:string,message?:string,order_id?:string,external_payment_id?:number,regent_id?:number,amount?:number,payment_type?:string,customer_ip?:string,name?:string,email?:string,phone?:string,addr1?:string,addr2?:string,city?:string,state?:string,country?:string,code?:string,current_status?:string,current_status_date?:string,pushed_to_gl?:boolean,pushed_to_gl_date?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    process;
    /** @type {string} */
    action;
    /** @type {string} */
    note;
    /** @type {string} */
    message;
    /** @type {string} */
    order_id;
    /** @type {number} */
    external_payment_id;
    /** @type {number} */
    regent_id;
    /** @type {number} */
    amount;
    /** @type {string} */
    payment_type;
    /** @type {string} */
    customer_ip;
    /** @type {string} */
    name;
    /** @type {string} */
    email;
    /** @type {string} */
    phone;
    /** @type {string} */
    addr1;
    /** @type {string} */
    addr2;
    /** @type {string} */
    city;
    /** @type {string} */
    state;
    /** @type {string} */
    country;
    /** @type {string} */
    code;
    /** @type {string} */
    current_status;
    /** @type {?string} */
    current_status_date;
    /** @type {boolean} */
    pushed_to_gl;
    /** @type {?string} */
    pushed_to_gl_date;
}

JavaScript FinancePaymentLogRequest 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/Payment/Log HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"process":"String","action":"String","note":"String","message":"String","order_id":"String","external_payment_id":0,"regent_id":0,"amount":0,"payment_type":"String","customer_ip":"String","name":"String","email":"String","phone":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","current_status":"String","current_status_date":"0001-01-01T00:00:00.0000000","pushed_to_gl":false,"pushed_to_gl_date":"0001-01-01T00:00:00.0000000"}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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"}