Billhighway Cloud API

PaymentApplicationRequest

The following routes are available for this service:
GET	/payments/paymentApplication

**PaymentApplicationRequest** Parameters:
Name	Parameter	Data Type	Required
transactionID	query	int?	No
groupID	query	string	No
userID	query	string	No
bhUserID	query	int?	No
transactionBeginDate	query	DateTime?	No
transactionEndDate	query	DateTime?	No
fiscalYear	query	int?	No
page	query	int?	No

**PaymentApplicationResponse** Parameters:
Name	Parameter	Data Type	Required
IsError	form	bool	No
users	form	List<PaymentApplicationUser>	No
ErrorMessage	form	string	No
paging	form	Paging	No

**PaymentApplicationUser** Parameters:
Name	Parameter	Data Type	Required
groupID	form	string	No
fiscalYear	form	int	No
userID	form	string	No
bhUserID	form	int	No
autoPayStatus	form	string	No
userTransactions	form	List<UserTransaction>	No

**UserTransaction** Parameters:
Name	Parameter	Data Type	Required
transactionID	form	long	No
date	form	string	No
type	form	string	No
accountLast4	form	string	No
amount	form	decimal	No
unapplied	form	decimal	No
unappliedFee	form	decimal	No
returnReason	form	string	No
returnDate	form	string	No
refundAmount	form	decimal	No
lineItems	form	List<LineItem>	No
transactionHistory	form	List<TransactionHistory>	No

**LineItem** Parameters:
Name	Parameter	Data Type	Required
chartOfAccountRefID	form	string	No
chartOfAccountDescription	form	string	No
cashAccount	form	string	No
amount	form	decimal	No
fee	form	decimal	No

**TransactionHistory** Parameters:
Name	Parameter	Data Type	Required
type	form	string	No
date	form	string	No
lineItems	form	List<LineItem>	No

**Paging** Parameters:
Name	Parameter	Data Type	Required
page	form	int	No
totalPages	form	int	No
next	form	string	No

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>