JDBC Driver for QuickBooks Online

Build 20.0.7587

VendorCredits

Create, update, delete, and query QuickBooks Vendor Credits.

Table Specific Information

VendorCredits may be inserted, queried, or updated via the VendorCredits or VendorCreditLineItems tables. VendorCredits may be deleted by using the VendorCredits table.

Insert

To add a VendorCredit, specify a Vendor, TotalAmt, and at least one Line Item. The LineAggregate column may be used to specify an XML aggregate of Line Item data. The columns that may be used in these aggregates are defined in the VendorCreditLineItems table as # columns. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). For example, the following will insert a new VendorCredit with two Line Items:

INSERT INTO VendorCredits (VendorRef, TotalAmt, LineAggregate) 
VALUES ('21', '0.03', '
<Line><Amount>0.01</Amount><DetailType>AccountBasedExpenseLineDetail</DetailType><AccountBasedExpenseLineDetail><CustomerRef>4</CustomerRef><AccountRef>41</AccountRef></AccountBasedExpenseLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>AccountBasedExpenseLineDetail</DetailType><AccountBasedExpenseLineDetail><CustomerRef>4</CustomerRef><AccountRef>41</AccountRef></AccountBasedExpenseLineDetail></Line>
')

Columns

Name Type ReadOnly References Filterable Sortable Description
Id [KEY] String True true true

The Id of the vendor credit.

SyncToken String True false false

Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.

MetaData_CreateTime Datetime True true true

The time the record was created.

MetaData_LastUpdatedTime Datetime True true true

The time the record was last updated.

DocNumber String False true true

The primary document number for this transaction. If it is not provided, QuickBooks business logic will assign the document number using the next-in-sequence algorithm.

TxnDate Date False true true

The date of the transaction. Often, but not required to be, this value is the date the transaction was created in the system. For posting transactions, this is the posting date that affects financial statements.

PrivateNote String False false false

A private note about the transaction. This note will not appear on the transaction records by default.

DepartmentRef String False

Departments.Id

false false

The Id of the department, which stores the location of the transaction.

DepartmentRef_Name String True

Departments.Name

false false

The name of the department, which stores the location of the transaction.

LineAggregate String False false false

An XML aggregate of the individual line item entries contained in the vendor credit.

VendorRef String False

Vendors.Id

true false

The Id of the vendor.

VendorRef_Name String True

Vendors.DisplayName

false false

The name of the vendor.

APAccountRef String False

Accounts.Id

true true

The accounts-payable account the bill is credited to. If the company has a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.

APAccountRef_Name String True

Accounts.Name

false false

The accounts-payable account to which the bill is credited. If the company has a single accounts-payable account, this account is implied. When specified, the account must be a Liability account and the subtype must be of type Payables.

TotalAmt Decimal False true true

The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.

CurrencyRef String False false false

The Id of the currency used in the transaction.

CurrencyRef_Name String True false false

The name of the currency used in the transaction.

ExchangeRate Decimal False false false

Currency exchange rate. Valid only if the company file is set up to use multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available for the UK, AU, IN, and CA editions.

GlobalTaxCalculation String False false false

Method in which tax is applied. This field is valid in the UK, AU, IN, and CA editions.

使用できる値は次のとおりです。TaxExcluded, TaxInclusive, NotApplicable

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587