IPPSalesTransaction.php

Show:

inherited

Classes
- \IPPSalesTransaction

Table of Contents

Package: Default

\IPPSalesTransaction
jump to top

Package: Default

Parent(s): \IPPTransaction < \IPPIntuitEntity
Children: \IPPSalesOrder; \IPPSalesReceipt; \IPPEstimate; \IPPRefundReceipt; \IPPCreditMemo; \IPPInvoice
Inherited_from: \IPPTransaction
IPPSalesTransaction: \IPPSalesTransaction
XmlDefinition: Product: ALL Description: Base class of all Sales transaction entities.
XmlName: IPPSalesTransaction
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: Product: QBW Description: Reference to the ARAccount (accounts receivable account) associated with the transaction. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: ARAccountRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $ApplyTaxAfterDiscount

Details

Type: boolean
Definition: Product: QBO Description: If false or null, calculate the sales tax first, and then apply the discount. If true, subtract the discount first and then calculate the sales tax.
XmlMinOccurs: 0
XmlName: ApplyTaxAfterDiscount
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

boolean $AutoDocNumber

Details

Type: boolean
Definition: Product: QBO Description: If AutoDocNumber is true, DocNumber is generated automatically. If false or null, the DocNumber is generated based on preference of the user.
XmlMinOccurs: 0
XmlName: AutoDocNumber
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $Balance

Details

Type: float
Definition: Product: QBO Description: The balance reflecting any payments made against the transaction. Initially this will be equal to the TotalAmt. Product: QBW Description: Indicates the unpaid amount of the transaction. Filterable: ALL Sortable: QBW InputType: ReadOnly
XmlMinOccurs: 0
XmlName: Balance
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPPhysicalAddress $BillAddr

Details

Type: \com\intuit\schema\finance\v3\IPPPhysicalAddress
Definition: Product: ALL Description: QBO: Bill-to address of the Invoice.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a] Description: QBW: The physical (postal) address where the bill or invoice is sent.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a] InputType: ReadWrite
XmlMinOccurs: 0
XmlName: BillAddr
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPEmailAddress $BillEmail

Details

Type: \com\intuit\schema\finance\v3\IPPEmailAddress
Definition: Product: QBO Description: Identifies the e-mail address where the invoice is sent. At present, you can provide only one e-mail address.[br /]If the ToBeEmailed attribute is true and the BillEmail attribute contains an e-mail address, the user can send an e-mail message to the e-mail address that is specified in the BillEmail attribute.[br /]If the BillEmail attribute contains an invalid e-mail address, QBO does not send the e-mail message to the invalid e-mail address. QBO also does not return any error message to indicate that the e-mail address is invalid.[br /]The maximum length for BillEmail is 100 characters. Product: QBW Description: Identifies the email address where the bill or invoice is sent. [br /]UNSUPPORTED FIELD.
XmlMinOccurs: 0
XmlName: BillEmail
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPCheckPayment
Definition: Product: ALL Description Information about a check payment for the Invoice. NotApplicableTo: Estimate, SalesOrder
XmlMinOccurs: 0
XmlName: CheckPayment
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: QBW Description: Reference to the Class associated with the transaction. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: ClassRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPCreditCardPayment
Definition: Product: ALL Description Information about a credit card payment for the Invoice. NotApplicableTo: Estimate, SalesOrder
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\IPPMemoRef $CustomerMemo

Details

Type: \com\intuit\schema\finance\v3\IPPMemoRef
Definition: Product: ALL Description: QBO: For an Invoice, this is the user-entered message to the customer that does appear in the invoice, and does appear in the printed invoice. The maximum length for Invoice Msg is 1000 characters.[br /]For a Bill, this is the memo of the transaction to provide more detail, and does not appear in the printed message of the bill. The maximum length for Bill Msg is 4000 characters.[br /]For a CreditCardCharge, this message appears in the printed record; maximum length is 4000 characters.[br /]Not supported for BillPayment, JournalEntry or Payment. Description: QBW: User-entered message to the customer; this message will be visible to end user on their transactions. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: CustomerMemo
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: Reference to a Customer or job. Filterable: QBW InputType: ReadWrite BusinessRules: QBW: CustomerRef is mandatory for some SalesTransactions like Invoice
XmlMinOccurs: 0
XmlName: CustomerRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPTransactionDeliveryInfo $DeliveryInfo

Details

Type: \com\intuit\schema\finance\v3\IPPTransactionDeliveryInfo
Definition: Product: QBO Description: Last delivery info of this transaction.
XmlMinOccurs: 0
XmlName: DeliveryInfo
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: Product: ALL Description: QBW: Reference to the DepositToAccount entity. If not specified, the Undeposited Funds account will be used. Description: QBO: Asset account where the payment money is deposited. If you do not specify this account, QBO uses the Undeposited Funds account. Supported for Payment and SalesReceipt only. NotApplicableTo: QBW: Estimate, SalesOrder
XmlMinOccurs: 0
XmlName: DepositToAccountRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $DiscountAmt

Details

Type: float
Definition: Product: QBO Description: Indicates the discount amount that is applied on the transaction as a whole. This will be pro-rated through item lines for tax calculation.
XmlMinOccurs: 0
XmlName: DiscountAmt
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $DiscountRate

Details

Type: float
Definition: Product: QBO Description: Indicates the discount rate that is applied on the transaction as a whole. This will be pro-rated through item lines for tax calculation.
XmlMinOccurs: 0
XmlName: DiscountRate
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

string $DueDate

Details

Type: string
Br
Ul: If DueDate is not included when creating an invoice, QuickBooks may determine the due date according to the terms set for this customer. If the Terms are not provided, the Due Date is set to the transaction date.
XmlMinOccurs: 0
XmlName: DueDate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPEmailStatusEnum $EmailStatus

Details

Type: \com\intuit\schema\finance\v3\IPPEmailStatusEnum
Definition: Product: ALL Description: Email status of the invoice.[br /] InputType: ReadWrite
XmlMinOccurs: 0
XmlName: EmailStatus
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

string $FOB

Details

Type: string
Definition: Product: ALL Description: "Free On Board", the terms between buyer and seller regarding transportation costs; does not have any bookkeeping implications. Description: "Free On Board", the terms between buyer and seller regarding transportation costs; does not have any bookkeeping implications. ValidRange: QBW: max=13 ValidRange: QBO: max=15
XmlMinOccurs: 0
XmlName: FOB
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

boolean $FinanceCharge

Details

Type: boolean
Definition: Product: ALL Description: Indicates whether the transaction is a finance charge. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: FinanceCharge
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPGlobalTaxCalculationEnum $GlobalTaxCalculation

Details

Type: \com\intuit\schema\finance\v3\IPPGlobalTaxCalculationEnum
Definition: Product: QBO Description: Indicates the GlobalTax model if the model inclusive of tax, exclusive of taxes or not applicable
XmlMinOccurs: 0
XmlName: GlobalTaxCalculation
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $GovtTxnRefIdentifier

Details

Type: string
Definition: Product: QBO Description: this is the reference to the NotaFiscal created for the salesTransaction. ValidRange: QBO: max=30
XmlMinOccurs: 0
XmlName: GovtTxnRefIdentifier
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $HomeBalance

Details

Type: float
Definition: Product: QBO Description: The balance reflecting any payments made against the transaction in home currency. Initially this will be equal to the HomeTotalAmt.[br /]Read-only field. Product: QBW Description: Indicates the unpaid amount of the transaction in home currency.[br /]Cannot be written to QuickBooks. Filterable: ALL Sortable: QBW
XmlMinOccurs: 0
XmlName: HomeBalance
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $HomeTotalAmt

Details

Type: float
Definition: Product: ALL Description: QBW: Total amount of the transaction in the home currency for multi-currency enabled companies. Single currency companies will not have this field. Includes the total of all the charges, allowances and taxes. Calculated by QuickBooks business logic. Cannot be written to QuickBooks. InputType: QBW: ReadOnly
XmlMinOccurs: 0
XmlName: HomeTotalAmt
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

string $PONumber

Details

Type: string
Definition: Product: ALL Description: Purchase Order number. ValidRange: QBW: max=25 ValidRange: QBO: max=15
XmlMinOccurs: 0
XmlName: PONumber
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. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: PaymentMethodRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $PaymentRefNum

Details

Type: string
Definition: Product: QBO 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: QBO Description: Valid values are Cash, Check, CreditCard, or Other. No defaults. Cash based expense is not supported by QuickBooks Windows. NotApplicableTo: Estimate, SalesOrder
XmlMinOccurs: 0
XmlName: PaymentType
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPPrintStatusEnum $PrintStatus

Details

Type: \com\intuit\schema\finance\v3\IPPPrintStatusEnum
Definition: Product: ALL Description: Printing status of the invoice.[br /] InputType: ReadWrite
XmlMinOccurs: 0
XmlName: PrintStatus
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

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: QBW Description: Reference to the party receiving payment. InputType: ReadOnly
XmlMinOccurs: 0
XmlName: RemitToRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: QBW Description: Reference to the SalesRep associated with the transaction. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: SalesRepRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: QBW Description: Reference to the SalesTerm associated with the transaction. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: SalesTermRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

\com\intuit\schema\finance\v3\IPPPhysicalAddress $ShipAddr

Details

Type: \com\intuit\schema\finance\v3\IPPPhysicalAddress
Definition: Product: ALL Description: QBO: Shipping address of the Invoice.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a] Description: QBW: Identifies the address where the goods must be shipped. [br /]QuickBooks Note: If ShipAddr is not specified, and a default ship-to address is specified in QuickBooks for this customer, the default ship-to address will be used by QuickBooks.[br]See [a href="http://ipp.developer.intuit.com/0010_Intuit_Partner_Platform/0060_Financial_Management_Services_(v3)/01000_Using_Data_Service_Entities#Addresses"]Addresses[/a]
XmlMinOccurs: 0
XmlName: ShipAddr
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $ShipDate

Details

Type: string
Definition: Product: QBW Description: Date for delivery of goods or services. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: ShipDate
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: QBW Description: Reference to the ShipMethod associated with the transaction. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: ShipMethodRef
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

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

Details

Type: \com\intuit\schema\finance\v3\IPPReferenceType
Definition: Product: QBW Description: Reference to the Template for the invoice form. InputType: ReadWrite
XmlMinOccurs: 0
XmlName: TemplateRef
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

float $TotalAmt

Details

Type: float
Definition: Product: All Description: QBO: Indicates the total amount of the transaction. This includes the total of all the charges, allowances and taxes. By default, this is recalculated based on sub items total and overridden. Description: QBW: Indicates the total amount of the transaction. This includes the total of all the charges, allowances and taxes.[br /]Calculated by QuickBooks business logic; cannot be written to QuickBooks. Filterable: QBW Sortable: QBW InputType: QBW: OverrideOnSync
XmlMinOccurs: 0
XmlName: TotalAmt
XmlNamespace: http://schema.intuit.com/finance/v3
XmlType: element

string $TrackingNum

Details

Type: string
Definition: Product: QBW Description: Shipping provider's tracking number for the delivery of the goods associated with the transaction.
XmlMinOccurs: 0
XmlName: TrackingNum
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

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

IPPSalesTransaction.php

\IPPSalesTransactionjump to top

Properties

Methods

\IPPSalesTransaction
jump to top