Billhighway Cloud API

PaymentApplicationRequest

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

namespace BH.CloudAPI.Common4.DTO.PaymentApplication.Request

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type LineItem() = 
        member val chartOfAccountRefID:String = null with get,set
        member val chartOfAccountDescription:String = null with get,set
        member val cashAccount:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val fee:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type TransactionHistory() = 
        member val type:String = null with get,set
        member val date:String = null with get,set
        member val lineItems:ResizeArray<LineItem> = new ResizeArray<LineItem>() with get,set

    [<AllowNullLiteral>]
    type UserTransaction() = 
        member val transactionID:Int64 = new Int64() with get,set
        member val date:String = null with get,set
        member val type:String = null with get,set
        member val accountLast4:String = null with get,set
        member val amount:Decimal = new Decimal() with get,set
        member val unapplied:Decimal = new Decimal() with get,set
        member val unappliedFee:Decimal = new Decimal() with get,set
        member val returnReason:String = null with get,set
        member val returnDate:String = null with get,set
        member val refundAmount:Decimal = new Decimal() with get,set
        member val lineItems:ResizeArray<LineItem> = new ResizeArray<LineItem>() with get,set
        member val transactionHistory:ResizeArray<TransactionHistory> = new ResizeArray<TransactionHistory>() with get,set

    [<AllowNullLiteral>]
    type PaymentApplicationUser() = 
        member val groupID:String = null with get,set
        member val fiscalYear:Int32 = new Int32() with get,set
        member val userID:String = null with get,set
        member val bhUserID:Int32 = new Int32() with get,set
        member val autoPayStatus:String = null with get,set
        member val userTransactions:ResizeArray<UserTransaction> = new ResizeArray<UserTransaction>() with get,set

    [<AllowNullLiteral>]
    type Paging() = 
        member val page:Int32 = new Int32() with get,set
        member val totalPages:Int32 = new Int32() with get,set
        member val next:String = null with get,set

    [<AllowNullLiteral>]
    type PaymentApplicationResponse() = 
        member val IsError:Boolean = new Boolean() with get,set
        member val users:ResizeArray<PaymentApplicationUser> = new ResizeArray<PaymentApplicationUser>() with get,set
        member val ErrorMessage:String = null with get,set
        member val paging:Paging = null with get,set

    [<AllowNullLiteral>]
    type PaymentApplicationRequest() = 
        member val transactionID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val groupID:String = null with get,set
        member val userID:String = null with get,set
        member val bhUserID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val transactionBeginDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val transactionEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val fiscalYear:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val page:Nullable<Int32> = new Nullable<Int32>() with get,set

F# 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>