Billhighway Cloud API

Pmi

The following routes are available for this service:
POST	/PMI

import java.math.*
import java.util.*
import net.servicestack.client.*


open class Pmi
{
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:Int? = null
    var MemberInfo:Member? = null
    var InvoiceCollection:ArrayList<Invoice> = ArrayList<Invoice>()
    var CcPaymentInfo:CreditCardPayment? = null
    var CreditInfo:CreateApplyCredit? = null
    var AchPaymentInfo:AchPayment? = null
    var LockboxId:Long? = null
    var MemberSubscriptionInvoiceId:Long? = null
}

open class Member
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:String? = null
    var AlternateUserId:String? = null
    var BhUserId:Int? = null
    var FirstName:String? = null
    var LastName:String? = null
    var MiddleName:String? = null
    var PreferredEmailAddress:String? = null
    var OtherEmailAddress:String? = null
    var PreferredPhoneNumber:String? = null
    var PreferredAddress1:String? = null
    var PreferredAddress2:String? = null
    var PreferredCity:String? = null
    var PreferredState:String? = null
    var PreferredZip:String? = null
    var PreferredCountry:String? = null
    var AccessLevel:String? = null
    var MemberStatus:String? = null
    var MemberTypeClient:String? = null
    var BillingType:String? = null
    var FiscalYear:Int? = null
    var WorkLocation:String? = null
    var DOB:Date? = null
    var Paperless:String? = null
    var DisplayName:String? = null
    var DisableLogin:String? = null
    var RecurringInvoiceSettings:RecurringInvoiceSettings? = null
    var FormFields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
    var Attributes:ArrayList<AttributeItem> = ArrayList<AttributeItem>()
    var GroupList:ArrayList<Chapter> = ArrayList<Chapter>()
}

open class RecurringInvoiceSettings
{
    var DonationAmount:String? = null
}

open class SubscriberFormField
{
    var Name:String? = null
    var Value:String? = null
}

open class AttributeItem
{
    var Name:String? = null
    var Value:String? = null
}

open class Chapter
{
    var GroupId:String? = null
}

open class Invoice : IInvoiceValidation
{
    var UniqueId:String? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var Description:String? = null
    var OpportunityId:String? = null
    var Installments:Int? = null
    var Frequency:Int? = null
    var InvoiceDueDate:Date? = null
    var Deliver:Boolean? = null
    var UserId:String? = null
    var BhUserId:Int? = null
    var CurrencyType:String? = null
    var InvoiceItems:ArrayList<InvoiceItem> = ArrayList<InvoiceItem>()
    var InvoiceNo:Int? = null
    var InvoiceAmt:BigDecimal? = null
    var ExternalInvBatchNo:String? = null
    var ExemptFromLateFee:Boolean? = null
}

open class InvoiceItem : IInvoiceItemValidation
{
    var UniqueId:String? = null
    var ProductName:String? = null
    var AmountDue:BigDecimal? = null
    var ProductType:String? = null
    var ActPatternTypeID:Int? = null
    var TermStartDate:Date? = null
    var TermEndDate:Date? = null
    var RecognitionPeriod:Int? = null
    var RevenueAccount:String? = null
    var AccountsReceivableAccount:String? = null
    var LiabilityAccount:String? = null
    var CreditExpenseAccount:String? = null
    var InvoiceClearingAccount:String? = null
    var CostCenter:String? = null
    var Region:String? = null
}

open class CreditCardPayment : CreditCardPayment()
{
    var SubscriptionInfo:SubscriptionParameters? = null
}

open class SubscriptionParameters
{
    var FormTemplateID:Int? = null
    var SubscriptionInvoiceID:Int? = null
    var ClientSubscriberId:String? = null
    var SignupTypeID:Int? = null
    var FrequencyID:Int? = null
    var AutoRenew:Boolean? = null
    var CompanyID:Long? = null
    var UserID:Int? = null
    var ChapMemPayID:Long? = null
    var MemberSubscriptionInvID:Long? = null
    var Fields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
    var CreatedBy:Int? = null
    var UpdatedBy:Int? = null
    var AptifyUpdateType:Int? = null
    var RenewedMemberSubscriptionInvID:Long? = null
    var ChapId:Int? = null
}

open class CreateApplyCredit
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:String? = null
    var BhUserId:Int? = null
    var CreditId:Int? = null
    var CurrencyType:String? = null
    var CreditType:String? = null
    var Notes:String? = null
    var InvoiceDetails:ArrayList<SalesForceCreditInvoiceDetails> = ArrayList<SalesForceCreditInvoiceDetails>()
}

open class SalesForceCreditInvoiceDetails
{
    var Invoice:Long? = null
    var AmountPaid:BigDecimal? = null
    var Region:String? = null
    var CostCenter:String? = null
}

open class AchPayment
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:String? = null
    var BhUserId:Int? = null
    var Amount:BigDecimal? = null
    var CurrencyType:String? = null
    var Country:String? = null
    var RoutingNumber:String? = null
    var AccountNumber:String? = null
    var AchReference:String? = null
    var AccountType:String? = null
    var IsSavingsAccount:Boolean? = null
    var PayerName:String? = null
    var CheckNumber:String? = null
    var PreferredEmailAddress:String? = null
    var Memo:String? = null
    var InvoiceList:ArrayList<SalesForceMemberPaymentInvoiceDetail> = ArrayList<SalesForceMemberPaymentInvoiceDetail>()
    var AutoPay:Boolean? = null
    var StoreAchInfo:Boolean? = null
    var EncryptionTypeId:Int? = null
}

open class SalesForceMemberPaymentInvoiceDetail
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var Invoice:Int? = null
    var AmountPaid:String? = null
}

open class PmiReply : IHaveErrorField
{
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var BillhighwayPaymentConfirmationNumber:String? = null
    var BillhighwayUserId:Int? = null
    var BhInvoiceBatchId:ArrayList<Int> = ArrayList<Int>()
    var ChapMemPayid:Long? = null
    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
    var IsError:Boolean? = null
}

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

POST /PMI HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	GroupId: 0,
	MemberInfo: 
	{
		ClassName: String,
		UniqueId: String,
		CreatedDateTime: 0001-01-01,
		ClientId: 0,
		GroupId: String,
		UserId: String,
		AlternateUserId: String,
		BhUserId: 0,
		FirstName: String,
		LastName: String,
		MiddleName: String,
		PreferredEmailAddress: String,
		OtherEmailAddress: String,
		PreferredPhoneNumber: String,
		PreferredAddress1: String,
		PreferredAddress2: String,
		PreferredCity: String,
		PreferredState: String,
		PreferredZip: String,
		PreferredCountry: String,
		AccessLevel: String,
		MemberStatus: String,
		MemberTypeClient: String,
		BillingType: String,
		FiscalYear: 0,
		WorkLocation: String,
		DOB: 0001-01-01,
		Paperless: String,
		DisplayName: String,
		DisableLogin: String,
		RecurringInvoiceSettings: 
		{
			DonationAmount: String
		},
		FormFields: 
		[
			{
				Name: String,
				Value: String
			}
		],
		Attributes: 
		[
			{
				Name: String,
				Value: String
			}
		],
		GroupList: 
		[
			{
				GroupId: String
			}
		]
	},
	InvoiceCollection: 
	[
		{
			UniqueId: String,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			OpportunityId: String,
			InvoiceDueDate: 0001-01-01,
			Installments: 0,
			Frequency: 0,
			BhUserId: 0,
			Description: String,
			Deliver: False,
			CurrencyType: String,
			InvoiceItems: 
			[
				{
					ProductName: String,
					AmountDue: String,
					RevenueAccount: String
				}
			],
			InvoiceNo: 0,
			InvoiceAmt: 0,
			ExternalInvBatchNo: String,
			ExemptFromLateFee: False
		}
	],
	CcPaymentInfo: 
	{
		ClassName: String,
		UniqueId: String,
		CreatedDateTime: 0001-01-01,
		ClientId: 0,
		GroupId: String,
		UserId: String,
		BhUserId: 0,
		Amount: String,
		AutoPay: False,
		CurrencyType: String,
		Country: String,
		CardReferenceOrCardNumber: String,
		StoreCardInfo: False,
		Address1: String,
		Address2: String,
		BillingCity: String,
		BillingState: String,
		PreferredEmailAddress: String,
		Memo: String,
		OpportunityId: String,
		ExpMonth: 0,
		ExpYear: 0,
		Cvv: String,
		PostalCode: String,
		Location: String,
		NameOnCard: String,
		CardType: String,
		InvoiceList: 
		[
			{
				ClassName: String,
				UniqueId: String,
				CreatedDateTime: 0001-01-01,
				ClientId: 0,
				Invoice: 0,
				AmountPaid: String
			}
		]
	},
	CreditInfo: 
	{
		ClassName: String,
		UniqueId: String,
		CreatedDateTime: 0001-01-01,
		ClientId: 0,
		GroupId: String,
		UserId: String,
		BhUserId: 0,
		CreditId: 0,
		CurrencyType: String,
		CreditType: String,
		Notes: String,
		InvoiceDetails: 
		[
			{
				Invoice: 0,
				AmountPaid: 0,
				Region: String,
				CostCenter: String
			}
		]
	},
	AchPaymentInfo: 
	{
		ClassName: String,
		UniqueId: String,
		CreatedDateTime: 0001-01-01,
		ClientId: 0,
		GroupId: String,
		UserId: String,
		BhUserId: 0,
		Amount: 0,
		CurrencyType: String,
		Country: String,
		RoutingNumber: String,
		AccountNumber: String,
		AchReference: String,
		AccountType: String,
		IsSavingsAccount: False,
		PayerName: String,
		CheckNumber: String,
		PreferredEmailAddress: String,
		Memo: String,
		InvoiceList: 
		[
			{
				ClassName: String,
				UniqueId: String,
				CreatedDateTime: 0001-01-01,
				ClientId: 0,
				Invoice: 0,
				AmountPaid: String
			}
		],
		AutoPay: False,
		StoreAchInfo: False,
		EncryptionTypeId: 0
	},
	LockboxId: 0,
	MemberSubscriptionInvoiceId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	BillhighwayPaymentConfirmationNumber: String,
	BillhighwayUserId: 0,
	BhInvoiceBatchId: 
	[
		0
	],
	ChapMemPayid: 0,
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: True
}