Billhighway Cloud API

Pmi

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

**Pmi** Parameters:
Name	Parameter	Data Type	Required
UniqueId	body	string	No
CreatedDateTime	body	DateTime	No
ClientId	body	int	No
GroupId	body	int	No
MemberInfo	body	Member	No
InvoiceCollection	body	List<Invoice>	No
CcPaymentInfo	body	CreditCardPayment	No
CreditInfo	body	CreateApplyCredit	No
AchPaymentInfo	body	AchPayment	No
LockboxId	body	long	No
MemberSubscriptionInvoiceId	body	long	No

**Member** Parameters:
Name	Parameter	Data Type	Required
ClassName	form	string	No
UniqueId	form	string	No
CreatedDateTime	form	DateTime	No
ClientId	form	int	No
GroupId	form	string	No
UserId	form	string	No
AlternateUserId	form	string	No
BhUserId	form	int	No
FirstName	form	string	No
LastName	form	string	No
MiddleName	form	string	No
PreferredEmailAddress	form	string	No
OtherEmailAddress	form	string	No
PreferredPhoneNumber	form	string	No
PreferredAddress1	form	string	No
PreferredAddress2	form	string	No
PreferredCity	form	string	No
PreferredState	form	string	No
PreferredZip	form	string	No
PreferredCountry	form	string	No
AccessLevel	form	string	No
MemberStatus	form	string	No
MemberTypeClient	form	string	No
BillingType	form	string	No
FiscalYear	form	int	No
WorkLocation	form	string	No
DOB	form	DateTime	No
Paperless	form	string	No
DisplayName	form	string	No
DisableLogin	form	string	No
RecurringInvoiceSettings	form	RecurringInvoiceSettings	No
FormFields	form	List<SubscriberFormField>	No
Attributes	form	List<AttributeItem>	No
GroupList	form	List<Chapter>	No

**RecurringInvoiceSettings** Parameters:
Name	Parameter	Data Type	Required	Description
DonationAmount	form	string	No

**SubscriberFormField** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**AttributeItem** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	No
Value	form	string	No

**Chapter** Parameters:
Name	Parameter	Data Type	Required	Description
GroupId	form	string	No

**Invoice** Parameters:
Name	Parameter	Data Type	Required
UniqueId	form	string	No
ClientId	form	int	No
GroupId	form	string	No
Description	form	string	No
OpportunityId	form	string	No
Installments	form	int	No
Frequency	form	int	No
InvoiceDueDate	form	DateTime	No
Deliver	form	bool	No
UserId	form	string	No
BhUserId	form	int	No
CurrencyType	form	string	No
InvoiceItems	form	List<InvoiceItem>	No
InvoiceNo	form	int	No
InvoiceAmt	form	decimal	No

**InvoiceItem** Parameters:
Name	Parameter	Data Type	Required
UniqueId	form	string	No
ProductName	form	string	No
AmountDue	form	decimal	No
ProductType	form	string	No
ActPatternTypeID	form	int	No
TermStartDate	form	DateTime	No
TermEndDate	form	DateTime	No
RecognitionPeriod	form	int	No
RevenueAccount	form	string	No
AccountsReceivableAccount	form	string	No
LiabilityAccount	form	string	No
CreditExpenseAccount	form	string	No
InvoiceClearingAccount	form	string	No
CostCenter	form	string	No
Region	form	string	No

**CreditCardPayment** Parameters:
Name	Parameter	Data Type	Required	Description
SubscriptionInfo	form	SubscriptionParameters	No

**SubscriptionParameters** Parameters:
Name	Parameter	Data Type	Required
FormTemplateID	form	int	No
SubscriptionInvoiceID	form	int	No
ClientSubscriberId	form	string	No
SignupTypeID	form	int	No
FrequencyID	form	int	No
AutoRenew	form	bool	No
CompanyID	form	long	No
UserID	form	int	No
ChapMemPayID	form	long	No
MemberSubscriptionInvID	form	long	No
Fields	form	List<SubscriberFormField>	No
CreatedBy	form	int	No
UpdatedBy	form	int	No
AptifyUpdateType	form	int	No
RenewedMemberSubscriptionInvID	form	long	No
ChapId	form	int	No

**CreateApplyCredit** Parameters:
Name	Parameter	Data Type	Required
ClassName	form	string	No
UniqueId	form	string	No
CreatedDateTime	form	DateTime	No
ClientId	form	int	No
GroupId	form	string	No
UserId	form	string	No
BhUserId	form	int	No
CreditId	form	int	No
CurrencyType	form	string	No
CreditType	form	string	No
Notes	form	string	No
InvoiceDetails	form	List<SalesForceCreditInvoiceDetails>	No

**SalesForceCreditInvoiceDetails** Parameters:
Name	Parameter	Data Type	Required
Invoice	form	long	No
AmountPaid	form	decimal	No
Region	form	string	No
CostCenter	form	string	No

**AchPayment** Parameters:
Name	Parameter	Data Type	Required
ClassName	form	string	No
UniqueId	form	string	No
CreatedDateTime	form	DateTime	No
ClientId	form	int	No
GroupId	form	string	No
UserId	form	string	No
BhUserId	form	int	No
Amount	form	decimal	No
CurrencyType	form	string	No
Country	form	string	No
RoutingNumber	form	string	No
AccountNumber	form	string	No
AchReference	form	string	No
AccountType	form	string	No
IsSavingsAccount	form	bool	No
PayerName	form	string	No
CheckNumber	form	string	No
PreferredEmailAddress	form	string	No
Memo	form	string	No
InvoiceList	form	List<SalesForceMemberPaymentInvoiceDetail>	No
AutoPay	form	bool	No
StoreAchInfo	form	bool	No
EncryptionTypeId	form	int	No

**SalesForceMemberPaymentInvoiceDetail** Parameters:
Name	Parameter	Data Type	Required
ClassName	form	string	No
UniqueId	form	string	No
CreatedDateTime	form	DateTime	No
ClientId	form	int	No
Invoice	form	int	No
AmountPaid	form	string	No

**PmiReply** Parameters:
Name	Parameter	Data Type	Required
UniqueId	form	string	No
CreatedDateTime	form	DateTime	No
ClientId	form	int	No
BillhighwayPaymentConfirmationNumber	form	string	No
BillhighwayUserId	form	int	No
BhInvoiceBatchId	form	List<int>	No
ChapMemPayid	form	long	No
ErrorCode	form	int	No
ErrorMessage	form	string	No
IsError	form	bool	No

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