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