Billhighway Cloud API

SalesForcePmi

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


export class SalesForcePmiReply implements IHaveErrorField
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public BillhighwayPaymentConfirmationNumber?: string;
    public BillhighwayUserId?: number;
    public BhInvoiceBatchId?: number[];
    public ChapMemPayid?: number;
    public ErrorCode?: number;
    public ErrorMessage?: string;
    public IsError?: boolean;

    public constructor(init?: Partial<SalesForcePmiReply>) { (Object as any).assign(this, init); }
}

export class RecurringInvoiceSettings
{
    public DonationAmount?: string;

    public constructor(init?: Partial<RecurringInvoiceSettings>) { (Object as any).assign(this, init); }
}

export class SubscriberFormField
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<SubscriberFormField>) { (Object as any).assign(this, init); }
}

export class AttributeItem
{
    public Name?: string;
    public Value?: string;

    public constructor(init?: Partial<AttributeItem>) { (Object as any).assign(this, init); }
}

export class Chapter
{
    public GroupId?: string;

    public constructor(init?: Partial<Chapter>) { (Object as any).assign(this, init); }
}

export class SalesForceMember
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public AlternateUserId?: string;
    public BhUserId?: number;
    public FirstName?: string;
    public LastName?: string;
    public MiddleName?: string;
    public PreferredEmailAddress?: string;
    public OtherEmailAddress?: string;
    public PreferredPhoneNumber?: string;
    public PreferredAddress1?: string;
    public PreferredAddress2?: string;
    public PreferredCity?: string;
    public PreferredState?: string;
    public PreferredZip?: string;
    public PreferredCountry?: string;
    public AccessLevel?: string;
    public MemberStatus?: string;
    public MemberTypeClient?: string;
    public BillingType?: string;
    public FiscalYear?: number;
    public WorkLocation?: string;
    public DOB?: string;
    public Paperless?: string;
    public DisplayName?: string;
    public DisableLogin?: string;
    public RecurringInvoiceSettings?: RecurringInvoiceSettings;
    public FormFields?: SubscriberFormField[];
    public Attributes?: AttributeItem[];
    public GroupList?: Chapter[];

    public constructor(init?: Partial<SalesForceMember>) { (Object as any).assign(this, init); }
}

export class SalesForceInvoiceItem
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public ProductName?: string;
    public AmountDue?: string;
    public ProductType?: string;
    public ActPatternTypeId?: number;
    public TermStartDate?: string;
    public TermEndDate?: string;
    public RecognitionPeriod?: number;
    public RevenueAccount?: string;
    public AccountsReceivableAccount?: string;
    public LiabilityAccount?: string;
    public CreditExpenseAccount?: string;
    public InvoiceClearingAccount?: string;
    public CostCenter?: string;
    public Region?: string;

    public constructor(init?: Partial<SalesForceInvoiceItem>) { (Object as any).assign(this, init); }
}

export class SalesForceInvoice
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public OpportunityId?: string;
    public InvoiceDueDate?: string;
    public Installments?: number;
    public Frequency?: number;
    public BhUserId?: number;
    public Description?: string;
    public Deliver?: boolean;
    public CurrencyType?: string;
    public InvoiceItems?: SalesForceInvoiceItem[];
    public InvoiceNo?: number;
    public InvoiceAmt?: number;
    public ExternalInvBatchNo?: string;
    public ExemptFromLateFee?: boolean;

    public constructor(init?: Partial<SalesForceInvoice>) { (Object as any).assign(this, init); }
}

export class SalesForceMemberPaymentInvoiceDetail
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public Invoice?: number;
    public AmountPaid?: string;

    public constructor(init?: Partial<SalesForceMemberPaymentInvoiceDetail>) { (Object as any).assign(this, init); }
}

export class SalesForceCreditCardPayment
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public Amount?: string;
    public AutoPay?: boolean;
    public CurrencyType?: string;
    public Country?: string;
    public CardReferenceOrCardNumber?: string;
    public StoreCardInfo?: boolean;
    public Address1?: string;
    public Address2?: string;
    public BillingCity?: string;
    public BillingState?: string;
    public PreferredEmailAddress?: string;
    public Memo?: string;
    public OpportunityId?: string;
    public ExpMonth?: number;
    public ExpYear?: number;
    public Cvv?: string;
    public PostalCode?: string;
    public Location?: string;
    public NameOnCard?: string;
    public CardType?: string;
    public InvoiceList?: SalesForceMemberPaymentInvoiceDetail[];

    public constructor(init?: Partial<SalesForceCreditCardPayment>) { (Object as any).assign(this, init); }
}

export class SalesForceCreditInvoiceDetails
{
    public Invoice?: number;
    public AmountPaid?: number;
    public Region?: string;
    public CostCenter?: string;

    public constructor(init?: Partial<SalesForceCreditInvoiceDetails>) { (Object as any).assign(this, init); }
}

export class SalesForceCreateApplyCredit
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public CreditId?: number;
    public CurrencyType?: string;
    public CreditType?: string;
    public Notes?: string;
    public InvoiceDetails?: SalesForceCreditInvoiceDetails[];

    public constructor(init?: Partial<SalesForceCreateApplyCredit>) { (Object as any).assign(this, init); }
}

export class AchPayment
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: string;
    public UserId?: string;
    public BhUserId?: number;
    public Amount?: number;
    public CurrencyType?: string;
    public Country?: string;
    public RoutingNumber?: string;
    public AccountNumber?: string;
    public AchReference?: string;
    public AccountType?: string;
    public IsSavingsAccount?: boolean;
    public PayerName?: string;
    public CheckNumber?: string;
    public PreferredEmailAddress?: string;
    public Memo?: string;
    public InvoiceList?: SalesForceMemberPaymentInvoiceDetail[];
    public AutoPay?: boolean;
    public StoreAchInfo?: boolean;
    public EncryptionTypeId?: number;

    public constructor(init?: Partial<AchPayment>) { (Object as any).assign(this, init); }
}

export class SalesForcePmi
{
    public ClassName?: string;
    public UniqueId?: string;
    public CreatedDateTime?: string;
    public ClientId?: number;
    public GroupId?: number;
    public MemberInfo?: SalesForceMember;
    public InvoiceCollection?: SalesForceInvoice[];
    public CcPaymentInfo?: SalesForceCreditCardPayment;
    public CreditInfo?: SalesForceCreateApplyCredit;
    public AchPaymentInfo?: AchPayment;
    public LockboxId?: number;

    public constructor(init?: Partial<SalesForcePmi>) { (Object as any).assign(this, init); }
}

TypeScript SalesForcePmi 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 /api/SalesForce/PMI HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SalesForcePmi 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>
  <ClassName>String</ClassName>
  <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>
    <SalesForceInvoice>
      <BhUserId>0</BhUserId>
      <ClassName>String</ClassName>
      <ClientId>0</ClientId>
      <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
      <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>
        <SalesForceInvoiceItem>
          <AccountsReceivableAccount>String</AccountsReceivableAccount>
          <ActPatternTypeId>0</ActPatternTypeId>
          <AmountDue>String</AmountDue>
          <ClassName>String</ClassName>
          <ClientId>0</ClientId>
          <CostCenter>String</CostCenter>
          <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
          <CreditExpenseAccount>String</CreditExpenseAccount>
          <InvoiceClearingAccount>String</InvoiceClearingAccount>
          <LiabilityAccount>String</LiabilityAccount>
          <ProductName>String</ProductName>
          <ProductType>String</ProductType>
          <RecognitionPeriod>0</RecognitionPeriod>
          <Region>String</Region>
          <RevenueAccount>String</RevenueAccount>
          <TermEndDate>0001-01-01T00:00:00</TermEndDate>
          <TermStartDate>0001-01-01T00:00:00</TermStartDate>
          <UniqueId>String</UniqueId>
        </SalesForceInvoiceItem>
      </InvoiceItems>
      <InvoiceNo>0</InvoiceNo>
      <OpportunityId>String</OpportunityId>
      <UniqueId>String</UniqueId>
      <UserId>String</UserId>
    </SalesForceInvoice>
  </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>
  <UniqueId>String</UniqueId>
</SalesForcePmi>

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

<SalesForcePmiReply 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>
  <ClassName>String</ClassName>
  <ClientId>0</ClientId>
  <CreatedDateTime>0001-01-01T00:00:00</CreatedDateTime>
  <ErrorCode>0</ErrorCode>
  <ErrorMessage>String</ErrorMessage>
  <UniqueId>String</UniqueId>
</SalesForcePmiReply>