QuickBooks Integrator 2020 macOS Edition

Questions / Feedback?

DepositLine Type

A single deposit line item.

Remarks

This type of line item is used by the Deposit class.

Fields

accountId
String

A reference to the account to which funds are to be deposited. Either AccountName or AccountId (but not both) may be used to reference the account. For example, AccountName might be "Checking".

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

accountName
String

A reference to the account to which funds are to be deposited. Either AccountName or AccountId (but not both) may be used to reference the account. For example, AccountName might be "Checking".

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

amount
String

The total amount of this deposit line item. This should be a positive number.

The amount should be formatted as a string in dollars.

checkNumber
String

Optional check number for this deposit line item.

If the source of funds for this deposit line item is a check, this property should contain the check number. Otherwise it should be left blank.

classId
String

Specifies the class of the deposit line item

ClassName or ClassId may reference to the class of this deposit. This is only used if class tracking is being done with the QuickBooks company.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

className_
String

Specifies the class of the deposit line item

ClassName or ClassId may reference to the class of this deposit. This is only used if class tracking is being done with the QuickBooks company.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

entityId
String

An entity Id for this deposit line item.

A Deposit Line Entity refers to a Customer, Vendor, Employee, or "Other Name" associated with this deposit line. If a Deposit Line Account is an accounts receivable account, the Entity should refer to a customer. If the Account is an accounts payable account, the Entity should refer to a vendor. Either EntityName or EntityId (but not both) may be used to specify the Entity.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

entityName
String

An entity name for this deposit line item.

A Deposit Line Entity refers to a Customer, Vendor, Employee, or "Other Name" associated with this deposit line. If a Deposit Line Account is an accounts receivable account, the Entity should refer to a customer. If the Account is an accounts payable account, the Entity should refer to a vendor. Either EntityName or EntityId (but not both) may be used to specify the Entity.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

lineId
String

Identification number of the deposit line, used for Updates.

If you need to add a new deposit line in a transaction Update request, you can do so by setting the LineId to -1.

memo
String

A memo for this deposit line.

paymentId
String

The PaymentTxnId for this deposit line item

For any given deposit there are many line items properties, such as AccountId, PaymentMethodId, Amount, etc. All of these properties may be replaced by referencing a transaction already stored in quickbooks. Just set the PaymentId property, and no other Deposit Line Item properties need be set.

When this property is set, you may also specify a PaymentLineId to indicate which payment line in the transaction referenced by PaymentId is to be added. If specified, the Memo, CheckNumber, and ClassName/ClassId properties will override those from the original transaction. All other properties are ignored when PaymentId has a value.

paymentLineId
String

The PaymentTxnLineId for this deposit line item

For the PaymentTxnLineID, use a TxnLineID value exactly as it has been returned by the ReceivePayment class after a Get. If you do not include a PaymentLineId but do include a PaymentId for a transaction that includes payment lines, only the first payment line from that transaction will be deposited.

paymentMethodId
String

The payment method for this deposit line item.

The funding source for this deposit. For example: "cash", "check", or "Master Card". Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

paymentMethodName
String

The payment method (funding source) for this deposit line item. For example: "cash", "check", or "Master Card". Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

refId
String

Identification number of the transaction associated with this deposit line.

Constructors

public init()

Copyright (c) 2021 /n software inc. - All rights reserved.
QuickBooks Integrator 2020 macOS Edition - Version 20.0 [Build 7941]