Billhighway Cloud API

Smp

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SmpReply(IHaveErrorField):
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    billhighway_user_id: Optional[int] = None
    confirmation_number: Optional[str] = None
    payment_confirmation_number: Optional[int] = None
    subscription_confirmation_number: Optional[int] = None
    error_code: Optional[int] = None
    error_message: Optional[str] = None
    is_error: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringInvoiceSettings:
    donation_amount: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriberFormField:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AttributeItem:
    name: Optional[str] = None
    value: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Chapter:
    group_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Member:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    alternate_user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    middle_name: Optional[str] = None
    preferred_email_address: Optional[str] = None
    other_email_address: Optional[str] = None
    preferred_phone_number: Optional[str] = None
    preferred_address1: Optional[str] = None
    preferred_address2: Optional[str] = None
    preferred_city: Optional[str] = None
    preferred_state: Optional[str] = None
    preferred_zip: Optional[str] = None
    preferred_country: Optional[str] = None
    access_level: Optional[str] = None
    member_status: Optional[str] = None
    member_type_client: Optional[str] = None
    billing_type: Optional[str] = None
    fiscal_year: Optional[int] = None
    work_location: Optional[str] = None
    dob: Optional[datetime.datetime] = None
    paperless: Optional[str] = None
    display_name: Optional[str] = None
    disable_login: Optional[str] = None
    recurring_invoice_settings: Optional[RecurringInvoiceSettings] = None
    form_fields: Optional[List[SubscriberFormField]] = None
    attributes: Optional[List[AttributeItem]] = None
    group_list: Optional[List[Chapter]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubscriptionParameters:
    form_template_i_d: Optional[int] = None
    subscription_invoice_i_d: Optional[int] = None
    client_subscriber_id: Optional[str] = None
    signup_type_i_d: Optional[int] = None
    frequency_i_d: Optional[int] = None
    auto_renew: Optional[bool] = None
    company_i_d: Optional[int] = None
    user_i_d: Optional[int] = None
    chap_mem_pay_i_d: Optional[int] = None
    member_subscription_inv_i_d: Optional[int] = None
    fields: Optional[List[SubscriberFormField]] = None
    created_by: Optional[int] = None
    updated_by: Optional[int] = None
    aptify_update_type: Optional[int] = None
    renewed_member_subscription_inv_i_d: Optional[int] = None
    chap_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreditCardPayment(CreditCardPayment):
    subscription_info: Optional[SubscriptionParameters] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesForceMemberPaymentInvoiceDetail:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    invoice: Optional[int] = None
    amount_paid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AchPayment:
    class_name: Optional[str] = None
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[str] = None
    bh_user_id: Optional[int] = None
    amount: Optional[Decimal] = None
    currency_type: Optional[str] = None
    country: Optional[str] = None
    routing_number: Optional[str] = None
    account_number: Optional[str] = None
    ach_reference: Optional[str] = None
    account_type: Optional[str] = None
    is_savings_account: Optional[bool] = None
    payer_name: Optional[str] = None
    check_number: Optional[str] = None
    preferred_email_address: Optional[str] = None
    memo: Optional[str] = None
    invoice_list: Optional[List[SalesForceMemberPaymentInvoiceDetail]] = None
    auto_pay: Optional[bool] = None
    store_ach_info: Optional[bool] = None
    encryption_type_id: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Subscription:
    unique_id: Optional[str] = None
    form_template_i_d: Optional[int] = None
    subscription_invoice_i_d: Optional[int] = None
    client_subscriber_id: Optional[str] = None
    signup_type_i_d: Optional[int] = None
    frequency_i_d: Optional[int] = None
    auto_renew: Optional[bool] = None
    user_i_d: Optional[int] = None
    chap_mem_pay_i_d: Optional[int] = None
    fields: Optional[List[SubscriberFormField]] = None
    created_by: Optional[int] = None
    updated_by: Optional[int] = None
    renewed_member_subscription_inv_i_d: Optional[int] = None
    subscription_type_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignInformation:
    campaign_id: Optional[int] = None
    campaign_name: Optional[str] = None
    amount: Optional[Decimal] = None
    chap_pay_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillMeLaterInformation:
    is_bill_me_later_payment: Optional[bool] = None
    is_bill_me_later_subscription: Optional[bool] = None
    member_subscription_inv_id: Optional[int] = None
    campaigns: Optional[List[CampaignInformation]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Smp:
    unique_id: Optional[str] = None
    created_date_time: Optional[datetime.datetime] = None
    client_id: Optional[int] = None
    group_id: Optional[str] = None
    user_id: Optional[int] = None
    admin_id: Optional[int] = None
    member_info: Optional[Member] = None
    cc_payment_info: Optional[CreditCardPayment] = None
    ach_payment_info: Optional[AchPayment] = None
    subscription: Optional[Subscription] = None
    bill_me_later_info: Optional[BillMeLaterInformation] = None

Python Smp 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 /SMP 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: String,
	UserId: 0,
	AdminId: 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
			}
		]
	},
	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
			}
		]
	},
	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
	},
	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/jsv
Content-Length: length

{
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	BillhighwayUserId: 0,
	ConfirmationNumber: String,
	PaymentConfirmationNumber: 0,
	SubscriptionConfirmationNumber: 0,
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: False
}