ObjectStructure

From Intrannuity Merchant Services

Field Names : Type, isRequired , isCreateOnly , isReadOnly , Definition

CustomerAccount						Represents a party (person or organization) making/responsible for invoicing, payments, plans in the system.
	code	String		true	true	The code used to uniquely identify the account.
	createDate	Date	true	true	true	The create date of account
	name	String	true			Name
	type	String	true			Type of the account.
	isActive	Boolean	true			If false, account has no active payment option or payment plans.
	homePhone	String				Home phone number.
	workPhone	String				Work phone number/contact number if organization.
	cellPhone	String				Cell phone number.
	email	String				Contact e-mail.
	street	String				Street of the address.
	city	String				City of the address.
	state	String				State of the address.
	zipCode	String				Zip code of the address.
	balance	Integer			true	Current balance on the account.
	beneficiaryInfo	String				Buyer's information (if somebody else is responsible for payments). Contains full name and contact info
	merchantAccountCode	Integer	true	true	true	The code identifying merchant
	customerAccountGroup	String				Predefined classification code for this account (to simplify searching/reporting).
	isAccountVerified	Boolean			true	Not Used. Reserved for future use.
	notes	String				Any notes associated with the account.
	lastUpdateDate	Date			true	Last time the account was updated.
	birthDate	Date				If person - date of birth, not used otherwise.
PaymentOption						Represents a form of payment that can be used in recurring billing process. Two forms of payments are available - Credit Card (CC) and Bank Account (EFT/ACH)
	code	String		true	true	The code used to uniquely identify the payment option.
	createDate	Date	true	true	true	The create date of payment option
	isActive	Boolean	true			Indicates if the payment option is active for billing
	holderName	String				Name of the card or bank account holder
	number	String	true	true	true	Credit Card's/Bank Account's number
	accessory	String	true	true	true	Expiration Date (MMYY) for Credit Card; Routing number for Bank Account
	street	String				Street of billing address
	city	String				City of billing address
	state	String				State of billing address
	zipCode	String				Zip code of billing address
	type	String		true	true	Type of payment option
	merchantAccountCode	Integer	true	true	true	The code identifying merchant
	lastUpdateDate	Date			true	Date when the payment option was last updated
CaptureInfo						Represents electronic processor related info. Used for credit card and ACH processing transactions.
	accountNumber	String	true	true	true	Credit card number if credit card; bank account number if bank account.
	accessory	String	true	true	true	Expiration date (MMyy) if credit card; routing number if bank account.
	requestDate	Date	true	true	true	Date when the request was sent to processor.
	responseDate	Date			true	Date when the response from the processor was received.
	holderName	String	true	true	true	Name on the credit card or bank account's holder's name.
	taxAmount	Integer			true	Tax amount if available (part of total amount).
	street	String			true	Street of the billing address.
	city	String			true	City of the billing address.
	state	String			true	State (two-letter code) of the billing address.
	phone	String			true	Phone of the billing address.
	zipCode	String			true	ZipCode of the billing address
	email	String			true	E-mail associated with holder of the card/bank account.
	type	String			true	Type of the transaction.
	approvalCode	String			true	Approval reference code generated by the processor in case of successful authorization (credit card only).
	referenceNumber	String			true	Reference number of the transaction represented by this CaptureInfo in the processor's system (used to issue same-day voids).
	merchantAccountCode	Integer	true		true	The code identifying merchant
	cvv2	String		true	true	Security code on the back of a credit card (credit card only).
	trackData	String		true	true	Copy of the data from credit card's magnetic tape (credit card only).
PaymentPlan						Represents a series of future payments that should be executed on the specified schedule using defined Payment Option. All future payments are encoded using Charge objects (see Charge) for more information
	code	String		true	true	The code used to uniquely identify the payment plan.
	createDate	Date	true	true	true	The create date of Plan
	lastInvoicingDate	Date			true	The date when the invoice for this plan was last created
	lastProcessingDate	Date			true	The date when this plan was processed by Invoicing Service for the last time
	sellerCode	String				Optional code identifying the plan's seller in the external system
	length	Integer	true		true	Current length of the payment plan (for perpetual and complimentary plans, the length will be derived from the forecasting period (see FAQ)
	value	Integer			true	Length multiplied by amount
	deferredLength	Integer			true	current total length of deferred charges or freezes included in the plan
	deferredValue	Integer			true	deferredLength multiplied by amount
	amount	Integer	true	true		Amount of a single payment represented by the plan
	groupCode1	String				optional group code for external systems
	groupCode2	String				optional group code for external systems
	groupCode3	String				optional group code for external systems
	groupCode4	String				optional group code for external systems
	groupCode5	String				optional group code for external systems
	groupCode6	String				optional group code for external systems
	groupCode7	String				optional group code for external systems
	groupCode8	String				optional group code for external systems
	merchantAccountCode	Integer	true	true	true	The code identifying merchant
	type	String			true	Type of the payment plan.
	firstBillingDate	Date			true	The date when first invoice is expected to be created
	billingCycleCode	String	true	true	true	code specified the billing cycle.
	itemCode	String				optional item code; tax code can be derived from it.
	taxCode	String				optional tax code defining tax amount.
	lastUpdateDate	Date			true	the date when this plan was updated for the last time
RevenueTransaction						A type of AccountTransaction that represents sales (revenue) on the account. Invoice, Fee, Credit and Reversal are main examples of RevenueTransaction.
	merchantAccountCode	Integer	true	true	true	The code identifying merchant
	accountActivityType	String	true	true	true	The type of transaction
	code	String		true	true	The code used to uniquely identify the revenue transaction.
	amount	Integer	true	true	true	Initial (fixed) amount of the transaction.
	balance	Integer	true	true	true	Current balance of the transaction.
	note	String				Optional text note (description).
	createDate	Date	true	true	true	The create date of Transaction
	creatorCode	String				Optional free-hand code, can be used to identify creator of the transaction (usually in external client system).
	sellerCode	String				Optional free-hand code, can be used to identify seller associated with the transaction (usually in external client system).
	shiftCode	String				Optional free-hand code, can be used to identify POS shift that generated this transaction (usually in external client system).
	terminalCode	String				Optional free-hand code, can be used to identify POS terminal that generated this transaction (usually in external client system).
	dueDate	Date				Date when the transaction becomes effective (applied to CustomerAccount).
	taxAmount	Integer		true	true	Amount of the tax (part of amount).
	itemCode	String				optional item code for classification purposes.
	isComplimantary	Boolean		true	true	indicates whether this invoice was created to reflect complimentary value vs actual request for payment
AssetTransaction
	merchantAccountCode	Integer	true	true	true	The code identifying merchant
	accountActivityType	String	true	true	true	The type of transaction
	code	String		true	true	The code used to uniquely identify the revenue transaction.
	amount	Integer	true	true	true	Initial (fixed) amount of the transaction.
	balance	Integer	true	true	true	Current balance of the transaction.
	note	String				Optional text note (description).
	createDate	Date	true	true	true	The create date of Transaction
	creatorCode	String				Optional free-hand code, can be used to identify creator of the transaction (usually in external client system).
	sellerCode	String				Optional free-hand code, can be used to identify seller associated with the transaction (usually in external client system).
	shiftCode	String				Optional free-hand code, can be used to identify POS shift that generated this transaction (usually in external client system).
	terminalCode	String				Optional free-hand code, can be used to identify POS terminal that generated this transaction (usually in external client system).
	transactionType	String				Type of AssetTransaction, e.g. Cash, Visa, Checking
	isPrepayment	Boolean				If true, this transaction was created as a prepayment against charge (future invoice).
	accountNumber	String	true	true	true	For credit card related transactions - number on the card, For bank account related transactions - number of the account, For check related transactions - check number, Not used otherwise.
	accessory	String	true	true	true	For credit card related transactions - expiration date - MMyy, For bank account related transactions - routing number, Not used otherwise.