| Required permission: | CreatePayments |
| POST | /Finance/Payment/Log |
|---|
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 FinancePaymentLogRequest
{
public process: string;
public action: string;
public note: string;
public message: string;
public order_id: string;
public external_payment_id: number;
public regent_id: number;
public amount: number;
public payment_type: string;
public customer_ip: string;
public name: string;
public email: string;
public phone: string;
public addr1: string;
public addr2: string;
public city: string;
public state: string;
public country: string;
public code: string;
public current_status: string;
public current_status_date?: string;
public pushed_to_gl: boolean;
public pushed_to_gl_date?: string;
public constructor(init?: Partial<FinancePaymentLogRequest>) { (Object as any).assign(this, init); }
}
TypeScript FinancePaymentLogRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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-01,
pushed_to_gl: False,
pushed_to_gl_date: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}