| POST | /PMI |
|---|
import Foundation
import ServiceStack
public class Pmi : Codable
{
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var groupId:Int?
public var memberInfo:Member?
public var invoiceCollection:[Invoice] = []
public var ccPaymentInfo:CreditCardPayment?
public var creditInfo:CreateApplyCredit?
public var achPaymentInfo:AchPayment?
public var lockboxId:Int?
public var memberSubscriptionInvoiceId:Int?
required public init(){}
}
public class Member : Codable
{
public var className:String?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var groupId:String?
public var userId:String?
public var alternateUserId:String?
public var bhUserId:Int?
public var firstName:String?
public var lastName:String?
public var middleName:String?
public var preferredEmailAddress:String?
public var otherEmailAddress:String?
public var preferredPhoneNumber:String?
public var preferredAddress1:String?
public var preferredAddress2:String?
public var preferredCity:String?
public var preferredState:String?
public var preferredZip:String?
public var preferredCountry:String?
public var accessLevel:String?
public var memberStatus:String?
public var memberTypeClient:String?
public var billingType:String?
public var fiscalYear:Int?
public var workLocation:String?
public var dob:Date?
public var paperless:String?
public var displayName:String?
public var disableLogin:String?
public var recurringInvoiceSettings:RecurringInvoiceSettings?
public var formFields:[SubscriberFormField] = []
public var attributes:[AttributeItem] = []
public var groupList:[Chapter] = []
required public init(){}
}
public class RecurringInvoiceSettings : Codable
{
public var donationAmount:String?
required public init(){}
}
public class SubscriberFormField : Codable
{
public var name:String?
public var value:String?
required public init(){}
}
public class AttributeItem : Codable
{
public var name:String?
public var value:String?
required public init(){}
}
public class Chapter : Codable
{
public var groupId:String?
required public init(){}
}
public class Invoice : IInvoiceValidation, Codable
{
public var uniqueId:String?
public var clientId:Int?
public var groupId:String?
public var Description:String?
public var opportunityId:String?
public var installments:Int?
public var frequency:Int?
public var invoiceDueDate:Date?
public var deliver:Bool?
public var userId:String?
public var bhUserId:Int?
public var currencyType:String?
public var invoiceItems:[InvoiceItem] = []
public var invoiceNo:Int?
public var invoiceAmt:Double?
public var externalInvBatchNo:String?
public var exemptFromLateFee:Bool?
required public init(){}
}
public class InvoiceItem : IInvoiceItemValidation, Codable
{
public var uniqueId:String?
public var productName:String?
public var amountDue:Double?
public var productType:String?
public var actPatternTypeID:Int?
public var termStartDate:Date?
public var termEndDate:Date?
public var recognitionPeriod:Int?
public var revenueAccount:String?
public var accountsReceivableAccount:String?
public var liabilityAccount:String?
public var creditExpenseAccount:String?
public var invoiceClearingAccount:String?
public var costCenter:String?
public var region:String?
required public init(){}
}
public class CreditCardPayment : CreditCardPayment
{
public var subscriptionInfo:SubscriptionParameters?
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case subscriptionInfo
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
subscriptionInfo = try container.decodeIfPresent(SubscriptionParameters.self, forKey: .subscriptionInfo)
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if subscriptionInfo != nil { try container.encode(subscriptionInfo, forKey: .subscriptionInfo) }
}
}
public class SubscriptionParameters : Codable
{
public var formTemplateID:Int?
public var subscriptionInvoiceID:Int?
public var clientSubscriberId:String?
public var signupTypeID:Int?
public var frequencyID:Int?
public var autoRenew:Bool?
public var companyID:Int?
public var userID:Int?
public var chapMemPayID:Int?
public var memberSubscriptionInvID:Int?
public var fields:[SubscriberFormField] = []
public var createdBy:Int?
public var updatedBy:Int?
public var aptifyUpdateType:Int?
public var renewedMemberSubscriptionInvID:Int?
public var chapId:Int?
required public init(){}
}
public class CreateApplyCredit : Codable
{
public var className:String?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var groupId:String?
public var userId:String?
public var bhUserId:Int?
public var creditId:Int?
public var currencyType:String?
public var creditType:String?
public var notes:String?
public var invoiceDetails:[SalesForceCreditInvoiceDetails] = []
required public init(){}
}
public class SalesForceCreditInvoiceDetails : Codable
{
public var invoice:Int?
public var amountPaid:Double?
public var region:String?
public var costCenter:String?
required public init(){}
}
public class AchPayment : Codable
{
public var className:String?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var groupId:String?
public var userId:String?
public var bhUserId:Int?
public var amount:Double?
public var currencyType:String?
public var country:String?
public var routingNumber:String?
public var accountNumber:String?
public var achReference:String?
public var accountType:String?
public var isSavingsAccount:Bool?
public var payerName:String?
public var checkNumber:String?
public var preferredEmailAddress:String?
public var memo:String?
public var invoiceList:[SalesForceMemberPaymentInvoiceDetail] = []
public var autoPay:Bool?
public var storeAchInfo:Bool?
public var encryptionTypeId:Int?
required public init(){}
}
public class SalesForceMemberPaymentInvoiceDetail : Codable
{
public var className:String?
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var invoice:Int?
public var amountPaid:String?
required public init(){}
}
public class PmiReply : IHaveErrorField, Codable
{
public var uniqueId:String?
public var createdDateTime:Date?
public var clientId:Int?
public var billhighwayPaymentConfirmationNumber:String?
public var billhighwayUserId:Int?
public var bhInvoiceBatchId:[Int] = []
public var chapMemPayid:Int?
public var errorCode:Int?
public var errorMessage:String?
public var isError:Bool?
required public 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
}