Billhighway Cloud API

Pmi

The following routes are available for this service:
POST	/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; }
    }

    public partial class Invoice
        : IInvoiceValidation
    {
        public Invoice()
        {
            InvoiceItems = new List<InvoiceItem>{};
        }

        public virtual string UniqueId { get; set; }
        public virtual int ClientId { get; set; }
        public virtual string GroupId { get; set; }
        public virtual string Description { get; set; }
        public virtual string OpportunityId { get; set; }
        public virtual int Installments { get; set; }
        public virtual int Frequency { get; set; }
        public virtual DateTime InvoiceDueDate { get; set; }
        public virtual bool Deliver { get; set; }
        public virtual string UserId { get; set; }
        public virtual int BhUserId { get; set; }
        public virtual string CurrencyType { get; set; }
        public virtual List<InvoiceItem> 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 InvoiceItem
        : IInvoiceItemValidation
    {
        public virtual string UniqueId { get; set; }
        public virtual string ProductName { get; set; }
        public virtual decimal 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; }
    }

}

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; }
    }

    public partial class CreditCardPayment
        : CreditCardPayment
    {
        public virtual SubscriptionParameters SubscriptionInfo { 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 CreateApplyCredit
    {
        public CreateApplyCredit()
        {
            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 Member
    {
        public Member()
        {
            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 Pmi
    {
        public Pmi()
        {
            InvoiceCollection = new List<Invoice>{};
        }

        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 Member MemberInfo { get; set; }
        public virtual List<Invoice> InvoiceCollection { get; set; }
        public virtual CreditCardPayment CcPaymentInfo { get; set; }
        public virtual CreateApplyCredit CreditInfo { get; set; }
        public virtual AchPayment AchPaymentInfo { get; set; }
        public virtual long LockboxId { get; set; }
        public virtual long MemberSubscriptionInvoiceId { get; set; }
    }

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

        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 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 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 SubscriberFormField
    {
        public virtual string Name { get; set; }
        public virtual string Value { get; set; }
    }

    public partial class SubscriptionParameters
    {
        public SubscriptionParameters()
        {
            Fields = new List<SubscriberFormField>{};
        }

        public virtual int FormTemplateID { get; set; }
        public virtual int SubscriptionInvoiceID { get; set; }
        public virtual string ClientSubscriberId { get; set; }
        public virtual int SignupTypeID { get; set; }
        public virtual int FrequencyID { get; set; }
        public virtual bool AutoRenew { get; set; }
        public virtual long CompanyID { get; set; }
        public virtual int UserID { get; set; }
        public virtual long ChapMemPayID { get; set; }
        public virtual long MemberSubscriptionInvID { get; set; }
        public virtual List<SubscriberFormField> Fields { get; set; }
        public virtual int CreatedBy { get; set; }
        public virtual int UpdatedBy { get; set; }
        public virtual int AptifyUpdateType { get; set; }
        public virtual long RenewedMemberSubscriptionInvID { get; set; }
        public virtual int ChapId { get; set; }
    }

}

C# Pmi DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /PMI HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Pmi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <AchPaymentInfo>
    <AccountNumber>String</AccountNumber>
    <AccountType>String</AccountType>
    <AchReference>String</AchReference>
    <Amount>0</Amount>
    <AutoPay>false</AutoPay>
    <BhUserId>0</BhUserId>
    <CheckNumber>String</CheckNumber>
    <ClassName>String</ClassName>
    <ClientId>0</ClientId>
    <Country>String</Country>
    <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
    <CurrencyType>String</CurrencyType>
    <EncryptionTypeId>0</EncryptionTypeId>
    <GroupId>String</GroupId>
    <InvoiceList>
      <SalesForceMemberPaymentInvoiceDetail>
        <AmountPaid>String</AmountPaid>
        <ClassName>String</ClassName>
        <ClientId>0</ClientId>
        <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
        <Invoice>0</Invoice>
        <UniqueId>String</UniqueId>
      </SalesForceMemberPaymentInvoiceDetail>
    </InvoiceList>
    <Memo>String</Memo>
    <PayerName>String</PayerName>
    <PreferredEmailAddress>String</PreferredEmailAddress>
    <RoutingNumber>String</RoutingNumber>
    <StoreAchInfo>false</StoreAchInfo>
    <UniqueId>String</UniqueId>
    <UserId>String</UserId>
  </AchPaymentInfo>
  <CcPaymentInfo>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <Amount>String</Amount>
    <AutoPay>false</AutoPay>
    <BhUserId>0</BhUserId>
    <BillingCity>String</BillingCity>
    <BillingState>String</BillingState>
    <CardReferenceOrCardNumber>String</CardReferenceOrCardNumber>
    <CardType>String</CardType>
    <ClassName>String</ClassName>
    <ClientId>0</ClientId>
    <Country>String</Country>
    <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
    <CurrencyType>String</CurrencyType>
    <Cvv>String</Cvv>
    <ExpMonth>0</ExpMonth>
    <ExpYear>0</ExpYear>
    <GroupId>String</GroupId>
    <InvoiceList>
      <SalesForceMemberPaymentInvoiceDetail>
        <AmountPaid>String</AmountPaid>
        <ClassName>String</ClassName>
        <ClientId>0</ClientId>
        <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
        <Invoice>0</Invoice>
        <UniqueId>String</UniqueId>
      </SalesForceMemberPaymentInvoiceDetail>
    </InvoiceList>
    <Location>String</Location>
    <Memo>String</Memo>
    <NameOnCard>String</NameOnCard>
    <OpportunityId>String</OpportunityId>
    <PostalCode>String</PostalCode>
    <PreferredEmailAddress>String</PreferredEmailAddress>
    <StoreCardInfo>false</StoreCardInfo>
    <UniqueId>String</UniqueId>
    <UserId>String</UserId>
  </CcPaymentInfo>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <CreditInfo>
    <BhUserId>0</BhUserId>
    <ClassName>String</ClassName>
    <ClientId>0</ClientId>
    <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
    <CreditId>0</CreditId>
    <CreditType>String</CreditType>
    <CurrencyType>String</CurrencyType>
    <GroupId>String</GroupId>
    <InvoiceDetails>
      <SalesForceCreditInvoiceDetails>
        <AmountPaid>0</AmountPaid>
        <CostCenter>String</CostCenter>
        <Invoice>0</Invoice>
        <Region>String</Region>
      </SalesForceCreditInvoiceDetails>
    </InvoiceDetails>
    <Notes>String</Notes>
    <UniqueId>String</UniqueId>
    <UserId>String</UserId>
  </CreditInfo>
  <GroupId>0</GroupId>
  <InvoiceCollection>
    <Invoice>
      <BhUserId>0</BhUserId>
      <ClientId>0</ClientId>
      <CurrencyType>String</CurrencyType>
      <Deliver>false</Deliver>
      <Description>String</Description>
      <ExemptFromLateFee>false</ExemptFromLateFee>
      <ExternalInvBatchNo>String</ExternalInvBatchNo>
      <Frequency>0</Frequency>
      <GroupId>String</GroupId>
      <Installments>0</Installments>
      <InvoiceAmt>0</InvoiceAmt>
      <InvoiceDueDate>0001-01-01T00:00:00</InvoiceDueDate>
      <InvoiceItems>
        <InvoiceItem>
          <AmountDue>String</AmountDue>
          <ProductName>String</ProductName>
          <RevenueAccount>String</RevenueAccount>
        </InvoiceItem>
      </InvoiceItems>
      <InvoiceNo>0</InvoiceNo>
      <OpportunityId>String</OpportunityId>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </Invoice>
  </InvoiceCollection>
  <LockboxId>0</LockboxId>
  <MemberInfo>
    <AccessLevel>String</AccessLevel>
    <AlternateUserId>String</AlternateUserId>
    <Attributes xmlns:d3p1="https://www.billhighway.com/api">
      <d3p1:AttributeItem>
        <d3p1:Name>String</d3p1:Name>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:AttributeItem>
    </Attributes>
    <BhUserId>0</BhUserId>
    <BillingType>String</BillingType>
    <ClassName>String</ClassName>
    <ClientId>0</ClientId>
    <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
    <DOB>0001-01-01T00:00:00</DOB>
    <DisableLogin>String</DisableLogin>
    <DisplayName>String</DisplayName>
    <FirstName>String</FirstName>
    <FiscalYear>0</FiscalYear>
    <FormFields>
      <SubscriberFormField>
        <_x003C_Name_x003E_k__BackingField>String</_x003C_Name_x003E_k__BackingField>
        <_x003C_Value_x003E_k__BackingField>String</_x003C_Value_x003E_k__BackingField>
      </SubscriberFormField>
    </FormFields>
    <GroupId>String</GroupId>
    <GroupList xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
      <d3p1:Chapter>
        <d3p1:GroupId>String</d3p1:GroupId>
      </d3p1:Chapter>
    </GroupList>
    <LastName>String</LastName>
    <MemberStatus>String</MemberStatus>
    <MemberTypeClient>String</MemberTypeClient>
    <MiddleName>String</MiddleName>
    <OtherEmailAddress>String</OtherEmailAddress>
    <Paperless>String</Paperless>
    <PreferredAddress1>String</PreferredAddress1>
    <PreferredAddress2>String</PreferredAddress2>
    <PreferredCity>String</PreferredCity>
    <PreferredCountry>String</PreferredCountry>
    <PreferredEmailAddress>String</PreferredEmailAddress>
    <PreferredPhoneNumber>String</PreferredPhoneNumber>
    <PreferredState>String</PreferredState>
    <PreferredZip>String</PreferredZip>
    <RecurringInvoiceSettings xmlns:d3p1="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO.Member">
      <d3p1:DonationAmount>String</d3p1:DonationAmount>
    </RecurringInvoiceSettings>
    <UniqueId>String</UniqueId>
    <UserId>String</UserId>
    <WorkLocation>String</WorkLocation>
  </MemberInfo>
  <MemberSubscriptionInvoiceId>0</MemberSubscriptionInvoiceId>
  <UniqueId>String</UniqueId>
</Pmi>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PmiReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common4.DTO.SalesForce">
  <BhInvoiceBatchId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </BhInvoiceBatchId>
  <BillhighwayPaymentConfirmationNumber>String</BillhighwayPaymentConfirmationNumber>
  <BillhighwayUserId>0</BillhighwayUserId>
  <ChapMemPayid>0</ChapMemPayid>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <UniqueId>String</UniqueId>
</PmiReply>