| POST | /SMP |
|---|
namespace BH.CloudAPI.Common.DTO
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type SmpReply() =
member val UniqueId:String = null with get,set
member val CreatedDateTime:DateTime = new DateTime() with get,set
member val ClientId:Int32 = new Int32() with get,set
member val BillhighwayUserId:Int32 = new Int32() with get,set
member val ConfirmationNumber:String = null with get,set
member val PaymentConfirmationNumber:Int64 = new Int64() with get,set
member val SubscriptionConfirmationNumber:Int64 = new Int64() with get,set
member val ErrorCode:Int32 = new Int32() with get,set
member val ErrorMessage:String = null with get,set
member val IsError:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type RecurringInvoiceSettings() =
member val DonationAmount:String = null with get,set
[<AllowNullLiteral>]
type SubscriberFormField() =
member val Name:String = null with get,set
member val Value:String = null with get,set
[<AllowNullLiteral>]
type AttributeItem() =
member val Name:String = null with get,set
member val Value:String = null with get,set
[<AllowNullLiteral>]
type Chapter() =
member val GroupId:String = null with get,set
[<AllowNullLiteral>]
type Member() =
member val ClassName:String = null with get,set
member val UniqueId:String = null with get,set
member val CreatedDateTime:DateTime = new DateTime() with get,set
member val ClientId:Int32 = new Int32() with get,set
member val GroupId:String = null with get,set
member val UserId:String = null with get,set
member val AlternateUserId:String = null with get,set
member val BhUserId:Int32 = new Int32() with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val MiddleName:String = null with get,set
member val PreferredEmailAddress:String = null with get,set
member val OtherEmailAddress:String = null with get,set
member val PreferredPhoneNumber:String = null with get,set
member val PreferredAddress1:String = null with get,set
member val PreferredAddress2:String = null with get,set
member val PreferredCity:String = null with get,set
member val PreferredState:String = null with get,set
member val PreferredZip:String = null with get,set
member val PreferredCountry:String = null with get,set
member val AccessLevel:String = null with get,set
member val MemberStatus:String = null with get,set
member val MemberTypeClient:String = null with get,set
member val BillingType:String = null with get,set
member val FiscalYear:Int32 = new Int32() with get,set
member val WorkLocation:String = null with get,set
member val DOB:DateTime = new DateTime() with get,set
member val Paperless:String = null with get,set
member val DisplayName:String = null with get,set
member val DisableLogin:String = null with get,set
member val RecurringInvoiceSettings:RecurringInvoiceSettings = null with get,set
member val FormFields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set
member val Attributes:ResizeArray<AttributeItem> = new ResizeArray<AttributeItem>() with get,set
member val GroupList:ResizeArray<Chapter> = new ResizeArray<Chapter>() with get,set
[<AllowNullLiteral>]
type SubscriptionParameters() =
member val FormTemplateID:Int32 = new Int32() with get,set
member val SubscriptionInvoiceID:Int32 = new Int32() with get,set
member val ClientSubscriberId:String = null with get,set
member val SignupTypeID:Int32 = new Int32() with get,set
member val FrequencyID:Int32 = new Int32() with get,set
member val AutoRenew:Boolean = new Boolean() with get,set
member val CompanyID:Int64 = new Int64() with get,set
member val UserID:Int32 = new Int32() with get,set
member val ChapMemPayID:Int64 = new Int64() with get,set
member val MemberSubscriptionInvID:Int64 = new Int64() with get,set
member val Fields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set
member val CreatedBy:Int32 = new Int32() with get,set
member val UpdatedBy:Int32 = new Int32() with get,set
member val AptifyUpdateType:Int32 = new Int32() with get,set
member val RenewedMemberSubscriptionInvID:Int64 = new Int64() with get,set
member val ChapId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type CreditCardPayment() =
inherit CreditCardPayment()
member val SubscriptionInfo:SubscriptionParameters = null with get,set
[<AllowNullLiteral>]
type SalesForceMemberPaymentInvoiceDetail() =
member val ClassName:String = null with get,set
member val UniqueId:String = null with get,set
member val CreatedDateTime:DateTime = new DateTime() with get,set
member val ClientId:Int32 = new Int32() with get,set
member val Invoice:Int32 = new Int32() with get,set
member val AmountPaid:String = null with get,set
[<AllowNullLiteral>]
type AchPayment() =
member val ClassName:String = null with get,set
member val UniqueId:String = null with get,set
member val CreatedDateTime:DateTime = new DateTime() with get,set
member val ClientId:Int32 = new Int32() with get,set
member val GroupId:String = null with get,set
member val UserId:String = null with get,set
member val BhUserId:Int32 = new Int32() with get,set
member val Amount:Decimal = new Decimal() with get,set
member val CurrencyType:String = null with get,set
member val Country:String = null with get,set
member val RoutingNumber:String = null with get,set
member val AccountNumber:String = null with get,set
member val AchReference:String = null with get,set
member val AccountType:String = null with get,set
member val IsSavingsAccount:Boolean = new Boolean() with get,set
member val PayerName:String = null with get,set
member val CheckNumber:String = null with get,set
member val PreferredEmailAddress:String = null with get,set
member val Memo:String = null with get,set
member val InvoiceList:ResizeArray<SalesForceMemberPaymentInvoiceDetail> = new ResizeArray<SalesForceMemberPaymentInvoiceDetail>() with get,set
member val AutoPay:Boolean = new Boolean() with get,set
member val StoreAchInfo:Boolean = new Boolean() with get,set
member val EncryptionTypeId:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type Subscription() =
member val UniqueId:String = null with get,set
member val FormTemplateID:Int32 = new Int32() with get,set
member val SubscriptionInvoiceID:Int32 = new Int32() with get,set
member val ClientSubscriberId:String = null with get,set
member val SignupTypeID:Int32 = new Int32() with get,set
member val FrequencyID:Int32 = new Int32() with get,set
member val AutoRenew:Boolean = new Boolean() with get,set
member val UserID:Int32 = new Int32() with get,set
member val ChapMemPayID:Int64 = new Int64() with get,set
member val Fields:ResizeArray<SubscriberFormField> = new ResizeArray<SubscriberFormField>() with get,set
member val CreatedBy:Int32 = new Int32() with get,set
member val UpdatedBy:Int32 = new Int32() with get,set
member val RenewedMemberSubscriptionInvID:Int64 = new Int64() with get,set
member val SubscriptionTypeId:String = null with get,set
[<AllowNullLiteral>]
type CampaignInformation() =
member val CampaignId:Int32 = new Int32() with get,set
member val CampaignName:String = null with get,set
member val Amount:Decimal = new Decimal() with get,set
member val ChapPayID:String = null with get,set
[<AllowNullLiteral>]
type BillMeLaterInformation() =
member val IsBillMeLaterPayment:Boolean = new Boolean() with get,set
member val IsBillMeLaterSubscription:Boolean = new Boolean() with get,set
member val MemberSubscriptionInvId:Int32 = new Int32() with get,set
member val Campaigns:ResizeArray<CampaignInformation> = new ResizeArray<CampaignInformation>() with get,set
[<AllowNullLiteral>]
type Smp() =
member val UniqueId:String = null with get,set
member val CreatedDateTime:DateTime = new DateTime() with get,set
member val ClientId:Int32 = new Int32() with get,set
member val GroupId:String = null with get,set
member val UserId:Int32 = new Int32() with get,set
member val AdminId:Int32 = new Int32() with get,set
member val MemberInfo:Member = null with get,set
member val CcPaymentInfo:CreditCardPayment = null with get,set
member val AchPaymentInfo:AchPayment = null with get,set
member val Subscription:Subscription = null with get,set
member val BillMeLaterInfo:BillMeLaterInformation = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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}