Billhighway Cloud API

<back to all web services

SalesForcePmi

The following routes are available for this service:
POST/api/SalesForce/PMI
SalesForcePmi Parameters:
NameParameterData TypeRequiredDescription
ClassNamebodystringNo
UniqueIdbodystringNo
CreatedDateTimebodyDateTimeNo
ClientIdbodyintNo
GroupIdbodyintNo
MemberInfobodySalesForceMemberNo
InvoiceCollectionbodyList<SalesForceInvoice>No
CcPaymentInfobodySalesForceCreditCardPaymentNo
CreditInfobodySalesForceCreateApplyCreditNo
AchPaymentInfobodyAchPaymentNo
LockboxIdbodylongNo
SalesForceMember Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
AlternateUserIdformstringNo
BhUserIdformintNo
FirstNameformstringNo
LastNameformstringNo
MiddleNameformstringNo
PreferredEmailAddressformstringNo
OtherEmailAddressformstringNo
PreferredPhoneNumberformstringNo
PreferredAddress1formstringNo
PreferredAddress2formstringNo
PreferredCityformstringNo
PreferredStateformstringNo
PreferredZipformstringNo
PreferredCountryformstringNo
AccessLevelformstringNo
MemberStatusformstringNo
MemberTypeClientformstringNo
BillingTypeformstringNo
FiscalYearformintNo
WorkLocationformstringNo
DOBformDateTimeNo
PaperlessformstringNo
DisplayNameformstringNo
DisableLoginformstringNo
RecurringInvoiceSettingsformRecurringInvoiceSettingsNo
FormFieldsformList<SubscriberFormField>No
AttributesformList<AttributeItem>No
GroupListformList<Chapter>No
RecurringInvoiceSettings Parameters:
NameParameterData TypeRequiredDescription
DonationAmountformstringNo
SubscriberFormField Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
AttributeItem Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformstringNo
Chapter Parameters:
NameParameterData TypeRequiredDescription
GroupIdformstringNo
SalesForceInvoice Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
OpportunityIdformstringNo
InvoiceDueDateformDateTimeNo
InstallmentsformintNo
FrequencyformintNo
BhUserIdformintNo
DescriptionformstringNo
DeliverformboolNo
CurrencyTypeformstringNo
InvoiceItemsformList<SalesForceInvoiceItem>No
InvoiceNoformintNo
InvoiceAmtformdecimalNo
SalesForceInvoiceItem Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
ProductNameformstringNo
AmountDueformstringNo
ProductTypeformstringNo
ActPatternTypeIdformintNo
TermStartDateformDateTimeNo
TermEndDateformDateTimeNo
RecognitionPeriodformintNo
RevenueAccountformstringNo
AccountsReceivableAccountformstringNo
LiabilityAccountformstringNo
CreditExpenseAccountformstringNo
InvoiceClearingAccountformstringNo
CostCenterformstringNo
RegionformstringNo
SalesForceCreditCardPayment Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
BhUserIdformintNo
AmountformstringNo
AutoPayformboolNo
CurrencyTypeformstringNo
CountryformstringNo
CardReferenceOrCardNumberformstringNo
StoreCardInfoformboolNo
Address1formstringNo
Address2formstringNo
BillingCityformstringNo
BillingStateformstringNo
PreferredEmailAddressformstringNo
MemoformstringNo
OpportunityIdformstringNo
ExpMonthformintNo
ExpYearformintNo
CvvformstringNo
PostalCodeformstringNo
LocationformstringNo
NameOnCardformstringNo
CardTypeformstringNo
InvoiceListformList<SalesForceMemberPaymentInvoiceDetail>No
SalesForceMemberPaymentInvoiceDetail Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
InvoiceformintNo
AmountPaidformstringNo
SalesForceCreateApplyCredit Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
BhUserIdformintNo
CreditIdformintNo
CurrencyTypeformstringNo
CreditTypeformstringNo
NotesformstringNo
InvoiceDetailsformList<SalesForceCreditInvoiceDetails>No
SalesForceCreditInvoiceDetails Parameters:
NameParameterData TypeRequiredDescription
InvoiceformlongNo
AmountPaidformdecimalNo
RegionformstringNo
CostCenterformstringNo
AchPayment Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
GroupIdformstringNo
UserIdformstringNo
BhUserIdformintNo
AmountformdecimalNo
CurrencyTypeformstringNo
CountryformstringNo
RoutingNumberformstringNo
AccountNumberformstringNo
AchReferenceformstringNo
AccountTypeformstringNo
IsSavingsAccountformboolNo
PayerNameformstringNo
CheckNumberformstringNo
PreferredEmailAddressformstringNo
MemoformstringNo
InvoiceListformList<SalesForceMemberPaymentInvoiceDetail>No
AutoPayformboolNo
StoreAchInfoformboolNo
EncryptionTypeIdformintNo
SalesForcePmiReply Parameters:
NameParameterData TypeRequiredDescription
ClassNameformstringNo
UniqueIdformstringNo
CreatedDateTimeformDateTimeNo
ClientIdformintNo
BillhighwayPaymentConfirmationNumberformstringNo
BillhighwayUserIdformintNo
BhInvoiceBatchIdformList<int>No
ChapMemPayidformlongNo
ErrorCodeformintNo
ErrorMessageformstringNo
IsErrorformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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}],"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: application/json
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}