Billhighway Cloud API

<back to all web services

PaymentApplicationRequest

The following routes are available for this service:
GET/payments/paymentApplication
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.PaymentApplication.Request;
using BH.CloudAPI.Common4.DTO.PaymentApplication.Response;

namespace BH.CloudAPI.Common4.DTO.PaymentApplication.Request
{
    public partial class PaymentApplicationRequest
    {
        public virtual int? transactionID { get; set; }
        public virtual string groupID { get; set; }
        public virtual string userID { get; set; }
        public virtual int? bhUserID { get; set; }
        public virtual DateTime? transactionBeginDate { get; set; }
        public virtual DateTime? transactionEndDate { get; set; }
        public virtual int? fiscalYear { get; set; }
        public virtual int? page { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.PaymentApplication.Response
{
    public partial class LineItem
    {
        public virtual string chartOfAccountRefID { get; set; }
        public virtual string chartOfAccountDescription { get; set; }
        public virtual string cashAccount { get; set; }
        public virtual decimal amount { get; set; }
        public virtual decimal fee { get; set; }
    }

    public partial class Paging
    {
        public virtual int page { get; set; }
        public virtual int totalPages { get; set; }
        public virtual string next { get; set; }
    }

    public partial class PaymentApplicationResponse
    {
        public PaymentApplicationResponse()
        {
            users = new List<PaymentApplicationUser>{};
        }

        public virtual bool IsError { get; set; }
        public virtual List<PaymentApplicationUser> users { get; set; }
        public virtual string ErrorMessage { get; set; }
        public virtual Paging paging { get; set; }
    }

    public partial class PaymentApplicationUser
    {
        public PaymentApplicationUser()
        {
            userTransactions = new List<UserTransaction>{};
        }

        public virtual string groupID { get; set; }
        public virtual int fiscalYear { get; set; }
        public virtual string userID { get; set; }
        public virtual int bhUserID { get; set; }
        public virtual string autoPayStatus { get; set; }
        public virtual List<UserTransaction> userTransactions { get; set; }
    }

    public partial class TransactionHistory
    {
        public TransactionHistory()
        {
            lineItems = new List<LineItem>{};
        }

        public virtual string type { get; set; }
        public virtual string date { get; set; }
        public virtual List<LineItem> lineItems { get; set; }
    }

    public partial class UserTransaction
    {
        public UserTransaction()
        {
            lineItems = new List<LineItem>{};
            transactionHistory = new List<TransactionHistory>{};
        }

        public virtual long transactionID { get; set; }
        public virtual string date { get; set; }
        public virtual string type { get; set; }
        public virtual string accountLast4 { get; set; }
        public virtual decimal amount { get; set; }
        public virtual decimal unapplied { get; set; }
        public virtual decimal unappliedFee { get; set; }
        public virtual string returnReason { get; set; }
        public virtual string returnDate { get; set; }
        public virtual decimal refundAmount { get; set; }
        public virtual List<LineItem> lineItems { get; set; }
        public virtual List<TransactionHistory> transactionHistory { get; set; }
    }

}

C# PaymentApplicationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsError: True,
	users: 
	[
		{
			groupID: String,
			fiscalYear: 0,
			userID: String,
			bhUserID: 0,
			autoPayStatus: String,
			userTransactions: 
			[
				{
					transactionID: 0,
					date: String,
					type: String,
					accountLast4: String,
					amount: 0,
					unapplied: 0,
					unappliedFee: 0,
					returnReason: String,
					returnDate: String,
					refundAmount: 0,
					lineItems: 
					[
						{
							chartOfAccountRefID: String,
							chartOfAccountDescription: String,
							cashAccount: String,
							amount: 0,
							fee: 0
						}
					],
					transactionHistory: 
					[
						{
							type: String,
							date: String,
							lineItems: 
							[
								{
									chartOfAccountRefID: String,
									chartOfAccountDescription: String,
									cashAccount: String,
									amount: 0,
									fee: 0
								}
							]
						}
					]
				}
			]
		}
	],
	ErrorMessage: String,
	paging: 
	{
		page: 0,
		totalPages: 0,
		next: String
	}
}