Billhighway Cloud API

<back to all web services

SalesForcePmi

The following routes are available for this service:
POST/api/SalesForce/PMI
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SalesForcePmi
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var GroupId:Int? = null
    var MemberInfo:SalesForceMember? = null
    var InvoiceCollection:ArrayList<SalesForceInvoice> = ArrayList<SalesForceInvoice>()
    var CcPaymentInfo:SalesForceCreditCardPayment? = null
    var CreditInfo:SalesForceCreateApplyCredit? = null
    var AchPaymentInfo:AchPayment? = null
    var LockboxId:Long? = null
}

open class SalesForceMember
{
    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 SalesForceInvoice
{
    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 OpportunityId:String? = null
    var InvoiceDueDate:Date? = null
    var Installments:Int? = null
    var Frequency:Int? = null
    var BhUserId:Int? = null
    var Description:String? = null
    var Deliver:Boolean? = null
    var CurrencyType:String? = null
    var InvoiceItems:ArrayList<SalesForceInvoiceItem> = ArrayList<SalesForceInvoiceItem>()
    var InvoiceNo:Int? = null
    var InvoiceAmt:BigDecimal? = null
    var ExternalInvBatchNo:String? = null
    var ExemptFromLateFee:Boolean? = null
}

open class SalesForceInvoiceItem
{
    var ClassName:String? = null
    var UniqueId:String? = null
    var CreatedDateTime:Date? = null
    var ClientId:Int? = null
    var ProductName:String? = null
    var AmountDue:String? = 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 SalesForceCreditCardPayment
{
    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:String? = null
    var AutoPay:Boolean? = null
    var CurrencyType:String? = null
    var Country:String? = null
    var CardReferenceOrCardNumber:String? = null
    var StoreCardInfo:Boolean? = null
    var Address1:String? = null
    var Address2:String? = null
    var BillingCity:String? = null
    var BillingState:String? = null
    var PreferredEmailAddress:String? = null
    var Memo:String? = null
    var OpportunityId:String? = null
    var ExpMonth:Int? = null
    var ExpYear:Int? = null
    var Cvv:String? = null
    var PostalCode:String? = null
    var Location:String? = null
    var NameOnCard:String? = null
    var CardType:String? = null
    var InvoiceList:ArrayList<SalesForceMemberPaymentInvoiceDetail> = ArrayList<SalesForceMemberPaymentInvoiceDetail>()
}

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 SalesForceCreateApplyCredit
{
    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 SalesForcePmiReply : IHaveErrorField
{
    var ClassName:String? = null
    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 SalesForcePmi 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 /api/SalesForce/PMI HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":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"}]},"InvoiceCollection":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"GroupId":"String","UserId":"String","OpportunityId":"String","InvoiceDueDate":"0001-01-01T00:00:00.0000000","Installments":0,"Frequency":0,"BhUserId":0,"Description":"String","Deliver":false,"CurrencyType":"String","InvoiceItems":[{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"ProductName":"String","AmountDue":"String","ProductType":"String","ActPatternTypeId":0,"TermStartDate":"0001-01-01T00:00:00.0000000","TermEndDate":"0001-01-01T00:00:00.0000000","RecognitionPeriod":0,"RevenueAccount":"String","AccountsReceivableAccount":"String","LiabilityAccount":"String","CreditExpenseAccount":"String","InvoiceClearingAccount":"String","CostCenter":"String","Region":"String"}],"InvoiceNo":0,"InvoiceAmt":0,"ExternalInvBatchNo":"String","ExemptFromLateFee":false}],"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"}]},"CreditInfo":{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","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-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},"LockboxId":0}

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

{"ClassName":"String","UniqueId":"String","CreatedDateTime":"0001-01-01T00:00:00.0000000","ClientId":0,"BillhighwayPaymentConfirmationNumber":"String","BillhighwayUserId":0,"BhInvoiceBatchId":[0],"ChapMemPayid":0,"ErrorCode":0,"ErrorMessage":"String","IsError":true}