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

public class dtos
{

    public static class PaymentApplicationRequest
    {
        public Integer transactionID = null;
        public String groupID = null;
        public String userID = null;
        public Integer bhUserID = null;
        public Date transactionBeginDate = null;
        public Date transactionEndDate = null;
        public Integer fiscalYear = null;
        public Integer page = null;
        
        public Integer getTransactionID() { return transactionID; }
        public PaymentApplicationRequest setTransactionID(Integer value) { this.transactionID = value; return this; }
        public String getGroupID() { return groupID; }
        public PaymentApplicationRequest setGroupID(String value) { this.groupID = value; return this; }
        public String getUserID() { return userID; }
        public PaymentApplicationRequest setUserID(String value) { this.userID = value; return this; }
        public Integer getBhUserID() { return bhUserID; }
        public PaymentApplicationRequest setBhUserID(Integer value) { this.bhUserID = value; return this; }
        public Date getTransactionBeginDate() { return transactionBeginDate; }
        public PaymentApplicationRequest setTransactionBeginDate(Date value) { this.transactionBeginDate = value; return this; }
        public Date getTransactionEndDate() { return transactionEndDate; }
        public PaymentApplicationRequest setTransactionEndDate(Date value) { this.transactionEndDate = value; return this; }
        public Integer getFiscalYear() { return fiscalYear; }
        public PaymentApplicationRequest setFiscalYear(Integer value) { this.fiscalYear = value; return this; }
        public Integer getPage() { return page; }
        public PaymentApplicationRequest setPage(Integer value) { this.page = value; return this; }
    }

    public static class PaymentApplicationResponse
    {
        public Boolean IsError = null;
        public ArrayList<PaymentApplicationUser> users = null;
        public String ErrorMessage = null;
        public Paging paging = null;
        
        public Boolean getIsError() { return IsError; }
        public PaymentApplicationResponse setIsError(Boolean value) { this.IsError = value; return this; }
        public ArrayList<PaymentApplicationUser> getUsers() { return users; }
        public PaymentApplicationResponse setUsers(ArrayList<PaymentApplicationUser> value) { this.users = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public PaymentApplicationResponse setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Paging getPaging() { return paging; }
        public PaymentApplicationResponse setPaging(Paging value) { this.paging = value; return this; }
    }

    public static class PaymentApplicationUser
    {
        public String groupID = null;
        public Integer fiscalYear = null;
        public String userID = null;
        public Integer bhUserID = null;
        public String autoPayStatus = null;
        public ArrayList<UserTransaction> userTransactions = null;
        
        public String getGroupID() { return groupID; }
        public PaymentApplicationUser setGroupID(String value) { this.groupID = value; return this; }
        public Integer getFiscalYear() { return fiscalYear; }
        public PaymentApplicationUser setFiscalYear(Integer value) { this.fiscalYear = value; return this; }
        public String getUserID() { return userID; }
        public PaymentApplicationUser setUserID(String value) { this.userID = value; return this; }
        public Integer getBhUserID() { return bhUserID; }
        public PaymentApplicationUser setBhUserID(Integer value) { this.bhUserID = value; return this; }
        public String getAutoPayStatus() { return autoPayStatus; }
        public PaymentApplicationUser setAutoPayStatus(String value) { this.autoPayStatus = value; return this; }
        public ArrayList<UserTransaction> getUserTransactions() { return userTransactions; }
        public PaymentApplicationUser setUserTransactions(ArrayList<UserTransaction> value) { this.userTransactions = value; return this; }
    }

    public static class UserTransaction
    {
        public Long transactionID = null;
        public String date = null;
        public String type = null;
        public String accountLast4 = null;
        public BigDecimal amount = null;
        public BigDecimal unapplied = null;
        public BigDecimal unappliedFee = null;
        public String returnReason = null;
        public String returnDate = null;
        public BigDecimal refundAmount = null;
        public ArrayList<LineItem> lineItems = null;
        public ArrayList<TransactionHistory> transactionHistory = null;
        
        public Long getTransactionID() { return transactionID; }
        public UserTransaction setTransactionID(Long value) { this.transactionID = value; return this; }
        public String getDate() { return date; }
        public UserTransaction setDate(String value) { this.date = value; return this; }
        public String getType() { return type; }
        public UserTransaction setType(String value) { this.type = value; return this; }
        public String getAccountLast4() { return accountLast4; }
        public UserTransaction setAccountLast4(String value) { this.accountLast4 = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public UserTransaction setAmount(BigDecimal value) { this.amount = value; return this; }
        public BigDecimal getUnapplied() { return unapplied; }
        public UserTransaction setUnapplied(BigDecimal value) { this.unapplied = value; return this; }
        public BigDecimal getUnappliedFee() { return unappliedFee; }
        public UserTransaction setUnappliedFee(BigDecimal value) { this.unappliedFee = value; return this; }
        public String getReturnReason() { return returnReason; }
        public UserTransaction setReturnReason(String value) { this.returnReason = value; return this; }
        public String getReturnDate() { return returnDate; }
        public UserTransaction setReturnDate(String value) { this.returnDate = value; return this; }
        public BigDecimal getRefundAmount() { return refundAmount; }
        public UserTransaction setRefundAmount(BigDecimal value) { this.refundAmount = value; return this; }
        public ArrayList<LineItem> getLineItems() { return lineItems; }
        public UserTransaction setLineItems(ArrayList<LineItem> value) { this.lineItems = value; return this; }
        public ArrayList<TransactionHistory> getTransactionHistory() { return transactionHistory; }
        public UserTransaction setTransactionHistory(ArrayList<TransactionHistory> value) { this.transactionHistory = value; return this; }
    }

    public static class LineItem
    {
        public String chartOfAccountRefID = null;
        public String chartOfAccountDescription = null;
        public String cashAccount = null;
        public BigDecimal amount = null;
        public BigDecimal fee = null;
        
        public String getChartOfAccountRefID() { return chartOfAccountRefID; }
        public LineItem setChartOfAccountRefID(String value) { this.chartOfAccountRefID = value; return this; }
        public String getChartOfAccountDescription() { return chartOfAccountDescription; }
        public LineItem setChartOfAccountDescription(String value) { this.chartOfAccountDescription = value; return this; }
        public String getCashAccount() { return cashAccount; }
        public LineItem setCashAccount(String value) { this.cashAccount = value; return this; }
        public BigDecimal getAmount() { return amount; }
        public LineItem setAmount(BigDecimal value) { this.amount = value; return this; }
        public BigDecimal getFee() { return fee; }
        public LineItem setFee(BigDecimal value) { this.fee = value; return this; }
    }

    public static class TransactionHistory
    {
        public String type = null;
        public String date = null;
        public ArrayList<LineItem> lineItems = null;
        
        public String getType() { return type; }
        public TransactionHistory setType(String value) { this.type = value; return this; }
        public String getDate() { return date; }
        public TransactionHistory setDate(String value) { this.date = value; return this; }
        public ArrayList<LineItem> getLineItems() { return lineItems; }
        public TransactionHistory setLineItems(ArrayList<LineItem> value) { this.lineItems = value; return this; }
    }

    public static class Paging
    {
        public Integer page = null;
        public Integer totalPages = null;
        public String next = null;
        
        public Integer getPage() { return page; }
        public Paging setPage(Integer value) { this.page = value; return this; }
        public Integer getTotalPages() { return totalPages; }
        public Paging setTotalPages(Integer value) { this.totalPages = value; return this; }
        public String getNext() { return next; }
        public Paging setNext(String value) { this.next = value; return this; }
    }

}

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