IPPPayment.php

Show:

inherited

Classes
- \IPPPayment

Table of Contents

Package: Default

\IPPPayment
jump to top

Package: Default

Parent(s): \IPPTransaction < \IPPIntuitEntity
Inherited_from: \IPPTransaction
IPPPayment: \IPPPayment
XmlDefinition: Financial transaction representing a payment from a customer applied to one or more sales transactions
XmlName: IPPPayment
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: Transaction

Properties

\com\intuit\schema\finance\v3\IPPReferenceType $ARAccountRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: ARAccountReferenceGroup Identifies the AR Account to be used for this Payment. [b]QuickBooks Notes[/b][br /] The AR Account should always be specified or a default will be used.
XmlMinOccurs: 0
XmlName: ARAccountRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPAttachableRef $AttachableRef

Details

Type: \com\intuit\schema\finance\v3\IPPAttachableRef
Definition: Specifies entity name of the attachment from where the attachment was requested
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: AttachableRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPCheckPayment $CheckPayment

Details

Type: \com\intuit\schema\finance\v3\IPPCheckPayment
XmlMinOccurs: 0
XmlName: CheckPayment
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPCreditCardPayment $CreditCardPayment

Details

Type: \com\intuit\schema\finance\v3\IPPCreditCardPayment
XmlMinOccurs: 0
XmlName: CreditCardPayment
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPReferenceType $CurrencyRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the Currency in which all amounts on the associated transaction are expressed.[br /] InputType: ReadWrite
XmlMinOccurs: 0
XmlName: CurrencyRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPCustomField $CustomField

Details

Type: \com\intuit\schema\finance\v3\IPPCustomField
Definition: Product: QBW Description: Custom field (or data extension). Filterable: QBW
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: CustomField
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPReferenceType $CustomerRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Represents Customer (or Job)Reference Filterable: QBW
XmlMinOccurs: 0
XmlName: CustomerRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPReferenceType $DepartmentRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: QBO Description: Location of the transaction, as defined using location tracking in QuickBooks Online.
XmlMinOccurs: 0
XmlName: DepartmentRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPReferenceType $DepositToAccountRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Optional asset account specification to designate the account the payment money needs to be deposited to. [b]QuickBooks Notes[/b][br /] If not specified, the Undeposited Funds account will be used.
XmlMinOccurs: 0
XmlName: DepositToAccountRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $DocNumber

Details

Type: string
Definition: Product: ALL Description: QBO: Reference number for the transaction. If DocNumber is not provided, and the Custom Transaction Number is set to "Off", QBO assigns a document number using the next-in-sequence algorithm for Sales transactions. Otherwise the value will remaing null. Alternatively, you can also pass in "AUTO_GENERATE" in this field to force QBO to auto-sequence the document number for Invoices, Estimates and Sales Receipt.[br /]The maximum length for DocNumber is 21 characters. The default value is an empty String. Filter support not provided for Payment. Description: QBW: The primary document number for this transaction. DocNumber is exposed to end users.[br /]If it is not provided, QuickBooks business logic will assign the document number using the "next in sequence" algorithm.[br /]Max. length is 11 characters for Payment, Bill, ItemReceipt and VendorCredit. Max. length is 20 characters for other entities. Filterable: QBO InputType: ReadWrite ValidRange: QBW: max=11 ValidRange: QBO: max=21
XmlMinOccurs: 0
XmlName: DocNumber
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $ExchangeRate

Details

Type: float
Definition: Product: ALL Description: Currency exchange rate. Valid only if the company file is set up to use Multi-Currency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. The foreign unit is always 1 and the amount of home units that equal that 1 foreign unit is what QuickBooks uses as the exchange rate. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: ExchangeRate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPid $Id

Details

Type: \com\intuit\schema\finance\v3\IPPid
Definition: Product: ALL Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation. Required: ALL Filterable: ALL
XmlMinOccurs: 0
XmlName: Id
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPLine $Line

Details

Type: \com\intuit\schema\finance\v3\IPPLine
Definition: Product: QBW Description: A line item of a transaction. Product: QBO Description: A line item of a transaction. QuickBooks Online does not support tax lines in the main transaction body, only in the TxnTaxDetail section.
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: Line
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPLinkedTxn $LinkedTxn

Details

Type: \com\intuit\schema\finance\v3\IPPLinkedTxn
Definition: Product: ALL Description: A linked (related) transaction. More than one transaction can be linked.
XmlMaxOccurs: unbounded
XmlMinOccurs: 0
XmlName: LinkedTxn
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPModificationMetaData $MetaData

Details

Type: \com\intuit\schema\finance\v3\IPPModificationMetaData
Definition: Product: ALL Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
XmlMinOccurs: 0
XmlName: MetaData
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPIntuitAnyType $PaymentEx

Details

Type: \com\intuit\schema\finance\v3\IPPIntuitAnyType
Definition: Internal use only: extension place holder for Payment
XmlMinOccurs: 0
XmlName: PaymentEx
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPReferenceType $PaymentMethodRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: ALL Description: Reference to the PaymentMethod.
XmlMinOccurs: 0
XmlName: PaymentMethodRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $PaymentRefNum

Details

Type: string
Definition: Product: ALL Description: The reference number for the payment received (I.e. Check # for a check, envelope # for a cash donation, CreditCardTransactionID for a credit card payment)
XmlMinOccurs: 0
XmlName: PaymentRefNum
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPPaymentTypeEnum $PaymentType

Details

Type: \com\intuit\schema\finance\v3\IPPPaymentTypeEnum
Definition: Product: ALL Description: Valid values are Cash, Check, CreditCard, or Other. No defaults. Cash based expense is not supported by QuickBooks Windows. Not applicable to Estimate and SalesOrder.[br /]
XmlMinOccurs: 0
XmlName: PaymentType
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $PrivateNote

Details

Type: string
Definition: Product: ALL Description: User entered, organization-private note about the transaction. This note will not appear on the transaction records by default. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: PrivateNote
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $ProcessPayment

Details

Type: boolean
Definition: Indicates that the payment should be processed by merchant account service. Valid for QBO companies with credit card processing. QBO only field.
XmlMinOccurs: 0
XmlName: ProcessPayment
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPReferenceType $RemitToRef

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Identifies the party or location that the payment is to be remitted to or sent to. [b]QuickBooks Notes[/b][br /] Non QB-writable.
XmlMinOccurs: 0
XmlName: RemitToRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $SyncToken

Details

Type: string
Definition: Product: ALL Description: Version number of the entity. The SyncToken is used to lock the entity for use by one application at a time. As soon as an application modifies an entity, its SyncToken is incremented; another application's request to modify the entity with the same SyncToken will fail. Only the latest version of the entity is maintained by Data Services. An attempt to modify an entity specifying an older SyncToken will fail. [br /]Required for the update operation. Required: ALL
XmlMinOccurs: 0
XmlName: SyncToken
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $TaxFormNum

Details

Type: string
Definition: Description: Tax Form Num holds data related to Tax Information based on Regional compliance laws.This is applicable for IN region and can be extended to other regions in future.
XmlMinOccurs: 0
XmlName: TaxFormNum
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $TaxFormType

Details

Type: string
Definition: Description: refer TaxFormTypeEnum. Tax Form Type holds data related to Tax Information, values based on regional compliance laws. Applicable for IN Region and can be extended for other Regions.
XmlMinOccurs: 0
XmlName: TaxFormType
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $TotalAmt

Details

Type: float
Definition: Product: ALL Description: Indicates the total amount of the entity associated. This includes the total of all the payments from the Payment Details. [b]QuickBooks Notes[/b][br /] Non QB-writable. Filterable: QBW Sortable: QBW
XmlMinOccurs: 0
XmlName: TotalAmt
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $TransactionLocationType

Details

Type: string
Definition: Product: QBO Description: Location of the purchase or sale transaction. The applicable values are those exposed through the TransactionLocationTypeEnum. This is currently applicable only for the FR region.
XmlMinOccurs: 0
XmlName: TransactionLocationType
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $TxnDate

Details

Type: string
Definition: Product: ALL Description: QBO: The date entered by the user when this transaction occurred. [br /]Often, it is the date when the transaction is created in the system. [br /]For "posting" transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used. Description: QBW: The nominal, user entered, date of the transaction. [br /]Often, but not required to be, the date the transaction was created in the system. [br /]For "posting" transactions, this is the posting date that affects financial statements. Filterable: ALL Sortable: ALL InputType: ReadWrite
XmlMinOccurs: 0
XmlName: TxnDate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $TxnSource

Details

Type: string
Definition: Product: QBO Description: Originating source of the Transaction. Valid values are defined in TxnSourceEnum: QBMobile.
XmlMinOccurs: 0
XmlName: TxnSource
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $TxnStatus

Details

Type: string
Definition: Product: ALL Description: QBW: The status of the transaction. Depending on the transaction type it may have different values.[br /]For Sales Transactions acceptable values are defined in PaymentStatusEnum. For Estimate, the values accepted are defined in EstimateStatusEnum. Description: QBO: The status of the transaction. Depending on the transaction type it may have different values.[br /]For Sales Transactions acceptable values are defined in PaymentStatusEnum. For Estimate, the values accepted are defined in QboEstimateStatusEnum. Filterable:QBW
XmlMinOccurs: 0
XmlName: TxnStatus
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPTxnTaxDetail $TxnTaxDetail

Details

Type: \com\intuit\schema\finance\v3\IPPTxnTaxDetail
Definition: Product: ALL Description: Details of taxes charged on the transaction as a whole. For US versions of QuickBooks, tax rates used in the detail section must not be used in any tax line appearing in the main transaction body. For international versions of QuickBooks, the TxnTaxDetail should provide the details of all taxes (sales or purchase) calculated for the transaction based on the tax codes referenced by the transaction. This can be calculated by QuickBooks business logic or you may supply it when adding a transaction. For US versions of QuickBooks you need only supply the tax code for the customer and the tax code (in the case of multiple rates) or tax rate (for a single rate) to apply for the transaction as a whole.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01100_Global_Tax_Model"]Global Tax Model[/a].
XmlMinOccurs: 0
XmlName: TxnTaxDetail
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $UnappliedAmt

Details

Type: float
Definition: Indicates the amount that has not been applied to pay amounts owed for sales transactions. [b]QuickBooks Notes[/b][br /] Non QB-writable.
XmlMinOccurs: 0
XmlName: UnappliedAmt
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $domain

Details

Type: string
Definition: Product: ALL Description: Domain in which the entity belongs.
XmlName: domain
XmlType: attribute

boolean $sparse

Details

Type: boolean
Definition: Product: ALL Description: True if the entity representation has a partial set of elements. Output only field.
XmlName: sparse
XmlType: attribute

array<mixed,\EntityStatusEnum> $status

Details

Type: array<mixed,\EntityStatusEnum>
Definition: Product: ALL Description: System status of the entity. Output only field.[br /] Filterable: ALL
XmlName: status
XmlType: attribute

Methods

__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : void

Initializes this object, optionally with pre-defined property values

Initializes this object and it's property members, using the dictionary of key/value pairs passed as an optional argument.

Parameters

Name	Type	Description
$keyValInitializers	\dictionary	key/value pairs to be populated into object's properties
$verbose	boolean	specifies whether object should echo warnings

__construct(\dictionary $keyValInitializers = array(), boolean $verbose = FALSE) : void

inherited

Initializes this object, optionally with pre-defined property values

Inherited from:

Initializes this object and it's property members, using the dictionary of key/value pairs passed as an optional argument.

Parameters

Name	Type	Description
$keyValInitializers	\dictionary	key/value pairs to be populated into object's properties
$verbose	boolean	specifies whether object should echo warnings

IPPPayment.php

\IPPPaymentjump to top

Properties

Methods

\IPPPayment
jump to top