Transaction Properties |
The Transaction type exposes the following members.
Name | Description | |
---|---|---|
![]() | AttachableRef |
Specifies entity name of the attachment from where the attachment was requested
(Inherited from IntuitEntity.) |
![]() | CurrencyRef |
Product: ALL
Description: Reference to the
Currency in which all amounts on the associated transaction are
expressed.[br /]
InputType: ReadWrite
|
![]() | CustomField |
Product: QBW
Description: Custom field (or data extension).
Filterable: QBW
(Inherited from IntuitEntity.) |
![]() | DepartmentRef |
Product: QBO
Description: Location of the
transaction, as defined using location tracking in QuickBooks
Online.
|
![]() | DocNumber |
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
|
![]() | domain |
Product: ALL
Description: Domain in which the entity belongs.
(Inherited from IntuitEntity.) |
![]() | ExchangeRate |
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
|
![]() | ExchangeRateSpecified | |
![]() | HeaderFull |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | HeaderLite |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | Id |
Product: ALL
Description: Unique Identifier for an Intuit entity (object). [br /]Required for the update operation.
Required: ALL
Filterable: ALL
(Inherited from IntuitEntity.) |
![]() | Line |
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.
|
![]() | LinkedTxn |
Product: ALL
Description: A linked (related)
transaction. More than one transaction can be linked.
|
![]() | MetaData |
Product: ALL
Description: Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.
(Inherited from IntuitEntity.) |
![]() | NameAndId |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | Overview |
Property used for Select clauses. This property is not used for entity operation and Where and orderBy clauses.
(Inherited from IntuitEntity.) |
![]() | PrivateNote |
Product: ALL
Description: User entered,
organization-private note about the transaction. This note will
not appear on the transaction records by default.
InputType: ReadWrite
|
![]() | sparse |
Product: ALL
Description: True if the entity representation has a partial set of elements. Output only field.
(Inherited from IntuitEntity.) |
![]() | sparseSpecified | (Inherited from IntuitEntity.) |
![]() | status |
Product: ALL
Description: System status of the entity. Output only field.[br /]
Filterable: ALL
(Inherited from IntuitEntity.) |
![]() | statusSpecified | (Inherited from IntuitEntity.) |
![]() | SyncToken |
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
(Inherited from IntuitEntity.) |
![]() | TaxFormNum |
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.
|
![]() | TaxFormType |
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.
|
![]() | TransactionLocationType |
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.
|
![]() | TxnDate |
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
|
![]() | TxnDateSpecified | |
![]() | TxnSource |
Product: QBO
Description: Originating source of
the Transaction. Valid values are defined in TxnSourceEnum:
QBMobile.
|
![]() | TxnStatus |
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
|
![]() | TxnTaxDetail |
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].
|