Billhighway Cloud API

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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PaymentApplicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.PaymentApplication.Response">
  <ErrorMessage>String</ErrorMessage>
  <paging>
    <next>String</next>
    <page>0</page>
    <totalPages>0</totalPages>
  </paging>
  <users>
    <PaymentApplicationUser>
      <autoPayStatus>String</autoPayStatus>
      <bhUserID>0</bhUserID>
      <fiscalYear>0</fiscalYear>
      <groupID>String</groupID>
      <userID>String</userID>
      <userTransactions>
        <UserTransaction>
          <accountLast4>String</accountLast4>
          <amount>0</amount>
          <date>String</date>
          <lineItems>
            <LineItem>
              <amount>0</amount>
              <cashAccount>String</cashAccount>
              <chartOfAccountDescription>String</chartOfAccountDescription>
              <chartOfAccountRefID>String</chartOfAccountRefID>
              <fee>0</fee>
            </LineItem>
          </lineItems>
          <refundAmount>0</refundAmount>
          <returnDate>String</returnDate>
          <returnReason>String</returnReason>
          <transactionHistory>
            <TransactionHistory>
              <date>String</date>
              <lineItems>
                <LineItem>
                  <amount>0</amount>
                  <cashAccount>String</cashAccount>
                  <chartOfAccountDescription>String</chartOfAccountDescription>
                  <chartOfAccountRefID>String</chartOfAccountRefID>
                  <fee>0</fee>
                </LineItem>
              </lineItems>
              <type>String</type>
            </TransactionHistory>
          </transactionHistory>
          <transactionID>0</transactionID>
          <type>String</type>
          <unapplied>0</unapplied>
          <unappliedFee>0</unappliedFee>
        </UserTransaction>
      </userTransactions>
    </PaymentApplicationUser>
  </users>
</PaymentApplicationResponse>