| POST | /PMI |
|---|
export class PmiReply implements IHaveErrorField
{
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<PmiReply>) { (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 Member
{
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<Member>) { (Object as any).assign(this, init); }
}
export class InvoiceItem implements IInvoiceItemValidation
{
public UniqueId?: string;
public ProductName?: string;
public AmountDue?: number;
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<InvoiceItem>) { (Object as any).assign(this, init); }
}
export class Invoice implements IInvoiceValidation
{
public UniqueId?: string;
public ClientId?: number;
public GroupId?: string;
public Description?: string;
public OpportunityId?: string;
public Installments?: number;
public Frequency?: number;
public InvoiceDueDate?: string;
public Deliver?: boolean;
public UserId?: string;
public BhUserId?: number;
public CurrencyType?: string;
public InvoiceItems?: InvoiceItem[];
public InvoiceNo?: number;
public InvoiceAmt?: number;
public ExternalInvBatchNo?: string;
public ExemptFromLateFee?: boolean;
public constructor(init?: Partial<Invoice>) { (Object as any).assign(this, init); }
}
export class SubscriptionParameters
{
public FormTemplateID?: number;
public SubscriptionInvoiceID?: number;
public ClientSubscriberId?: string;
public SignupTypeID?: number;
public FrequencyID?: number;
public AutoRenew?: boolean;
public CompanyID?: number;
public UserID?: number;
public ChapMemPayID?: number;
public MemberSubscriptionInvID?: number;
public Fields?: SubscriberFormField[];
public CreatedBy?: number;
public UpdatedBy?: number;
public AptifyUpdateType?: number;
public RenewedMemberSubscriptionInvID?: number;
public ChapId?: number;
public constructor(init?: Partial<SubscriptionParameters>) { (Object as any).assign(this, init); }
}
export class CreditCardPayment extends CreditCardPayment
{
public SubscriptionInfo?: SubscriptionParameters;
public constructor(init?: Partial<CreditCardPayment>) { super(init); (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 CreateApplyCredit
{
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<CreateApplyCredit>) { (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 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 Pmi
{
public UniqueId?: string;
public CreatedDateTime?: string;
public ClientId?: number;
public GroupId?: number;
public MemberInfo?: Member;
public InvoiceCollection?: Invoice[];
public CcPaymentInfo?: CreditCardPayment;
public CreditInfo?: CreateApplyCredit;
public AchPaymentInfo?: AchPayment;
public LockboxId?: number;
public MemberSubscriptionInvoiceId?: number;
public constructor(init?: Partial<Pmi>) { (Object as any).assign(this, init); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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:
[
{
UniqueId: String,
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:
[
{
ProductName: String,
AmountDue: String,
RevenueAccount: 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,
MemberSubscriptionInvoiceId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
UniqueId: String,
CreatedDateTime: 0001-01-01,
ClientId: 0,
BillhighwayPaymentConfirmationNumber: String,
BillhighwayUserId: 0,
BhInvoiceBatchId:
[
0
],
ChapMemPayid: 0,
ErrorCode: 0,
ErrorMessage: String,
IsError: True
}