Billhighway Cloud API

PaymentApplicationRequest

The following routes are available for this service:
GET	/payments/paymentApplication

import Foundation
import ServiceStack

public class PaymentApplicationRequest : Codable
{
    public var transactionID:Int?
    public var groupID:String?
    public var userID:String?
    public var bhUserID:Int?
    public var transactionBeginDate:Date?
    public var transactionEndDate:Date?
    public var fiscalYear:Int?
    public var page:Int?

    required public init(){}
}

public class PaymentApplicationResponse : Codable
{
    public var isError:Bool?
    public var users:[PaymentApplicationUser] = []
    public var errorMessage:String?
    public var paging:Paging?

    required public init(){}
}

public class PaymentApplicationUser : Codable
{
    public var groupID:String?
    public var fiscalYear:Int?
    public var userID:String?
    public var bhUserID:Int?
    public var autoPayStatus:String?
    public var userTransactions:[UserTransaction] = []

    required public init(){}
}

public class UserTransaction : Codable
{
    public var transactionID:Int?
    public var date:String?
    public var type:String?
    public var accountLast4:String?
    public var amount:Double?
    public var unapplied:Double?
    public var unappliedFee:Double?
    public var returnReason:String?
    public var returnDate:String?
    public var refundAmount:Double?
    public var lineItems:[LineItem] = []
    public var transactionHistory:[TransactionHistory] = []

    required public init(){}
}

public class LineItem : Codable
{
    public var chartOfAccountRefID:String?
    public var chartOfAccountDescription:String?
    public var cashAccount:String?
    public var amount:Double?
    public var fee:Double?

    required public init(){}
}

public class TransactionHistory : Codable
{
    public var type:String?
    public var date:String?
    public var lineItems:[LineItem] = []

    required public init(){}
}

public class Paging : Codable
{
    public var page:Int?
    public var totalPages:Int?
    public var next:String?

    required public init(){}
}

Swift PaymentApplicationRequest 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 /payments/paymentApplication HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}