Root element for client requests Represents request for search of CustomerAccounts Represents request for search of PaymentOptions Represents request for search of PaymentPlans Represents request for search of AccountTransactions (Asset or Revenue) Presence of this element implies save operation (of the defined CustomerAccount) Intrannuity assigned Merchant Code (value divisible by 1000) Password assigned to the merchant's account Root element for server responses In case of find operations, if nothing is found, the response object will be empty In case of save operation, represents the server representation of the persisted object. In case of find request, represents (multiple occurences possible) all objects that matched the criteria Represents (multiple occurences possible) all objects that matched the search criteria Represents (multiple occurences possible) all objects that matched the search criteria Represents (multiple occurences possible) all objects that matched the search criteria Represents (multiple occurences possible) all objects that matched the search criteria Root element for server responses when server-side error occurs Represents merchant account code Reresents a date, the format is yyyymmdd Abstract class for objects that represent CustomerAccount relatedfinancial activity. For example, invoice, payment, paper statement are all types of AccountActivity accountActivityType: Type of activity, e.g. invoice, payment customerAccount: Reference to the CustomerAccount affected by this activity. Enumerates possible types of AccountActivity. Invoice: Request for payment from CustomerAccount. Credit: Reversal (usually partial) of an existing invoice. Reversal: Full reversal of an existing invoice. Fee: Request for payment of a Fee (usually due to billing Decline). Payment: Payment from the party represented by a CustomerAccount. Void: Full reversal of an existing payment. Refund: Reversal (usually partial) of an existing payment. Claim: Request for payment generated by Invoicing process Should not be used increation of new object (reserved for server). Decline: Reversal of payment due to decline (CC or ACH). Chargeback: Reversal of payment due to chargeback (CC or late ACH). Statement: Represents paper statement generate as a request for payment.

Represents financial transaction posted to CustomerAccount. All financialtransaction have fixed amount, carry balance and affect CustomerAccount'soverall balance. Examples of AccountTransaction are payment, invoice, credit,refund.

Invoice, Void and Refund - increase CustomerAccount balance
Payment, Credit and Reversal - decrease CustomerAccount balance

 amount: Initial (fixed) amount of the transaction. balance: Current balance of the transaction. note: Optional text note (description). creatorCode: Optional free-hand code, can be used to identify creator of thetransaction (usually in external client system). sellerCode: Optional free-hand code, can be used to identify seller associated withthe transaction (usually in external client system). shiftCode: Optional free-hand code, can be used to identify POS shift that generatedthis transaction (usually in external client system). terminalCode: Optional free-hand code, can be used to identify POS terminal thatgenerated this transaction (usually in external client system). taxAmount: Amount of the tax (part of amount). dueDate: Date when the transaction becomes effective (applied to CustomerAccount).Before the due date, iBilling's balancing process will not apply anybalance on the transaction adjustmentTransaction: Reference to a transaction that reversed this transaction. Normally,Invoice or Fee can be reversed with Reversal, Payment or Claim with Voidor Decline Represents a change made to a PaymentPlan. Adjustment captures the reasonbehind the changes.

The following changes are possible:

  • Amount - changes billing amount of the plan
  • PaymentOption - changes payment option used for electronic billing
  • BillingCycle - changes date when invoices are generated
  • Cancellation - cancels some or all charges within a plan
  • Add - adds new billing charges to a plan
  • Freeze - adds new freeze (skip-billing) charges to a plan
 notes: Textual description of the adjustment reasons. adjustmentReasonCode: Predefined code explaining the reason for the changes. customerAccount: Reference to CustomerAccount that owns the plans affected by the change. A type of AccountTransaction that represents movement of money (assets) onthe account. Payment, Void and Refund are main examples of AssetTransaction. Store transaction processing information for CC/EFT transactions transactionType: Type of AssetTransaction, e.g. Cash, Visa, Checking isPrepayment: If true, this transaction was created as a prepayment against charge(future invoice). accountNumber: For credit card related transactions - number on the card
For bankaccount related transactions - number of the account
For checkrelated transactions - check number
Not used otherwise.
 accessory: For credit card related transactions - expiration date - MMyy
Forbank account related transactions - routing number
Not usedotherwise.
 maskedAccountNumber: For credit card related transactions - masked number on the card e.g.5******3452
For bank account related transactions - masked numberof the account e.g. C******4435
For check related transactions -check number
Not used otherwise.
 maskedAccessory: For credit card related transactions - expiration date - MMyy
Forbank account related transactions - masked routing number e.g. ***6675
Not used otherwise.
 captureInfo: Reference to the object representing processing related info. Onlyavailable when transaction is of electronic type (credit card or ACH) Defines possible sources of money for an AssetTransaction. Cash: Cash. Check: Check. Allowance: Discount (waiver). Represents electronic processor related info. Used for credit card and ACHprocessing transactions. requestDate: Date when the request was sent to processor. responseDate: Date when the response from the processor was received. holderName: Name on the credit card or bank account's holder's name. taxAmount: Tax amount if available (part of total amount). street: Street of the billing address. city: City of the billing address. state: State (two-letter code) of the billing address. phone: Phone of the billing address. zipCode: ZipCode of the billing address. email: E-mail associated with holder of the card/bank account. returnType: Code defining response type generated by the processor. approvalCode: Approval reference code generated by the processor in case of successfulauthorization (credit card only). referenceNumber: Reference number of the transaction represented by this CaptureInfo inthe processor's system (used to issue same-day voids). accountNumber: Credit card number if credit card; bank account number if bank account. accessory: Expiration date (MMyy) if credit card; routing number if bank account. transactionType: Type of the transaction. cvv2: Security code on the back of a credit card (credit card only). trackData: Copy of the data from credit card's magnetic tape (credit card only). Represents a future invoice within a PaymentPlan. Each time when billing isprocessed (Invoicing processing is executed) a charge is processed. Fixed andPerpetual charges are converted into invoices. Complimentary charges areconverted into invoices that are immediately balanced out with allowances.Freezes and Deferment produce no invoices. processedDate: Date when the charge was processed by the invoicing process. isPrepaid: If true, payment was taken against this charge. This doesn't guaranteethat the invoice created from this charge will be automatically paid type: TYpe of charge. index: Sequential number of the charge within PaymentPlan. 0 indicates that thecharge will be processed in the next billing process, 1 - the one afterthe next and so on paymentPlan: Reference to the PaymentPlan holding the charges. Enumerates possible types of Charges. Deferred: No invoice is generated when invoicing is run; unlike freeze, can only beused before any invoice is generated from the plan. Usually used to delaybilling after the initial sale Freeze: No invoice is generated when invoicing is run, skip-billing. The Interface ClaimType. Statement: The Statement. Prepayment: The Prepayment. Decline: The Decline. Complimentary: The Complimentary. Base class for all classes representing business entities within the library. id: System generated identifier. createDate: Date the transaction was created. code: User assigned identifier. (if not specified, id is used) merchantAccountCode: Merchant account code. Represents a party (person or organization) making/responsible for invoicing,payments, plans in the system. firstName: If person - first name, not used otherwise. lastName: If person - last name, if organization - organization's name. middleName: If person - middle name, not used otherwise. title: If person - title, not used otherwise. suffix: If person - suffix, not used otherwise. type: Type of the account. isActive: If false, account has no active payment option or payment plans. homePhone: Home phone number. workPhone: Work phone number/contact number if organization. cellPhone: Cell phone number. email: Contact e-mail. street1: Street1 of the address. street2: Street2 of the address. city: City of the address. state: State of the address. zipCode: Zip code of the address. balance: Current balance on the account. beneficiaryInfo: Buyer's information (if somebody else is responsible for payments).Contains full name and contact info customerAccountGroupCode: Predefined classification code for this account (to simplifysearching/reporting). isVerified: Not Used. Reserved for future use. notes: Any notes associated with the account. lastUpdateDate: Last time the account was updated. birthDate: If person - date of birth, not used otherwise. Enumerates possible CustomerAccount types. Male: Male. Female: Female. Organization: Organization. The Class PaymentOption. isActive: The is active. holderName: The holder name. number: The number. accessory: The accessory. street1: The street1. street2: The street2. city: The city. state: The state. zipCode: The zip code. type: The type. lastUpdateDate: The last update date. issue: The issue. cvv2: The cvv2. maskedNumber: The masked number. maskedAccessory: The masked accessory. customerAccount: The customer account. The Interface PaymentOptionType. Amex: The Amex. Checking: The Checking. Discover: The Discover. Savings: The Savings. Visa: The Visa. MasterCard: The Master card. The Class PaymentPlan. Adjustment explaining reasons behind payment plan changes Represents a single charge within a payment plan lastInvocingDate: The last invocing date. lastProcessingDate: The last processing date. sellerCode: The seller code. length: The length. value: The value. deferredLength: The deferred length. deferredValue: The deferred value. amount: The amount. groupCode1: The group code1. groupCode2: The group code2. groupCode3: The group code3. groupCode4: The group code4. groupCode5: The group code5. groupCode6: The group code6. groupCode7: The group code7. groupCode8: The group code8. type: The type. firstBillingDate: The first billing date. nextBillingDate: The next billing date. billingCycleCode: The billing cycle code. itemCode: The item code. taxCode: The tax code. lastUpdateDate: The last update date. status: The status. linkAccount: The link account. paymentOption: The payment option. customerAccount: The customer account. linkParentPlan: The link parent plan. Enumerates possible payment plans statuses Deferred: The plan has been processed at least once, but was never billedNo invoices were ever generated for this plan Current: The plan has been processed and invoiced in last billing Freeze: The plan has been processed in last billing and had Freeze charge.No invoice was generated in last billing process. Cancelled: The plan has been cancelled. The plan contains no charges. Expired: The plan has expired. The plan contains no more charges. Unbilled: The plan has neve been processed and was probably recently created. Ennumerates possible PaymentPlan types Fixed: The plan has fixed (defined) length and will expire after all chargesin the plan are processed Perpetual: The plan has no (defined) length and will be generating invoicesuntil explicitly cancelled Complimentary: The plan is a perpetual plan, however, every generated invoice will beautomatically waived by issuing adjustment (AssetTransaction) against it Ennumerates possible return codes. C01: Soft Decline C02: Soft Decline C03: Soft Decline C04: Soft Decline C05: Soft Decline C06: Soft Decline C07: Soft Decline C08: Soft Decline C09: Soft Decline C10: Soft Decline C11: Soft Decline C12: Soft Decline C13: Soft Decline C61: Soft Decline C62: Soft Decline C63: Soft Decline C64: Soft Decline C65: Soft Decline C66: Soft Decline. C67: Soft Decline C68: Soft Decline C69: Soft Decline R01: Soft Decline R02: Hard Decline R03: Hard Decline R04: Hard Decline R06: Hard Decline R07: Hard Decline R08: Hard Decline R09: Soft Decline R10: Hard Decline R11: Hard Decline R12: Hard Decline R13: Hard Decline R14: Hard Decline R15: Hard Decline R16: Hard Decline R17: Hard Decline R18: Hard Decline R19: Hard Decline R20: Hard Decline R21: Hard Decline R22: Hard Decline R23: Hard Decline R24: Hard Decline R25: Hard Decline R26: Hard Decline R27: Hard Decline R28: Hard Decline R29: Hard Decline R30: Hard Decline R31: Hard Decline R32: Hard Decline R33: Hard Decline R34: Hard Decline R35: Hard Decline R36: Hard Decline R37: Hard Decline R50: Hard Decline R51: Hard Decline R52: Hard Decline R53: Hard Decline R61: Hard Decline R62: Hard Decline R63: Hard Decline R64: Hard Decline R65: Hard Decline R66: Hard Decline R67: Hard Decline R68: Hard Decline R69: Hard Decline R70: Hard Decline R71: Hard Decline R72: Hard Decline R73: Hard Decline R74: Hard Decline R80: Hard Decline R81: Hard Decline R82: Hard Decline R83: Hard Decline R84: Hard Decline A01: Good A02: Good A03: Good D01: Hard Decline D02: Soft Decline D03: Soft Decline D04: Hard Decline D05: Hard Decline D06: Hard Decline D07: Soft Decline D08: Soft Decline D09: Soft Decline D10: Hard Decline D11: Hard Decline D12: Soft Decline D13: Hard Decline D14: Hard Decline E01: Hard Decline E02: Soft Decline The Class RevenueTransaction. itemCode: The item code. isComplimentary: The is complimentary. paymentOption: The payment option. Defines query against CustomerAccount records using specified criteria. Defines query against PaymentOption records using specified criteria. findPaymentPlan method. findAccountTransaction method. The Class Statement. name: The name. totalAmount: The total amount. taxAmount: The tax amount. street: The street. state: The state. phone: The phone. email: The email. city: The city. zipCode: The zip code.