Billhighway Cloud API

Smp

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

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


open class Smp
{
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:String? = null
    var UserId:Int? = null
    var AdminId:Int? = null
    var MemberInfo:Member? = null
    var CcPaymentInfo:CreditCardPayment? = null
    var AchPaymentInfo:AchPayment? = null
    var Subscription:Subscription? = null
    var BillMeLaterInfo:BillMeLaterInformation? = 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 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 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 Subscription
{
    var UniqueId:String? = null
    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 UserID:Int? = null
    var ChapMemPayID:Long? = null
    var Fields:ArrayList<SubscriberFormField> = ArrayList<SubscriberFormField>()
    var CreatedBy:Int? = null
    var UpdatedBy:Int? = null
    var RenewedMemberSubscriptionInvID:Long? = null
    var SubscriptionTypeId:String? = null
}

open class BillMeLaterInformation
{
    var IsBillMeLaterPayment:Boolean? = null
    var IsBillMeLaterSubscription:Boolean? = null
    var MemberSubscriptionInvId:Int? = null
    var Campaigns:ArrayList<CampaignInformation> = ArrayList<CampaignInformation>()
}

open class CampaignInformation
{
    var CampaignId:Int? = null
    var CampaignName:String? = null
    var Amount:BigDecimal? = null
    var ChapPayID:String? = null
}

open class SmpReply : IHaveErrorField
{
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var BillhighwayUserId:Int? = null
    var ConfirmationNumber:String? = null
    var PaymentConfirmationNumber:Long? = null
    var SubscriptionConfirmationNumber:Long? = null
    var ErrorCode:Int? = null
    var ErrorMessage:String? = null
    var IsError:Boolean? = null
}

Kotlin Smp DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":0,"AdminId":0,"MemberInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","Paperless":"String","DisplayName":"String","DisableLogin":"String","RecurringInvoiceSettings":{"DonationAmount":"String"},"FormFields":[{"Name":"String","Value":"String"}],"Attributes":[{"Name":"String","Value":"String"}],"GroupList":[{"GroupId":"String"}]},"CcPaymentInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}]},"AchPaymentInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","ClientId":0,"Invoice":0,"AmountPaid":"String"}],"AutoPay":false,"StoreAchInfo":false,"EncryptionTypeId":0},"Subscription":{"UniqueId":"String","FormTemplateID":0,"SubscriptionInvoiceID":0,"ClientSubscriberId":"String","SignupTypeID":0,"FrequencyID":0,"AutoRenew":false,"UserID":0,"ChapMemPayID":0,"Fields":[{"Name":"String","Value":"String"}],"CreatedBy":0,"UpdatedBy":0,"RenewedMemberSubscriptionInvID":0,"SubscriptionTypeId":"String"},"BillMeLaterInfo":{"IsBillMeLaterPayment":false,"IsBillMeLaterSubscription":false,"MemberSubscriptionInvId":0,"Campaigns":[{"CampaignId":0,"CampaignName":"String","Amount":0,"ChapPayID":"String"}]}}

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

{"UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"BillhighwayUserId":0,"ConfirmationNumber":"String","PaymentConfirmationNumber":0,"SubscriptionConfirmationNumber":0,"ErrorCode":0,"ErrorMessage":"String","IsError":false}