regis

<back to all web services

FinancePaymentsRequest

Requires Authentication
Required permission:ReadAccountReport
The following routes are available for this service:
POST/Finance/Payments
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 FinancePaymentsResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    List<FinancePaymentResponse>? payments;
    DateTime? from_date;
    DateTime? to_date;

    FinancePaymentsResponse({this.responseStatus,this.payments,this.from_date,this.to_date});
    FinancePaymentsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        payments = JsonConverters.fromJson(json['payments'],'List<FinancePaymentResponse>',context!);
        from_date = JsonConverters.fromJson(json['from_date'],'DateTime',context!);
        to_date = JsonConverters.fromJson(json['to_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'payments': JsonConverters.toJson(payments,'List<FinancePaymentResponse>',context!),
        'from_date': JsonConverters.toJson(from_date,'DateTime',context!),
        'to_date': JsonConverters.toJson(to_date,'DateTime',context!)
    };

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

class FinancePaymentsRequest implements IConvertible
{
    DateTime? from_date;
    DateTime? to_date;

    FinancePaymentsRequest({this.from_date,this.to_date});
    FinancePaymentsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        from_date = JsonConverters.fromJson(json['from_date'],'DateTime',context!);
        to_date = JsonConverters.fromJson(json['to_date'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'from_date': JsonConverters.toJson(from_date,'DateTime',context!),
        'to_date': JsonConverters.toJson(to_date,'DateTime',context!)
    };

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

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

Dart FinancePaymentsRequest 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/Payments HTTP/1.1 
Host: data.regent-college.edu 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FinancePaymentsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <from_date>0001-01-01T00:00:00</from_date>
  <to_date>0001-01-01T00:00:00</to_date>
</FinancePaymentsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinancePaymentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <from_date>0001-01-01T00:00:00</from_date>
  <payments>
    <FinancePaymentResponse>
      <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>
  </payments>
  <to_date>0001-01-01T00:00:00</to_date>
</FinancePaymentsResponse>