Billhighway Cloud API

<back to all web services

PaymentApplicationRequest

The following routes are available for this service:
GET/payments/paymentApplication
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class PaymentApplicationRequest
{
    var transactionID:Int? = null
    var groupID:String? = null
    var userID:String? = null
    var bhUserID:Int? = null
    var transactionBeginDate:Date? = null
    var transactionEndDate:Date? = null
    var fiscalYear:Int? = null
    var page:Int? = null
}

open class PaymentApplicationResponse
{
    var IsError:Boolean? = null
    var users:ArrayList<PaymentApplicationUser> = ArrayList<PaymentApplicationUser>()
    var ErrorMessage:String? = null
    var paging:Paging? = null
}

open class PaymentApplicationUser
{
    var groupID:String? = null
    var fiscalYear:Int? = null
    var userID:String? = null
    var bhUserID:Int? = null
    var autoPayStatus:String? = null
    var userTransactions:ArrayList<UserTransaction> = ArrayList<UserTransaction>()
}

open class UserTransaction
{
    var transactionID:Long? = null
    var date:String? = null
    @SerializedName("type") var Type:String? = null
    var accountLast4:String? = null
    var amount:BigDecimal? = null
    var unapplied:BigDecimal? = null
    var unappliedFee:BigDecimal? = null
    var returnReason:String? = null
    var returnDate:String? = null
    var refundAmount:BigDecimal? = null
    var lineItems:ArrayList<LineItem> = ArrayList<LineItem>()
    var transactionHistory:ArrayList<TransactionHistory> = ArrayList<TransactionHistory>()
}

open class LineItem
{
    var chartOfAccountRefID:String? = null
    var chartOfAccountDescription:String? = null
    var cashAccount:String? = null
    var amount:BigDecimal? = null
    var fee:BigDecimal? = null
}

open class TransactionHistory
{
    @SerializedName("type") var Type:String? = null
    var date:String? = null
    var lineItems:ArrayList<LineItem> = ArrayList<LineItem>()
}

open class Paging
{
    var page:Int? = null
    var totalPages:Int? = null
    var next:String? = null
}

Kotlin 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
	}
}