regis

<back to all web services

FinancePaymentLogRequest

Requires Authentication
Required permission:CreatePayments
The following routes are available for this service:
POST/Finance/Payment/Log
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class FinancePaymentResponse implements IConvertible
{
    String? paymentUUID;
    String? order_id;
    int? external_payment_id;
    DateTime? added_date;
    int? regent_id;
    String? uuid;
    double? amount;
    String? payment_type;
    bool? is_pushed_to_gl;
    String? current_status;
    DateTime? current_status_date;

    FinancePaymentResponse({this.paymentUUID,this.order_id,this.external_payment_id,this.added_date,this.regent_id,this.uuid,this.amount,this.payment_type,this.is_pushed_to_gl,this.current_status,this.current_status_date});
    FinancePaymentResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        paymentUUID = json['paymentUUID'];
        order_id = json['order_id'];
        external_payment_id = json['external_payment_id'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        regent_id = json['regent_id'];
        uuid = json['uuid'];
        amount = JsonConverters.toDouble(json['amount']);
        payment_type = json['payment_type'];
        is_pushed_to_gl = json['is_pushed_to_gl'];
        current_status = json['current_status'];
        current_status_date = JsonConverters.fromJson(json['current_status_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'paymentUUID': paymentUUID,
        'order_id': order_id,
        'external_payment_id': external_payment_id,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'regent_id': regent_id,
        'uuid': uuid,
        'amount': amount,
        'payment_type': payment_type,
        'is_pushed_to_gl': is_pushed_to_gl,
        'current_status': current_status,
        'current_status_date': JsonConverters.toJson(current_status_date,'DateTime',context!)
    };

    getTypeName() => "FinancePaymentResponse";
    TypeContext? context = _ctx;
}

class FinancePaymentLogRequest implements IConvertible
{
    String? process;
    String? action;
    String? note;
    String? message;
    String? order_id;
    int? external_payment_id;
    int? regent_id;
    double? amount;
    String? 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;
    DateTime? current_status_date;
    bool? pushed_to_gl;
    DateTime? pushed_to_gl_date;

    FinancePaymentLogRequest({this.process,this.action,this.note,this.message,this.order_id,this.external_payment_id,this.regent_id,this.amount,this.payment_type,this.customer_ip,this.name,this.email,this.phone,this.addr1,this.addr2,this.city,this.state,this.country,this.code,this.current_status,this.current_status_date,this.pushed_to_gl,this.pushed_to_gl_date});
    FinancePaymentLogRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        process = json['process'];
        action = json['action'];
        note = json['note'];
        message = json['message'];
        order_id = json['order_id'];
        external_payment_id = json['external_payment_id'];
        regent_id = json['regent_id'];
        amount = JsonConverters.toDouble(json['amount']);
        payment_type = json['payment_type'];
        customer_ip = json['customer_ip'];
        name = json['name'];
        email = json['email'];
        phone = json['phone'];
        addr1 = json['addr1'];
        addr2 = json['addr2'];
        city = json['city'];
        state = json['state'];
        country = json['country'];
        code = json['code'];
        current_status = json['current_status'];
        current_status_date = JsonConverters.fromJson(json['current_status_date'],'DateTime',context!);
        pushed_to_gl = json['pushed_to_gl'];
        pushed_to_gl_date = JsonConverters.fromJson(json['pushed_to_gl_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'process': process,
        'action': action,
        'note': note,
        'message': message,
        'order_id': order_id,
        'external_payment_id': external_payment_id,
        'regent_id': regent_id,
        'amount': amount,
        'payment_type': payment_type,
        'customer_ip': customer_ip,
        'name': name,
        'email': email,
        'phone': phone,
        'addr1': addr1,
        'addr2': addr2,
        'city': city,
        'state': state,
        'country': country,
        'code': code,
        'current_status': current_status,
        'current_status_date': JsonConverters.toJson(current_status_date,'DateTime',context!),
        'pushed_to_gl': pushed_to_gl,
        'pushed_to_gl_date': JsonConverters.toJson(pushed_to_gl_date,'DateTime',context!)
    };

    getTypeName() => "FinancePaymentLogRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'FinancePaymentResponse': TypeInfo(TypeOf.Class, create:() => FinancePaymentResponse()),
    'FinancePaymentLogRequest': TypeInfo(TypeOf.Class, create:() => FinancePaymentLogRequest()),
});

Dart FinancePaymentLogRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FinancePaymentLogRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <action>String</action>
  <addr1>String</addr1>
  <addr2>String</addr2>
  <amount>0</amount>
  <city>String</city>
  <code>String</code>
  <country>String</country>
  <current_status>String</current_status>
  <current_status_date>0001-01-01T00:00:00</current_status_date>
  <customer_ip>String</customer_ip>
  <email>String</email>
  <external_payment_id>0</external_payment_id>
  <message>String</message>
  <name>String</name>
  <note>String</note>
  <order_id>String</order_id>
  <payment_type>String</payment_type>
  <phone>String</phone>
  <process>String</process>
  <pushed_to_gl>false</pushed_to_gl>
  <pushed_to_gl_date>0001-01-01T00:00:00</pushed_to_gl_date>
  <regent_id>0</regent_id>
  <state>String</state>
</FinancePaymentLogRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancePaymentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <added_date>0001-01-01T00:00:00</added_date>
  <amount>0</amount>
  <current_status>String</current_status>
  <current_status_date>0001-01-01T00:00:00</current_status_date>
  <external_payment_id>0</external_payment_id>
  <is_pushed_to_gl>false</is_pushed_to_gl>
  <order_id>String</order_id>
  <paymentUUID>String</paymentUUID>
  <payment_type>String</payment_type>
  <regent_id>0</regent_id>
  <uuid>String</uuid>
</FinancePaymentResponse>