Billhighway Cloud API

<back to all web services

ExternalBankTransferReportRq

The following routes are available for this service:
GET/financial/reporting/ebt
import 'package:servicestack/servicestack.dart';

class TransferDetail implements IConvertible
{
    String? TransactionType;
    int? TransactionId;
    String? Member;
    String? ClientUserId;
    String? Company;
    String? OrderId;
    String? Frequency;
    String? ProcessedDate;
    String? CheckNumber;
    double? Amount;
    String? MemberTypeDescription;
    String? ChapBillCatID;
    String? ChartOfAccountRefID;
    String? ChartOfAccountDescription;
    String? HeldPaymentTransactionId;

    TransferDetail({this.TransactionType,this.TransactionId,this.Member,this.ClientUserId,this.Company,this.OrderId,this.Frequency,this.ProcessedDate,this.CheckNumber,this.Amount,this.MemberTypeDescription,this.ChapBillCatID,this.ChartOfAccountRefID,this.ChartOfAccountDescription,this.HeldPaymentTransactionId});
    TransferDetail.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TransactionType = json['TransactionType'];
        TransactionId = json['TransactionId'];
        Member = json['Member'];
        ClientUserId = json['ClientUserId'];
        Company = json['Company'];
        OrderId = json['OrderId'];
        Frequency = json['Frequency'];
        ProcessedDate = json['ProcessedDate'];
        CheckNumber = json['CheckNumber'];
        Amount = JsonConverters.toDouble(json['Amount']);
        MemberTypeDescription = json['MemberTypeDescription'];
        ChapBillCatID = json['ChapBillCatID'];
        ChartOfAccountRefID = json['ChartOfAccountRefID'];
        ChartOfAccountDescription = json['ChartOfAccountDescription'];
        HeldPaymentTransactionId = json['HeldPaymentTransactionId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TransactionType': TransactionType,
        'TransactionId': TransactionId,
        'Member': Member,
        'ClientUserId': ClientUserId,
        'Company': Company,
        'OrderId': OrderId,
        'Frequency': Frequency,
        'ProcessedDate': ProcessedDate,
        'CheckNumber': CheckNumber,
        'Amount': Amount,
        'MemberTypeDescription': MemberTypeDescription,
        'ChapBillCatID': ChapBillCatID,
        'ChartOfAccountRefID': ChartOfAccountRefID,
        'ChartOfAccountDescription': ChartOfAccountDescription,
        'HeldPaymentTransactionId': HeldPaymentTransactionId
    };

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

class TransferHeader implements IConvertible
{
    int? BatchId;
    int? TransactionId;
    String? CashAccount;
    String? TransferDate;
    double? Amount;
    String? ClearedDate;
    String? Status;
    String? BankAccount;
    List<TransferDetail>? TransferDetail;

    TransferHeader({this.BatchId,this.TransactionId,this.CashAccount,this.TransferDate,this.Amount,this.ClearedDate,this.Status,this.BankAccount,this.TransferDetail});
    TransferHeader.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        BatchId = json['BatchId'];
        TransactionId = json['TransactionId'];
        CashAccount = json['CashAccount'];
        TransferDate = json['TransferDate'];
        Amount = JsonConverters.toDouble(json['Amount']);
        ClearedDate = json['ClearedDate'];
        Status = json['Status'];
        BankAccount = json['BankAccount'];
        TransferDetail = JsonConverters.fromJson(json['TransferDetail'],'List<TransferDetail>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'BatchId': BatchId,
        'TransactionId': TransactionId,
        'CashAccount': CashAccount,
        'TransferDate': TransferDate,
        'Amount': Amount,
        'ClearedDate': ClearedDate,
        'Status': Status,
        'BankAccount': BankAccount,
        'TransferDetail': JsonConverters.toJson(TransferDetail,'List<TransferDetail>',context!)
    };

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

class ExternalBankTransferReportRs implements IConvertible
{
    String? GroupId;
    String? GroupNickName;
    String? GroupName;
    String? StartDate;
    String? EndDate;
    double? TotalAmount;
    List<TransferHeader>? Transfers;
    int? ErrorCode;
    String? ErrorMessage;
    // @ApiMember(ExcludeInSchema=true)
    bool? IsError;

    ExternalBankTransferReportRs({this.GroupId,this.GroupNickName,this.GroupName,this.StartDate,this.EndDate,this.TotalAmount,this.Transfers,this.ErrorCode,this.ErrorMessage,this.IsError});
    ExternalBankTransferReportRs.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        GroupId = json['GroupId'];
        GroupNickName = json['GroupNickName'];
        GroupName = json['GroupName'];
        StartDate = json['StartDate'];
        EndDate = json['EndDate'];
        TotalAmount = JsonConverters.toDouble(json['TotalAmount']);
        Transfers = JsonConverters.fromJson(json['Transfers'],'List<TransferHeader>',context!);
        ErrorCode = json['ErrorCode'];
        ErrorMessage = json['ErrorMessage'];
        IsError = json['IsError'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'GroupId': GroupId,
        'GroupNickName': GroupNickName,
        'GroupName': GroupName,
        'StartDate': StartDate,
        'EndDate': EndDate,
        'TotalAmount': TotalAmount,
        'Transfers': JsonConverters.toJson(Transfers,'List<TransferHeader>',context!),
        'ErrorCode': ErrorCode,
        'ErrorMessage': ErrorMessage,
        'IsError': IsError
    };

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

class ExternalBankTransferReportRq implements IConvertible
{
    int? ClientId;
    String? GroupId;
    DateTime? StartDate;
    DateTime? EndDate;

    ExternalBankTransferReportRq({this.ClientId,this.GroupId,this.StartDate,this.EndDate});
    ExternalBankTransferReportRq.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ClientId': ClientId,
        'GroupId': GroupId,
        'StartDate': JsonConverters.toJson(StartDate,'DateTime',context!),
        'EndDate': JsonConverters.toJson(EndDate,'DateTime',context!)
    };

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

TypeContext _ctx = TypeContext(library: 'devapi.billhighway.com', types: <String, TypeInfo> {
    'TransferDetail': TypeInfo(TypeOf.Class, create:() => TransferDetail()),
    'TransferHeader': TypeInfo(TypeOf.Class, create:() => TransferHeader()),
    'List<TransferDetail>': TypeInfo(TypeOf.Class, create:() => <TransferDetail>[]),
    'ExternalBankTransferReportRs': TypeInfo(TypeOf.Class, create:() => ExternalBankTransferReportRs()),
    'List<TransferHeader>': TypeInfo(TypeOf.Class, create:() => <TransferHeader>[]),
    'ExternalBankTransferReportRq': TypeInfo(TypeOf.Class, create:() => ExternalBankTransferReportRq()),
});

Dart ExternalBankTransferReportRq DTOs

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

HTTP + JSV

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

GET /financial/reporting/ebt HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	GroupId: String,
	GroupNickName: String,
	GroupName: String,
	StartDate: String,
	EndDate: String,
	TotalAmount: 0,
	Transfers: 
	[
		{
			BatchId: 0,
			TransactionId: 0,
			CashAccount: String,
			TransferDate: String,
			Amount: 0,
			ClearedDate: String,
			Status: String,
			BankAccount: String,
			TransferDetail: 
			[
				{
					TransactionType: String,
					TransactionId: 0,
					Member: String,
					ClientUserId: String,
					Company: String,
					OrderId: String,
					Frequency: String,
					ProcessedDate: String,
					CheckNumber: String,
					Amount: 0,
					MemberTypeDescription: String,
					ChapBillCatID: String,
					ChartOfAccountRefID: String,
					ChartOfAccountDescription: String,
					HeldPaymentTransactionId: String
				}
			]
		}
	],
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: False
}