Billhighway Cloud API

<back to all web services

SalesForcePmi

The following routes are available for this service:
POST/api/SalesForce/PMI
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BH.CloudAPI.Common4.DTO.SalesForce;
using BH.CloudAPI.Common.DTO.Member;
using BH.CloudAPI.Common4.DTO;
using BH.CloudAPI.Common.DTO;

namespace BH.CloudAPI.Common.DTO
{
    public partial class Chapter
    {
        public virtual string GroupId { get; set; }
    }

}

namespace BH.CloudAPI.Common.DTO.Member
{
    public partial class RecurringInvoiceSettings
    {
        public virtual string DonationAmount { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO
{
    public partial class AttributeItem
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

}

namespace BH.CloudAPI.Common4.DTO.SalesForce
{
    public partial class AchPayment
    {
        public AchPayment()
        {
            InvoiceList = new List<SalesForceMemberPaymentInvoiceDetail>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual decimal Amount { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual string Country { get; set; }
        public virtual string RoutingNumber { get; set; }
        public virtual string AccountNumber { get; set; }
        public virtual string AchReference { get; set; }
        public virtual string AccountType { get; set; }
        public virtual bool IsSavingsAccount { get; set; }
        public virtual string PayerName { get; set; }
        public virtual string CheckNumber { get; set; }
        public virtual string PreferredEmailAddress { get; set; }
        public virtual string Memo { get; set; }
        public virtual List<SalesForceMemberPaymentInvoiceDetail> InvoiceList { get; set; }
        public virtual bool AutoPay { get; set; }
        public virtual bool StoreAchInfo { get; set; }
        public virtual int EncryptionTypeId { get; set; }
    }

    public partial class SalesForceCreateApplyCredit
    {
        public SalesForceCreateApplyCredit()
        {
            InvoiceDetails = new List<SalesForceCreditInvoiceDetails>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual int CreditId { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual string CreditType { get; set; }
        public virtual string Notes { get; set; }
        public virtual List<SalesForceCreditInvoiceDetails> InvoiceDetails { get; set; }
    }

    public partial class SalesForceCreditCardPayment
    {
        public SalesForceCreditCardPayment()
        {
            InvoiceList = new List<SalesForceMemberPaymentInvoiceDetail>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual string Amount { get; set; }
        public virtual bool AutoPay { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual string Country { get; set; }
        public virtual string CardReferenceOrCardNumber { get; set; }
        public virtual bool StoreCardInfo { get; set; }
        public virtual string Address1 { get; set; }
        public virtual string Address2 { get; set; }
        public virtual string BillingCity { get; set; }
        public virtual string BillingState { get; set; }
        public virtual string PreferredEmailAddress { get; set; }
        public virtual string Memo { get; set; }
        public virtual string OpportunityId { get; set; }
        public virtual int ExpMonth { get; set; }
        public virtual int ExpYear { get; set; }
        public virtual string Cvv { get; set; }
        public virtual string PostalCode { get; set; }
        public virtual string Location { get; set; }
        public virtual string NameOnCard { get; set; }
        public virtual string CardType { get; set; }
        public virtual List<SalesForceMemberPaymentInvoiceDetail> InvoiceList { get; set; }
    }

    public partial class SalesForceCreditInvoiceDetails
    {
        public virtual long Invoice { get; set; }
        public virtual decimal AmountPaid { get; set; }
        public virtual string Region { get; set; }
        public virtual string CostCenter { get; set; }
    }

    public partial class SalesForceInvoice
    {
        public SalesForceInvoice()
        {
            InvoiceItems = new List<SalesForceInvoiceItem>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual string OpportunityId { get; set; }
        public virtual DateTime InvoiceDueDate { get; set; }
        public virtual int Installments { get; set; }
        public virtual int Frequency { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual string Description { get; set; }
        public virtual bool Deliver { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual List<SalesForceInvoiceItem> InvoiceItems { get; set; }
        public virtual int InvoiceNo { get; set; }
        public virtual decimal InvoiceAmt { get; set; }
        public virtual string ExternalInvBatchNo { get; set; }
        public virtual bool ExemptFromLateFee { get; set; }
    }

    public partial class SalesForceInvoiceItem
    {
        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string ProductName { get; set; }
        public virtual string AmountDue { get; set; }
        public virtual string ProductType { get; set; }
        public virtual int ActPatternTypeId { get; set; }
        public virtual DateTime TermStartDate { get; set; }
        public virtual DateTime TermEndDate { get; set; }
        public virtual int RecognitionPeriod { get; set; }
        public virtual string RevenueAccount { get; set; }
        public virtual string AccountsReceivableAccount { get; set; }
        public virtual string LiabilityAccount { get; set; }
        public virtual string CreditExpenseAccount { get; set; }
        public virtual string InvoiceClearingAccount { get; set; }
        public virtual string CostCenter { get; set; }
        public virtual string Region { get; set; }
    }

    public partial class SalesForceMember
    {
        public SalesForceMember()
        {
            FormFields = new List<SubscriberFormField>{};
            Attributes = new List<AttributeItem>{};
            GroupList = new List<Chapter>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string UserId { get; set; }
        public virtual string AlternateUserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string MiddleName { get; set; }
        public virtual string PreferredEmailAddress { get; set; }
        public virtual string OtherEmailAddress { get; set; }
        public virtual string PreferredPhoneNumber { get; set; }
        public virtual string PreferredAddress1 { get; set; }
        public virtual string PreferredAddress2 { get; set; }
        public virtual string PreferredCity { get; set; }
        public virtual string PreferredState { get; set; }
        public virtual string PreferredZip { get; set; }
        public virtual string PreferredCountry { get; set; }
        public virtual string AccessLevel { get; set; }
        public virtual string MemberStatus { get; set; }
        public virtual string MemberTypeClient { get; set; }
        public virtual string BillingType { get; set; }
        public virtual int FiscalYear { get; set; }
        public virtual string WorkLocation { get; set; }
        public virtual DateTime DOB { get; set; }
        public virtual string Paperless { get; set; }
        public virtual string DisplayName { get; set; }
        public virtual string DisableLogin { get; set; }
        public virtual RecurringInvoiceSettings RecurringInvoiceSettings { get; set; }
        public virtual List<SubscriberFormField> FormFields { get; set; }
        public virtual List<AttributeItem> Attributes { get; set; }
        public virtual List<Chapter> GroupList { get; set; }
    }

    public partial class SalesForceMemberPaymentInvoiceDetail
    {
        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual int Invoice { get; set; }
        public virtual string AmountPaid { get; set; }
    }

    public partial class SalesForcePmi
    {
        public SalesForcePmi()
        {
            InvoiceCollection = new List<SalesForceInvoice>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual int GroupId { get; set; }
        public virtual SalesForceMember MemberInfo { get; set; }
        public virtual List<SalesForceInvoice> InvoiceCollection { get; set; }
        public virtual SalesForceCreditCardPayment CcPaymentInfo { get; set; }
        public virtual SalesForceCreateApplyCredit CreditInfo { get; set; }
        public virtual AchPayment AchPaymentInfo { get; set; }
        public virtual long LockboxId { get; set; }
    }

    public partial class SalesForcePmiReply
        : IHaveErrorField
    {
        public SalesForcePmiReply()
        {
            BhInvoiceBatchId = new List<int>{};
        }

        public virtual string ClassName { get; set; }
        public virtual string UniqueId { get; set; }
        public virtual DateTime CreatedDateTime { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string BillhighwayPaymentConfirmationNumber { get; set; }
        public virtual int BillhighwayUserId { get; set; }
        public virtual List<int> BhInvoiceBatchId { get; set; }
        public virtual long ChapMemPayid { get; set; }
        public virtual int ErrorCode { get; set; }
        public virtual string ErrorMessage { get; set; }
        public virtual bool IsError { get; set; }
    }

    public partial class SubscriberFormField
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

}

C# SalesForcePmi 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 /api/SalesForce/PMI HTTP/1.1 
Host: devapi.billhighway.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ClassName: String,
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	GroupId: 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
			}
		]
	},
	InvoiceCollection: 
	[
		{
			ClassName: String,
			UniqueId: String,
			CreatedDateTime: 0001-01-01,
			ClientId: 0,
			GroupId: String,
			UserId: String,
			OpportunityId: String,
			InvoiceDueDate: 0001-01-01,
			Installments: 0,
			Frequency: 0,
			BhUserId: 0,
			Description: String,
			Deliver: False,
			CurrencyType: String,
			InvoiceItems: 
			[
				{
					ClassName: String,
					UniqueId: String,
					CreatedDateTime: 0001-01-01,
					ClientId: 0,
					ProductName: String,
					AmountDue: String,
					ProductType: String,
					ActPatternTypeId: 0,
					TermStartDate: 0001-01-01,
					TermEndDate: 0001-01-01,
					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-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
			}
		]
	},
	CreditInfo: 
	{
		ClassName: String,
		UniqueId: String,
		CreatedDateTime: 0001-01-01,
		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-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
	},
	LockboxId: 0
}

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

{
	ClassName: String,
	UniqueId: String,
	CreatedDateTime: 0001-01-01,
	ClientId: 0,
	BillhighwayPaymentConfirmationNumber: String,
	BillhighwayUserId: 0,
	BhInvoiceBatchId: 
	[
		0
	],
	ChapMemPayid: 0,
	ErrorCode: 0,
	ErrorMessage: String,
	IsError: True
}