Billhighway Cloud API

<back to all web services

PaymentApplicationRequest

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BH.CloudAPI.Common4.DTO.PaymentApplication.Request
Imports BH.CloudAPI.Common4.DTO.PaymentApplication.Response

Namespace Global

    Namespace BH.CloudAPI.Common4.DTO.PaymentApplication.Request

        Public Partial Class PaymentApplicationRequest
            Public Overridable Property transactionID As Nullable(Of Integer)
            Public Overridable Property groupID As String
            Public Overridable Property userID As String
            Public Overridable Property bhUserID As Nullable(Of Integer)
            Public Overridable Property transactionBeginDate As Nullable(Of Date)
            Public Overridable Property transactionEndDate As Nullable(Of Date)
            Public Overridable Property fiscalYear As Nullable(Of Integer)
            Public Overridable Property page As Nullable(Of Integer)
        End Class
    End Namespace

    Namespace BH.CloudAPI.Common4.DTO.PaymentApplication.Response

        Public Partial Class LineItem
            Public Overridable Property chartOfAccountRefID As String
            Public Overridable Property chartOfAccountDescription As String
            Public Overridable Property cashAccount As String
            Public Overridable Property amount As Decimal
            Public Overridable Property fee As Decimal
        End Class

        Public Partial Class Paging
            Public Overridable Property page As Integer
            Public Overridable Property totalPages As Integer
            Public Overridable Property next As String
        End Class

        Public Partial Class PaymentApplicationResponse
            Public Sub New()
                users = New List(Of PaymentApplicationUser)
            End Sub

            Public Overridable Property IsError As Boolean
            Public Overridable Property users As List(Of PaymentApplicationUser)
            Public Overridable Property ErrorMessage As String
            Public Overridable Property paging As Paging
        End Class

        Public Partial Class PaymentApplicationUser
            Public Sub New()
                userTransactions = New List(Of UserTransaction)
            End Sub

            Public Overridable Property groupID As String
            Public Overridable Property fiscalYear As Integer
            Public Overridable Property userID As String
            Public Overridable Property bhUserID As Integer
            Public Overridable Property autoPayStatus As String
            Public Overridable Property userTransactions As List(Of UserTransaction)
        End Class

        Public Partial Class TransactionHistory
            Public Sub New()
                lineItems = New List(Of LineItem)
            End Sub

            Public Overridable Property type As String
            Public Overridable Property date As String
            Public Overridable Property lineItems As List(Of LineItem)
        End Class

        Public Partial Class UserTransaction
            Public Sub New()
                lineItems = New List(Of LineItem)
                transactionHistory = New List(Of TransactionHistory)
            End Sub

            Public Overridable Property transactionID As Long
            Public Overridable Property date As String
            Public Overridable Property type As String
            Public Overridable Property accountLast4 As String
            Public Overridable Property amount As Decimal
            Public Overridable Property unapplied As Decimal
            Public Overridable Property unappliedFee As Decimal
            Public Overridable Property returnReason As String
            Public Overridable Property returnDate As String
            Public Overridable Property refundAmount As Decimal
            Public Overridable Property lineItems As List(Of LineItem)
            Public Overridable Property transactionHistory As List(Of TransactionHistory)
        End Class
    End Namespace
End Namespace

VB.NET PaymentApplicationRequest DTOs

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