Billhighway Cloud API

<back to all web services

PaymentApplicationRequest

The following routes are available for this service:
GET/payments/paymentApplication
import 'package:servicestack/servicestack.dart';

class LineItem implements IConvertible
{
    String? chartOfAccountRefID;
    String? chartOfAccountDescription;
    String? cashAccount;
    double? amount;
    double? fee;

    LineItem({this.chartOfAccountRefID,this.chartOfAccountDescription,this.cashAccount,this.amount,this.fee});
    LineItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        chartOfAccountRefID = json['chartOfAccountRefID'];
        chartOfAccountDescription = json['chartOfAccountDescription'];
        cashAccount = json['cashAccount'];
        amount = JsonConverters.toDouble(json['amount']);
        fee = JsonConverters.toDouble(json['fee']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'chartOfAccountRefID': chartOfAccountRefID,
        'chartOfAccountDescription': chartOfAccountDescription,
        'cashAccount': cashAccount,
        'amount': amount,
        'fee': fee
    };

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

class TransactionHistory implements IConvertible
{
    String? type;
    String? date;
    List<LineItem>? lineItems;

    TransactionHistory({this.type,this.date,this.lineItems});
    TransactionHistory.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        type = json['type'];
        date = json['date'];
        lineItems = JsonConverters.fromJson(json['lineItems'],'List<LineItem>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'type': type,
        'date': date,
        'lineItems': JsonConverters.toJson(lineItems,'List<LineItem>',context!)
    };

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

class UserTransaction implements IConvertible
{
    int? transactionID;
    String? date;
    String? type;
    String? accountLast4;
    double? amount;
    double? unapplied;
    double? unappliedFee;
    String? returnReason;
    String? returnDate;
    double? refundAmount;
    List<LineItem>? lineItems;
    List<TransactionHistory>? transactionHistory;

    UserTransaction({this.transactionID,this.date,this.type,this.accountLast4,this.amount,this.unapplied,this.unappliedFee,this.returnReason,this.returnDate,this.refundAmount,this.lineItems,this.transactionHistory});
    UserTransaction.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        transactionID = json['transactionID'];
        date = json['date'];
        type = json['type'];
        accountLast4 = json['accountLast4'];
        amount = JsonConverters.toDouble(json['amount']);
        unapplied = JsonConverters.toDouble(json['unapplied']);
        unappliedFee = JsonConverters.toDouble(json['unappliedFee']);
        returnReason = json['returnReason'];
        returnDate = json['returnDate'];
        refundAmount = JsonConverters.toDouble(json['refundAmount']);
        lineItems = JsonConverters.fromJson(json['lineItems'],'List<LineItem>',context!);
        transactionHistory = JsonConverters.fromJson(json['transactionHistory'],'List<TransactionHistory>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'transactionID': transactionID,
        'date': date,
        'type': type,
        'accountLast4': accountLast4,
        'amount': amount,
        'unapplied': unapplied,
        'unappliedFee': unappliedFee,
        'returnReason': returnReason,
        'returnDate': returnDate,
        'refundAmount': refundAmount,
        'lineItems': JsonConverters.toJson(lineItems,'List<LineItem>',context!),
        'transactionHistory': JsonConverters.toJson(transactionHistory,'List<TransactionHistory>',context!)
    };

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

class PaymentApplicationUser implements IConvertible
{
    String? groupID;
    int? fiscalYear;
    String? userID;
    int? bhUserID;
    String? autoPayStatus;
    List<UserTransaction>? userTransactions;

    PaymentApplicationUser({this.groupID,this.fiscalYear,this.userID,this.bhUserID,this.autoPayStatus,this.userTransactions});
    PaymentApplicationUser.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        groupID = json['groupID'];
        fiscalYear = json['fiscalYear'];
        userID = json['userID'];
        bhUserID = json['bhUserID'];
        autoPayStatus = json['autoPayStatus'];
        userTransactions = JsonConverters.fromJson(json['userTransactions'],'List<UserTransaction>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'groupID': groupID,
        'fiscalYear': fiscalYear,
        'userID': userID,
        'bhUserID': bhUserID,
        'autoPayStatus': autoPayStatus,
        'userTransactions': JsonConverters.toJson(userTransactions,'List<UserTransaction>',context!)
    };

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

class Paging implements IConvertible
{
    int? page;
    int? totalPages;
    String? next;

    Paging({this.page,this.totalPages,this.next});
    Paging.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        page = json['page'];
        totalPages = json['totalPages'];
        next = json['next'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'page': page,
        'totalPages': totalPages,
        'next': next
    };

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

class PaymentApplicationResponse implements IConvertible
{
    bool? IsError;
    List<PaymentApplicationUser>? users;
    String? ErrorMessage;
    Paging? paging;

    PaymentApplicationResponse({this.IsError,this.users,this.ErrorMessage,this.paging});
    PaymentApplicationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        IsError = json['IsError'];
        users = JsonConverters.fromJson(json['users'],'List<PaymentApplicationUser>',context!);
        ErrorMessage = json['ErrorMessage'];
        paging = JsonConverters.fromJson(json['paging'],'Paging',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'IsError': IsError,
        'users': JsonConverters.toJson(users,'List<PaymentApplicationUser>',context!),
        'ErrorMessage': ErrorMessage,
        'paging': JsonConverters.toJson(paging,'Paging',context!)
    };

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

class PaymentApplicationRequest implements IConvertible
{
    int? transactionID;
    String? groupID;
    String? userID;
    int? bhUserID;
    DateTime? transactionBeginDate;
    DateTime? transactionEndDate;
    int? fiscalYear;
    int? page;

    PaymentApplicationRequest({this.transactionID,this.groupID,this.userID,this.bhUserID,this.transactionBeginDate,this.transactionEndDate,this.fiscalYear,this.page});
    PaymentApplicationRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        transactionID = json['transactionID'];
        groupID = json['groupID'];
        userID = json['userID'];
        bhUserID = json['bhUserID'];
        transactionBeginDate = JsonConverters.fromJson(json['transactionBeginDate'],'DateTime',context!);
        transactionEndDate = JsonConverters.fromJson(json['transactionEndDate'],'DateTime',context!);
        fiscalYear = json['fiscalYear'];
        page = json['page'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'transactionID': transactionID,
        'groupID': groupID,
        'userID': userID,
        'bhUserID': bhUserID,
        'transactionBeginDate': JsonConverters.toJson(transactionBeginDate,'DateTime',context!),
        'transactionEndDate': JsonConverters.toJson(transactionEndDate,'DateTime',context!),
        'fiscalYear': fiscalYear,
        'page': page
    };

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

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'LineItem': TypeInfo(TypeOf.Class, create:() => LineItem()),
    'TransactionHistory': TypeInfo(TypeOf.Class, create:() => TransactionHistory()),
    'List<LineItem>': TypeInfo(TypeOf.Class, create:() => <LineItem>[]),
    'UserTransaction': TypeInfo(TypeOf.Class, create:() => UserTransaction()),
    'List<TransactionHistory>': TypeInfo(TypeOf.Class, create:() => <TransactionHistory>[]),
    'PaymentApplicationUser': TypeInfo(TypeOf.Class, create:() => PaymentApplicationUser()),
    'List<UserTransaction>': TypeInfo(TypeOf.Class, create:() => <UserTransaction>[]),
    'Paging': TypeInfo(TypeOf.Class, create:() => Paging()),
    'PaymentApplicationResponse': TypeInfo(TypeOf.Class, create:() => PaymentApplicationResponse()),
    'List<PaymentApplicationUser>': TypeInfo(TypeOf.Class, create:() => <PaymentApplicationUser>[]),
    'PaymentApplicationRequest': TypeInfo(TypeOf.Class, create:() => PaymentApplicationRequest()),
});

Dart PaymentApplicationRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /payments/paymentApplication HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"IsError":true,"users":[{"groupID":"String","fiscalYear":0,"userID":"String","bhUserID":0,"autoPayStatus":"String","userTransactions":[{"transactionID":0,"date":"String","type":"String","accountLast4":"String","amount":0,"unapplied":0,"unappliedFee":0,"returnReason":"String","returnDate":"String","refundAmount":0,"lineItems":[{"chartOfAccountRefID":"String","chartOfAccountDescription":"String","cashAccount":"String","amount":0,"fee":0}],"transactionHistory":[{"type":"String","date":"String","lineItems":[{"chartOfAccountRefID":"String","chartOfAccountDescription":"String","cashAccount":"String","amount":0,"fee":0}]}]}]}],"ErrorMessage":"String","paging":{"page":0,"totalPages":0,"next":"String"}}