CData Cloud offers access to QuickBooks across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to QuickBooks through CData Cloud.
CData Cloud allows you to standardize and configure connections to QuickBooks as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to 接続の確立 to QuickBooks in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
接続の確立 shows how to authenticate to QuickBooks and configure any necessary connection properties to create a database in CData Cloud
Accessing data from QuickBooks through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to QuickBooks by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
The Cloud makes requests to QuickBooks through the Remote Connector. The Remote Connector runs on the same machine as QuickBooks and accepts connections through a lightweight, embedded Web server. The server supports SSL/TLS, enabling users to connect securely from remote machines. The first time you connect, you will need to authorize the Cloud with QuickBooks. For more information, refer to our Using the QuickBooks Gateway guide.
Follow the steps below to authorize with QuickBooks and connect to a company file when both QuickBooks and the Cloud are running on your local machine.
If you want to connect to the company file when QuickBooks is closed, set the CompanyFile connection option when you execute commands. QuickBooks will open automatically in the background with the file specified.
Note that if QuickBooks is open through the application UI, only that CompanyFile can be used.
The Remote Connector can be used to read and write to QuickBooks in situations where direct COM access to QuickBooks is not available (e.g., ASP.NET, Java, or QuickBooks on a remote machine). Follow the procedure below to connect to QuickBooks for the first time through the Remote Connector:
Open the Remote Connector from the system tray and add a user on the Users tab. Enter a User and Password and select the level of access in the Data Access menu.
Note: The Remote Connector does not use the User and Password properties to access QuickBooks; the User and Password properties authenticate the user to the Remote Connector. Authentication to QuickBooks is handled based on the ApplicationName property.
Note that if the QuickBooks UI is open, you can only connect to that company file. Additionally, note that the user permissions you run the Remote Connector under must match the user permissions you run QuickBooks under. The Remote Connector installation process installs the Remote Connector as a service under the current user account.
You can enable SSL/TLS on the Advanced tab.
You will also need to send your public key certificate to the Cloud. You can do so by setting the SSLServerCert property.
The QuickBooks Gateway for QuickBooks is a simple application that facilitates connections to company files from your application. The QuickBooks Gateway accepts connections via a lightweight embedded Web server that runs on the machine where QuickBooks is installed. The server supports SSL/TLS, enabling users to connect securely from remote machines.
The first time you connect to QuickBooks, you must authorize your application. Complementing the per-application authentication of QuickBooks, the QuickBooks Gateway has per-user authentication. Before connecting to QuickBooks for the first time, configure at least one QuickBooks Gateway user.
You can configure users through the UI on the ユーザー tab. You can then follow the procedure in "Getting Started" to connect an application to QuickBooks. After connecting, you can monitor QuickBooks connections on the ステータス tab.
It is recommended to configure the QuickBooks Gateway in the UI, but you can also run the QuickBooks Gateway from the command line. This can simplify deploying the QuickBooks Gateway in scenarios where normally there is not a user logged in, such as running a Web server. See the Advanced page to configure the QuickBooks Gateway when you are not using the UI.
The QuickBooks Gateway automatically manages the connection to QuickBooks, but you can configure almost every aspect of how users connect to QuickBooks through the QuickBooks Gateway. The following pages outline the capabilities of the QuickBooks Gateway and how to get started.
The Users tab provides an interface to add, edit, and delete users. At least one user must be added before communicating with QuickBooks.
This tab displays a list of existing users along with information about the user's configuration.
When adding or editing a user, the following options are available:
Basic Authentication (default): | Authenticates the user with a username and password. |
Windows Authentication: | Authenticates the user as a Windows user. In this case the Password field is not applicable. When the QuickBooks Gateway receives a connection request, it will authenticate the user to Windows using the credentials supplied in the request. |
Full: | Allows read and write access for the user. |
Read-only: | Restricts the user to read-only operations. QuickBooks data cannot be modified. |
The Test Connection button provides a quick way to verify the application can connect with QuickBooks.
When a user is added the QuickBooks Gateway will prompt you to authorize the application with QuickBooks if necessary.
The Status tab provides a log of the activity happening with the QuickBooks Gateway. Logs can be cleared or copied by right-clicking in the Recent Activity window.
You can adjust the detail of the logs to include information useful when troubleshooting: Select the granularity in the Log Mode menu on the Advanced tab. On the Advanced tab, you can also configure the QuickBooks Gateway to write logs to a file and select the log rotation interval.
The Advanced tab allows granular control over the QuickBooks Gateway's server. The QuickBooks Gateway contains an embedded Web server that runs as a Windows service and listens for HTTP requests. Each request contains the XML data to be communicated to QuickBooks as well as configuration settings specifying how the connection is to be opened. The QuickBooks Gateway then communicates with QuickBooks via COM and returns the QuickBooks response (or an error message) in the HTTP reply.
This chapter details how to control each of these aspects of connecting to QuickBooks through the UI, command-line interface, and the registry. The following sections detail the options available on the Advanced tab.
Daily (default): | Uses a new log file every day. Files are written with the format "yyyy_MM_dd.txt". For example, "2013_09_23.txt". |
Weekly: | Uses a new log file every week. Files are written with the format "yyyy_ww.txt". For example, "2013_34.txt", where 34 means this is the 34th week of 2013. |
Monthly: | Uses a new log file every month. Files are written with the format "yyyy_mm.txt". For example, "2013_09.txt". |
All communications to QuickBooks company files must first go through QuickBooks. If QuickBooks is closed, this means that for each attempt to connect to the company file, QuickBooks needs to be launched and then closed again. By default the QuickBooks Gateway queues requests for data and performs the necessary authentication for each request. The following options can be used to override this behavior and keep the connection to the company file alive after the query finishes executing, so further requests will respond more quickly.
Warning: If a user attempts to manually open QuickBooks while a persistent connection is opened, QuickBooks will return an error stating that the company file is already in use.
The following options are used to configure TLS/SSL:
In addition to the UI, the QuickBooks Gateway has a command-line interface that makes it easy to deploy on machines where a user is not always logged in, for example, a Web server. To facilitate deployment to these environments, the QuickBooks Gateway contains two executables:
RemoteConnector.exe | Provides the user interface and allows configuration of the application. |
RemoteConnectorService.exe | Processes requests and performs all interaction with QuickBooks. |
The syntax for managing the QuickBooks Gateway Windows service from the command line is as follows:
RemoteConnectorService.exe /Service <Command>
The following commands are available:
Install | Installs the Windows service. |
Delete | Deletes the Windows service. |
Start | Starts the Windows service. |
Stop | Stops the Windows service. |
State | Reports the current state of the Windows service (started or stopped). |
Auto | Changes the Windows service startup type to Automatic. |
Manual | Changes the Windows service startup type to Manual. |
Disabled | Changes the Windows service startup type to Disabled. |
次に示すように、MySQL デーモンをコマンドラインから開始できます。
java -jar cdata.jdbc.quickbooks.jar [ options ]次のコマンドラインオプションを利用できます。
オプション | 説明 | |
-h, --help | 使用できるオプションのヘルプを表示して終了します。 | |
-f, --config-file | デーモンのコンフィギュレーションファイル。 | |
-u, --user | 接続を許可されているユーザー。コンフィギュレーションファイルを使用して複数のユーザーを設定します。コマンドラインでユーザーが指定されている場合は、そのユーザーだけがアクセスを許可されます。 | |
-p, --password | ユーザーオプションで指定されたユーザーのパスワード。ユーザーとパスワードの両方がコマンドラインで設定されている場合は、コンフィグファイルのユーザーセクションは無視されます。 | |
-d, --database | クライアントが接続に使用するデータベース。コンフィグファイルで複数のデータベースが指定されている場合は、コマンドラインで指定されているデータベースにのみ接続が許可されます。 | |
-c, --connection | 対象となるデータソースに接続するために使用される接続文字列。コマンドラインで接続文字列が指定されない場合は、コンフィグファイルの接続文字列が読み込まれます。 | |
-P, --port | TCP/IP接続の監視に使用するポート番号。デフォルトポート番号は3306です。 | |
-m, --max-connections | 許可されるTCP/IP接続の最大数。デフォルト値は25接続です。 | |
--session-timeout | セッションタイムアウト時間(秒単位)。デフォルトのタイムアウトは20秒です。 | |
-t, --protocol | リモーティングに使用するプロトコル。デフォルト値はMYSQL です。 | |
-g, --logfile | ログファイルの完全パス。 | |
-F, --logrotationscheme | ログを切り捨てる間隔。オプションは、1(毎日。[MyFileName]_2016_3_21.txt 形式)、2(毎週。[MyFileName]_Week_5.txt 形式、5は一年の第5週目)、および3(毎月。[MyFileName]_2016_3_21.txt 形式)。 | |
-v, --verbosity | ログのメッセージレベル。1 は情報提供レベル。レベルは5段階あり、以下の詳細が追加されます。(2) HTTP ヘッダー、(3) HTTP ボディ、(4) SSL を含むトランスポートレベルのコミュニケーション、(5) インターフェースコマンドおよびその他のデータソースコミュニケーション。 | |
--test | 接続をテストするデータベース。このプロパティが指定されない場合は、デフォルトのデータベースが使用されます。 | |
--ssl-cert | SSL 証明書へのパス。 | |
--ssl-subject | SSL 証明書の件名。 | |
--ssl-password | SSL 証明書のパスワード。 | |
-n, --nodeid | このシステムのNodeId を表示します。 | |
-l, --license | このシステム上にライセンスをインストールします。このオプションは、ライセンスタイプおよびその他の詳細情報についてプロンプトします。 |
All configuration data is read from the registry at "HKEY_LOCAL_MACHINE\SOFTWARE\RemoteConnector". Each user will have a separate subkey with user-specific settings. For instance "HKEY_LOCAL_MACHINE\SOFTWARE\RemoteConnector\User1".
Name | Type | Description |
LocalAuth | String | A randomly generated administrator password that is used for authorization between the user interface and the Windows service. This is only used when authorizing a user configured for Windows authentication to QuickBooks from the user interface. This may be removed or changed if desired. |
AllowedClients | String | A comma-separated list of host names or IP addresses that can access the server. The wildcard character '*' is supported (default). If unspecified any client can connect. |
AuthFlags | DWORD | Specifies the versions of QuickBooks to which the application can connect. The value is a binary OR of the values below, represented in hex. The default value is "0xF" (all editions are supported).
|
CloseAndRetryConnect | DWORD | Specifies whether connection retry logic is enabled. When set to 1 (True), if an error is encountered while opening a connection to QuickBooks the application will attempt to stop the QuickBooks process and reconnect. The CloseAndRetryTimeout, CloseAndRetryCount, and CloseAndRetryErrorList settings are applicable when this setting is 1 (True). |
CloseAndRetryTimeout | DWORD | Sets the time in seconds that the application will wait for the connection to QuickBooks to be established. The default value is 30 (seconds). If the timeout is reached, the QuickBooks process will be closed and the connection will be retried. Note that this setting should be adjusted with caution. If the timeout is set too low the QuickBooks process may not have time to open normally before reaching the timeout. This setting is only applicable when CloseAndRetryConnect is True. |
CloseAndRetryCount | DWORD | Sets the number of times to retry the connection. If an error is encountered while opening a connection to QuickBooks, the application will stop the QuickBooks process and retry until this limit is reached. The default value is 3. This setting is only applicable when CloseAndRetryConnect is True. |
CloseAndRetryErrorList | String | Specifies a comma-separated list of QuickBooks error codes on which to retry a connection. If QuickBooks returns an error code listed in this property, the QuickBooks process will be stopped and the connection will be retried. If the error is not in this list the application will return the error as normal. The default value is "0x80040402,0x80040408". Specify the value "*" to indicate all errors. This setting is only applicable when CloseAndRetryConnect is True. |
QBInstanceFile | String |
Specifies the full path to the QBINSTANCEFINDER file in the QuickBooks installation. For instance: "C:\ProgramData\Intuit\QuickBooks\QBINSTANCEFINDER17.INI". This setting is only applicable when CloseAndRetryConnect is set to True. If the connection retry logic stops the QuickBooks process the specified QBINSTANCEFINDER file will be cleared of any previous entries. QuickBooks uses the QBINSTANCEFINDER file to keep track of open instances, however, in some situations it may not be properly reset after stopping the process. When specified this setting allows the application to properly reset the file after stopping the process. |
LocalHost | String | Sets the host name or user-assigned IP interface through which connections are initiated or accepted. In most cases this does not need to be set, as the application will use the default interface on the machine. If you have multiple interfaces, you can specify the interface to use here. For instance, "192.168.1.102". |
LogEnabled | DWORD | Enables or disables logging to a file. Logs are always written to the console. The default is 0 (False). |
LogDir | String | Sets the path to a folder on disk where log files will be written. This is only applicable if LogEnabled is set to True. |
LogFormat | DWORD | Sets how often new log files are created. Possible values are the following:
|
LogLevel | DWORD | Sets the logging level. Possible values are the following:
|
LogPort | DWORD | Sets a separate port for logging. Log messages are sent over UDP from RemoteConnectorService.exe to the UI. By default this is the same value as the port defined in the Port option. Set this option to avoid using the same port as another UDP service running on the same machine. |
Port | DWORD | Sets the port where the server listens for incoming connections. The default value is 8166. |
PersistentEnabled | DWORD | Enables or disables persistent connections to QuickBooks. The default is 0 (False), meaning that your code controls when the connection to QuickBooks is opened and closed by calling the Open and Close methods. However, when this setting is enabled, a persistent connection to QuickBooks is established by the QuickBooks Gateway even when Open and Close are not used. This is helpful in situations when multiple applications may be simultaneously accessing the QuickBooks Gateway, because it allows them to share the connection. |
PersistentIdleTimeout | DWORD | Sets the idle timeout for the persistent connection in seconds. If there is no activity within this time window, the connection to QuickBooks will be closed. This is only applicable when PersistentEnabled is True. |
PromptForRegPermissions | DWORD | Specifies whether to prompt to modify registry permissions when access is not allowed. This is only applicable when saving settings from the UI. |
RunAsService | DWORD | Run the application as a service or with the standard run-time permissions. The default value is 1 (True). |
SSLCertPassword | String | Sets the password of the SSL certificate. |
SSLCertStore | String | Sets the location of the SSL certificate. This may be a path to a file or the name of a Windows certificate store: "MY", "ROOT", "CA", or "SPC". |
SSLCertSubject | String | Sets the subject of the SSL certificate. |
SSLCertType | String | Sets the type of SSL certificate to use. A certificate must be specified when SSL is enabled. The PFX option signifies a .pfx file on disk. The User option signifies the user's Windows certificate store. The Machine option signifies the Windows certificate store of the machine. |
SSLEnabled | DWORD | Sets whether TLS/SSL connections are allowed. The default value is 0 (False). Enabling TLS/SSL disables plaintext connections. |
Timeout | DWORD | Sets the operational timeout for connected clients. The default value is 60. |
UseInteractiveLogon | DWORD | Sets whether interactive or network logon will authorize users when AuthMode is set to 1 (Windows). In most cases this does not need to be set. This should be set to 1 (True) if your domain controller is Samba. The default value is 0 (False). |
AppName | String | Sets the name of the application that will be used to provide authentication to QuickBooks when a connection is made. If this value is not set, the QuickBooks Gateway uses the value provided by the client. |
CompanyFile | String | Sets the path to a QuickBooks company file (.qbw). If this is not set, the currently open company file is used. When QuickBooks is not running, this option must be set. |
Password | String | Sets the password of the user. This is required when AuthMode is set to 0 (Basic Authentication). The QuickBooks Gateway application will always store the SHA-256 hash of the password for security. However, this may also be manually set to a plaintext password to allow backward compatibility. |
AuthMode | DWORD | Sets the type of authentication to perform when the user connects. From the client side the process of connecting is exactly the same no matter which option you choose. Possible values are the following:
|
Authorized | DWORD | Specifies whether the AppName has been authorized for the CompanyFile. If 1 (True) the AppName has been authorized with the CompanyFile. This is an indicator used by the application when changing settings in the UI. |
ConnectionMode | String | Sets the connection mode for the user. The default is DontCare. In most cases you do not need to set this value. If this is not set, the application will connect in whatever mode QuickBooks is already open in. Possible values are the following:
|
ReadOnly | DWORD | Specifies whether the user has read-only (1) or full access (0). |
このセクションでは、QuickBooks Cloud の高度な機能を厳選して説明します。
Cloud を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Cloud が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようCloud を設定します。トンネル接続を設定することもできます。
Cloud は、QuickBooks にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
CData Cloud を使用すると、事前設定されたクエリによって内容が決定される仮想テーブルを定義できます。これらはユーザー定義ビューと呼ばれ、ツール からドライバーを使用する場合など、ドライバーに発行されるクエリを直接制御できない場合に役立ちます。 ユーザー定義ビューを使用して、常に適用されるプレディケートを定義することができます。ビューへのクエリで追加のプレディケートを指定すると、それらはビューの一部としてすでに定義されているクエリと結合されます。
ユーザー定義ビューを作成する方法は2つあります。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがCloud によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Customers WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
SELECT * FROM Customers WHERE City = 'Raleigh';ドライバーへのクエリは次のようになります。
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';ソースへの効果的なクエリは次のようになります。
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';これは、ビュークエリとビュー定義を効果的に組み合わせた、ユーザー定義ビューへのクエリの非常にシンプルな例です。これらのクエリをはるかに複雑なパターンで構成することが可能です。すべてのSQL 操作は両方のクエリでサポートされ、必要に応じて組み合わされます。
レコードを挿入する際、親レコードに依存する子レコードに関する詳細を入力する必要がある状況は度々発生します。
例えばCRM システムを使う場合には、Invoices を入力するには最低1つの明細行が必要です。
Invoices には、各行が複数のフィールドを持つ多数の明細行を入力できます。こうしたInvoices の仕様は、データをリレーショナルテーブルとして提供する際に問題となります。
データを読み込む際、外部キーで接続されたInvoice とInvoiceLineItem テーブルをモデル化するのは容易です。
しかし挿入の際には、CRM システムはInvoice およびInvoiceLineItems を1つの操作で作成する必要があります。
こうした問題を解決するために、CData のツールは親コレクションカラム上に子コレクションカラムを提供します。
これらのカラムは、親および子レコード両方の情報を持つINSERT ステートメントを発行する際に使用することができます。
このページの例では、Invoice テーブルにはInvoiceLineItems というカラムが存在します。
挿入の際には、InvoiceLineItems テーブルに挿入する必要があるレコードの詳細を、Invoice レコードのInvoiceLineItems カラムに渡すことができます。
これは、以下の方法で可能です。
親および子レコードを挿入するために、Cloud は2つの方法を用意しています。一時テーブルを使った挿入と、XML / JSON への集約による挿入です。
データを入力する最も簡易な方法は、Cloud がメモリに格納する#TEMP テーブル、または一時テーブルを使用することです。
#TEMP テーブルは以下の構文で参照してください。
TableName#TEMP
#TEMP テーブルは接続中はメモリに格納されます。
そのため、これらのテーブルを使用する際には挿入の発行間で接続を閉じることができず、各クエリで異なる接続を使用する環境では一時テーブルは使用できません。
単一の接続内では、テーブルはバルク挿入が成功するまでメモリに残り、成功した時点でメモリから消去されます。
例:
INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Basketball', 10, 9.99) INSERT INTO InvoiceLineItems#TEMP (ReferenceNumber, Item, Quantity, Amount) VALUES ('INV001', 'Football', 5, 12.99)
InvoiceLineItems テーブルに書き込みが行われた後で、Invoice テーブルへの挿入中に#TEMP テーブルが参照されます。
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')
内部ではCloud が#TEMP テーブルから値を読み込みます。
ReferenceNumber は、どのInvoice に明細が紐付けられているかを特定するのに使用されています。
これは、異なるInvoice に異なる明細が記載されている状況で、#TEMP テーブルにバルク挿入で書き込みが行われ、使用される可能性があるためです。
これで#TEMP テーブルをバルク挿入で使用することができます。例:
INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP') INSERT INTO Invoices#TEMP (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV002', 'Jane Doe', 'InvoiceLineItems#TEMP') INSERT INTO Invoices SELECT ReferenceNumber, Customer, InvoiceLines FROM Invoices#TEMP
この場合、2つの異なるInvoice を挿入しています。ReferenceNumber によって、どのLines がどのInvoice に入力されるかを決定します。
Note:ここで示したテーブルとカラムは、Cloud が一般にどのように動作するかを示す一例です。特定のテーブルおよびカラム名は、Cloud 内で異なることがあります。
#TEMP テーブルの代替として、XML / JSON を直接使うこともできます。#TEMP テーブルはXML / JSON を作成するためには使われないので、同じ接続を使うか挿入後に接続を閉じるかは影響しません。
例:
[ { "Item", "Basketball", "Quantity": 10 "Amount": 9.99 }, { "Item", "Football", "Quantity": 5 "Amount": 12.99 } ]
または
<Row> <Item>Basketball</Item> <Quantity>10</Quantity> <Amount>9.99</Amount> </Row> <Row> <Item>Football</Item> <Quantity>5</Quantity> <Amount>12.99</Amount> </Row>
以下の例ではReferenceNumber は使用していません。
これは、XML / JSON が仕様上参照によって渡されるものではなく、親レコードに対して挿入ごとに全体で渡されるためです。
行ごとに完全なXML / JSON を作成および発行する必要があるので、親レコードに子レコードを紐付け直すものは必要ありません。
その後、値を挿入します。
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '{...}')
または
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '<Row>...</Row>')
For a working example of how temp tables can be used for bulk insert in QuickBooks, please see the following:
// Insert into Invoices table INSERT INTO InvoiceLineItems#TEMP (ItemName, ItemQuantity) VALUES ('Repairs','1') INSERT INTO InvoiceLineItems#TEMP (ItemName, ItemQuantity) VALUES ('Removal','2') INSERT INTO Invoices (CustomerName, Memo, ItemAggregate) VALUES ('Abercrombie, Kristy', 'NUnit Memo', 'InvoiceLineItems#TEMP') // Insert into InvoiceLineItems table INSERT INTO InvoiceLineItems#TEMP (CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate) VALUES ('Abercrombie, Kristy', '2011-01-01', 'UPS', '2011-01-02', 'NUnit Memo', 'We appreciate your prompt payment.', '2011-01-03', 'Some other data', 'Repairs', '1', '3.50') INSERT INTO InvoiceLineItems#TEMP (CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate) VALUES ('Abercrombie, Kristy', '2011-01-01', 'UPS', '2011-01-02', 'NUnit Memo', 'We appreciate your prompt payment.', '2011-01-03', 'Some other data', 'Removal', '2', '3.50') INSERT INTO InvoiceLineItems (CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate) SELECT CustomerName, Date, ShipMethod, ShipDate, Memo, Message, DueDate, Other, ItemName, ItemQuantity, ItemRate InvoiceLineItems#TEMP
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
SQL-92をサポートしないソースに対しては、Cloud はQuickBooks にSQLステートメントの処理を可能な限りオフロードし、残りのクエリをクライアントサイドのインメモリで処理します。その結果、最適なパフォーマンスを得ることができます。
限られたクエリ能力のデータソースに対しては、Cloud はSQL クエリの変換をおこない、Cloud がより単純になるよう処理します。 目標はデータソースのクエリ能力に基づいて賢く判断し可能な限り計算を抑えることです。QuickBooks のクエリ評価コンポーネントはSQL クエリを検証し、Cloud がネイティブに実行できないクエリ部分を示す情報を返します。
QuickBooks のクエリスライサーコンポーネントはより具体的なケースにおいて1つのクエリを複数の独立したクエリに分割するために使用されます。クライアントサイドのクエリエンジンはクエリの簡素化、複数のクエリへの分割、結果セットのサイズを最小化しながらクライアントサイドで集約のプッシュダウンや計算をするなどの決定を行います。
クエリを部分的にでもクライアントサイドで評価するということには大きなトレードオフがあります。このモデルでは効果的に実行することが不可能なクエリは常に存在し、この方法で計算すると特にコストが高くなるものもあります。CData は可能な限り効率的なクエリを生成し、最も柔軟なクエリ機能を提供するために常にデータソースに対して実行可能な限りのクエリをプッシュダウンしています。
Cloud のログを取得しておくことで、エラーメッセージや想定外の振る舞いを診断する際に役立ちます。
2つの接続プロパティを設定するだけで、Cloud のログを取得できます。
このプロパティを設定すると、認証が実行されたときやクエリが実行されたときなど、さまざまなタスクを実行する際に、Cloud がログファイルを生成します。指定したファイルが存在しない場合は作成されます。
Verbosity レベルは、Cloud がLogfile にどの程度の詳細さで記載するかを決定します。1 から5 までのVerbosity レベルがサポートされています。次のリストで、これらについて説明します。
1 | Verbosity を1に設定すると、クエリ、返された行数、実行開始とかかった時間、エラーが記録されます。 |
2 | Verbosity を2に設定すると、Verbosity 1に含まれるすべておよびリクエストに関する追加の情報が記録されます。 |
3 | Verbosity を3に設定すると、2 に加えてHTTP ヘッダーおよびリクエストとレスポンスの本文が記録されます。 |
4 | Verbosity を4に設定すると、3 に加えてデータソースとのトランスポートレベルの通信が記録されます。これには、SSL ネゴシエーションが含まれます。 |
5 | Verbosity を5に設定すると、データソースとのやり取りおよび問題のトラブルシューティングに役立つ追加情報も記録されます。これには、インターフェースコマンドが含まれます。 |
通常の実行では、Verbosity を2以上に設定しないでください。高い詳細レベルでは、大量のデータが記録されて、実行に遅れが生じる恐れがあります。
特定の情報に関するカテゴリを表示または非表示にしてログ内容を調整するには、LogModules を参照してください。
データセキュリティのベストプラクティス
パスワードなどのセンシティブデータは、接続文字列やログ内のすべてのリクエストでマスクされますが、組織外で共有する前に機密情報がないかログを確認することをお勧めします。
ログファイルに記録される情報を、正確に絞り込みたい場合があるかもしれません。これは、LogModules プロパティを使用することで可能です。
このプロパティを使えば、セミコロン区切りでリスト化されたログモジュールを使用してログ内容をフィルタできます。
すべてのモジュール名は4文字です。注意点として、3文字のモジュール名は、必ず最後に空白文字を含みます。利用可能なモジュールは次のとおりです。
LogModules=INFO;EXEC;SSL ;SQL ;META;
これらのモジュールはVerbosity を考慮して、取得中の情報の詳細レベルを変更します。
CData Cloud はクエリ、削除、編集、および挿入を含む、データに対する複数の処理をサポートします。
構文のリファレンスと例については、SELECT ステートメント を参照してください。
QuickBooks API 機能の詳細については、データモデル を参照してください。
構文のリファレンスと例、および新しいレコードId の取得については、INSERT ステートメント を参照してください。
レコードの更新には、主キーId が必要です。構文のリファレンスと例については、UPDATE ステートメント を参照してください。
レコードの削除には、主キーId が必要です。構文のリファレンスと例については、DELETE ステートメント を参照してください。
GETDELETED ステートメントは削除されたレコードのId を返します。構文のリファレンスと例については、GETDELETED ステートメント を参照してください。
EXECUTE またはEXEC ステートメントを使用して、ストアドプロシージャを実行します。構文のリファレンスと例については、EXECUTE ステートメント を参照してください。
SELECT ステートメントは次の基本的な句で構成できます。
次の構文ダイアグラムは、Cloud のSQL エンジン:
SELECT {
[ TOP <numeric_literal> | DISTINCT ]
{
*
| {
<expression> [ [ AS ] <column_reference> ]
| { <table_name> | <correlation_name> } .*
} [ , ... ]
}
[ INTO csv:// [ filename= ] <file_path> [ ;delimiter=tab ] ]
{
FROM <table_reference> [ [ AS ] <identifier> ]
} [ , ... ]
[ [
INNER | { { LEFT | RIGHT | FULL } [ OUTER ] }
] JOIN <table_reference> [ ON <search_condition> ] [ [ AS ] <identifier> ]
] [ ... ]
[ WHERE <search_condition> ]
[ GROUP BY <column_reference> [ , ... ]
[ HAVING <search_condition> ]
[ UNION [ ALL ] <select_statement> ]
[
ORDER BY
<column_reference> [ ASC | DESC ] [ NULLS FIRST | NULLS LAST ]
]
[
LIMIT <expression>
[
{ OFFSET | , }
<expression>
]
]
} | SCOPE_IDENTITY()
<expression> ::=
| <column_reference>
| @ <parameter>
| ?
| COUNT( * | { [ DISTINCT ] <expression> } )
| { AVG | MAX | MIN | SUM | COUNT } ( <expression> )
| NULLIF ( <expression> , <expression> )
| COALESCE ( <expression> , ... )
| CASE <expression>
WHEN { <expression> | <search_condition> } THEN { <expression> | NULL } [ ... ]
[ ELSE { <expression> | NULL } ]
END
| <literal>
| <sql_function>
<search_condition> ::=
{
<expression> { = | > | < | >= | <= | <> | != | LIKE | NOT LIKE | IN | NOT IN | IS NULL | IS NOT NULL | AND | OR | CONTAINS | BETWEEN } [ <expression> ]
} [ { AND | OR } ... ]
でサポートされている構文の概要を示します。
SELECT * FROM Customers
SELECT [Name] AS MY_Name FROM Customers
SELECT CAST(AnnualRevenue AS VARCHAR) AS Str_AnnualRevenue FROM Customers
SELECT * FROM Customers WHERE Name = 'Cook, Brian'
SELECT COUNT(*) AS MyCount FROM Customers
SELECT COUNT(DISTINCT Name) FROM Customers
SELECT DISTINCT Name FROM Customers
SELECT Name, MAX(AnnualRevenue) FROM Customers GROUP BY Name詳しくは、集計関数 を参照してください。
SELECT i.ReferenceNumber, c.AccountNumber FROM Invoices i INNER JOIN Customers c ON i.CustomerId=c.ID詳しくは、JOIN クエリ を参照してください。
SELECT Id, Name FROM Customers ORDER BY Name ASC
SELECT Id, Name FROM Customers LIMIT 10
SELECT * FROM Customers WHERE Name = @param
SELECT ステートメントで入力専用フィールドを使用できます。これらのフィールド(疑似カラム)は、結果には
通常のカラムとして表示されることはありませんが、WHERE 句の一部として指定できます。疑似カラムを使用して、QuickBooks から追加機能にアクセスできます。
SELECT * FROM Customers WHERE IncludeJobs = 'TRUE'
クエリ条件に一致する行の数を返します。
SELECT COUNT(*) FROM Customers WHERE Name = 'Cook, Brian'
クエリ条件に一致する、null 以外の個別のフィールド値の数を返します。
SELECT COUNT(DISTINCT Id) AS DistinctValues FROM Customers WHERE Name = 'Cook, Brian'
カラムの値の平均を返します。
SELECT Name, AVG(AnnualRevenue) FROM Customers WHERE Name = 'Cook, Brian' GROUP BY Name
カラムの値の最小値を返します。
SELECT MIN(AnnualRevenue), Name FROM Customers WHERE Name = 'Cook, Brian' GROUP BY Name
カラムの値の最大値を返します。
SELECT Name, MAX(AnnualRevenue) FROM Customers WHERE Name = 'Cook, Brian' GROUP BY Name
カラムの値の合計を返します。
SELECT SUM(AnnualRevenue) FROM Customers WHERE Name = 'Cook, Brian'
CData Cloud は次の例のような標準SQL の結合をサポートします。
内部結合は、結合条件に合う行のみを両テーブルから選択します。
SELECT i.ReferenceNumber, c.AccountNumber FROM Invoices i INNER JOIN Customers c ON i.CustomerId=c.ID
左結合は、FROM テーブルのすべての行とJOIN テーブルの条件に合う行のみを選択します。
SELECT i.ReferenceNumber, c.AccountNumber FROM Invoices i LEFT JOIN Customers c ON i.CustomerId=c.ID
次の日付リテラル関数を使用して、相対間隔を使って日付フィールドをフィルタできます。これらの関数では、<、>、および = 演算子がサポートされていますが、<= および >= はサポートされていないことに注意してください。
現在の日。
SELECT * FROM MyTable WHERE MyDateField = L_TODAY()
前の日。
SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()
次の日。
SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()
前の週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()
現在の週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()
次の週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()以下も利用可能です:
現在の日を除く過去n 日。
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)
現在の日を含む次のn 日。
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)以下も利用可能です:
現在の週のn 週前から始まり、前の週で終わる、すべての週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)
次の週から始まり、n 週後に終わる、すべての週のすべての日。
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)以下も利用可能です:
SELECT INTO ステートメントを使って、書式付きデータをファイルにエクスポートできます。
次のクエリは、comma-separated values(CSV)ファイルフォーマットにデータをエクスポートします。
SELECT Id, Name INTO [csv://Customers.txt] FROM [Customers] WHERE Name = 'Cook, Brian'ファイルURI で他のフォーマットを指定できます。利用可能な区切り文字はタブ、セミコロン、カンマです。デフォルトはカンマです。次の例は、tab-separated values(TSV)にエクスポートします。
SELECT Id, Name INTO [csv://Customers.txt;delimiter=tab] FROM [Customers] WHERE Name = 'Cook, Brian'URI で他のファイルフォーマットを指定できます。以下の例は、tab-separated values(TSV)にエクスポートします。
Cloud には、ほとんどの標準的なデータベースで使用できる関数と同様の関数が用意されています。これらの関数は、CData プロバイダーエンジンで実装されるため、同じ一貫したAPI を使用してすべてのデータソースに渡って使用できます。関数にはstring、date、math の3つのカテゴリがあります。
Cloud はすべてのSQL 関数入力を文字列またはカラム識別子のいずれかとして解釈するため、すべてのリテラルを単一引用符で文字列としてエスケープする必要があります。例えば、DATENAME 関数のSQL Server 構文とCloud 構文を比較すると次のようになります。
SELECT DATENAME(yy,GETDATE())
SELECT DATENAME('yy',GETDATE())
これらの関数は、文字列操作を実行し、文字列値を返します。詳しくは、文字列関数 を参照してください。
SELECT CONCAT(firstname, space(4), lastname) FROM Customers WHERE Name = 'Cook, Brian'
これらの関数は、日付および日時操作を実行します。詳しくは、日付関数 を参照してください。
SELECT CURRENT_TIMESTAMP() FROM Customers
これらの関数は、数値演算を提供します。詳しくは、算術関数 を参照してください。
SELECT RAND() FROM Customers
SELECT CONCAT('Mr.', SPACE(2), firstname, SPACE(4), lastname) FROM Customers
文字式の左端の文字のASCII コード値を返します。
SELECT ASCII('0'); -- Result: 48
整数のASCII コードを対応する文字に変換します。
SELECT CHAR(48); -- Result: '0'
指定した文字列式の開始位置を返します。
SELECT CHARINDEX('456', '0123456'); -- Result: 4 SELECT CHARINDEX('456', '0123456', 5); -- Result: -1
式内にあるUTF-8 文字の数を返します。
SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1 -- Result: 11
2つ以上の文字列値を連結した文字列を返します。
SELECT CONCAT('Hello, ', 'world!'); -- Result: 'Hello, world!'
expressionToSearch 中にexpressionToFind が見つかった場合は1を、それ以外は0を返します。
SELECT CONTAINS('0123456', '456'); -- Result: 1 SELECT CONTAINS('0123456', 'Not a number'); -- Result: 0
character_expression がcharacter_suffix で終わる場合は1を、それ以外は0を返します。
SELECT ENDSWITH('0123456', '456'); -- Result: 1 SELECT ENDSWITH('0123456', '012'); -- Result: 0
指定されたファイルパスのファイルに存在するバイト数を返します。
SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt'); -- Result: 23684
指定された書式で値をフォーマットして返します。
SELECT FORMAT(12.34, '#'); -- Result: 12 SELECT FORMAT(12.34, '#.###'); -- Result: 12.34 SELECT FORMAT(1234, '0.000E0'); -- Result: 1.234E3 SELECT FORMAT('2019/01/01', 'yyyy-MM-dd'); -- Result: 2019-01-01 SELECT FORMAT('20190101', 'yyyyMMdd', 'yyyy-MM-dd'); -- Result: '2019-01-01'
unix_timestamp 引数を、現在のタイムゾーンで表されたYYYY-MM-DD HH:MM:SS の値で返します。
SELECT FROM_UNIXTIME(1540495231, 1); -- Result: 2018-10-25 19:20:31 SELECT FROM_UNIXTIME(1540495357385, 0); -- Result: 2018-10-25 19:22:37
指定されたアルゴリズムを使用して、入力値のハッシュをバイト配列として返します。サポートされているアルゴリズムはMD5、SHA1、SHA2_256、SHA2_512、SHA3_224、SHA3_256、SHA3_384、およびSHA3_512 です。
SELECT HASHBYTES('MD5', 'Test'); -- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
指定した文字列式の開始位置を返します。
SELECT INDEXOF('0123456', '456'); -- Result: 4 SELECT INDEXOF('0123456', '456', 5); -- Result: -1
null を指定した置換値に置き換えます。
SELECT ISNULL(42, 'Was NULL'); -- Result: 42 SELECT ISNULL(NULL, 'Was NULL'); -- Result: 'Was NULL'
JSON オブジェクト内のJSON 配列の平均値を計算します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_AVG('[1,2,3,4,5]', '$[x]'); -- Result: 3 SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]'); -- Result: 3 SELECT JSON_AVG('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]'); -- Result: 4.5
JSON オブジェクト内のJSON 配列のエレメント数を返します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_COUNT('[1,2,3,4,5]', '$[x]'); -- Result: 5 SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]'); -- Result: 5 SELECT JSON_COUNT('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]'); -- Result: 2
JSON 配列またはオブジェクトのあらゆる値を選択します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test'); -- Result: '{"data":1}' SELECT JSON_EXTRACT('{"test": {"data": 1}}', '$.test.data'); -- Result: 1 SELECT JSON_EXTRACT('{"test": {"data": [1, 2, 3]}}', '$.test.data[1]'); -- Result: 2
JSON オブジェクト内のJSON 配列の最大値を取得します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_MAX('[1,2,3,4,5]', '$[x]'); -- Result: 5 SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]'); -- Result: 5 SELECT JSON_MAX('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[..3]'); -- Result: 4
JSON オブジェクト内のJSON 配列の最小値を取得します。配列へのパスはjsonpath 引数で指定します。戻り値は数値またはnull です。
SELECT JSON_MIN('[1,2,3,4,5]', '$[x]'); -- Result: 1 SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]'); -- Result: 1 SELECT JSON_MIN('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]'); -- Result: 4
JSONPath 式に応じたJSON のサマリー値を計算します。戻り値は数値またはnull です。
SELECT JSON_SUM('[1,2,3,4,5]', '$[x]'); -- Result: 15 SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[x]'); -- Result: 15 SELECT JSON_SUM('{"test": {"data": [1,2,3,4,5]}}', '$.test.data[3..]'); -- Result: 9
指定された文字列の左端から指定された数の文字を返します。
SELECT LEFT('1234567890', 3); -- Result: '123'
指定された文字列式の文字数を返します。
SELECT LEN('12345'); -- Result: 5
部分文字列が表示される文字列の文字数を表す整数を返します。
SELECT LOCATE('sample','XXXXXsampleXXXXX'); -- Result: 6
大文字データを小文字に変換した文字式を返します。
SELECT LOWER('MIXED case'); -- Result: 'mixed case'
先頭の空白を除いた文字式を返します。
SELECT LTRIM(' trimmed'); -- Result: 'trimmed'
start_index とend_index の間の文字を文字列内のmask_character に置き換えます。
SELECT MASK('1234567890','*',); -- Result: '**********' SELECT MASK('1234567890','*', 4); -- Result: '1234******' SELECT MASK('1234567890','*', 4, 2); -- Result: '1234****90'
Unicode 標準の定義に従って、指定された整数コードのUnicode 文字を返します。
式内にあるバイト数を返します。
SELECT OCTET_LENGTH('text') FROM Account LIMIT 1 -- Result: 4
式内に最初に見つかったパターンの開始位置を返します。パターンが見つからなかった場合は0を返します。
SELECT PATINDEX('123%', '1234567890'); -- Result: 1 SELECT PATINDEX('%890', '1234567890'); -- Result: 8 SELECT PATINDEX('%456%', '1234567890'); -- Result: 4
指定した文字列式の開始位置を返します。
SELECT POSITION('456' IN '123456'); -- Result: 4 SELECT POSITION('x' IN '123456'); -- Result: 0
指定されたUnicode 文字列に必要な区切り記号を追加することで、有効なSQL Server の区切り付き識別子を返します。
SELECT QUOTENAME('table_name'); -- Result: '[table_name]' SELECT QUOTENAME('table_name', '"'); -- Result: '"table_name"' SELECT QUOTENAME('table_name', '['); -- Result: '[table_name]'
見つかった文字列をすべて別の文字列に置換します。
SELECT REPLACE('1234567890', '456', '|'); -- Result: '123|7890' SELECT REPLACE('123123123', '123', '.'); -- Result: '...' SELECT REPLACE('1234567890', 'a', 'b'); -- Result: '1234567890'
文字列値を指定された回数だけ繰り返します。
SELECT REPLACE('x', 5); -- Result: 'xxxxx'
文字列式を逆順序で返します。
SELECT REVERSE('1234567890'); -- Result: '0987654321'
文字列の右側から指定された数の文字を返します。
SELECT RIGHT('1234567890', 3); -- Result: '890'
末尾の空白を削除した後の文字式を返します。
SELECT RTRIM('trimmed '); -- Result: 'trimmed'
文字列の音声表現に基づいて、4文字のSoundex コードを返します。
SELECT SOUNDEX('smith'); -- Result: 'S530'
空白の繰り返しで構成される文字列を返します。
SELECT SPACE(5); -- Result: ' '
区切り文字の間の文字列のセクションを返します。
SELECT SPLIT('a/b/c/d', '/', 1); -- Result: 'a' SELECT SPLIT('a/b/c/d', '/', -2); -- Result: 'c'
character_expression がcharacter_prefix で始まる場合は1を、それ以外は0を返します。
SELECT STARTSWITH('0123456', '012'); -- Result: 1 SELECT STARTSWITH('0123456', '456'); -- Result: 0
数値データから変換された文字データを返します。例えば、STR(123.45, 6, 1) は123.5 を返します。
SELECT STR('123.456'); -- Result: '123' SELECT STR('123.456', 2); -- Result: '**' SELECT STR('123.456', 10, 2); -- Result: '123.46'
文字列を別の文字列内に挿入します。まず、最初の文字列の指定された開始位置から指定された長さの文字を削除し、次に、2番目の文字列を最初の文字列の指定された開始位置に挿入します。
SELECT STUFF('1234567890', 3, 2, 'xx'); -- Result: '12xx567890'
文字列のうち、指定されたインデックスから始まる指定された長さの部分を返します。
SELECT SUBSTRING('1234567890' FROM 3 FOR 2); -- Result: '34' SELECT SUBSTRING('1234567890' FROM 3); -- Result: '34567890'
インスタンスの値を同様の文字列表現に変換します。
SELECT TOSTRING(123); -- Result: '123' SELECT TOSTRING(123.456); -- Result: '123.456' SELECT TOSTRING(null); -- Result: ''
左および/または右の空白を除いた文字式を返します。
SELECT TRIM(' trimmed '); -- Result: 'trimmed' SELECT TRIM(LEADING FROM ' trimmed '); -- Result: 'trimmed ' SELECT TRIM('-' FROM '-----trimmed-----'); -- Result: 'trimmed' SELECT TRIM(BOTH '-' FROM '-----trimmed-----'); -- Result: 'trimmed' SELECT TRIM(TRAILING '-' FROM '-----trimmed-----'); -- Result: '-----trimmed'
インプット式の最初の文字のUnicode 標準で定義された整数の値を返します。
文字式の小文字データを大文字に変換して返します。
SELECT UPPER('MIXED case'); -- Result: 'MIXED CASE'
指定されたXPath を使ってXML ドキュメントを抽出して、XML をフラット化します。デフォルトでは、出力の区切りにはカンマが使用されますが、これは3番目のパラメータを指定することで変更できます。
SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch'); -- Result: 'a,e,i,o,u' SELECT XML_EXTRACT('<vowels><ch>a</ch><ch>e</ch><ch>i</ch><ch>o</ch><ch>u</ch></vowels>', '/vowels/ch', ';'); -- Result: 'a;e;i;o;u'
現在のdate 値を返します。
SELECT CURRENT_DATE(); -- Result: 2018-02-01
現在のデータベースシステムのタイムスタンプをdatetime 値で返します。この値はGETDATE およびSYSDATETIME と等しく、常にローカルタイムゾーンになります。
SELECT CURRENT_TIMESTAMP(); -- Result: 2018-02-01 03:04:05
date の指定されたdatepart に、指定されたnumber(符号付き整数)を加算したdatetime 値を返します。
SELECT DATEADD('d', 5, '2018-02-01'); -- Result: 2018-02-06 SELECT DATEADD('hh', 5, '2018-02-01 00:00:00'); -- Result: 2018-02-01 05:00:00
指定されたstartdate とenddate の差(符号付き整数)を返します。
SELECT DATEDIFF('d', '2018-02-01', '2018-02-10'); -- Result: 9 SELECT DATEDIFF('hh', '2018-02-01 00:00:00', '2018-02-01 12:00:00'); -- Result: 12
指定された年、月、および日のdatetime 値を返します。
SELECT DATEFROMPARTS(2018, 2, 1); -- Result: 2018-02-01
指定されたdate の指定されたdatepart を表す文字列を返します。
SELECT DATENAME('yy', '2018-02-01'); -- Result: '2018' SELECT DATENAME('dw', '2018-02-01'); -- Result: 'Thursday'
指定されたdate の指定されたdatepart を表す文字列を返します。
SELECT DATEPART('yy', '2018-02-01'); -- Result: 2018 SELECT DATEPART('dw', '2018-02-01'); -- Result: 5
指定されたdatepart のdatetime 値を返します。
SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3); -- Result: 2018-02-01 01:02:03.456
指定されたdatepart のdatetime 値を返します。
SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456); -- Result: 2018-02-01 01:02:03.456
指定されたdatepart の精度に日付を切り捨てます。Oracle TRUNC 関数をモデルにしています。
SELECT DATE_TRUNC('05-04-2005', 'YY'); -- Result: '1/1/2005' SELECT DATE_TRUNC('05-04-2005', 'MM'); -- Result: '5/1/2005'
指定されたdatepart の精度に日付を切り捨てます。PostgreSQL date_trunc 関数をモデルにしています。
SELECT DATE_TRUNC2('year', '2020-02-04'); -- Result: '2020-01-01' SELECT DATE_TRUNC2('week', '2020-02-04', 'monday'); -- Result: '2020-02-02', which is the previous Monday
指定されたdate の日コンポーネントを指定する整数を返します。
SELECT DAY('2018-02-01'); -- Result: 1
SELECT DAYOFMONTH('04/15/2000'); -- Result: 15
SELECT DAYOFWEEK('04/15/2000'); -- Result: 7
SELECT DAYOFYEAR('04/15/2000'); -- Result: 106
指定されたdate を含む月、またはオプションでその月からオフセットされた月の最終日を返します。
SELECT EOMONTH('2018-02-01'); -- Result: 2018-02-28 SELECT LAST_DAY('2018-02-01'); -- Result: 2018-02-28 SELECT EOMONTH('2018-02-01', 2); -- Result: 2018-04-30
SELECT FDWEEK('02-08-2018'); -- Result: 2/4/2018
SELECT FDMONTH('02-08-2018'); -- Result: 2/1/2018
SELECT FDQUARTER('05-08-2018'); -- Result: 4/1/2018
関連ファイルの変更日に関連付けられたタイムスタンプを返します。
SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt'); -- Result: 6/25/2019 10:06:58 AM
1582-10-15以降の日数から派生した日付を返します(グレゴリオ暦に基づく)。これはMYSQL FROM_DAYS 関数と同等です。
SELECT FROM_DAYS(736000); -- Result: 2/6/2015
現在のデータベースシステムのタイムスタンプをdatetime 値で返します。この値はCURRENT_TIMESTAMP およびSYSDATETIME と等しく、常にローカルタイムゾーンになります。
SELECT GETDATE(); -- Result: 2018-02-01 03:04:05
UTC datetime 値としてフォーマットされた現在のデータベースシステムのタイムスタンプを返します。SYSUTCDATETIME と同じです。
SELECT GETUTCDATE(); -- For example, if the local timezone is Eastern European Time (GMT+2) -- Result: 2018-02-01 05:04:05
指定されたdatetime から時間コンポーネントを返します。
SELECT HOUR('02-02-2020 11:30:00'); -- Result: 11
この値が有効なdate、time、またはdatetime 値である場合は1を返します。それ以外の場合は0を返します。
SELECT ISDATE('2018-02-01', 'yyyy-MM-dd'); -- Result: 1 SELECT ISDATE('Not a date'); -- Result: 0
現在の日付のちょうど一週間前のタイムスタンプを返します。
SELECT LAST_WEEK(); //Assume the date is 3/17/2020 -- Result: 3/10/2020
現在の日付のちょうど一ヶ月前のタイムスタンプを返します。
SELECT LAST_MONTH(); //Assume the date is 3/17/2020 -- Result: 2/17/2020
現在の日付のちょうど一年前のタイムスタンプを返します。
SELECT LAST_YEAR(); //Assume the date is 3/17/2020 -- Result: 3/10/2019
指定された週の最終日を返します。
SELECT LDWEEK('02-02-2020'); -- Result: 2/8/2020
指定された月の最終日を返します。
SELECT LDMONTH('02-02-2020'); -- Result: 2/29/2020
指定された四半期の最終日を返します。
SELECT LDQUARTER('02-02-2020'); -- Result: 3/31/2020
年と日数から日付値を返します。
SELECT MAKEDATE(2020, 1); -- Result: 2020-01-01
指定されたdatetime から分コンポーネントを返します。
SELECT MINUTE('02-02-2020 11:15:00'); -- Result: 15
指定されたdatetime から月コンポーネントを返します。
SELECT MONTH('02-02-2020'); -- Result: 2
指定されたdatetime に関連付けられた四半期を返します。
SELECT QUARTER('02-02-2020'); -- Result: 1
指定されたdatetime から秒コンポーネントを返します。
SELECT SECOND('02-02-2020 11:15:23'); -- Result: 23
指定された日時のdatetime 値を返します。
SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2); -- Result: 2018-02-01 01:02:00
指定された文字列値をパースし、対応する日時を返します。
SELECT STRTODATE('03*04*2020','dd*MM*yyyy'); -- Result: 4/3/2020
現在のタイムスタンプをデータベースシステムのdatetime 値として返します。この値はGETDATE およびCURRENT_TIMESTAMP と等しく、常にローカルタイムゾーンになります。
SELECT SYSDATETIME(); -- Result: 2018-02-01 03:04:05
現在のシステム日時をUTC datetime 値として返します。GETUTCDATE と同じです。
SELECT SYSUTCDATETIME(); -- For example, if the local timezone is Eastern European Time (GMT+2) -- Result: 2018-02-01 05:04:05
指定されたhour、minute、およびsecond のtime 値を指定した有効桁数で返します。
SELECT TIMEFROMPARTS(1, 2, 3, 456, 3); -- Result: 01:02:03.456
0000-00-01以降の日数を返します。1582-10-15以降の日付に対してのみ値を返します(グレゴリオ暦に基づく)。これはMYSQL TO_DAYS 関数と同等です。
SELECT TO_DAYS('02-06-2015'); -- Result: 736000
指定されたdatetime に関連付けられた(その年の)週を返します。
SELECT WEEK('02-17-2020 11:15:23'); -- Result: 8
指定されたdate の年を表す整数を返します。
SELECT YEAR('2018-02-01'); -- Result: 2018
指定された数値の絶対値(正の値)を返します。
SELECT ABS(15); -- Result: 15 SELECT ABS(-15); -- Result: 15
指定された浮動小数点式がコサインの値となる角度をラジアン単位で返します。これは、アークコサインとも呼ばれます。
SELECT ACOS(0.5); -- Result: 1.0471975511966
指定された浮動小数点式がサインの値となる角度をラジアン単位で返します。これは、アークサインとも呼ばれます。
SELECT ASIN(0.5); -- Result: 0.523598775598299
指定された浮動小数点式がタンジェントの値となる角度をラジアン単位で返します。これは、アークタンジェントとも呼ばれます。
SELECT ATAN(10); -- Result: 1.47112767430373
正のx 軸と原点から点(y, x) までの線との間の角度をラジアン単位で返します。x とy は、指定された2つの浮動小数点式です。
SELECT ATN2(1, 1); -- Result: 0.785398163397448
指定された数値式以上で最小の整数を返します。
SELECT CEILING(1.3); -- Result: 2 SELECT CEILING(1.5); -- Result: 2 SELECT CEILING(1.7); -- Result: 2
指定された式で示されるラジアン単位の角度の三角関数コサインを返します。
SELECT COS(1); -- Result: 0.54030230586814
指定された浮動小数点式で示されるラジアン単位の角度の三角関数コタンジェントを返します。
SELECT COT(1); -- Result: 0.642092615934331
ラジアン単位で指定された角度に相当する度単位の角度を返します。
SELECT DEGREES(3.1415926); -- Result: 179.999996929531
指定された浮動小数点値の指数値を返します。例えば、EXP(LOG(20)) は20です。
SELECT EXP(2); -- Result: 7.38905609893065
式を評価します。
SELECT EXPR('1 + 2 * 3'); -- Result: 7 SELECT EXPR('1 + 2 * 3 == 7'); -- Result: true
指定された数値式以下で最大の整数を返します。
SELECT FLOOR(1.3); -- Result: 1 SELECT FLOOR(1.5); -- Result: 1 SELECT FLOOR(1.7); -- Result: 1
指定された整数の最大値を返します。
SELECT GREATEST(3,5,8,10,1) -- Result: 10
入力値に相当する16進数を返します。
SELECT HEX(866849198); -- Result: 33AB11AE SELECT HEX('Sample Text'); -- Result: 53616D706C652054657874
指定された整数の最小値を返します。
SELECT LEAST(3,5,8,10,1) -- Result: 1
指定された浮動小数点式の自然対数を返します。
SELECT LOG(7.3890560); -- Result: 1.99999998661119
指定された浮動小数点式の10を底とする対数を返します。
SELECT LOG10(10000); -- Result: 4
被除数を除数で除算したときの余剰に関連付けられた整数値を返します。
SELECT MOD(10,3); -- Result: 1
実数入力のopposite を返します。
SELECT NEGATE(10); -- Result: -10 SELECT NEGATE(-12.4) --Result: 12.4
PI の定数値を返します。
SELECT PI() -- Result: 3.14159265358979
指定された式の指定されたべき乗値を返します。
SELECT POWER(2, 10); -- Result: 1024 SELECT POWER(2, -2); -- Result: 0.25
数値式が度単位で入力されたときのラジアン値を返します。
SELECT RADIANS(180); -- Result: 3.14159265358979
0と1の間の(0と1は除く)の疑似乱数(浮動小数点値)を返します。
SELECT RAND(); -- This result may be different, since the seed is randomized -- Result: 0.873159630165044 SELECT RAND(1); -- This result will always be the same, since the seed is constant -- Result: 0.248668584157093
指定された長さまたは有効桁数に丸められた数値を返します。
SELECT ROUND(1.3, 0); -- Result: 1 SELECT ROUND(1.55, 1); -- Result: 1.6 SELECT ROUND(1.7, 0, 0); -- Result: 2 SELECT ROUND(1.7, 0, 1); -- Result: 1 SELECT ROUND (1.24); -- Result: 1.0
指定された式の符号を、正(+1)、ゼロ(0)、または負(-1)で返します。
SELECT SIGN(0); -- Result: 0 SELECT SIGN(10); -- Result: 1 SELECT SIGN(-10); -- Result: -1
指定された角度の三角関数のサイン値をラジアン単位で返します。
SELECT SIN(1); -- Result: 0.841470984807897
指定された浮動小数点値の平方根を返します。
SELECT SQRT(100); -- Result: 10
指定された浮動小数点値の2乗を返します。
SELECT SQUARE(10); -- Result: 100 SELECT SQUARE(-10); -- Result: 100
入力式のタンジェントを返します。
SELECT TAN(1); -- Result: 1.5574077246549
指定された小数精度に切り捨てられた、指定された10進数を返します。
SELECT TRUNC(10.3423,2); -- Result: 10.34
新しいレコードを作成するには、INSERT ステートメントを使用します。
INSERT ステートメントは、挿入するカラムと新しいカラム値を指定します。複数のカラム値は、次の例に示すように、VALUES 句のカンマ区切りリストで指定できます。
INSERT INTO <table_name>
( <column_reference> [ , ... ] )
VALUES
( { <expression> | NULL } [ , ... ] )
<expression> ::=
| @ <parameter>
| ?
| <literal>
次にクエリの例を示します。
INSERT INTO Customers (Name) VALUES ('Hook, Captain')
既存のレコードを変更するには、UPDATE ステートメントを使用します。
UPDATE 構文はカンマ区切りのカラムをインプットとして取り、SET 句のname-value ペアを新しいカラム値として取ります。
UPDATE <table_name> SET { <column_reference> = <expression> } [ , ... ] WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
クエリの例:
UPDATE Customers SET Name='Hook, Captain' WHERE Id = @myId
テーブルから情報を削除するには、DELETE ステートメントを使用します。
DELETE ステートメントには、次の例に示すように、FROM 句のテーブル名とWHERE 句の行の主キーが必要です。
<delete_statement> ::= DELETE FROM <table_name> WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
次にクエリの例を示します。
DELETE FROM Customers WHERE Id = @myId
GETDELETED クエリを発行して、指定した期間内にライブデータから削除されたすべてのレコードを取得できます。このクエリは、次の例に示すように、フィルタとしてdatetime 値を許容します。
GETDELETED FROM <table_name> WHERE <search_condition>
<search_condition> ::=
{
<expression> { = | < | <= | > | >= } [ <expression> ]
} [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
次にクエリの例を示します。
GETDELETED FROM Customers WHERE TimeModified >='2013-01-01' AND TimeModified <='2013-02-01'
ストアドプロシージャを実行するには、EXECUTE またはEXEC ステートメントを使用できます。
EXEC およびEXECUTE は、名前で参照されたストアドプロシージャのインプットを値またはパラメータ名に割当てます。
ストアドプロシージャをSQL ステートメントとして実行するには、次の構文を使用します。
{ EXECUTE | EXEC } <stored_proc_name>
{
[ @ ] <input_name> = <expression>
} [ , ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
名前によるストアドプロシージャのインプットの参照:
EXECUTE my_proc @second = 2, @first = 1, @third = 3;
パラメータ化されたストアドプロシージャ構文の実行:
EXECUTE my_proc second = @p1, first = @p2, third = @p3;
PIVOT and UNPIVOT can be used to change a table-valued expression into another table.
"SELECT 'AverageCost' AS Cost_Sorted_By_Production_Days, [0], [1], [2], [3], [4]
FROM
(
SELECT DaysToManufacture, StandardCost
FROM Production.Product
) AS SourceTable
PIVOT
(
AVG(StandardCost)
FOR DaysToManufacture IN ([0], [1], [2], [3], [4])
) AS PivotTable;"
"SELECT VendorID, Employee, Orders
FROM
(SELECT VendorID, Emp1, Emp2, Emp3, Emp4, Emp5
FROM pvt) p
UNPIVOT
(Orders FOR Employee IN
(Emp1, Emp2, Emp3, Emp4, Emp5)
)AS unpvt;"
For further information on PIVOT and UNPIVOT, see FROM clause plus JOIN, APPLY, PIVOT (Transact-SQL)
QuickBooks への1回の要求で複数の挿入処理を実行するには、INSERT INTO SELECT 構文を使用して、データの一時テーブルをQuickBooks に挿入します。このとき、QuickBooks に送信されるデータは、まず一時テーブルに入力されます。挿入するデータがすべて一時テーブルに入力されたら、そのテーブルがQuickBooks のテーブルに渡されます。
入力先の一時テーブルは動的なテーブルで、実行時に最初のデータをテーブルに入力するときに作成されます。一時テーブルは、その名前に「#」を付加して示されます。一時テーブルを使用してデータを挿入する場合、その一時テーブルには「[TableName]#TEMP」という形式で名前を付ける必要があります。「TableName」は、データを挿入するテーブルの名前です。
次に例を示します。
INSERT INTO Customers#TEMP (Name, MyCustomField__c) VALUES ('New Customers', '9000'); INSERT INTO Customers#TEMP (Name, MyCustomField__c) VALUES ('New Customers 2', '9001'); INSERT INTO Customers#TEMP (Name, MyCustomField__c) VALUES ('New Customers 3', '9002');
このコードでは、2つのデータカラムと3つのデータ行を含む「Customers#TEMP」という名前の一時テーブルが作成されます。一時テーブルでは型を指定できないため、すべての値が文字列としてメモリに保存されます。これらの値の型は、Customers テーブルに送信された後で正しい型に変換されます。
一時テーブルにデータが入力されたら、QuickBooks の実際のテーブルに対して挿入を実行します。そのためには、実際のテーブルへの挿入(INSERT)を実行し、一時テーブルから入力データを選択します。次に例を示します。
INSERT INTO Customers (Name, MyCustomField__c) SELECT Name, MyCustomField__c FROM Customers#TEMPこの例では、Customers#TEMP テーブルのすべての内容がCustomers テーブルに渡されます。この結果、各要求で複数の挿入を送信できるため、QuickBooks に送信される要求の数が少なくて済み、多くのレコードを挿入する場合のパフォーマンスが向上します。
クエリの結果は、一時テーブルLastResultInfo#TEMP に保存されます。次に一時テーブルが渡されてデータが変更されると、このテーブルはクリアされて、データが再挿入されます。LastResultInfo#TEMP テーブルはスキーマが事前定義されていないことに注意してください。データを読み取る前に、実行時にそのメタデータを確認する必要があります。
一時テーブルは、接続が開いている間だけ存続します。QuickBooks への接続が閉じられると、LastResultInfo#TEMP テーブルを含むすべての一時テーブルがクリアされます。
QuickBooks への1回の要求で複数の削除処理を実行するには、まずINSERT INTO 構文を使用して、削除するデータのインメモリ一時テーブルを作成します。削除するデータがすべて一時テーブルに入力されたら、DELETE FROM 構文を使用してQuickBooks のライブテーブルからデータを削除します。この機能は、JDBC で利用可能な標準バッチ処理API 経由でも利用できます。
入力先の一時テーブルは動的なテーブルで、実行時に最初のデータをテーブルに入力するときに作成されます。一時テーブルは、その名前に「#」を付加して示されます。一時テーブルを使用してデータを削除する場合、その一時テーブルには「[TableName]#TEMP」という形式で名前を付ける必要があります。「TableName」は、データを挿入するテーブルの名前です。
次に例を示します。
INSERT INTO Customers#TEMP (Id) VALUES ('AX1000001'); INSERT INTO Customers#TEMP (Id) VALUES ('AX1000002'); INSERT INTO Customers#TEMP (Id) VALUES ('AX1000003');
このコードでは、1つのデータカラムと3つのデータ行を含む「Customers#TEMP」という名前の一時テーブルが作成されます。一時テーブルでは型を指定できないため、すべての値が文字列としてメモリに保存されます。これらの値の型は、Customers テーブルに送信された後で正しい型に変換されます。
一時テーブルにデータが入力されたら、QuickBooks の実際のテーブルに対して挿入を実行します。そのためには、実際のテーブルからの削除(DELETE)を実行し、一時テーブルから入力データを選択します。次に例を示します。
DELETE FROM Customers WHERE EXISTS SELECT Id FROM Customers#TEMP
この例では、Customers#TEMP テーブルのすべての内容がCustomers テーブルに渡されます。この結果、各要求で複数の削除を送信できるため、QuickBooks に送信される要求の数が少なくて済み、多くのレコードを削除する場合のパフォーマンスが向上します。
クエリの結果は、一時テーブルLastResultInfo#TEMP に保存されます。次に一時テーブルが渡されてデータが変更されると、このテーブルはクリアされて、データが再挿入されます。LastResultInfo#TEMP テーブルはスキーマが事前定義されていないことに注意してください。データを読み取る前に、実行時にそのメタデータを確認する必要があります。
一時テーブルは、接続が開いている間だけ存続します。QuickBooks への接続が閉じられると、LastResultInfo#TEMP テーブルを含むすべての一時テーブルがクリアされます。
CData Cloud は、QuickBooks API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。データモデルには3つのパートがあります。テーブル、ビュー、およびストアドプロシージャです。これらは、簡単なテキストベースのコンフィギュレーションファイルであるスキーマファイルにて定義されます。
このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
CData Cloud は、データをテーブル にモデル化し、クエリおよび更新を容易にします。
NOTE: In case of Bulk insert operation, the Cloud supports multiple values only for the aggregate columns whereas for the other columns only single value is supported.
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
Cloud はQuickBooks のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、QuickBooks テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
Name | Description |
Accounts | Create, update, delete, and query Reckon Accounts. |
BillExpenseItems | Create, update, delete, and query Reckon Bill Expense Line Items. |
BillLineItems | Create, update, delete, and query Reckon Bill Line Items. |
BillPaymentChecks | Create, update, delete, and query Reckon Bill Payment Checks. |
BillPaymentChecksAppliedTo | Create, update, delete, and query Reckon Bill Payment AppliedTo aggregates. In a Bill Payment, each AppliedTo aggregate represents the Bill transaction to which this part of the payment is being applied. |
BillPaymentCreditCards | Create, update, delete, and query Reckon Bill Payments. |
BillPaymentCreditCardsAppliedTo | Create, update, delete, and query Reckon Bill Payment AppliedTo aggregates. In a Bill Payment, each AppliedTo aggregate represents the Bill transaction to which this part of the payment is being applied. |
Bills | Create, update, delete, and query Reckon Bills. |
BuildAssemblies | Delete and query Reckon Build Assembly transactions. |
BuildAssemblyLineItems | Create and query Reckon Build Assembly transactions. |
CheckExpenseItems | Create, update, delete, and query Reckon Check Expense Line Items. |
CheckLineItems | Create, update, delete, and query Reckon Check Line Items. |
Checks | Create, update, delete, and query Reckon Checks. |
Class | Create, delete, and query Reckon Classes. |
CreditCardChargeExpenseItems | Create, update, delete, and query Reckon Credit Card Charge Expense Line Items. |
CreditCardChargeLineItems | Create, update, delete, and query Reckon Credit Card Charge Line Items. |
CreditCardCharges | Create, update, delete, and query Reckon Credit Card Charges. |
CreditCardCreditExpenseItems | Create, update, delete, and query Reckon Credit Card Credit Expense Line Items. |
CreditCardCreditLineItems | Create, update, delete, and query Reckon Credit Card Credit Line Items. |
CreditCardCredits | Create, update, delete, and query Reckon Credit Card Credits. |
CreditMemoLineItems | Create, update, delete, and query Reckon Credit Memo Line Items. |
CreditMemos | Create, update, delete, and query Reckon Credit Memos. |
CustomerMessages | Create, delete, and query Customer Messages. |
Customers | Create, update, delete, and query Reckon Customers. |
CustomerTypes | Create, update, delete, and query Reckon Customer Types. |
DateDrivenTerms | Create, delete, and query Reckon Date Driven Terms. |
DepositLineItems | Create, update, delete, and query Reckon Deposit Line Items. |
Deposits | Create, update, delete, and query Reckon Deposits. |
EmployeeEarnings | Create, update, delete, and query Reckon Employee Earnings. |
Employees | Create, update, delete, and query Reckon Employees. |
EstimateLineItems | Create, update, delete, and query Reckon Estimate Line Items. |
Estimates | Create, update, delete, and query Reckon Estimates. |
InventoryAdjustmentLineItems | Create and query QuickBooks Inventory Adjustment Line Items. |
InventoryAdjustments | Create, query, and delete QuickBooks Inventory Adjustments. |
InvoiceLineItems | Create, update, delete, and query Reckon Invoice Line Items. |
Invoices | Create, update, delete, and query Reckon Invoices. |
ItemLineItems | Create, update, delete, and query Reckon Item Line Items. |
ItemReceiptExpenseItems | Create, update, delete, and query Reckon Item Receipt Expense Line Items. |
ItemReceiptLineItems | Create, update, delete, and query Reckon Item Receipt Line Items. |
ItemReceipts | Create, update, delete, and query Reckon Item Receipts. |
Items | Create, update, delete, and query Reckon Items. |
JournalEntries | Create, update, delete, and query Reckon Journal Entries. Note that while Journal Entry Lines can be created with a new Journal Entry, they cannot be added or removed from an existing Journal Entry. |
JournalEntryLines | Create, update, delete, and query Reckon Journal Entries. Note that while Journal Entry Lines can be created with a new Journal Entry, they cannot be added or removed from an existing Journal Entry. |
OtherNames | Create, update, delete, and query Reckon Other Name entities. |
PaymentMethods | Create, update, delete, and query Reckon Payment Methods. |
PayrollNonWageItems | Query Reckon Non-Wage Payroll Items. |
PayrollWageItems | Create and query Reckon Wage Payroll Items. |
PriceLevelPerItem | Create and query Reckon Price Levels Per Item. Only Reckon Premier and Enterprise support Per-Item Price Levels. Note that while Price Levels can be added from this table, you may only add Per-Item Price Levels from this table. Price Levels may be deleted from the PriceLevels table. |
PriceLevels | Create, delete, and query Reckon Price Levels. Note that while Price Levels can be added and deleted from this table, you may add only fixed-percentage Price Levels from this table. Per-Item Price Levels may be added via the PriceLevelPerItem table. |
PurchaseOrderLineItems | Create, update, delete, and query Reckon Purchase Order Line Items. |
PurchaseOrders | Create, update, delete, and query Reckon Purchase Orders. |
ReceivePayments | Create, update, delete, and query Reckon Receive Payment transactions. |
ReceivePaymentsAppliedTo | Create, update, and query Reckon Receive Payment AppliedTo aggregates. In a Receive Payment, each AppliedTo aggregate represents the transaction to which this part of the payment is being applied. |
SalesOrderLineItems | Create, update, delete, and query Reckon Sales Order Line Items. |
SalesOrders | Create, update, delete, and query Reckon Sales Orders. |
SalesReceiptLineItems | Create, update, delete, and query Reckon Sales Receipt Line Items. |
SalesReceipts | Create, update, delete, and query Reckon Sales Receipts. |
SalesReps | Create, update, delete, and query Reckon Sales Rep entities. |
SalesTaxCodes | Create, update, delete, and query Reckon Sales Tax Codes. |
SalesTaxItems | Create, update, delete, and query Reckon Sales Tax Items. |
ShippingMethods | Create, update, delete, and query Reckon Shipping Methods. |
StandardTerms | Create, update, delete, and query Reckon Standard Terms. |
StatementCharges | Create, update, delete, and query Reckon Statement Charges. |
TimeTracking | Create, update, delete, and query Reckon Time Tracking events. |
ToDo | Create, update, delete, and query Reckon To Do entries. |
VehicleMileage | Create, update, delete, and query Reckon Vehicle Mileage entities. |
VendorCreditExpenseItems | Create, update, delete, and query Reckon Vendor Credit Expense Line Items. |
VendorCreditLineItems | Create, update, delete, and query Reckon Vendor Credit Line Items. |
VendorCredits | Create, update, delete, and query Reckon Vendor Credits. |
Vendors | Create, update, delete, and query Reckon Vendors. |
VendorTypes | Create, update, delete, and query Reckon Vendor Types. |
Create, update, delete, and query Reckon Accounts.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Accounts are Id, Name, Type, IsActive, and TimeModified. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Accounts WHERE Name LIKE '%Bank%' AND TimeModified > '1/1/2011' AND TimeModified < '2/1/2011'
To add an Account, specify the Name and Type fields.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier of the account. | |
Name | String | False |
The name of the account. This is required to have a value when inserting. | |
FullName | String | True |
The full name of the account, including any ancestors (parents) in the format Parent:AccountName. | |
Type | String | False |
The type of account. 使用できる値は次のとおりです。ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, BANK, COSTOFGOODSSOLD, CREDITCARD, EQUITY, EXPENSE, FIXEDASSET, INCOME, LONGTERMLIABILITY, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, NONPOSTING | |
SpecialType | String | True |
The special account type in Reckon if applicable. 使用できる値は次のとおりです。AccountsPayable, AccountsReceivable, CondenseItemAdjustmentExpenses, CostOfGoodsSold, DirectDepositLiabilities, Estimates, ExchangeGainLoss, InventoryAssets, ItemReceiptAccount, OpeningBalanceEquity, PayrollExpenses, PayrollLiabilities, PettyCash, PurchaseOrders, ReconciliationDifferences, RetainedEarnings, SalesOrders, SalesTaxPayable, UncategorizedExpenses, UncategorizedIncome, UndepositedFunds | |
Number | String | False |
The bank number of the account. | |
Balance | Double | True |
The total balance of the account, including subaccounts. | |
AccountBalance | Double | True |
The balance of this account only. This balance does not include subaccounts. | |
BankAccount | String | False |
The bank account number for the account (or an identifying note). | |
Description | String | False |
A textual description of the account. | |
IsActive | Boolean | False |
This property indicates whether the object is currently enabled for use by Reckon. | |
ParentName | String | False |
Accounts.FullName |
This is a reference to a parent account. If set to a nonempty string, then this account is a subaccount of its parent. |
ParentId | String | False |
Accounts.ID |
This is a reference to a parent account. If set to a nonempty string, then this account is a subaccount or job of its parent. |
Sublevel | Integer | True |
The number of ancestors the account has. | |
CashFlowClassification | String | True |
Indicates how the account is classified for cash flow reporting.' value='None, Operating, Investing, Financing, NotApplicable. | |
TaxLineName | String | True |
The name of the line on the tax form this account is associated with, if any. Check the CompanyInfo to see which tax form is associated with the company file. | |
TaxLineId | String | False |
The Id of the line on the tax form this account is associated with, if any. Check the CompanyInfo to see which tax form is associated with the company file. | |
TimeModified | Datetime | True |
When the account was last modified. | |
TimeCreated | Datetime | True |
When the account was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
OpeningBalance | String |
The opening balance of the account (by default 0). Note that this property is only used when adding new accounts to Reckon. |
OpeningDate | String |
The opening balance date of the account. Note that this property is only used when adding new accounts to Reckon. |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ALL, ACTIVE, INACTIVE, NA デフォルト値はALLです。 |
NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on name. 使用できる値は次のとおりです。EXACT, STARTSWITH, ENDSWITH, CONTAINS デフォルト値はCONTAINSです。 |
Create, update, delete, and query Reckon Bill Expense Line Items.
Bills may be inserted, queried, or updated via the Bills, BillExpenseItems, or BillLineItems tables. Bills may be deleted by using the Bills table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Bills are Id, Date, ReferenceNumber, VendorName, VendorId, AccountsPayable, AccountsPayableId, IsPaid, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Bills WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
You can also use Bills and BillExpenseItems to insert a Bill.
To add a Bill, specify a Vendor, Date, and at least one Expense or Line Item. All Expense Line Item columns can be used for inserting multiple expense Line Items for a new Bill transaction. For example, the following will insert a new Bill with two Expense Line Items:
INSERT INTO BillExpenseItems#TEMP (VendorName, Date, ExpenseAccount, ExpenseAmount) VALUES ('Cal Telephone', '1/1/2011', 'Utilities:Telephone', 52.25) INSERT INTO BillExpenseItems#TEMP (VendorName, Date, ExpenseAccount, ExpenseAmount) VALUES ('Cal Telephone', '1/1/2011', 'Professional Fees:Accounting', 235.87) INSERT INTO BillExpenseItems (VendorName, Date, ExpenseAccount, ExpenseAmount) SELECT VendorName, Date, ExpenseAccount, ExpenseAmount FROM BillExpenseItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format BillId|ExpenseLineId. | |
BillId | String | False |
Bills.ID |
The bill identifier. |
VendorName | String | False |
Vendors.Name |
Vendor for this transaction. Either VenderName or VendorId must have a value when inserting. |
VendorId | String | False |
Vendors.ID |
Vendor Id for this transaction. Either VenderName or VendorId must have a value when inserting. |
ReferenceNumber | String | False |
Reference number for the transaction. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
DueDate | Date | False |
Date when payment is due. | |
Terms | String | False |
Reference to terms of payment. | |
TermsId | String | False |
Reference Id for the terms of payment. | |
AccountsPayable | String | False |
Accounts.ID |
Reference to the accounts-payable account. |
AccountsPayableId | String | False |
Accounts.FullName |
Reference Id for the accounts-payable account. |
Amount | Double | True |
Amount of the transaction. This is calculated by Reckon based on the line items or expense line items. | |
Memo | String | False |
Memo for the transaction. | |
IsPaid | Boolean | True |
Indicates whether this bill has been paid. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ExpenseLineId | String | True |
The expense line item identifier. | |
ExpenseAccount | String | False |
Accounts.ID |
The account name for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAccountId | String | False |
Accounts.FullName |
The account Id for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAmount | Double | False |
The total amount of this expense line. | |
ExpenseBillableStatus | String | False |
The billing status of this expense line. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED | |
ExpenseCustomer | String | False |
Customers.FullName |
The customer associated with this expense line. |
ExpenseCustomerId | String | False |
Customers.ID |
The customer associated with this expense line. |
ExpenseClass | String | False |
Class.FullName |
The class name of this expense. |
ExpenseClassId | String | False |
Class.ID |
The class Id of this expense. |
ExpenseMemo | String | False |
A memo for this expense line. | |
ExpenseTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or non-taxable). |
ExpenseTaxCodeId | String | False |
Sales tax information for this item (taxable or non-taxable). | |
TimeModified | Datetime | True |
When the Bill was last modified. | |
TimeCreated | Datetime | True |
When the Bill was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
PaidStatus | String |
The paid status of the bill. 使用できる値は次のとおりです。ALL, PAID, UNPAID, NA デフォルト値はALLです。 |
LinkToTxnId | String |
A transaction to link the bill to. This transaction must be a purchase order. You will get a run-time error if the transaction specified is already closed or fully received. This is only available on insert and requires a minimum QBXML Version 4.0. |
Create, update, delete, and query Reckon Bill Line Items.
Bills may be inserted, queried, or updated via the Bills, BillExpenseItems, or BillLineItems tables. Bills may be deleted by using the Bills table.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Bills are Id, Date, ReferenceNumber, VendorName, VendorId, AccountsPayable, AccountsPayableId, IsPaid, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Bills WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
You can also use Bills and BillExpenseItems to insert a Bill.
To add a Bill, specify a Vendor, Date, and at least one Expense or Line Item. All Line Item columns can be used for inserting multiple Line Items for a new Bill transaction. For example, the following will insert a new Bill with two Line Items:
INSERT INTO BillLineItems#TEMP (VendorName, Date, ItemName, ItemQuantity) VALUES ('Cal Telephone', '1/1/2011', 'Repairs', 1) INSERT INTO BillLineItems#TEMP (VendorName, Date, ItemName, ItemQuantity) VALUES ('Cal Telephone', '1/1/2011', 'Removal', 2) INSERT INTO BillLineItems (VendorName, Date, ItemName, ItemQuantity) SELECT VendorName, Date, ItemName, ItemQuantity FROM BillLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format BillId|ItemLineId. | |
BillId | String | False |
Bills.ID |
The bill identifier. |
VendorName | String | False |
Vendors.Name |
Vendor for this transaction. Either VenderName or VendorId must have a value when inserting. |
VendorId | String | False |
Vendors.ID |
Vendor Id for this transaction. Either VenderName or VendorId must have a value when inserting. |
ReferenceNumber | String | False |
Reference number for the transaction. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
DueDate | Date | False |
Date when payment is due. | |
Terms | String | False |
Reference to terms of payment. | |
TermsId | String | False |
Reference Id for the terms of payment. | |
AccountsPayable | String | False |
Accounts.FullName |
Reference to the accounts-payable account. |
AccountsPayableId | String | False |
Accounts.ID |
Reference Id for the accounts-payable account. |
Amount | Double | True |
Amount of the transaction. This is calculated by Reckon based on the line items or expense line items. | |
Memo | String | False |
Memo for the transaction. | |
IsPaid | Boolean | True |
Indicates whether this bill has been paid. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item name. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group name. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemCost | Double | False |
The unit cost for the item. | |
ItemAmount | Double | False |
Total amount for the item. | |
ItemBillableStatus | String | False |
Billing status of the item. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED | |
ItemCustomer | String | False |
Customers.FullName |
The name of the customer who ordered the item. |
ItemCustomerId | String | False |
Customers.ID |
The Id of the customer who ordered the item. |
ItemClass | String | False |
Class.FullName |
The name for the class of the item. |
ItemClassId | String | False |
Class.ID |
The Id for the class of the item. |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or non-taxable). |
ItemTaxCodeId | String | False |
Sales tax information for this item (taxable or non-taxable). | |
TimeModified | Datetime | True |
When the Bill was last modified. | |
TimeCreated | Datetime | True |
When the Bill was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
PaidStatus | String |
The paid status of the vendor credit. 使用できる値は次のとおりです。ALL, PAID, UNPAID, NA デフォルト値はALLです。 |
LinkToTxnId | String |
A transaction to link the bill to. This transaction must be a purchase order. You will get a run-time error if the transaction specified is already closed or fully received. This is only available on insert and requires a minimum QBXML Version 4.0. |
Create, update, delete, and query Reckon Bill Payment Checks.
BillPaymentChecks may be inserted, queried, or updated via the BillPaymentChecks or BillPaymentChecksAppliedTo tables. BillPaymentChecks may be deleted by using the BillPaymentChecks table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for BillPaymentChecks are Id, Date, ReferenceNumber, PayeeName, PayeeId, AccountsPayable, AccountsPayableId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM BillPaymentChecks WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a BillPaymentCheck, specify a Payee and BankAccount. The Payee must match the Vendor associated with the Bill you are adding a payment for. The AppliedToAggregate column may be used to specify an XML aggregate of AppliedTo data. The columns that may be used in these aggregates are defined in the BillPaymentChecksAppliedTo table and it starts with AppliedTo. For example, the following will insert a new BillPaymentCheck with two AppliedTo entries:
INSERT INTO BillPaymentChecks (PayeeName, BankAccountName, AppliedToAggregate) VALUES ('Vu Contracting', 'Checking', '<BillPaymentChecksAppliedTo> <Row><AppliedToRefId>178C1-1450221347</AppliedToRefId><AppliedToAmount>20.00</AppliedToAmount></Row> <Row><AppliedToRefId>178C1-1450221347</AppliedToRefId><AppliedToAmount>51.25</AppliedToAmount></Row> </BillPaymentChecksAppliedTo>')
AppliedToRefId is a reference to a BillId and can be found in Bills, BillLineItems, or BillExpenseItems.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier for the transaction. | |
PayeeName | String | False |
Vendors.Name |
A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. |
PayeeId | String | False |
Vendors.ID |
A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. |
ReferenceNumber | String | False |
The transaction reference number. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
Amount | Double | True |
Amount of the transaction. This is calculated by Reckon based on the line items or expense line items. | |
AccountsPayable | String | False |
Accounts.FullName |
Reference to the accounts-payable account. |
AccountsPayableId | String | False |
Accounts.ID |
Reference to the accounts-payable account Id. |
BankAccountName | String | False |
Accounts.FullName |
Refers to the Account funds are being drawn from for this bill payment. This property is only applicable to the check payment method. |
BankAccountId | String | False |
Accounts.ID |
Refers to the Account funds are being drawn from for this bill payment. This property is only applicable to the check payment ethod. |
IsToBePrinted | Boolean | False |
Indicates whether or not the transaction is to be printed. If set to true, the 'To Be Printed' box in the Reckon user interface will be checked. デフォルト値はfalseです。 | |
Memo | String | False |
A memo to appear on internal reports. | |
AppliedToAggregate | String | False |
An aggregate of the applied-to data which can be used for adding a bill payment check and its applied-to data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the bill payment was last modified. | |
TimeCreated | Datetime | True |
When the bill payment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
AppliedTo* | String |
All applied-to-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Bill Payment AppliedTo aggregates. In a Bill Payment, each AppliedTo aggregate represents the Bill transaction to which this part of the payment is being applied.
BillPaymentChecks may be inserted, queried, or updated via the BillPaymentChecks or BillPaymentChecksAppliedTo tables. BillPaymentChecks may be deleted by using the BillPaymentChecks table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for BillPaymentChecks are Id, Date, ReferenceNumber, PayeeName, PayeeId, AccountsPayable, AccountsPayableId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM BillPaymentChecksAppliedTo WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a BillPaymentCheck entry, specify the Payee and BankAccount fields. The Payee must match the Vendor associated with the Bill you are adding a payment for. All AppliedTo columns can be used to explicitly identify the Bills being paid. For example, the following will insert a new BillPaymentCheck with two AppliedTo entries:
INSERT INTO BillPaymentChecksAppliedTo#TEMP (PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount) VALUES ('Vu Contracting', 'Checking', '178C1-1450221347', 20.00) INSERT INTO BillPaymentChecksAppliedTo#TEMP (PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount) VALUES ('Vu Contracting', 'Checking', '881-933371709', 51.25) INSERT INTO BillPaymentChecksAppliedTo (PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount) SELECT PayeeName, BankAccountName, AppliedToRefId, AppliedToAmount FROM BillPaymentChecksAppliedTo#TEMP
AppliedToRefId is a reference to a BillId and can be found in Bills, BillLineItems, or BillExpenseItems.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format BillPaymentId|AppliedToId. | |
BillPaymentId | String | False |
The Id of the bill payment transaction. | |
PayeeName | String | False |
Vendors.Name |
A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. This must match the Vendor associated with the Bill being paid when inserting. |
PayeeId | String | False |
Vendors.ID |
A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. This must match the Vendor associated with the Bill being paid when inserting. |
ReferenceNumber | String | False |
The transaction reference number. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
AccountsPayable | String | False |
Reference to the accounts-payable account. | |
AccountsPayableId | String | False |
Reference to the accounts-payable account Id. | |
BankAccountId | String | False |
Refers to the account funds are being drawn from for this bill payment. This property is only applicable to the check payment method. | |
BankAccountName | String | False |
Refers to the account funds are being drawn from for this bill payment. This property is only applicable to the check payment method. | |
IsToBePrinted | Boolean | False |
Indicates whether or not the transaction is to be printed. If set to true, the 'To Be Printed' box in the Reckon user interface will be checked. デフォルト値はfalseです。 | |
Memo | String | False |
A memo to appear on internal reports. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
AppliedToRefId | String | True |
The applied-to reference identifier. This is a reference to a bill Id, which can be found in the Bills table. | |
AppliedToAmount | Double | True |
The amount to be applied. | |
AppliedToBalanceRemaining | Double | True |
The balance remaining to be applied. | |
AppliedToCreditAmount | Double | False |
The amount of the credit to be applied. | |
AppliedToCreditMemoId | String | False |
The Id of the credit memo to be applied. | |
AppliedToDiscountAccountId | String | False |
The discount account Id to be applied. | |
AppliedToDiscountAccountName | String | False |
The discount account name to be applied. | |
AppliedToDiscountAmount | Double | False |
The discount amount to be applied. | |
AppliedToPaymentAmount | Double | False |
The payment amount to be applied. | |
AppliedToReferenceNumber | String | True |
The ref number to be applied. | |
AppliedToTxnDate | Date | True |
The transaction date to be applied. | |
AppliedToTxnType | String | True |
The transaction type that was applied. | |
TimeModified | Datetime | True |
When the bill payment was last modified. | |
TimeCreated | Datetime | True |
When the bill payment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
AppliedToCreditAppliedAmount | String |
The credit applied amount to be applied. |
Create, update, delete, and query Reckon Bill Payments.
BillPaymentCreditCards may be inserted, queried, or updated via the BillPaymentCreditCards or BillPaymentCreditCardsAppliedTo tables. BillPaymentCreditCards may be deleted by using the BillPaymentCreditCards table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for BillPaymentCreditCards are Id, Date, ReferenceNumber, PayeeName, PayeeId, AccountsPayable, AccountsPayableId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM BillPaymentCreditCards WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a BillPaymentCreditCard, specify a Payee and CreditCard. The Payee must match the Vendor associated with the Bill you are adding a payment for. The AppliedToAggregate column may be used to specify an XML aggregate of AppliedTo data. The columns that may be used in these aggregates are defined in the BillPaymentCreditCardsAppliedTo table and it starts with AppliedTo. For example, the following will insert a new BillPaymentCreditCard with two AppliedTo entries:
INSERT INTO BillPaymentCreditCard (PayeeName, CreditCardName, AppliedToAggregate) VALUES ('Vu Contracting', 'CalOil Credit Card', '<BillPaymentCreditCardsAppliedTo> <Row><AppliedToRefId>178C1-1450221347</AppliedToRefId><AppliedToAmount>20.00</AppliedToAmount></Row> <Row><AppliedToRefId>881-933371709</AppliedToRefId><AppliedToAmount>51.25</AppliedToAmount></Row> </BillPaymentCreditCardsAppliedTo>')
AppliedToRefId is a reference to a BillId and can be found in Bills, BillLineItems, or BillExpenseItems.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier for the transaction. | |
PayeeName | String | False |
Vendors.Name |
A reference to the the entity merchandise was purchased from. Either PayeeId or PayeeName is required. |
PayeeId | String | False |
Vendors.ID |
A reference to the the entity merchandise was purchased from. Either PayeeId or PayeeName is required. |
ReferenceNumber | String | False |
The transaction reference number. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
Amount | Double | True |
Amount of the transaction. This is calculated by Reckon based on the line items or expense line items. | |
AccountsPayable | String | False |
Accounts.FullName |
Reference to the accounts-payable account. |
AccountsPayableId | String | False |
Accounts.ID |
Reference to the accounts-payable account Id. |
CreditCardName | String | False |
Refers to the credit card account this payment is being charged to. This property is only applicable to the credit card payment Method. | |
CreditCardId | String | False |
Refers to the credit card account this payment is being charged to. This property is only applicable to the credit card payment Method. | |
IsToBePrinted | Boolean | False |
Indicates whether or not the transaction is to be printed. If set to true, the 'To Be Printed' box in the Reckon user interface will be checked. デフォルト値はfalseです。 | |
Memo | String | False |
A memo to appear on internal reports. | |
AppliedToAggregate | String | False |
An aggregate of the applied-to data which can be used for adding a bill payment credit card and its applied-to data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the bill payment was last modified. | |
TimeCreated | Datetime | True |
When the bill payment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
AppliedTo* | String |
All applied-to-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Bill Payment AppliedTo aggregates. In a Bill Payment, each AppliedTo aggregate represents the Bill transaction to which this part of the payment is being applied.
BillPaymentCreditCards may be inserted, queried, or updated via the BillPaymentCreditCards or BillPaymentCreditCardsAppliedTo tables. BillPaymentCreditCards may be deleted by using the BillPaymentCreditCards table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for BillPaymentCreditCards are Id, Date, ReferenceNumber, PayeeName, PayeeId, AccountsPayable, AccountsPayableId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM BillPaymentCreditCardsAppliedTo WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
You can also use BillPaymentCreditCards to insert a BillPaymentCreditCard.
To add a BillPaymentCreditCard, specify a Payee and CreditCard. The Payee must match the Vendor associated with the Bill you are adding a payment for. All AppliedTo columns can be used to explicitly identify the Bills being paid. For example, the following will insert a new BillPaymentCreditCard with two AppliedTo entries:
INSERT INTO BillPaymentCreditCardsAppliedTo#TEMP (PayeeName, CreditCardName, AppliedToRefId, AppliedToAmount) VALUES ('Vu Contracting', 'CalOil Credit Card', '178C1-1450221347', 20.00) INSERT INTO BillPaymentCreditCardsAppliedTo#TEMP (PayeeName, CreditCardName, AppliedToRefId, AppliedToAmount) VALUES ('Vu Contracting', 'CalOil Credit Card', '881-933371709', 51.25) INSERT INTO BillPaymentCreditCardsAppliedTo (PayeeName, CreditCardName, AppliedToRefId, AppliedToAmount) SELECT PayeeName, CreditCardName, AppliedToRefId, AppliedToAmount FROM BillPaymentCreditCardsAppliedTo#TEMP
AppliedToRefId is a reference to a BillId and can be found in Bills, BillLineItems, or BillExpenseItems.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format BillPaymentId|AppliedToId. | |
BillPaymentId | String | False |
The Id of the bill payment transaction. | |
PayeeName | String | False |
Vendors.Name |
A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. This must match the vendor associated with the bill being paid when inserting. |
PayeeId | String | False |
Vendors.ID |
A reference to the entity merchandise was purchased from. Either PayeeId or PayeeName is required. This must match the vendor associated with the bill being paid when inserting. |
ReferenceNumber | String | False |
The transaction reference number. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
AccountsPayable | String | False |
Accounts.FullName |
Reference to the accounts-payable account. |
AccountsPayableId | String | False |
Accounts.ID |
Reference to the accounts-payable account Id. |
CreditCardName | String | False |
Refers to the credit card account this payment is being charged to. This property is only applicable to the credit card payment method. | |
CreditCardId | String | False |
Refers to the credit card account this payment is being charged to. This property is only applicable to the credit card payment method. | |
IsToBePrinted | Boolean | False |
Indicates whether or not the transaction is to be printed. If set to true, the 'To Be Printed' box in the Reckon user interface will be checked. デフォルト値はfalseです。 | |
Memo | String | False |
A memo to appear on internal reports. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
AppliedToRefId | String | True |
CreditMemos.ID |
The applied-to reference identifier. This is a reference to a bill Id, which can be found in the bills table. |
AppliedToAmount | Double | True |
The amount to be applied. | |
AppliedToBalanceRemaining | Double | True |
The balance remaining to be applied. | |
AppliedToCreditMemoId | String | False |
The Id of the credit memo to be applied. | |
AppliedToDiscountAccountName | String | False |
Accounts.FullName |
The discount account name to be applied. |
AppliedToDiscountAccountId | String | False |
Accounts.ID |
The discount account Id to be applied. |
AppliedToDiscountAmount | Double | False |
The discount amount to be applied. | |
AppliedToPaymentAmount | Double | False |
The payment amount to be applied. | |
AppliedToReferenceNumber | String | True |
The ref number to be applied. | |
AppliedToTxnDate | Date | True |
The transaction date to be applied. | |
AppliedToTxnType | String | True |
The transaction type that was applied. | |
TimeModified | Datetime | True |
When the bill payment was last modified. | |
TimeCreated | Datetime | True |
When the bill payment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
AppliedToCreditAppliedAmount | String |
The credit applied amount to be applied. |
Create, update, delete, and query Reckon Bills.
Bills may be inserted, queried, or updated via the Bills, BillExpenseItems, or BillLineItems tables. Bills may be deleted by using the Bills table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Bills are Id, Date, ReferenceNumber, VendorName, VendorId, AccountsPayable, AccountsPayableId, IsPaid, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Bills WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
You can also use BillLineItems and BillExpenseItems to insert a bill.
To add a Bill, specify a Vendor, Date, and at least one Expense or Line Item. The ItemAggregate and ExpenseAggregate columns may be used to specify an XML aggregate of Line or Expense Item data. The columns that may be used in these aggregates are defined in the BillLineItems and BillExpenseItems tables and it starts with Item and Expense. For example, the following will insert a new Bill with two Line Items:
INSERT INTO Bills (VendorName, Date, ItemAggregate) VALUES ('Cal Telephone', '1/1/2011', '<BillLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </BillLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier for the bill. | |
VendorName | String | False |
Vendors.Name |
Vendor for this transaction. Either VenderName or VendorId must have a value when inserting. |
VendorId | String | False |
Vendors.ID |
Vendor Id for this transaction. Either VenderName or VendorId must have a value when inserting. |
ReferenceNumber | String | False |
Reference number for the transaction. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
Amount | Double | True |
Amount of the transaction. This is calculated by Reckon based on the Line Items or Expense Line Items. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
DueDate | Date | False |
Date when payment is due. | |
Terms | String | False |
Reference to terms of payment. | |
TermsId | String | False |
Reference Id for the terms of payment. | |
AccountsPayable | String | False |
Accounts.FullName |
Reference to the accounts-payable account. |
AccountsPayableId | String | False |
Accounts.ID |
Reference Id for the accounts-payable account. |
Memo | String | False |
Memo for the transaction. | |
IsPaid | Boolean | True |
Indicates whether this Bill has been paid. | |
ExchangeRate | Double | False |
The market price for which this currency can be exchanged for the currency used by the Reckon company file as the home currency. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ItemCount | Integer | True |
The count of line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a bill and its line item data. | |
ExpenseItemCount | Integer | True |
The count of expense line items. | |
ExpenseItemAggregate | String | False |
An aggregate of the expense item data which can be used for adding a bill and its expense item data. | |
TransactionCount | Integer | True |
The count of related transactions to the bill. | |
TransactionAggregate | String | True |
An aggregate of the linked transaction data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the bill was last modified. | |
TimeCreated | Datetime | True |
When the bill was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
Expense* | String |
All expense-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
PaidStatus | String |
The paid status of the bill. 使用できる値は次のとおりです。ALL, PAID, UNPAID, NA デフォルト値はALLです。 |
LinkToTxnId | String |
A transaction to link the bill to. This transaction must be a purchase order. You will get a run-time error if the transaction specified is already closed or fully received. This is only available on insert and requires a minimum QBXML Version 4.0. |
Delete and query Reckon Build Assembly transactions.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
TxnNumber | Integer | True |
An identifying number for this transaction. | |
ItemInventoryAssemblyRef_ListID | String | False |
Items.ID |
A reference to the Id of an inventory assembly. Either ItemInventoryAssemblyRef_ListID or ItemInventoryAssemblyRef_FullName is required when inserting a BuildAssembly. |
ItemInventoryAssemblyRef_FullName | String | False |
Items.FullName |
A reference to the name of an inventory assembly. Either ItemInventoryAssemblyRef_ListID or ItemInventoryAssemblyRef_FullName is required when inserting a BuildAssembly. |
SerialNumber | String | False |
The serial number of the asset. This cannot be used with LotNumber. | |
LotNumber | String | False |
The lot number of the asset. This cannot be used with SerialNumber. | |
TxnDate | Date | False |
The date of the transaction. | |
RefNumber | String | False |
A reference number identifying the transaction. This does not have to be unique. | |
Memo | String | False |
A memo about the transaction. | |
IsPending | Boolean | True |
If IsPending is set to true, the transaction in question has not been completed. | |
QuantityToBuild | Double | False |
Specifies the number of assemblies to be built. The transaction will fail if the number specified here exceeds the number of on-hand items. | |
QuantityCanBuild | Double | True |
Indicates the number of this assembly that can be built from the parts on hand. | |
QuantityOnHand | Double | True |
The number of these items in the inventory. To change the QuantityOnHand, you would need to add an inventory adjustment. | |
QuantityOnSalesOrder | Double | True |
The number of these items that have been sold (as recorded in sales orders) but not delivered to customers. | |
BuildAssemblyLineAggregate | String | True |
An aggregate of the line item data which can be used for adding a transfer inventory and its line item data. | |
TimeCreated | Datetime | True |
The datetime the transaction was made. | |
TimeModified | Datetime | True |
The last datetime the transaction was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create and query Reckon Build Assembly transactions.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
BuildAssemblyId | String | False |
The unique Id of the build assembly. | |
TxnNumber | Integer | True |
An identifying number for this transaction. | |
ItemInventoryAssemblyRef_ListID | String | False |
Items.ID |
A reference to the Id of an inventory assembly. Either ItemInventoryAssemblyRef_ListID or ItemInventoryAssemblyRef_FullName is required when inserting a BuildAssembly. |
ItemInventoryAssemblyRef_FullName | String | False |
Items.FullName |
A reference to the name of an inventory assembly. Either ItemInventoryAssemblyRef_ListID or ItemInventoryAssemblyRef_FullName is required when inserting a BuildAssembly. |
SerialNumber | String | False |
The serial number of the asset. This cannot be used with LotNumber. | |
LotNumber | String | False |
The lot number of the asset. This cannot be used with SerialNumber. | |
TxnDate | Date | False |
The date of the transaction. | |
RefNumber | String | False |
A reference number identifying the transaction. This does not have to be unique. | |
Memo | String | False |
A memo about the transaction. | |
IsPending | Boolean | True |
If IsPending is set to true, the transaction in question has not been completed. | |
QuantityToBuild | Double | False |
Specifies the number of assemblies to be built. The transaction will fail if the number specified here exceeds the number of on-hand items. | |
QuantityCanBuild | Double | True |
Indicates the number of this assembly that can be built from the parts on hand. | |
QuantityOnHand | Double | True |
The number of these items in the inventory. To change the QuantityOnHand, you would need to add an inventory adjustment. | |
QuantityOnSalesOrder | Double | True |
The number of these items that have been sold (as recorded in sales orders) but not delivered to customers. | |
ComponentItemLineRet_ItemRef_ListID | String | True |
Items.ID |
Reference to the Id of an item. |
ComponentItemLineRet_ItemRef_FullName | String | True |
Items.FullName |
Reference to the full name of an item. |
ComponentItemLineRet_Desc | String | True |
Description for the line item. | |
ComponentItemLineRet_QuantityOnHand | Double | True |
The number of these items in the inventory. | |
ComponentItemLineRet_QuantityNeeded | Double | True |
The number of these items used in the assembly. | |
TimeCreated | Datetime | True |
The datetime the transaction was made. | |
TimeModified | Datetime | True |
The last datetime the transaction was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Check Expense Line Items.
Checks may be inserted, queried, or updated via the Checks, CheckExpenseItems, or CheckLineItems tables. Checks may be deleted by using the Checks table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Checks are Id, Date, ReferenceNumber, Payee, PayeeId, Account, AccountId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CheckExpenseItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%' SELECT * FROM CheckExpenseItems WHERE Date >= '2020-01-07' AND Date < '2020-01-10' SELECT * FROM CheckExpenseItems WHERE [Date] = '2020-01-07'
To add a Check, specify an Account, a Date, and at least one Expense or Line Item. All Expense Line Item columns can be used for inserting multiple Expense Line Items for a new Check transaction. For example, the following will insert a new Check with two Expense Line Items:
INSERT INTO CheckExpenseItems#TEMP (Account, Date, ExpenseAccount, ExpenseAmount) VALUES ('Checking', '1/1/2011', 'Utilities:Telephone', 52.25,) INSERT INTO CheckExpenseItems#TEMP (Account, Date, ExpenseAccount, ExpenseAmount) VALUES ('Checking', '1/1/2011', 'Professional Fees:Accounting', 235.87) INSERT INTO CheckExpenseItems (Account, Date, ExpenseAccount, ExpenseAmount) SELECT Account, Date, ExpenseAccount, ExpenseAmount FROM CheckExpenseItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format CheckId|ExpenseLineId. | |
CheckId | String | False |
Checks.ID |
The item identifier for the check. This is obtained from the Checks table. |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Account | String | False |
Accounts.FullName |
The name of the account funds are being drawn from. |
AccountId | String | False |
Accounts.ID |
The Id of the account funds are being drawn from. |
Payee | String | False |
Vendors.Name |
The name of the payee for the check. |
PayeeId | String | False |
Vendors.ID |
The Id of the payee for the check. |
Date | Date | False |
Date of transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
Amount | Double | True |
Amount of the transaction. | |
Memo | String | False |
A memo regarding this transaction. | |
Address | String | True |
Full address returned by Reckon. | |
Line1 | String | False |
First line of the address. | |
Line2 | String | False |
Second line of the address. | |
Line3 | String | False |
Third line of the address. | |
Line4 | String | False |
Fourth line of the address. | |
Line5 | String | False |
Fifth line of the address. | |
City | String | False |
City name for the address of the check. | |
State | String | False |
State name for the address of the check. | |
PostalCode | String | False |
Postal code for the address of the check. | |
Country | String | False |
Country for the address of the check. | |
Note | String | False |
Note for the address of the check. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
ExpenseLineId | String | True |
The line item identifier. | |
ExpenseAccount | String | False |
Accounts.FullName |
The account name for this expense line. |
ExpenseAccountId | String | False |
Accounts.ID |
The account Id for this expense line. |
ExpenseAmount | Double | False |
The total amount of this expense line. | |
ExpenseBillableStatus | String | False |
The billing status of this expense line. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED デフォルト値はEMPTYです。 | |
ExpenseCustomer | String | False |
Customers.FullName |
The customer associated with this expense line. |
ExpenseCustomerId | String | False |
Customers.ID |
The customer associated with this expense line. |
ExpenseClass | String | False |
Class.FullName |
The class name of this expense. |
ExpenseClassId | String | False |
Class.ID |
The class Id of this expense. |
ExpenseTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item. Available in only international editions of Reckon. |
ExpenseTaxCodeId | String | False |
Sales tax Id information for this item. Available in only international editions of Reckon. | |
ExpenseMemo | String | False |
A memo for this expense line. | |
ExpenseCustomFields | String | True |
The custom fields for this expense item. | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. デフォルト値はfalseです。 | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ExchangeRate | Double | False |
The market price for which this currency can be exchanged for the currency used by the Reckon company file as the home currency. | |
TimeModified | Datetime | True |
When the check was last modified. | |
TimeCreated | Datetime | True |
When the check was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ApplyCheckToTxnId | String |
Identifies the transaction to be paid by this check. This can be used in updates and inserts. |
ApplyCheckToTxnAmount | String |
The amount of the transaction to be paid by this check. This can be used in updates and inserts. |
Create, update, delete, and query Reckon Check Line Items.
Checks may be inserted, queried, or updated via the Checks, CheckExpenseItems, or CheckLineItems tables. Checks may be deleted by using the Checks table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Checks are Id, Date, ReferenceNumber, Payee, PayeeId, Account, AccountId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CheckLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%' SELECT * FROM CheckLineItems WHERE Date >= '2020-01-07' AND Date < '2020-01-10' SELECT * FROM CheckLineItems WHERE [Date] = '2020-01-07'
To add a Check, specify an Account, a Date, and at least one Expense or Line Item. All Line Item columns can be used for inserting multiple Line Items for a new Check transaction. For example, the following will insert a new Check with two Line Items:
INSERT INTO CheckLineItems#TEMP (Account, Date, ItemName, ItemQuantity) VALUES ('Checking', '1/1/2011', 'Repairs', 1) INSERT INTO CheckLineItems#TEMP (Account, Date, ItemName, ItemQuantity) VALUES ('Checking', '1/1/2011', 'Removal', 2) INSERT INTO CheckLineItems (Account, Date, ItemName, ItemQuantity) VALUES Account, Date, ItemName, ItemQuantity FROM CheckLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format CheckId|ItemLineId. | |
CheckId | String | False |
Checks.ID |
The item identifier for the check. This is obtained from the checks table. |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Account | String | False |
Accounts.FullName |
The name of the account funds are being drawn from. |
AccountId | String | False |
Accounts.ID |
The Id of the account funds are being drawn from. |
Payee | String | False |
Vendors.Name |
The name of the payee for the check. |
PayeeId | String | False |
Vendors.ID |
The id of the payee for the check. |
Date | Date | False |
Date of transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
Amount | Double | True |
Amount of the transaction. | |
Memo | String | False |
A memo regarding this transaction. | |
Address | String | True |
Full address returned by Reckon. | |
Line1 | String | False |
First line of the address. | |
Line2 | String | False |
Second line of the address. | |
Line3 | String | False |
Third line of the address. | |
Line4 | String | False |
Fourth line of the address. | |
Line5 | String | False |
Fifth line of the address. | |
City | String | False |
City name for the address of the check. | |
State | String | False |
State name for the address of the check. | |
PostalCode | String | False |
Postal code for the address of the check. | |
Country | String | False |
Country for the address of the check. | |
Note | String | False |
Note for the address of the check. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item Id. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemCost | Double | False |
The unit cost for the item. | |
ItemAmount | Double | False |
Total amount for the item. | |
ItemBillableStatus | String | False |
Billing status of the item. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED デフォルト値はEMPTYです。 | |
ItemCustomer | String | False |
Customers.FullName |
The name of the customer who ordered the item. |
ItemCustomerId | String | False |
Customers.ID |
The Id of the customer who ordered the item. |
ItemClass | String | False |
Class.FullName |
The name for the class of the item. |
ItemClassId | String | False |
Class.ID |
The Id for the class of the item. |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item. Available in only international editions of Reckon. |
ItemTaxCodeId | String | False |
Sales tax Id information for this item. Available in only international editions of Reckon. | |
ItemCustomFields | String | False |
The custom fields for this lineitem. | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. デフォルト値はfalseです。 | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ExchangeRate | Double | False |
The market price for which this currency can be exchanged for the currency used by the Reckon company file as the home currency. | |
TimeModified | Datetime | True |
When the check was last modified. | |
TimeCreated | Datetime | True |
When the check was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ApplyCheckToTxnId | String |
Identifies the transaction to be paid by this check. This can be used in updates and inserts. |
ApplyCheckToTxnAmount | String |
The amount of the transaction to be paid by this check. This can be used in updates and inserts. |
Create, update, delete, and query Reckon Checks.
Checks may be inserted, queried, or updated via the Checks, CheckExpenseItems, or CheckLineItems tables. Checks may be deleted by using the Checks table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Checks are Id, Date, ReferenceNumber, Payee, PayeeId, Account, AccountId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Checks WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%' SELECT * FROM Checks WHERE Date >= '2020-01-07' AND Date < '2020-01-10' SELECT * FROM Checks WHERE [Date] = '2020-01-07'
To add a Check, specify an Account, a Date, and at least one Expense or Line Item. The ItemAggregate and ExpenseAggregate columns may be used to specify an XML aggregate of Line or Expense Item data. The columns that may be used in these aggregates are defined in the CheckLineItems and CheckExpenseItems tables and it starts with Item and Expense. For example, the following will insert a new Check with two Line Items:
INSERT INTO Checks (Account, Date, ItemAggregate) VALUES ('Checking', '1/1/2011', '<CheckLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </CheckLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Account | String | False |
Accounts.FullName |
The name of the account funds are being drawn from. |
AccountId | String | False |
Accounts.ID |
The id of the account funds are being drawn from. |
Payee | String | False |
Vendors.Name |
The name of the payee for the Check. |
PayeeId | String | False |
Vendors.ID |
The Id of the payee for the Check. |
Date | Date | False |
Date of transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
Amount | Double | True |
Amount of the transaction. | |
Memo | String | False |
A memo regarding this transaction. | |
Address | String | True |
Full address returned by Reckon. | |
Line1 | String | False |
First line of the address. | |
Line2 | String | False |
Second line of the address. | |
Line3 | String | False |
Third line of the address. | |
Line4 | String | False |
Fourth line of the address. | |
Line5 | String | False |
Fifth line of the address. | |
City | String | False |
City name for the address of the check. | |
State | String | False |
State name for the address of the check. | |
PostalCode | String | False |
Postal code for the address of the check. | |
Country | String | False |
Country for the address of the check. | |
Note | String | False |
Note for the address of the check. | |
ItemCount | Integer | True |
The count of line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a check and its line item data. | |
ExpenseItemCount | Integer | True |
The count of expense line items. | |
ExpenseItemAggregate | String | False |
An aggregate of the expense item data which can be used for adding a check and its expense item data. | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. デフォルト値はfalseです。 | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ExchangeRate | Double | False |
The market price for which this currency can be exchanged for the currency used by the Reckon company file as the home currency. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the check was last modified. | |
TimeCreated | Datetime | True |
When the check was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
Expense* | String |
All expense-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ApplyCheckToTxnId | String |
Identifies the transaction to be paid by this check. This can be used in updates and inserts. |
ApplyCheckToTxnAmount | String |
The amount of the transaction to be paid by this check. This can be used in updates and inserts. |
Create, delete, and query Reckon Classes.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for the Class table are Id, Name, and IsActive. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier of the class. | |
Name | String | False |
The name of the class. | |
FullName | String | True |
The full name of the class in the form ParentName|ClassName. | |
IsActive | Boolean | False |
Boolean determining if the class is active. | |
ParentRef_FullName | String | False |
Class.FullName |
Full name of the parent for the class. You may specify only ParentRef_FullName or ParentRef_ListId on INSERT/UPDATE statements and not both. |
ParentRef_ListId | String | False |
Class.ID |
Id for the parent of the class. You may specify only ParentRef_FullName or ParentRef_ListId on INSERT/UPDATE statements and not both. |
Sublevel | Integer | True |
How many parents the class has. | |
EditSequence | String | True |
A string indicating the revision of the class. | |
TimeCreated | Datetime | True |
The time the class was created. | |
TimeModified | Datetime | True |
The last time the class was modified. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format) |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format). |
NameMatch | String |
This pseudo column is deprecated and should no longer be used. The type of match to use if specifying the name. 使用できる値は次のとおりです。CONTAINS, EXACT, STARTSWITH, ENDSWITH |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ACTIVE, INACTIVE, ALL, NA デフォルト値はALLです。 |
Create, update, delete, and query Reckon Credit Card Charge Expense Line Items.
CreditCardCharges may be inserted, queried, or updated via the CreditCardCharges, CreditCardChargeExpenseItems, or CreditCardChargeLineItems tables. CreditCardCharges may be deleted by using the CreditCardCharges table.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditCardCharges are Id, ReferenceNumber, Date, TimeModified, AccountName, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditCardChargeExpenseItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditCardCharge, specify an Account and at least one Expense or Line Item. All Expense Line Item columns can be used for inserting multiple Expense Line Items for a new CreditCardCharge transaction. For example, the following will insert a new CreditCardCharge with two Expense Line Items:
INSERT INTO CreditCardChargeExpenseItems#TEMP (AccountName, ExpenseAccount ExpenseAmount) VALUES ('CalOil Credit Card', 'Job Expenses:Job Materials', 52.25) INSERT INTO CreditCardChargeExpenseItems#TEMP (AccountName, ExpenseAccount ExpenseAmount) VALUES ('CalOil Credit Card', 'Automobile:Fuel', 235.87) INSERT INTO CreditCardChargeExpenseItems (AccountName, ExpenseAccount, ExpenseAmount) SELECT AccountName, ExpenseAccount, ExpenseAmount FROM CreditCardChargeExpenseItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format CCChargeId|ItemLineId. | |
CCChargeId | String | False |
The item identifier. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ReferenceNumber | String | False |
Reference number for the transaction. | |
AccountName | String | False |
Accounts.FullName |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
AccountId | String | False |
Accounts.ID |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
Memo | String | False |
Memo to appear on internal reports only. | |
PayeeName | String | False |
Vendors.Name |
Name of the payee for the transaction. |
PayeeId | String | False |
Vendors.ID |
Id of the payee for the transaction. |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ExpenseLineId | String | True |
The expense line item identifier. | |
ExpenseAccount | String | False |
Accounts.FullName |
The account name for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAccountId | String | False |
Accounts.ID |
The account Id for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAmount | Double | False |
The total amount of this expense line. | |
ExpenseBillableStatus | String | False |
The billing status of this expense line. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED | |
ExpenseCustomer | String | False |
Customers.FullName |
The customer associated with this expense line. |
ExpenseCustomerId | String | False |
Customers.ID |
The customer associated with this expense line. |
ExpenseClass | String | False |
Class.FullName |
The class name of this expense. |
ExpenseClassId | String | False |
Class.ID |
The class Id of this expense. |
ExpenseMemo | String | False |
A memo for this expense line. | |
ExpenseTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or nontaxable). |
ExpenseTaxCodeId | String | False |
Sales tax information for this item (taxable or nontaxable). | |
ExchangeRate | Double | False |
The market price for which this currency can be exchanged for the currency used by the Reckon company file as the home currency. | |
TimeModified | Datetime | True |
When the credit card charge was last modified. | |
TimeCreated | Datetime | True |
When the credit card charge was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Credit Card Charge Line Items.
CreditCardCharges may be inserted, queried, or updated via the CreditCardCharges, CreditCardChargeExpenseItems, or CreditCardChargeLineItems tables. CreditCardCharges may be deleted by using the CreditCardCharges table.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditCardCharges are Id, ReferenceNumber, Date, TimeModified, AccountName, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditCardChargeLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditCardCharge, specify an Account and at least one Expense or Line Item. All Line Item columns can be used for inserting multiple Line Items for a new CreditCardCharge transaction. For example, the following will insert a new CreditCardCharge with two Line Items:
INSERT INTO CreditCardChargeLineItems#TEMP (AccountName, ItemName, ItemQuantity) VALUES ('CalOil Credit Card', '1/1/2011', 'Repairs', 1) INSERT INTO CreditCardChargeLineItems#TEMP (AccountName, ItemName, ItemQuantity) VALUES ('CalOil Credit Card', '1/1/2011', 'Removal', 2) INSERT INTO CreditCardChargeLineItems (AccountName, ItemName, ItemQuantity) SELECT AccountName, ItemName, ItemQuantity FROM CreditCardChargeLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format CCChargeId|ItemLineId. | |
CCChargeId | String | False |
The item identifier. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ReferenceNumber | String | False |
Reference number for the transaction. | |
AccountName | String | False |
Accounts.FullName |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
AccountId | String | False |
Accounts.ID |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
Memo | String | False |
Memo to appear on internal reports only. | |
PayeeName | String | False |
Vendors.Name |
Name of the payee for the transaction. |
PayeeId | String | False |
Vendors.ID |
Id of the payee for the transaction. |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item name. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group name. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemCost | Double | False |
The unit cost for an item. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemBillableStatus | String | False |
Billing status of the item. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED | |
ItemCustomer | String | False |
Customers.FullName |
The name of the customer who ordered the item. |
ItemCustomerId | String | False |
Customers.ID |
The Id of the customer who ordered the item. |
ItemClass | String | False |
Class.FullName |
The name for the class of the item. |
ItemClassId | String | False |
Class.ID |
The Id for the class of the item. |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or nontaxable). |
ItemTaxCodeId | String | False |
Sales tax information for this item (taxable or nontaxable). | |
TimeModified | Datetime | True |
When the transaction was last modified. | |
TimeCreated | Datetime | True |
When the transaction was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Credit Card Charges.
CreditCardCharges may be inserted, queried, or updated via the CreditCardCharges, CreditCardChargeExpenseItems, or CreditCardChargeLineItems tables. CreditCardCharges may be deleted by using the CreditCardCharges table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditCardCharges are Id, ReferenceNumber, Date, TimeModified, AccountName, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditCardCharges WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditCardCharge, specify an Account and at least one Expense or Line Item. The ItemAggregate and ExpenseAggregate columns may be used to specify an XML aggregate of Line or Expense Item data. The columns that may be used in these aggregates are defined in the CreditCardChargeLineItems and CreditCardChargeExpenseItems tables and it starts with Item and Expense. For example, the following will insert a new CreditCardCharge with two Line Items:
INSERT INTO CreditCardCharges (AccountName, ItemAggregate) VALUES ('CalOil Credit Card', '<CreditCardChargeLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </CreditCardChargeLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier of the transaction. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ReferenceNumber | String | False |
Reference number for the transaction. | |
AccountName | String | False |
Accounts.FullName |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
AccountId | String | False |
Accounts.ID |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
Memo | String | False |
Memo to appear on internal reports only. | |
PayeeName | String | False |
Vendors.Name |
Name of the payee for the transaction. |
PayeeId | String | False |
Vendors.ID |
Id of the payee for the transaction. |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
ItemCount | Integer | True |
The count of line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a bill and its line item data. | |
ExpenseItemCount | Integer | True |
The count of expense line items. | |
ExpenseItemAggregate | String | False |
An aggregate of the expense item data which can be used for adding a bill and its expense item data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the credit card charge was last modified. | |
TimeCreated | Datetime | True |
When the credit card charge was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
Expense* | String |
All expense-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Credit Card Credit Expense Line Items.
CreditCardCredits may be inserted, queried, or updated via the CreditCardCredits, CreditCardCreditExpenseItems, or CreditCardCreditLineItems tables. CreditCardCredits may be deleted by using the CreditCardCredits table.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditCardCredits are Id, ReferenceNumber, Date, TimeModified, AccountName, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditCardCreditExpenseItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditCardCredit, specify an Account and at least one Expense or Line Item. All Expense Line Item columns can be used for inserting multiple Expense Line Items for a new CreditCardCredit transaction. For example, the following will insert a new CreditCardCredit with two Expense Line Items:
INSERT INTO CreditCardCreditExpenseItems#TEMP (AccountName, ExpenseAccount, ExpenseAmount) VALUES ('CalOil Credit Card', 'Job Expenses:Job Materials', 52.25) INSERT INTO CreditCardCreditExpenseItems#TEMP (AccountName, ExpenseAccount, ExpenseAmount) VALUES ('CalOil Credit Card', 'Automobile:Fuel', 235.87) INSERT INTO CreditCardCreditExpenseItems (AccountName, ExpenseAccount, ExpenseAmount) SELECT AccountName, ExpenseAccount, ExpenseAmount FROM CreditCardCreditExpenseItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format CCCreditId|ItemLineId. | |
CCCreditId | String | False |
The item identifier. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ReferenceNumber | String | False |
Reference number for the transaction. | |
AccountName | String | False |
Accounts.FullName |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
AccountId | String | False |
Accounts.ID |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
Memo | String | False |
Memo to appear on internal reports only. | |
PayeeName | String | False |
Vendors.Name |
Name of the payee for the transaction. |
PayeeId | String | False |
Vendors.ID |
Id of the payee for the transaction. |
ExpenseLineId | String | True |
The expense line item identifier. | |
ExpenseAccount | String | False |
Accounts.FullName |
The account name for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAccountId | String | False |
Accounts.ID |
The account Id for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAmount | Double | False |
The total amount of this expense line. | |
ExpenseBillableStatus | String | False |
The billing status of this expense line. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED | |
ExpenseCustomer | String | False |
Customers.FullName |
The customer associated with this expense line. |
ExpenseCustomerId | String | False |
Customers.ID |
The customer associated with this expense line. |
ExpenseClass | String | False |
Class.FullName |
The class name of this expense. |
ExpenseClassId | String | False |
Class.ID |
The class Id of this expense. |
ExpenseMemo | String | False |
A memo for this expense line. | |
ExpenseTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or nontaxable). |
ExpenseTaxCodeId | String | False |
Sales tax information for this item (taxable or nontaxable). | |
TimeModified | Datetime | True |
When the credit card credit was last modified. | |
TimeCreated | Datetime | True |
When the credit card credit was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Credit Card Credit Line Items.
CreditCardCredits may be inserted, queried, or updated via the CreditCardCredits, CreditCardCreditExpenseItems, or CreditCardCreditLineItems tables. CreditCardCredits may be deleted by using the CreditCardCredits table.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditCardCredits are Id, ReferenceNumber, Date, TimeModified, AccountName, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditCardCreditLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditCardCredit, specify an Account and at least one Expense or Line Item. All Line Item columns can be used for inserting multiple Line Items for a new CreditCardCredit transaction. For example, the following will insert a new CreditCardCredit with two Line Items:
INSERT INTO CreditCardCreditLineItems#TEMP (AccountName, ItemName, ItemQuantity) VALUES ('CalOil Credit Card', '1/1/2011', 'Repairs', 1) INSERT INTO CreditCardCreditLineItems#TEMP (AccountName, ItemName, ItemQuantity) VALUES ('CalOil Credit Card', '1/1/2011', 'Removal', 2) INSERT INTO CreditCardCreditLineItems (AccountName, ItemName, ItemQuantity) SELECT AccountName, ItemName ItemQuantity FROM CreditCardCreditLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format CCCreditId|ItemLineId. | |
CCCreditId | String | False |
The item identifier. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ReferenceNumber | String | False |
Reference number for the transaction. | |
AccountName | String | False |
Accounts.FullName |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
AccountId | String | False |
Accounts.ID |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
Memo | String | False |
Memo to appear on internal reports only. | |
PayeeName | String | False |
Vendors.Name |
Name of the payee for the transaction. |
PayeeId | String | False |
Vendors.ID |
Id of the payee for the transaction. |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item name. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group name. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemCost | Double | False |
The unit cost for an item. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemBillableStatus | String | False |
Billing status of the item. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED | |
ItemCustomer | String | False |
Customers.FullName |
The name of the customer who ordered the item. |
ItemCustomerId | String | False |
Customers.ID |
The Id of the customer who ordered the item. |
ItemClass | String | False |
Class.FullName |
The name for the class of the item. |
ItemClassId | String | False |
Class.ID |
The Id for the class of the item. |
TimeModified | Datetime | True |
When the bill was last modified. | |
TimeCreated | Datetime | True |
When the bill was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Credit Card Credits.
CreditCardCredits may be inserted, queried, or updated via the CreditCardCredits, CreditCardCreditExpenseItems, or CreditCardCreditLineItems tables. CreditCardCredits may be deleted by using the CreditCardCredits table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditCardCredits are Id, ReferenceNumber, Date, TimeModified, AccountName, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditCardCredits WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditCardCredit, specify an Account and at least one Expense or Line Item. The ItemAggregate and ExpenseAggregate columns may be used to specify an XML aggregate of Line or Expense Item data. The columns that may be used in these aggregates are defined in the CreditCardCreditLineItems and CreditCardCreditExpenseItems tables and it starts with Item and Expense. For example, the following will insert a new CreditCardCredit with two Line Items:
INSERT INTO CreditCardCredits (AccountName, ItemAggregate) VALUES ('CalOil Credit Card', '<CreditCardCreditLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </CreditCardCreditLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
Date | Date | False |
Date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ReferenceNumber | String | False |
Reference number for the transaction. | |
AccountName | String | False |
Accounts.FullName |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
AccountId | String | False |
Accounts.ID |
A reference to the credit card account. Either AccountId or AccountName must have a value when inserting. |
Memo | String | False |
Memo to appear on internal reports only. | |
PayeeName | String | False |
Vendors.Name |
Name of the payee for the transaction. |
PayeeId | String | False |
Vendors.ID |
Id of the payee for the transaction. |
ItemCount | Integer | True |
The count of line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a credit card credit and its line item data. | |
ExpenseItemCount | Integer | True |
The count of expense line items. | |
ExpenseItemAggregate | String | False |
An aggregate of the expense item data which can be used for adding a credit card credit and its expense item data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the credit card credit was last modified. | |
TimeCreated | Datetime | True |
When the credit card credit was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
Expense* | String |
All expense-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Credit Memo Line Items.
CreditMemos may be inserted, queried, or updated via the CreditMemoLineItems table. CreditMemos may be deleted by using the CreditMemos table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditMemos are Id, ReferenceNumber, Date, TimeModified, CustomerName, CustomerId, AccountsReceivable, and AccountsReceivableId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditMemoLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditMemo, specify a Customer and at least one Line Item. All Line Item columns can be used for inserting multiple Line Items for a new CreditMemo transaction. For example, the following will insert a new CreditMemo with two Line Items:
INSERT INTO CreditMemoLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Repairs', 1) INSERT INTO CreditMemoLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Removal', 2) INSERT INTO CreditMemoLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM CreditMemoLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format CreditMemoId|ItemLineId. | |
CreditMemoId | String | False |
CreditMemos.ID |
The item identifier. |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
CustomerName | String | False |
Customers.FullName |
The name of the customer on the credit memo. CustomerName or CustomerId are required to have a value when inserting. |
CustomerId | String | False |
Customers.ID |
The Id of the customer on the credit memo. CustomerName or CustomerId are required to have a value when inserting. |
AccountsReceivable | String | False |
Accounts.FullName |
A reference to the name of the accounts-receivable account where the money received from this transaction will be deposited. |
AccountsReceivableId | String | False |
Accounts.ID |
A reference to the Id of the accounts-receivable account where the money received from this transaction will be deposited. |
ShipMethod | String | False |
ShippingMethods.Name |
The shipping method. |
ShipMethodId | String | False |
The shipping method id. | |
ShipDate | Date | False |
The shipping date. | |
Memo | String | False |
A memo regarding this transaction. | |
Amount | Double | False |
Total amount for this transaction. | |
Message | String | False |
CustomerMessages.Name |
A message to the customer. |
MessageId | String | False |
Id of the message to the customer. | |
SalesRep | String | False |
SalesReps.Initial |
Reference to (the initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference Id to the sales rep. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address of the credit memo. | |
BillingState | String | False |
State name for the billing address of the credit memo. | |
BillingPostalCode | String | False |
Postal code for the billing address of the credit memo. | |
BillingCountry | String | False |
Country for the billing address of the credit memo. | |
BillingNote | String | False |
Note for the billing address of the credit memo. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address of the credit memo. | |
ShippingState | String | False |
State name for the shipping address of the credit memo. | |
ShippingPostalCode | String | False |
Postal code for the shipping address of the credit memo. | |
ShippingCountry | String | False |
Country for the shipping address of the credit memo. | |
ShippingNote | String | False |
Note for the shipping address of the credit memo. | |
Subtotal | Double | True |
The gross subtotal. This does not include tax or the amount already paid. | |
Tax | Double | False |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
IsPending | Boolean | False |
Transaction status (whether this transaction has been completed or it is still pending). | |
IsToBeEmailed | Boolean | False |
Whether this credit memo is to be emailed. | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
PONumber | String | False |
The purchase order number. | |
Terms | String | False |
The payment terms. | |
TermsId | String | False |
The payment terms. | |
CreditRemaining | Double | True |
Remaining credit. | |
DueDate | Date | False |
Date when the credit is due. | |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
CustomerSalesTax | String | False |
SalesTaxCodes.Name |
Reference to sales tax information for the customer. |
CustomerSalesTaxId | String | False |
Reference to sales tax information for the customer. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item identifier. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemRate | Double | False |
The unit rate charged for this item. | |
ItemRatePercent | Double | False |
The rate percent charged for this item. | |
ItemTaxCode | String | False |
SalesTaxItems.Name |
Sales tax information for this item (taxable or nontaxable). |
ItemTaxCodeId | String | False |
Sales tax information for this item (taxable or nontaxable). | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemClass | String | False |
Class.FullName |
The class name of the item. |
ItemClassId | String | False |
Class.ID |
The class name of the item. |
ItemOther1 | String | False |
The Other1 field of this line item. | |
ItemOther2 | String | False |
The Other2 field of this line item. | |
ItemCustomFields | String | False |
The custom fields for this lineitem. | |
ItemIsGetPrintItemsInGroup | String | False |
If true, a list of this group's individual items their amounts will appear on printed forms. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the credit memo was last modified. | |
TimeCreated | Datetime | True |
When the credit memo was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ItemPriceLevel | String |
Item price level name. Reckon will not return the price level. |
Create, update, delete, and query Reckon Credit Memos.
CreditMemos may be inserted, queried, or updated via the CreditMemoLineItems table. CreditMemos may be deleted by using the CreditMemos table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditMemos are Id, ReferenceNumber, Date, TimeModified, CustomerName, CustomerId, AccountsReceivable, and AccountsReceivableId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM CreditMemos WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a CreditMemo, specify a Customer and at least one Line Item. The ItemAggregate 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 CreditMemoLineItems tableand it starts with Item. For example, the following will insert a new CreditMemo with two Line Items:
INSERT INTO CreditMemos (CustomerName, ItemAggregate) VALUES ('Abercrombie, Kristy', '<CreditMemoLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </CreditMemoLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
CustomerName | String | False |
Customers.FullName |
The name of the customer on the credit memo. CustomerName or CustomerId are required to have a value when inserting. |
CustomerId | String | False |
Customers.ID |
The Id of the customer on the credit memo. CustomerName or CustomerId are required to have a value when inserting. |
AccountsReceivable | String | False |
Accounts.FullName |
A reference to the name of the accounts-receivable account where the money received from this transaction will be deposited. |
AccountsReceivableId | String | False |
Accounts.ID |
A reference to the Id of the accounts-receivable account where the money received from this transaction will be deposited. |
ShipMethod | String | False |
ShippingMethods.Name |
The shipping method. |
ShipMethodId | String | False |
The shipping method Id. | |
ShipDate | Date | False |
The shipping date. | |
Memo | String | False |
A memo regarding this transaction. | |
Amount | Double | False |
Total amount for this transaction. | |
Message | String | False |
CustomerMessages.Name |
A message to the customer. |
MessageId | String | False |
Id of the message to the customer. | |
SalesRep | String | False |
SalesReps.Initial |
Reference to (initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference Id to the sales rep. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address of the credit memo. | |
BillingState | String | False |
State name for the billing address of the credit memo. | |
BillingPostalCode | String | False |
Postal code for the billing address of the credit memo. | |
BillingCountry | String | False |
Country for the billing address of the credit memo. | |
BillingNote | String | False |
Note for the billing address of the credit memo. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address of the credit memo. | |
ShippingState | String | False |
State name for the shipping address of the credit memo. | |
ShippingPostalCode | String | False |
Postal code for the shipping address of the credit memo. | |
ShippingCountry | String | False |
Country for the shipping address of the credit memo. | |
ShippingNote | String | False |
Note for the shipping address of the credit memo. | |
Subtotal | Double | True |
The gross subtotal. This does not include tax or the amount already paid. | |
Tax | Double | False |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
IsPending | Boolean | False |
Transaction status (whether this transaction has been completed or is still pending). | |
IsToBeEmailed | Boolean | False |
Whether this credit memo is to be emailed. | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
PONumber | String | False |
The purchase order number. | |
Terms | String | False |
The payment terms. | |
TermsId | String | False |
The payment terms. | |
CreditRemaining | Double | True |
Remaining credit. | |
DueDate | Date | False |
Date when the credit is due. | |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
CustomerSalesTax | String | False |
SalesTaxCodes.Name |
Reference to sales tax information for the customer. |
CustomerSalesTaxId | String | False |
Reference to sales tax information for the customer. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
ExchangeRate | Double | False |
Indicates the exchange rate for the transaction. | |
ItemCount | Integer | True |
The count of line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a credit memo and its line item data. | |
TransactionCount | Integer | True |
The count of related transactions to the credi tmemo. | |
TransactionAggregate | String | True |
An aggregate of the linked transaction data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the credit memo was last modified. | |
TimeCreated | Datetime | True |
When the credit memo was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, delete, and query Customer Messages.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier of the customer message. | |
Name | String | False |
The name of the customer message. | |
IsActive | Boolean | False |
Boolean determining if the customer message is active. | |
EditSequence | String | True |
A string indicating the revision of the customer message. | |
TimeCreated | Datetime | True |
The time the customer message was created. | |
TimeModified | Datetime | True |
The last time the customer message was modified. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format) |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format). |
NameMatch | String |
This pseudo column is deprecated and should no longer be used. The type of match to use if specifying the name. 使用できる値は次のとおりです。CONTAINS, EXACT, STARTSWITH, ENDSWITH |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ACTIVE, INACTIVE, ALL, NA デフォルト値はALLです。 |
Create, update, delete, and query Reckon Customers.
To add a Customer, you must specify the Name field.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Customers are Id, Name, Balance, IsActive, and TimeModified. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Balance may be used with the >=, <=, or = conditions but cannot be used to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Customers WHERE Name LIKE '%George%' AND TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Balance > 100.00 AND Balance < 200.00
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier of the customer. | |
Name | String | False |
The name of the customer. This is required to have a value when inserting. | |
FullName | String | True |
The full name of the customer, including parents in the format parent:customer. | |
Salutation | String | False |
A salutation, such as Mr., Mrs., etc. | |
FirstName | String | False |
The first name of the customer as stated in the address info. | |
MiddleInitial | String | False |
A middle name or middle initial of the customer. | |
LastName | String | False |
The last name of the customer as stated in the address info. | |
AccountNumber | String | False |
The account number for the customer. | |
Company | String | False |
The name of the company of the customer. | |
Balance | Double | True |
The balance owned by this customer including subcustomers. | |
CustomerBalance | Double | True |
The balance owned by only this customer not including subcustomers. | |
Contact | String | False |
The name of the main contact person for the customer. | |
Type | String | False |
CustomerTypes.FullName |
A predefined customer type within Reckon. Typical customer types, if defined, might be Commercial, Residential, etc. |
TypeId | String | False |
A predefined customer type within Reckon. | |
Phone | String | False |
The main telephone number for the customer. | |
Fax | String | False |
The fax number number for the customer. | |
AlternateContact | String | False |
The name of an alternate contact person for the customer. | |
AlternatePhone | String | False |
The alternate telephone number for the customer. | |
String | False |
The email address for communicating with the customer. | ||
Notes | String | False |
The first note for a customer. To retrieve all notes for a customer, use the NotesAggregate column or the CustomerNotes table. | |
ParentName | String | False |
Customers.FullName |
The parent name of the job. |
ParentId | String | False |
Customers.ID |
The parent Id of the job. |
Sublevel | Integer | False |
The number of ancestors this customer has. | |
JobStatus | String | False |
The current status of the job. 使用できる値は次のとおりです。Awarded, Closed, InProgress, None, NotAwarded, Pending | |
JobStartDate | Date | False |
The start date of the job. | |
JobProjectedEndDate | Date | False |
The expected end date for the job. | |
JobEndDate | Date | False |
The actual end date for the job. | |
JobDescription | String | False |
A description of the job. | |
JobType | String | False |
The name of the job type. | |
JobTypeId | String | False |
A job type reference Id. | |
CreditCardAddress | String | False |
The address associated with the credit card. | |
CreditCardExpMonth | Integer | False |
The expiration month associated with the credit card. | |
CreditCardExpYear | Integer | False |
The expiration year associated with the credit card. | |
CreditCardNameOnCard | String | False |
The name as it appears on the credit card of the customer. | |
CreditCardNumber | String | False |
The credit card number on file for this customer. | |
CreditCardPostalCode | String | False |
The postal code associated with the address and number on file for this customer. | |
CreditLimit | Double | False |
The credit limit for this customer. If it is equal to 0, there is no credit limit. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address of the customer. | |
BillingState | String | False |
State name for the billing address of the customer. | |
BillingPostalCode | String | False |
Postal code for the billing address of the customer. | |
BillingCountry | String | False |
Country for the billing address of the customer. | |
BillingNote | String | False |
Note for the billing address of the customer. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address of the customer. | |
ShippingState | String | False |
State name for the shipping address of the customer. | |
ShippingPostalCode | String | False |
Postal code for the shipping address of the customer. | |
ShippingCountry | String | False |
Country for the shipping address of the customer. | |
ShippingNote | String | False |
Note for the shipping address of the customer. | |
ResaleNumber | String | False |
The resale number of the customer, if he/she has one. This field can be set in inserts but not in updates. | |
SalesRep | String | False |
SalesReps.ID |
A reference to a sales rep for the customer. |
SalesRepId | String | False |
SalesReps.Initial |
A reference to a sales rep for the customer. |
Terms | String | False |
A reference to terms of payment for this customer. A typical example might be '2% 10 Net 60'. This field can be set in inserts but not in updates. | |
TermsId | String | False |
A reference to terms of payment for this customer. | |
TaxCode | String | False |
SalesTaxCodes.Name |
This is a reference to a sales tax code predefined within Reckon. This field can be set in inserts but not in updates. |
TaxCodeId | String | False |
This is a reference to a sales tax code predefined within Reckon. This field can be set in inserts but not in updates. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
SalesTaxCountry | String | False |
Identifies the country collecting applicable sales taxes. Only available in international editons of Reckon. | |
PriceLevel | String | False |
PriceLevels.Name |
Reference to a price level for the customer. |
PriceLevelId | String | False |
PriceLevels.ID |
Reference to a price level for the customer. |
PreferredPaymentMethodName | String | False |
PaymentMethods.Name |
The preferred method of payment. |
PreferredPaymentMethodId | String | False |
The preferred method of payment. | |
IsActive | Boolean | False |
Whether or not the customer is active. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the customer was last modified. | |
TimeCreated | Datetime | True |
When the customer was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on SearchName. 使用できる値は次のとおりです。CONTAINS, EXACT, STARTSWITH, ENDSWITH デフォルト値はCONTAINSです。 |
IncludeJobs | Boolean |
Whether or not to include job information in the results. デフォルト値はTRUEです。 |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ACTIVE, INACTIVE, ALL, NA デフォルト値はALLです。 |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
MinBalance | String |
This pseudo column is deprecated and should no longer be used. A minimum balance that returned records should have. Limits the search to records with balances greater than or equal to MinBalance. |
MaxBalance | String |
This pseudo column is deprecated and should no longer be used. A maximum balance that returned records should have. Limits the search to records with balances less than or equal to MaxBalance. |
Create, update, delete, and query Reckon Customer Types.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
Name | String | False |
The name of the customer type. | |
FullName | String | True |
The full name of the customer, including parents in the format Parent:Customer. | |
ParentName | String | False |
CustomerTypes.FullName |
The parent name of the job. |
ParentId | String | False |
The parent id of the job. | |
IsActive | Boolean | False |
Whether or not the customer type is active. | |
TimeCreated | Datetime | True |
The datetime the customer type was made. | |
TimeModified | Datetime | True |
The last datetime the customer type was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Create, delete, and query Reckon Date Driven Terms.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for DateDrivenTerms are Name, TimeModified, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The Id of the date driven term. | |
Name | String | False |
The name of the date driven term. | |
IsActive | Boolean | False |
Boolean indicating if the date driven term is active. | |
DayOfMonthDue | Integer | False |
Day of the month when full payment is due with no discount. | |
DueNextMonthDays | Integer | False |
If the invoice or bill is issued within this many days of the due date, payment is not due until the following month. | |
DiscountDayOfMonth | Integer | False |
If the payment is made by this day of the month, then DiscountPct applies. | |
DiscountPct | Double | False |
If the payment is received by DiscountDayOfMonth, then this discount will apply to the payment. DiscountPct must be between 0 and 100. | |
EditSequence | String | True |
A string indicating the revision of the date driven term. | |
TimeCreated | Datetime | True |
The time the date driven term was created. | |
TimeModified | Datetime | True |
The time the date driven term was last modified. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format) |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format). |
NameMatch | String |
This pseudo column is deprecated and should no longer be used. The type of match to use when searching with the name. 使用できる値は次のとおりです。EXACT, STARTSWITH, CONTAINS, ENDSWITH デフォルト値はEXACTです。 |
Create, update, delete, and query Reckon Deposit Line Items.
Deposits may be inserted, queried, or updated via the Deposits or DepositLineItems tables. Deposits may be deleted by using the Deposits table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Deposits are Id, Date, TimeModified, DepositToAccount, and DepositToAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. For example:
SELECT * FROM DepositLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011'
To add a Deposit, specify the DepositToAccount field and at least one Line Item. All Line Items must have an ItemAccount specified.
All Line Item columns can be used for inserting multiple Line Items for a new Deposit transaction. For example, the following will insert a new Deposit with two Line Items:
INSERT INTO DepositLineItems#TEMP (DepositToAccount, ItemAccount, ItemAmount) VALUES ('Checking', 'Undeposited Funds', 12.25) INSERT INTO DepositLineItems#TEMP (DepositToAccount, ItemAccount, ItemAmount) VALUES ('Checking', 'Savings', 155.35) INSERT INTO DepositLineItems (DepositToAccount, ItemAccount, ItemAmount) SELECT DepositToAccount, ItemAccount, ItemAmount FROM DepositLineItems#TEMP
Following is an example to Insert with Transaction Id(ItemPaymentId)
INSERT INTO DepositLineItems (DepositToAccount, Date, ItemPaymentId) VALUES ('Petty Cash', '2022-06-21', '28D31-1702630754')
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format DepositId|ItemLineId. | |
DepositId | String | False |
Deposits.ID |
The deposit identifier. Set this value when inserting values to an existing deposit, or leave it blank to add a new deposit. |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
CashBackAccount | String | False |
Accounts.FullName |
Account reference to the bank or credit card company. |
CashBackAccountId | String | False |
Accounts.ID |
Account reference to the bank or credit card company. |
CashBackAmount | Double | False |
Cash-back amount. | |
CashBackId | String | True |
Id of the cash back transaction. | |
CashBackMemo | String | False |
Additional info for the cash back transaction. | |
DepositToAccount | String | False |
Accounts.FullName |
Account to deposit funds to. |
DepositToAccountId | String | False |
Accounts.ID |
Account to deposit funds to. |
Memo | String | False |
Memo to appear on internal reports only. | |
TotalDeposit | Double | True |
The total of the deposit. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
ItemLineId | String | True |
The line item identifier. | |
ItemAccount | String | False |
Accounts.FullName |
A reference to the account funds are being deposited to. |
ItemAccountId | String | False |
Accounts.ID |
A reference to the account funds are being deposited to. |
ItemAmount | Double | False |
The total amount of this deposit line item. This should be a positive number. | |
ItemCheckNumber | String | False |
The check number for this deposit line item. | |
ItemClass | String | False |
Class.FullName |
Specifies the class of the deposit line item. |
ItemClassId | String | False |
Class.ID |
Specifies the class of the deposit line item. |
ItemEntityName | String | False |
An entity name for this deposit line item. | |
ItemEntityId | String | False |
An entity Id for this deposit line item. | |
ItemMemo | String | False |
Memo for this deposit line item. | |
ItemPaymentMethod | String | False |
PaymentMethods.Name |
The payment method (funding source) for this deposit line item. For example: cash, check, or Master Card. |
ItemPaymentId | String | False |
The payment transaction Id for this deposit line item. | |
ItemPaymentLineId | String | False |
The payment transaction line id for this deposit line item. | |
ItemRefId | String | False |
Identification number of the transaction associated with this deposit line. | |
ItemTxnType | String | True |
Type of the transaction associated with this deposit line. | |
TimeModified | Datetime | True |
When the deposit was last modified. | |
TimeCreated | Datetime | True |
When the deposit was created. | |
Payee | String | False |
Vendors.Name |
The name of the payee for the Check. |
PayeeId | String | False |
Vendors.ID |
The Id of the payee for the Check. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ItemPriceLevel | String |
Item price level name. Reckon will not return the price level. |
Create, update, delete, and query Reckon Deposits.
Deposits may be inserted, queried, or updated via the Deposits or DepositLineItems tables. Deposits may be deleted by using the Deposits table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Deposits are Id, DepositToAccount, and DepositToAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. For example:
SELECT * FROM Deposits WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011'
To add a Deposit, specify the DepositToAccount field and at least one Line Item. The ItemAggregate 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 DepositLineItems table and it starts with Item. For example, the following will insert a new Deposit with two Line Items:
INSERT INTO Deposits (DepositToAccount, ItemAggregate) VALUES ('Checking', '<DepositLineItems> <Row><ItemAccount>Undeposited Funds</ItemAccount><ItemAmount>12.25</ItemAmount></Row> <Row><ItemAccount>Savings</ItemAccount><ItemAmount>155.35</ItemAmount></Row> </DepositLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
CashBackAccount | String | False |
Accounts.FullName |
Account reference to the bank or credit card company. |
CashBackAccountId | String | False |
Accounts.ID |
Account reference to the bank or credit card company. |
CashBackAmount | Double | False |
Cash back amount. | |
CashBackId | String | True |
Id of the cash back transaction. | |
CashBackMemo | String | False |
Additional info for the cash back transaction. | |
DepositToAccount | String | False |
Accounts.FullName |
Account to deposit funds to. |
DepositToAccountId | String | False |
Accounts.ID |
Account to deposit funds to. |
Memo | String | False |
Memo to appear on internal reports only. | |
TotalDeposit | Double | True |
The total of the deposit. | |
ItemCount | Integer | True |
The count of line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a deposit and its line item data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the deposit was last modified. | |
TimeCreated | Datetime | True |
When the deposit was created. | |
Payee | String | False |
Vendors.Name |
The name of the payee for the Check. |
PayeeId | String | False |
Vendors.ID |
The Id of the payee for the Check. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Employee Earnings.
The Ids for the EmployeeEarnings table operate a bit differently than Line Items. Unlike Line Items, QuickBooks does not return a unique Id for EmployeeEarnings. Instead, each EmployeeEarnings entry is returned in a specific order, and Employee Earnings entries can be updated in that order back to QuickBooks. To give the Employee Earnings unique Ids, we have appended the index number of each EmployeeEarnings entry to the Id. It will be up to the programmer to ensure that any modifications to Employee entries through the QuickBooks UI (or another application between a select and an update call) are handled.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Employees are Id, Name, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM EmployeeEarnings WHERE Name LIKE '%George%' AND TimeModified > '1/1/2011' AND TimeModified < '2/1/2011'
To add an EmployeeEarnings entry, specify the EmployeeId field in the INSERT statement. If you instead specify the Employee Name, the Cloud will attempt to add a new Employee. For example:
INSERT INTO EmployeeEarnings (Name, EarningsWageName, EarningsRate) VALUES ('370000-933272659', 'Regular Pay', 21.32)
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format EmployeeId|EmployeeEarningsId. | |
Name | String | True |
The name of the employee. | |
PayPeriod | String | False |
Indicates how often employees are paid 使用できる値は次のとおりです。Daily, Weekly, Biweekly, Semimonthly, Monthly, Quarterly, Yearly | |
EmployeeId | String | False |
Employees.ID |
The Id of the employee. This is required to have a value when inserting. |
EarningsId | String | True |
The Id of the employee earnings entry. | |
EarningsWageName | String | False |
The wage name. This is required to have a value when inserting. | |
EarningsWageId | String | False |
A reference Id to the wage. Used for payroll. | |
EarningsRate | Double | False |
Employee earnings rate. Used for payroll. | |
EarningsRatePercent | String | False |
Employee earnings ratepercent. Used for payroll. | |
TimeModified | Datetime | True |
When the item was last modified. | |
TimeCreated | Datetime | True |
When the item was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ACTIVE, INACTIVE, ALL, NA デフォルト値はALLです。 |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Employees.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Employees are Id, Name, TimeModified, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Employees WHERE Name LIKE '%George%' AND TimeModified > '1/1/2011' AND TimeModified < '2/1/2011'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier of the employee. | |
Name | String | False |
The name of the employee. This is required to have a value when inserting. | |
Salutation | String | False |
A salutation, such as Mr., Mrs., etc. | |
FirstName | String | False |
The first name of the employee. | |
MiddleInitial | String | False |
A middle name or middle initial of the employee. | |
LastName | String | False |
The last name of the employee. | |
AccountNumber | String | False |
The account number for this employee. | |
SSN | String | False |
The social security number of the employee. | |
EmployeeType | String | False |
The type of employee. 使用できる値は次のとおりです。Regular, Unspecified, Officer, Statutory, Owner | |
Gender | String | False |
The gender of the employee. 使用できる値は次のとおりです。Unspecified, Male, Female | |
Address | String | True |
Full address returned by Reckon. | |
Line1 | String | False |
First line of the address. | |
Line2 | String | False |
Second line of the address. | |
City | String | False |
City name for the address. | |
State | String | False |
State name for the address. | |
PostalCode | String | False |
Postal code for the address. | |
Country | String | False |
Country for the address. | |
AlternatePhone | String | False |
An alternate phone number for the employee. | |
String | False |
The email address of the employee. | ||
PrintAs | String | False |
How the employee name should be printed. | |
MobilePhone | String | False |
The mobile phone number of this employee. | |
Pager | String | False |
The pager number of this employee. | |
PagerPIN | String | False |
The personal identification number for the pager of this employee. | |
Fax | String | False |
The fax number of this employee. | |
BirthDate | Date | False |
The date of birth of this employee. | |
HiredDate | Date | False |
The date the employee was hired. | |
IsActive | Boolean | False |
This property indicates whether this object is currently enabled for use by Reckon. | |
Notes | String | False |
This property may contain any notes you wish to make concerning the transaction. | |
PayPeriod | String | False |
Indicates how often employees are paid. 使用できる値は次のとおりです。NotSet, Daily, Weekly, Biweekly, Semimonthly, Monthly, Quarterly, Yearly | |
PayrollClassName | String | False |
Class.FullName |
A reference to the class into which this employee payroll falls. Id/Name Reference Properties. |
PayrollClassId | String | False |
Class.ID |
A reference to the class into which this employee payroll falls. Id/Name Reference Properties. |
Phone | String | False |
The phone number of the employee. | |
ReleasedDate | Date | False |
The date the employee was released (if he/she was released). | |
TimeDataForPaychecks | String | False |
Indicates whether time data is used to create paychecks for this employee. 使用できる値は次のとおりです。NotSet, UseTimeData, DoNotUseTimeData | |
SickTimeAccrualPeriod | String | False |
Sick-time hours accrual period. 使用できる値は次のとおりです。BeginningOfYear, EveryHourOnPaycheck, EveryPaycheck | |
SickTimeAccrualStartDate | Date | False |
Sick-time accrual start date. The standard formatting for dates is YYYY-MM-DD; e.g., September 2, 2002 is formatted as 2002-09-02. | |
SickTimeAccrued | String | False |
Sick-time hours accrued. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported. The integrated application has no permission to access personal data. The Reckon administrator can grant permission to access personal data through the Integrated Application preferences. | |
SickTimeAvailable | String | False |
Sick-time hours available. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported. The integrated application has no permission to access personal data. The Reckon administrator can grant permission to access personal data through the Integrated Application preferences. | |
SickTimeMaximum | String | False |
Sick-time maximum hours. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported | |
SickTimeYearlyReset | Boolean | False |
Sick-time hours resets each year. Default false. | |
SickTimeUsed | String | False |
Sick-time hours used. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported. | |
VacationTimeAccrualPeriod | String | False |
Vacation-time hours accrual period. 使用できる値は次のとおりです。BeginningOfYear, EveryHourOnPaycheck, EveryPaycheck | |
VacationTimeAccrualStartDate | Date | False |
Vacation-time accrual start date. The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. | |
VacationTimeAccrued | String | False |
Vacation-time hours accrued. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported. | |
VacationTimeAvailable | String | False |
Vacation-time hours available. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported. | |
VacationTimeMaximum | String | False |
Vacation-time maximum hours. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported. | |
VacationTimeYearlyReset | Boolean | False |
Vacation-time hours resets each year. Default false. | |
VacationTimeUsed | String | False |
Vacation-time hours used. Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as '2:30'. Seconds are not supported. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
A string indicating the revision of the employee record. | |
TimeModified | Datetime | True |
When the employee record was last modified. | |
TimeCreated | Datetime | True |
When the employee record was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
OpeningBalance | String |
The opening balance of the account (by default 0). Note that this property is used only when adding new accounts to Reckon. |
OpeningDate | String |
The opening balance date of the account. Note that this property is used only when adding new accounts to Reckon. |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ALL, ACTIVE, INACTIVE, NA デフォルト値はALLです。 |
NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on name. 使用できる値は次のとおりです。EXACT, STARTSWITH, ENDSWITH, CONTAINS デフォルト値はCONTAINSです。 |
Create, update, delete, and query Reckon Estimate Line Items.
Estimates may be inserted, queried, or updated via the Estimates or EstimateLineItems tables. Estimates may be deleted by using the Estimates table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for Estimates are Id, ReferenceNumber, Date, TimeModified, CustomerName, and CustomerId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM EstimateLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add an Estimate, specify a Customer and at least one Line Item. All Line Item columns can be used for inserting multiple Line Items for a new Estimate transaction. For example, the following will insert a new Estimate with two Line Items:
INSERT INTO EstimateLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Repairs', 1) INSERT INTO EstimateLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Removal', 2) INSERT INTO EstimateLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM EstimateLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format EstimateId|ItemLineId. | |
EstimateId | String | False |
Estimates.ID |
The unique identifier of the estimate. |
ReferenceNumber | String | False |
Transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
CustomerName | String | False |
Customers.FullName |
Customer name this transaction is recorded under. This is required to have a value when inserting. |
CustomerId | String | False |
Customers.ID |
Customer Id this transaction is recorded under. This is required to have a value when inserting. |
Date | Date | False |
Transaction date. | |
Memo | String | False |
Memo regarding this transaction. | |
TotalAmount | Double | True |
Total amount for this transaction. | |
ItemLineID | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item identifier. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemRate | Double | False |
The unit rate charged for this item. | |
ItemRatePercent | Double | False |
The rate percent charged for this item. | |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or nontaxable). |
ItemTaxCodeId | String | False |
Sales tax Id for this tax item. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemClass | String | False |
Class.FullName |
The class name of the item. |
ItemClassId | String | False |
Class.ID |
The class name of the item. |
ItemMarkupRate | Double | False |
Item markup rate, to be applied over the base purchase cost. | |
ItemMarkupRatePercent | Double | False |
Item markup rate percent, to be applied over the base purchase cost. | |
ItemOther1 | String | False |
The Other1 field of this line item. | |
ItemOther2 | String | False |
The Other2 field of this line item. | |
ItemCustomFields | String | False |
The custom fields for this line item. | |
ItemIsGetPrintItemsInGroup | String | False |
If true, a list of this group's individual items their amounts will appear on printed forms. | |
Message | String | False |
CustomerMessages.Name |
Message to the customer. |
MessageId | String | False |
Message to the customer. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
SalesRep | String | False |
SalesReps.Initial |
Reference to (initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference to (initials of) the sales rep. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
Note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. Requires QBBXML Version 7.0 or higher. | |
ShippingLine1 | String | False |
First line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine2 | String | False |
Second line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine3 | String | False |
Third line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingCity | String | False |
City name for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingState | String | False |
State name for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingCountry | String | False |
Country for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingNote | String | False |
Note for the shipping address. Requires QBBXML Version 7.0 or higher. | |
Subtotal | Double | True |
Gross subtotal. This does not include tax/amount already paid. | |
Tax | Double | True |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
IsActive | Boolean | False |
Whether or not the estimate is active. | |
IsToBeEmailed | Boolean | False |
Whether or not this email is to be emailed. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
PONumber | String | False |
The purchase order number. | |
Terms | String | False |
A reference to terms of payment, predefined within Reckon. | |
TermsId | String | False |
A reference to terms of payment, predefined within Reckon. | |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
CustomerSalesTaxName | String | False |
SalesTaxCodes.Name |
Reference to sales tax information for the customer. |
CustomerSalesTaxId | String | False |
Reference to sales tax information for the customer. | |
DueDate | Date | True |
Date when credit is due. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the credit memo was last modified. | |
TimeCreated | Datetime | True |
When the credit memo was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ItemPriceLevel | String |
Item price level name. Reckon will not return the price level. |
Create, update, delete, and query Reckon Estimates.
Estimates may be inserted, queried, or updated via the Estimates or EstimateLineItems tables. Estimates may be deleted by using the Estimates table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Estimates are Id, Date, TimeModified, ReferenceNumber, CustomerName, and CustomerId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Estimates WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add an Estimate, specify a Customer and at least one Line Item. The ItemAggregate 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 EstimateLineItems table and it starts with Item. For example, the following will insert a new Estimate with two Line Items:
INSERT INTO Estimates (CustomerName, ItemAggregate) VALUES ('Abercrombie, Kristy', '<EstimateLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </EstimateLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
ReferenceNumber | String | False |
Transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
CustomerName | String | False |
Customers.FullName |
Customer name this transaction is recorded under. This is required to have a value when inserting. |
CustomerId | String | False |
Customers.ID |
Customer Id this transaction is recorded under. This is required to have a value when inserting. |
Date | Date | False |
Transaction date. | |
Memo | String | False |
Memo regarding this transaction. | |
TotalAmount | Double | True |
Total amount for this transaction. | |
Message | String | False |
CustomerMessages.Name |
Message to the customer. |
MessageId | String | False |
Message to the customer. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
SalesRep | String | False |
SalesReps.Initial |
Reference to (initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference to (initials of) the sales rep. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
Note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. Requires QBBXML Version 7.0 or higher. | |
ShippingLine1 | String | False |
First line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine2 | String | False |
Second line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine3 | String | False |
Third line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingCity | String | False |
City name for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingState | String | False |
State name for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingCountry | String | False |
Country for the shipping address. Requires QBBXML Version 7.0 or higher. | |
ShippingNote | String | False |
Note for the shipping address. Requires QBBXML Version 7.0 or higher. | |
Subtotal | Double | True |
Gross subtotal. This does not include tax/amount already paid. | |
Tax | Double | True |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
IsActive | Boolean | False |
Whether or not the estimate is active. | |
IsToBeEmailed | Boolean | False |
Whether or not this email is to be emailed. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
PONumber | String | False |
The purchase order number. | |
Terms | String | False |
A reference to the terms of payment, predefined within Reckon. | |
TermsId | String | False |
A reference to the terms of payment, predefined within Reckon. | |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
CustomerSalesTaxName | String | False |
SalesTaxCodes.Name |
Reference to sales tax information for the customer. |
CustomerSalesTaxId | String | False |
Reference to sales tax information for the customer. | |
ExchangeRate | Double | False |
Indicates the exchange rate for the transaction. | |
DueDate | Date | True |
Date when credit is due. | |
Other | String | False |
Other data associated with the estimate. | |
ItemCount | Integer | True |
A count of the line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a estimates and its line item data. | |
TransactionCount | Integer | True |
The count of related transactions to the estimates. | |
TransactionAggregate | String | True |
An aggregate of the linked transaction data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the estimate was last modified. | |
TimeCreated | Datetime | True |
When the estimate was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create and query QuickBooks Inventory Adjustment Line Items.
InventoryAdjustments may be inserted, queried, or deleted via the InventoryAdjustments or InventoryAdjustmentLineItems tables. InventoryAdjustments may be deleted by using the InventoryAdjustments table.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for InventoryAdjustments are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, Account, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM InventoryAdjustmentLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add an InventoryAdjustment, specify an Account and at least one Line Item. To add a Line Item, either the ItemName or ItemId is required, as well as either ItemNewQuantity, ItemNewValue, or ItemQuantityDiff. All Line Item columns can be used for inserting multiple Line Items for a new InventoryAdjustment transaction. For example, the following will insert a new InventoryAdjustment with two Line Items:
INSERT INTO InventoryAdjustmentLineItems#TEMP (Account, ItemName, ItemNewQuantity) VALUES ('Cost of Good Sold', 'Wood Door:Exterior', 100) INSERT INTO InventoryAdjustmentLineItems#TEMP (Account, ItemName, ItemNewQuantity) VALUES ('Cost of Good Sold', 'Wood Door:Interior', 200) INSERT INTO InventoryAdjustmentLineItems (Account, ItemName, ItemNewQuantity) SELECT Account, ItemName, ItemNewQuantity FROM InventoryAdjustmentLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format InventoryAdjustmentId|ItemLineId. | |
InventoryAdjustmentID | String | True |
The unique identifier for the Inventory Adjustment. | |
ReferenceNumber | String | False |
The transaction reference number. | |
Account | String | False |
Accounts.FullName |
The account the inventory adjustment is associated with. Either Account or AccountId is required on insert. |
AccountId | String | False |
Accounts.ID |
The account the inventory adjustment is associated with. Either Account or AccountId is required on insert. |
Class | String | False |
Class.FullName |
A reference to the class for the inventory adjustment. |
ClassId | String | False |
Class.ID |
A reference to the class for the inventory adjustment. |
CustomerName | String | False |
Customers.FullName |
The name of the customer on the inventory adjustment. |
CustomerId | String | False |
Customers.ID |
The id of the customer on the inventory adjustment. |
Memo | String | False |
A memo regarding this transaction. | |
Date | Date | False |
The date of the transaction. | |
ItemLineId | String | False |
The line id of the item. | |
ItemLineNumber | String | True |
The line item number. | |
ItemName | String | False |
Items.FullName |
The item name. Either ItemName or ItemId is required on an insert. |
ItemId | String | False |
Items.ID |
The item identifier. Either ItemName or ItemId is required on an insert. |
ItemNewQuantity | Double | False |
The new quantity for this adjustment. Used on only insert. There is no response value. | |
ItemNewValue | Double | False |
New value of this adjustment. Used on only insert. There is no response value. | |
ItemQuantityDiff | Double | False |
The change in quantity for this adjustment. | |
ItemValueDiff | Double | False |
The change in total value for this adjustment. | |
ItemLotNumber | String | False |
The lot number for this adjustment. This field requires QBXML Version 11.0. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the inventory adjustment was last modified. | |
TimeCreated | Datetime | True |
When the inventory adjustment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
LinkToTxnId | String |
Link this transaction to another transaction. This is available during only inserts and requires a minimum QBXML Version 6.0 |
Create, query, and delete QuickBooks Inventory Adjustments.
InventoryAdjustments may be inserted, queried, or deleted via the InventoryAdjustments or InventoryAdjustmentLineItems tables. InventoryAdjustments may be deleted by using the InventoryAdjustments table.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for InventoryAdjustments are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, Account, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM InventoryAdjustments WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add an InventoryAdjustment, specify an Account and at least one Line Item. To add a Line Item, either the ItemName or the ItemId is required, as well as either ItemNewQuantity, ItemNewValue, ItemQuantityDiff, or ItemValueDiff. The ItemAggregate columns 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 InventoryAdjustmentLineItems tables and it starts with Item. For example, the following will insert a new InventoryAdjustment with two Line Items:
INSERT INTO InventoryAdjustments (Account, ItemAggregate) VALUES ('Cost of Good Sold', '<InventoryAdjustmentLineItems> <Row><ItemName>Wood Door:Exterior</ItemName><ItemNewQuantity>100</ItemNewQuantity></Row> <Row><ItemName>Wood Door:Interior</ItemName><ItemNewQuantity>200</ItemNewQuantity></Row> </InventoryAdjustmentLineItems>')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
ReferenceNumber | String | False |
The transaction reference number. | |
Account | String | False |
Accounts.FullName |
The account the inventory adjustment is associated with. Either Account or AccountId is required on insert. |
AccountId | String | False |
Accounts.ID |
The account the inventory adjustment is associated with. Either Account or AccountId is required on insert. |
Class | String | False |
Class.FullName |
A reference to the class for the inventory adjustment. |
ClassId | String | False |
Class.ID |
A reference to the class for the inventory adjustment. |
CustomerName | String | False |
Customers.FullName |
The name of the customer on the inventory adjustment. |
CustomerId | String | False |
Customers.ID |
The Id of the customer on the inventory adjustment. |
Memo | String | False |
A memo regarding this transaction. | |
Date | Date | False |
The date of the transaction. | |
ItemCount | Integer | True |
The number of line items for the inventory adjustment. | |
ItemAggregate | String | False |
An aggregate of the Line Item data which can be used for adding an inventory adjustment and its line item data. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the inventory adjustment was last modified. | |
TimeCreated | Datetime | True |
When the inventory adjustment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions or updates. |
Create, update, delete, and query Reckon Invoice Line Items.
Invoices may be inserted, queried, or updated via the Invoices or InvoiceLineItems tables. Invoices may be deleted by using the Invoices table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Invoices are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, IsPaid, Account, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM InvoiceLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add an Invoice, specify a Customer and at least one Line Item. All Line Item columns can be used for inserting multiple Line Items for a new Invoice transaction. For example, the following will insert a new Invoice with two Line Items:
INSERT INTO InvoiceLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Repairs', 1) INSERT INTO InvoiceLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Removal', 2) INSERT INTO InvoiceLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM InvoiceLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format InvoiceId|ItemLineId. | |
InvoiceId | String | False |
Invoices.ID |
The unique identifier of the Invoice. |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
CustomerName | String | False |
Customers.FullName |
The name of the customer on the invoice. Either CustomerName or CustomerId must have a value when inserting. |
CustomerId | String | False |
Customers.ID |
The Id of the customer on the invoice. Alternatively give this field a value when inserting instead of CustomerName. |
Account | String | False |
Accounts.FullName |
A reference to the accounts-receivable account where the money received from this transaction will be deposited. |
AccountId | String | False |
Accounts.ID |
A reference to the accounts-receivable account where the money received from this transaction will be deposited. |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ShipMethod | String | False |
ShippingMethods.Name |
The shipping method associated with the invoice. |
ShipMethodId | String | False |
The shipping method associated with the invoice. | |
ShipDate | Date | False |
The shipping date associated with the invoice. | |
Memo | String | False |
A memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
Amount | Double | True |
The total amount for this invoice. | |
Message | String | False |
CustomerMessages.Name |
A message to the vendor or customer to appear in the invoice. |
MessageId | String | False |
A message to vendor or customer to appear in the invoice. | |
SalesRep | String | False |
SalesReps.Initial |
A reference to the (initials of) sales rep. |
SalesRepId | String | False |
SalesReps.ID |
A reference to the sales rep. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
A note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
A note for the shipping address. | |
Subtotal | Double | True |
The gross subtotal of the invoice. This does not include tax or amount already paid. | |
Tax | Double | True |
The total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
The percentage charged for sales tax. | |
PONumber | String | False |
The purchase order number. | |
DueDate | Date | False |
The date when payment is due. | |
Terms | String | False |
The payment terms. | |
TermsId | String | False |
The payment terms. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item identifier. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemRate | Double | False |
The unit rate charged for this item. | |
ItemRatePercent | Double | False |
The rate precent charged for this item. | |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or nontaxable). |
ItemTaxCodeId | String | False |
Sales tax information for this item. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemClass | String | False |
Class.FullName |
The class name of the item. |
ItemClassId | String | False |
Class.ID |
The class name of the item. |
ItemServiceDate | Date | False |
The service date for the item if the item is a type of service. | |
ItemOther1 | String | False |
The Other1 field of this line item. | |
ItemOther2 | String | False |
The Other2 field of this line item. | |
ItemCustomFields | String | False |
The custom fields for this line item. | |
ItemIsGetPrintItemsInGroup | String | False |
If true, a list of this group's individual items their amounts will appear on printed forms. | |
AppliedAmount | Double | True |
The total amount of applied credits and payments. | |
Balance | Double | False |
The unpaid amount for this sale. | |
CustomerTaxCode | String | False |
SalesTaxCodes.Name |
The tax code specific to this customer. |
CustomerTaxCodeId | String | False |
The tax code specific to this customer. | |
IsToBePrinted | Boolean | False |
Whether this invoice is to be printed. | |
IsToBeEmailed | Boolean | False |
Whether this invoice is to be emailed. | |
IsPaid | Boolean | True |
Whether this invoice has been paid in full. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. | |
IsPending | Boolean | False |
The transaction status (whether this transaction has been completed or it is still pending). | |
IsFinanceCharge | String | False |
Whether this invoice includes a finance charge. 使用できる値は次のとおりです。NotSet, IsFinanceCharge, NotFinanceCharge デフォルト値はNotSetです。 | |
Template | String | False |
Templates.Name |
A reference to a template specifying how to print the transaction. |
TemplateId | String | False |
Templates.ID |
A reference to a template specifying how to print the transaction. |
SuggestedDiscountAmount | Double | False |
A suggested discount amount for the invoice. | |
SuggestedDiscountDate | Date | False |
A suggested discount date for the invoice. | |
ExchangeRate | Double | False |
Currency exchange rate for this invoice. | |
BalanceInHomeCurrency | Double | False |
Balance remaining in units of the home currency. | |
Other | String | False |
Other data associated with the invoice. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the invoice was last modified. | |
TimeCreated | Datetime | True |
When the invoice was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
LinkToTxnId | String |
Link this transaction to another transaction. This is only available during inserts. |
ItemLinkToTxnId | String |
Link this individual line item to another transaction. This is only available during inserts. |
ItemLinkToTxnLineId | String |
Link this individual line item to another transaction line item. This is only available during inserts. |
Create, update, delete, and query Reckon Invoices.
Invoices may be inserted, queried, or updated via the Invoices or InvoiceLineItems tables. Invoices may be deleted by using the Invoices table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Invoices are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, IsPaid, Account, and AccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Invoices WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add an Invoice, specify a Customer and at least one Line Item. The ItemAggregate columns 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 InvoiceLineItems tables and it starts with Item. For example, the following will insert a new Invoice with two Line Items:
INSERT INTO Invoices (CustomerName, ItemAggregate) VALUES ('Abercrombie, Kristy', '<InvoiceLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </InvoiceLineItems>')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
CustomerName | String | False |
Customers.FullName |
The name of the customer on the invoice. Either CustomerName or CustomerId must have a value when inserting. |
CustomerId | String | False |
Customers.ID |
The Id of the customer on the invoice. Alternatively give this field a value when inserting instead of CustomerName. |
Account | String | False |
Accounts.FullName |
A reference to the accounts-receivable account where the money received from this transaction will be deposited. |
AccountId | String | False |
Accounts.ID |
A reference to the accounts-receivable account where the money received from this transaction will be deposited. |
Date | Date | False |
The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ShipMethod | String | False |
ShippingMethods.Name |
The shipping method associated with the invoice. |
ShipMethodId | String | False |
The shipping method associated with the invoice. | |
ShipDate | Date | False |
The shipping date associated with the invoice. | |
Memo | String | False |
A memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
Amount | Double | True |
The total amount for this invoice. | |
Message | String | False |
CustomerMessages.Name |
A message to vendor or customer to appear in the invoice. |
MessageId | String | False |
A message to vendor or customer to appear in the invoice. | |
SalesRep | String | False |
SalesReps.Initial |
A reference to the (initials of) sales rep. |
SalesRepId | String | False |
SalesReps.ID |
A reference to the sales rep. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
A note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
A note for the shipping address. | |
Subtotal | Double | True |
The gross subtotal of the invoice. This does not include tax or the amount already paid. | |
Tax | Double | True |
The total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
The percentage charged for sales tax. | |
POnumber | String | False |
The purchase order number. | |
DueDate | Date | False |
The date when payment is due. | |
Terms | String | False |
The payment terms. | |
TermsId | String | False |
The payment terms. | |
ItemCount | Integer | True |
The count of item entries for this transaction. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a invoices and its line item data. | |
TransactionCount | Integer | True |
The count of related transactions to the invoice. | |
TransactionAggregate | String | True |
An aggregate of the linked transaction data. | |
AppliedAmount | Double | True |
The total amount of applied credits and payments. | |
Balance | Double | False |
The unpaid amount for this sale. | |
CustomerTaxCode | String | False |
SalesTaxCodes.Name |
The tax code specific to this customer. |
CustomerTaxCodeId | String | False |
The tax code specific to this customer. | |
IsToBePrinted | Boolean | False |
Whether this invoice is to be printed. | |
IsToBeEmailed | Boolean | False |
Whether this invoice is to be emailed. | |
IsPaid | Boolean | True |
Whether this invoice has been paid in full. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. | |
IsPending | Boolean | False |
The transaction status (whether this transaction has been completed or it is still pending). | |
IsFinanceCharge | String | False |
Whether this invoice includes a finance charge. 使用できる値は次のとおりです。NotSet, IsFinanceCharge, NotFinanceCharge デフォルト値はNotSetです。 | |
Template | String | False |
Templates.Name |
A reference to a template specifying how to print the transaction. |
TemplateId | String | False |
Templates.ID |
A reference to a template specifying how to print the transaction. |
SuggestedDiscountAmount | Double | False |
A suggested discount amount for the invoice. | |
SuggestedDiscountDate | Date | False |
A suggested discount date for the invoice. | |
ExchangeRate | Double | False |
Currency exchange rate for this invoice. | |
BalanceInHomeCurrency | Double | False |
Balance remaining in units of the home currency. | |
Other | String | False |
Other data associated with the invoice. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the invoice was last modified. | |
TimeCreated | Datetime | True |
When the invoice was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions or updates. |
PaidStatus | String |
The paid status of the invoice. 使用できる値は次のとおりです。ALL, PAID, UNPAID, NA デフォルト値はALLです。 |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
LinkToTxnId | String |
Link this transaction to another transaction. |
Create, update, delete, and query Reckon Item Line Items.
Item Line Items may be inserted, deleted, and updated via the ItemLineItems table. Item Line Items refer to the Line Items associated with item groups, inventory assemblies, or sales tax groups.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for Items are Id, TimeModified, Name, Type, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM ItemLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Name LIKE '%12345%'
To add a Line Item, specify the ItemId or Assembly Id columns of the Item Group or Assembly you want to add the Line Item to when making the insertion. For example:
INSERT INTO ItemLineItems (ItemId, LineItemName, LineItemQuantity) VALUES ('430001-1071511103|130000-933272656', 'Hardware:Doorknobs Std', 1)
To insert a new Inventory Assembly, Item Group, or Sales Tax Group with Line Items, provide the Name and Type columns and at least one Line Item. For example:
INSERT INTO ItemLineItems#TEMP (Name, Type, LineItemName, LineItemQuantity) VALUES ('MyItemGroup', 'ItemGroup', 'Hardware:Doorknobs Std', 1) INSERT INTO ItemLineItems#TEMP (Name, Type, LineItemName, LineItemQuantity) VALUES ('MyItemGroup', 'ItemGroup', 'Cabinets', 2) INSERT INTO ItemLineItems (Name, Type, LineItemName, LineItemQuantity) SELECT Name, Type, LineItemName, LineItemQuantity FROM ItemLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format ItemId|ItemLineId. | |
ItemId | String | False |
Items.ID |
The unique identifier for the inventory assembly or group item. |
Name | String | False |
The name of the inventory assembly or group. | |
FullName | String | True |
Full item name in the format parentname:name if the item is a subitem). | |
Type | String | False |
The type of item. This is required to have a value when inserting. デフォルト値はALLです。 | |
Account | String | False |
Accounts.FullName |
Account name the inventory assembly or group is associated with. |
AccountId | String | False |
Accounts.ID |
Account Id the inventory assembly or group is associated with. |
COGSAccount | String | False |
Accounts.FullName |
Cost of Goods Sold account for the inventory assembly or group. |
COGSAccountId | String | False |
Accounts.ID |
Cost of Goods Sold account for the inventory assembly or group. |
AssetAccount | String | False |
Accounts.FullName |
Inventory asset account for the inventory assembly or group if it is an inventory item. |
AssetAccountId | String | False |
Accounts.ID |
Inventory asset account for the inventory assembly or group if it is an inventory item. |
LineItemId | String | False |
Items.ID |
The line item identifier. Either LineItemId or LineItemName need to have a value when inserting. |
LineItemName | String | False |
Items.FullName |
The line item name. Either LineItemId or LineItemName need to have a value when inserting. |
LineItemQuantity | Double | False |
The line item quantity. | |
ParentName | String | False |
Items.FullName |
The parent name of the inventory assembly or group if the inventory assembly or group is a subitem. |
ParentId | String | False |
Items.ID |
The parent Id of the inventory assembly or group if the inventory assembly or group is a subitem. |
Description | String | False |
A description of the inventory assembly or group. | |
Price | Double | False |
The price for the inventory assembly or group. | |
AverageCost | Double | True |
The average cost of the inventory assembly or group. | |
IsActive | Boolean | False |
Whether the inventory assembly or group is active or not. | |
PurchaseCost | Double | False |
Purchase cost for the inventory assembly or group. | |
PurchaseDescription | String | False |
Purchase description for the inventory assembly or group. | |
ExpenseAccount | String | False |
Expense account for the inventory assembly or group. | |
PreferredVendor | String | False |
Vendors.Name |
Preferred vendor for the inventory assembly or group. |
PreferredVendorId | String | False |
Vendors.ID |
Preferred vendor for the inventory assembly or group. |
TaxCode | String | False |
SalesTaxCodes.Name |
This is a reference to a sales tax code predefined within Reckon. |
TaxCodeId | String | False |
This is a reference to a sales tax code predefined within Reckon. | |
PurchaseTaxCode | String | False |
SalesTaxCodes.Name |
This is a reference to a purchase tax code predefined within Reckon. Only available in international versions of Reckon. |
PurchaseTaxCodeId | String | False |
This is a reference to a purchase tax code predefined within Reckon. Only available in international versions of Reckon. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the inventory assembly or group was last modified. | |
TimeCreated | Datetime | True |
When the inventory assembly or group was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ALL, ACTIVE, INACTIVE, NA デフォルト値はALLです。 |
Create, update, delete, and query Reckon Item Receipt Expense Line Items.
ItemReceipts may be inserted, queried, or updated via the ItemReceipts, ItemReceiptExpenseItems, or ItemReceiptLineItems tables. ItemReceipts may be deleted by using the ItemReceipts table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for ItemReceipts are Id, Date, ReferenceNumber, Payee, PayeeId, VendorName, VendorId, Account, AccountId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. VendorName and ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM ItemReceipts WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND VendorName LIKE '%Patton Hardware Supplies%' AND ReferenceNumber LIKE '12345%'
To add an ItemReceipt, specify the Vendor, Date, and at least one Expense or Line Item. All Expense Line Item columns can be used for inserting multiple Expense Line Items for a new ItemReceipt transaction. For example, the following will insert a new ItemReceipt with two Expense Line Items:
INSERT INTO ItemReceiptExpenseItems#TEMP (VendorName, Date, ExpenseAccount, ExpenseAmount) VALUES ('Patton Hardware Supplies', '1/1/2011', 'Utilities:Telephone', 52.25) INSERT INTO ItemReceiptExpenseItems#TEMP (VendorName, Date, ExpenseAccount, ExpenseAmount) VALUES ('Patton Hardware Supplies', '1/1/2011', 'Professional Fees:Accounting', 235.87) INSERT INTO ItemReceiptExpenseItems (VendorName, Date, ExpenseAccount, ExpenseAmount) SELECT VendorName, Date, ExpenseAccount, ExpenseAmount FROM ItemReceiptExpenseItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format ItemReceiptId|ExpenseLineId. | |
ItemReceiptId | String | False |
ItemReceipts.ID |
The item identifier for the item receipt. This is obtained from the ItemReceipts table. |
VendorName | String | False |
Vendors.Name |
The name of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
VendorId | String | False |
Vendors.ID |
The unique Id of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
Date | Date | False |
The transaction date. | |
ReferenceNumber | String | False |
The transaction reference number. | |
AccountsPayable | String | False |
Accounts.FullName |
A reference to the name of the account the item receipt is payable to. |
AccountsPayableId | String | False |
Accounts.ID |
A reference to the unique Id of the account the item receipt is payable to. |
Memo | String | False |
A memo regarding the item receipt. | |
Amount | Double | True |
Total amount of the item receipt. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
ExpenseLineId | String | True |
The line item identifier. | |
ExpenseAccount | String | False |
Accounts.FullName |
The account name for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAccountId | String | False |
Accounts.ID |
The account Id for this expense line. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAmount | Double | False |
The total amount of this expense line. | |
ExpenseBillableStatus | String | False |
The billing status of this expense line. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED デフォルト値はEMPTYです。 | |
ExpenseCustomer | String | False |
Customers.FullName |
The customer associated with this expense line. |
ExpenseCustomerId | String | False |
Customers.ID |
The customer associated with this expense line. |
ExpenseClass | String | False |
Class.FullName |
The class name of this expense. |
ExpenseClassId | String | False |
Class.ID |
The class Id of this expense. |
ExpenseTaxCode | String | False |
SalesTaxCodes.Name |
A reference to the name of the sales tax code associated with this expense item. Only available in Reckon UK and CA editions. |
ExpenseTaxCodeId | String | False |
A reference to the Id of the sales tax code associated with this expense item. Only available in Reckon UK and CA editions. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the item receipt was last modified. | |
TimeCreated | Datetime | True |
When the item receipt was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
LinkToTxnId | String |
The id of a transaction to link the new item receipt to. This should be a purchase order Id. Only available on an insert. |
Create, update, delete, and query Reckon Item Receipt Line Items.
ItemReceipts may be inserted, queried, or updated via the ItemReceipts, ItemReceiptExpenseItems, or ItemReceiptLineItems tables. ItemReceipts may be deleted by using the ItemReceipts table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. Typically, These columns can typically be used with only the equals or = comparison. The available columns for ItemReceipts are Id, Date, ReferenceNumber, VendorName, VendorId, Payee, PayeeId, Account, AccountId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. VendorName and ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM ItemReceipts WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND VendorName LIKE '%Patton Hardware Supplies%' AND ReferenceNumber LIKE '12345%'
To add an ItemReceipt, specify the Vendor, Date, and at least one Expense or Line Item. To create LineItems, you must insert data in a temporary table called 'LineItems#TEMP'. For example, the following will insert a new ItemReceipt with two Line Items:
INSERT INTO ItemReceiptLineItems#TEMP (VendorName, Date, ItemName, ItemQuantity) VALUES ('Patton Hardware Supplies', '1/1/2011', 'Repairs',1) INSERT INTO ItemReceiptLineItems#TEMP (VendorName, Date, ItemName, ItemQuantity) VALUES ('Patton Hardware Supplies', '1/1/2011', 'Removal',2) INSERT INTO ItemReceiptLineItems (VendorName, Date, ItemName, ItemQuantity) SELECT FROM VendorName, Date, ItemName, ItemQuantity ItemReceiptLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format ItemReceiptId|ItemLineId. | |
ItemReceiptId | String | False |
ItemReceipts.ID |
The item identifier for the item receipt. This is obtained from the ItemReceipt table. |
VendorName | String | False |
Vendors.Name |
The name of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
VendorId | String | False |
Vendors.ID |
The unique Id of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
Date | Date | False |
The transaction date. | |
ReferenceNumber | String | False |
The transaction reference number. | |
AccountsPayable | String | False |
Accounts.FullName |
A reference to the name of the account the item receipt is payable to. |
AccountsPayableId | String | False |
Accounts.ID |
A reference to the unique id of the account the item receipt is payable to. |
Memo | String | False |
A memo regarding the item receipt. | |
Amount | Double | True |
Total amount of the item receipt. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item Id. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
The name of the sales tax code for the line item. Only available in UK and CA editions of Reckon. |
ItemTaxCodeId | String | False |
The Id of the sales tax code for the line item. Only available in UK and CA editions of Reckon. | |
ItemLotNumber | String | False |
The lot number for the item. | |
ItemOverrideAccount | String | False |
Accounts.FullName |
Reference to the name of an account which may be used to override the default account associated with the item receipt. |
ItemOverrideAccountId | String | False |
Accounts.ID |
Reference to the Id of an account which may be used to override the default account associated with the item receipt. |
ItemCost | Double | False |
The unit cost for an item. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemBillableStatus | String | False |
Billing status of the item. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED デフォルト値はEMPTYです。 | |
ItemCustomer | String | False |
Customers.FullName |
The name of the customer who ordered the item. |
ItemCustomerId | String | False |
Customers.ID |
The Id of the customer who ordered the item. |
ItemClass | String | False |
Class.FullName |
The name for the class of the item. |
ItemClassId | String | False |
Class.ID |
The Id for the class of the item. |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the item receipt was last modified. | |
TimeCreated | Datetime | True |
When the item receipt was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
LinkToTxnId | String |
The Id of a transaction to link the new item receipt to. This should be a purchase order Id. Only available on an insert. |
ItemLinkToTxnId | String |
Link this individual line item to another transaction. |
ItemLinkToTxnLineId | String |
Link this individual line item to another transaction line item. |
Create, update, delete, and query Reckon Item Receipts.
ItemReceipts may be inserted, queried, or updated via the ItemReceipts, ItemReceiptExpenseItems or ItemReceiptLineItems tables. ItemReceipts may be deleted by using the ItemReceipts table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically only be used with the equals or = comparison. The available columns for ItemReceipts are Id, Date, ReferenceNumber, VendorName, VendorId, Payee, PayeeId, Account, AccountId, and TimeModified. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. VendorName and ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM ItemReceipts WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND VendorName LIKE '%Patton Hardware Supplies%' AND ReferenceNumber LIKE '12345%'
To add an ItemReceipt, specify the Vendor, Date, and at least one Expense or Line Item. The ItemAggregate and ExpenseAggregate columns may be used to specify an XML aggregate of Line Item or Expense Item data. The columns that may be used in these aggregates are defined in the ItemReceiptLineItems and ItemReceiptExpenseItems tables and it starts with Item. For example, the following will insert a new ItemReceipt with two Line Items:
INSERT INTO ItemReceipts (VendorName, Date, ItemAggregate) VALUES ('Patton Hardware Supplies', '1/1/2011', '<ItemReceiptLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </ItemReceiptLineItems>')To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
VendorName | String | False |
Vendors.Name |
The name of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
VendorId | String | False |
Vendors.ID |
The unique Id of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
Date | Date | False |
The transaction date. | |
ReferenceNumber | String | False |
The transaction reference number. | |
AccountsPayable | String | False |
Accounts.ID |
A reference to the name of the account the item receipt is payable to. |
AccountsPayableId | String | False |
Accounts.Name |
A reference to the unique Id of the account the item receipt is payable to. |
Memo | String | False |
A memo regarding the item receipt. | |
Amount | Double | True |
Total amount of the item receipt. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
ItemCount | Integer | True |
The count of line items. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a item receipt and its line item data. | |
ExpenseItemCount | Integer | True |
The count of expense line items. | |
ExpenseItemAggregate | String | False |
An aggregate of the expense item data which can be used for adding a item receipt and its expense item data. | |
TransactionCount | Integer | True |
The count of related transactions to the estimates. | |
TransactionAggregate | String | True |
An aggregate of the linked transaction data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the item receipt was last modified. | |
TimeCreated | Datetime | True |
When the item receipt was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
Expense* | String |
All expense-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
LinkToTxnId | String |
The Id of a transaction to link the new item receipt to. This should be a purchase order Id. Only available on an insert. |
Create, update, delete, and query Reckon Items.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for Items are Id, TimeModified, FullName, Type, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. FullName may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM Items WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND FullName LIKE '%12345%'
When inserting the Item, specify the Type and Name fields. Depending on the Type, other columns may also be required in the insertion. See the list below to see which columns are required for special cases:
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
Name | String | False |
The name of the item. | |
FullName | String | True |
Full item name in the format parentname:name if the item is a subitem. | |
Type | String | False |
The type of item. This is required to have a value when inserting. 使用できる値は次のとおりです。Unknown, Service, Inventory, NonInventory, Payment, Discount, SalesTax, SubTotal, OtherCharge, InventoryAssembly, Group, SalesTaxGroup, FixedAsset デフォルト値はALLです。 | |
Account | String | False |
Accounts.FullName |
Account name the item is associated with. |
AccountId | String | False |
Accounts.ID |
Account Id the item is associated with. |
COGSAccount | String | False |
Accounts.FullName |
Cost of Goods Sold account for the item. |
COGSAccountId | String | False |
Accounts.ID |
Cost of Goods Sold account for the item. |
AssetAccount | String | False |
Accounts.FullName |
Inventory asset account for the item if it is an inventory item. |
AssetAccountId | String | False |
Accounts.ID |
Inventory asset account for the item if it is an inventory item. |
DateSold | Datetime | False |
Indicates the date an asset was sold. This is required for fixed asset items. It is not used for any other types of items. | |
PurchaseDate | Date | False |
Indicates date asset was purchased. This field is required for the fixed-asset item type. It is not used by any other item type. | |
ItemCount | Integer | False |
The number of line items associated with the inventory assembly. | |
ParentName | String | False |
Items.FullName |
The parent name of the item if the item is a subitem. |
ParentId | String | False |
Items.ID |
The parent Id of the item if the item is a subitem. |
Description | String | False |
A description of the item. | |
Price | Double | False |
The price for the item. | |
PricePercent | Double | False |
A price percent for this item (you might use a price percent if, for example, you are a service shop that calculates labor costs as a percentage of parts costs). If you set PricePercent, Price will be set to zero. Not used for payment, sales tax, or subtotal items. | |
AverageCost | Double | True |
The average cost of the item. | |
IsActive | Boolean | False |
Whether the item is active or not. | |
PurchaseCost | Double | False |
Purchase cost for the item. | |
PurchaseDescription | String | False |
Purchase description for the item. | |
ExpenseAccount | String | False |
Accounts.FullName |
Expense account for the item. |
ExpenseAccountId | String | False |
Accounts.ID |
Expense account for the item. |
PreferredVendor | String | False |
Vendors.Name |
Preferred vendor for the item. |
PreferredVendorId | String | False |
Vendors.ID |
Preferred vendor for the item. |
QuantityOnHand | Double | True |
Quantity in stock for this inventory item. | |
QuantityOnOrder | Double | True |
The number of these items that have been ordered from vendors, but not received. | |
QuantityOnSalesOrder | Double | True |
The number of these items that have been ordered by customers, but not delivered. | |
InventoryDate | Date | False |
The date when the item was converted into an inventory item. | |
ReorderPoint | Double | False |
Quantity at which the user will be reminded to reorder this inventory item. | |
Barcode | String | False |
Barcode for the item. | |
TaxCode | String | False |
SalesTaxCodes.Name |
Reference to a sales tax code predefined within Reckon. |
TaxCodeId | String | False |
Reference to a sales tax code predefined within Reckon. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. Available in only international editions of Reckon. | |
PurchaseTaxCode | String | False |
SalesTaxCodes.Name |
Reference to a purchase tax code predefined within Reckon. Only available in international versions of Reckon. |
PurchaseTaxCodeId | String | False |
This is a reference to a purchase tax code predefined within Reckon. Available in only international versions of Reckon. | |
PaymentMethodName | String | False |
PaymentMethods.Name |
The method of payment: check, credit card, etc. |
PaymentMethodId | String | False |
The method of payment: check, credit card, etc. | |
TaxRate | Double | False |
The percentage rate of tax. | |
TaxVendorName | String | False |
SalesTaxItems.Name |
The VENDOR or tax agency to whom taxes are due. |
TaxVendorId | String | False |
The VENDOR or tax agency to whom taxes are due. | |
SpecialItemType | String | False |
The type of the item when the value of item type is Unknown. Calling Add on such an item will result in an error, however Get or GetByName can get any item without causing an error. 使用できる値は次のとおりです。FinanceCharge, ReimbursableExpenseGroup, ReimbursableExpenseSubtotal | |
VendorOrPayeeName | String | False |
Name of the vendor from whom this asset was purchased. | |
IsPrintItemsInGroup | Boolean | False |
If true, a list of this group's individual items their amounts will appear on printed forms. | |
SalesExpense | String | False |
Any expenses that were incurred during the sale of a fixed asset. This is applicable only if the asset has been sold. | |
AssetAcquiredAs | String | False |
Indicates whether this item was new or used when the business acquired it. If AssetAcquiredAs is left blank, it will not be sent in the request. 使用できる値は次のとおりです。New, Old | |
AssetDescription | String | False |
Description of the asset. | |
AssetLocation | String | False |
Where the asset is located or has been placed into service. | |
AssetPONumber | String | False |
The purchase order number associated with this asset. | |
AssetSerialNumber | String | False |
The serial number of the asset. | |
AssetWarrantyExpires | Date | False |
The date when the warranty for this asset expires. | |
AssetNotes | String | False |
Additional information about the asset. | |
AssetNumber | String | False |
The number used by the Reckon Fixed Asset Manager to identify this asset. | |
AssetCostBasis | Double | False |
The total cost of the fixed asset. This can include the cost of improvements or repairs. This amount is used to figure depreciation. | |
AssetDepreciation | Double | False |
The amount the fixed asset has lost in value since it was purchased, as of the end of the year. | |
AssetBookValue | Double | False |
A reasonable estimate of the sales value of the fixed asset, as of the end of the year. | |
Sublevel | Integer | True |
The number of ancestors this item has. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier for this copy of the object. | |
TimeModified | Datetime | True |
When the item was last modified. | |
TimeCreated | Datetime | True |
When the item was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ALL, ACTIVE, INACTIVE, NA デフォルト値はALLです。 |
Create, update, delete, and query Reckon Journal Entries. Note that while Journal Entry Lines can be created with a new Journal Entry, they cannot be added or removed from an existing Journal Entry.
JournalEntries are unique in that the Credit Line Items and Debit Line Items must add up to the same total in one transaction. It is not possible to change a Journal Line Item one at a time and thus end up with an unbalanced transaction.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for JournalEntries are Id, Date, TimeCreated, ReferenceNumber, LineEntityName, LineEntityId, LineAccount, and LineAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM JournalEntries WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a JournalEntry, specify at least one Credit and one Debit Line. The LineAggregate column may be used to specify an XML aggregate of JournalEntry Line data. The columns that may be used in these aggregates are defined in the JournalEntryLines table and it starts with Line. For example, the following will insert a new JournalEntry with two Credit Lines and one Debit Line:
INSERT Into JournalEntries (ReferenceNumber, LineAggregate) VALUES ('12345', '<JournalEntryLines> <Row><LineType>Credit</LineType><LineAccount>Retained Earnings</LineAccount><LineAmount>100</LineAmount></Row> <Row><LineType>Credit</LineType><LineAccount>Note Payable - Bank of Anycity</LineAccount><LineAmount>20</LineAmount></Row> <Row><LineType>Debit</LineType><LineAccount>Checking</LineAccount><LineAmount>120</LineAmount></Row> </JournalEntryLines>')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
To delete a JournalEntry, simply perform a DELETE statement and set the Id equal to the JournalEntryId you wish to delete. For example:
DELETE From JournalEntries WHERE Id='16336-1450196662'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier for the journal entry. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The transaction date. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
CreditLineCount | Integer | False |
Number of credit lines. | |
DebitLineCount | Integer | False |
Number of debit lines. | |
FirstCreditAccount | String | False |
Accounts.FullName |
The first credit account associated with the JournalEntry. |
FirstCreditAmount | Double | False |
The first credit amount associated with the JournalEntry. | |
FirstCreditMemo | String | False |
The first credit memo associated with the JournalEntry. | |
FirstCreditEntityName | String | False |
The first credit entity name associated with the JournalEntry. | |
FirstCreditEntityId | String | False |
The first credit entity id associated with the JournalEntry. | |
FirstDebitAccount | String | False |
Accounts.FullName |
The first debit account associated with the JournalEntry. |
FirstDebitAmount | Double | False |
The first debit amount associated with the JournalEntry. | |
FirstDebitMemo | String | False |
The first debit memo associated with the JournalEntry. | |
FirstDebitEntityName | String | False |
The first debit entity name associated with the JournalEntry. | |
FirstDebitEntityId | String | False |
The first debit entity id associated with the JournalEntry. | |
LineAggregate | String | False |
An aggregate of the credit lines and debit ines data which can be used for adding a journal entry and its line item data. | |
EditSequence | String | False |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | False |
When the journal entry was last modified. | |
TimeCreated | Datetime | False |
When the journal entry was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Line* | String |
All line-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Journal Entries. Note that while Journal Entry Lines can be created with a new Journal Entry, they cannot be added or removed from an existing Journal Entry.
JournalEntries are unique in that the Credit Line Items and Debit Line Items must add up to the same total in one transaction. It is not possible to change a Journal Line Item one at a time and thus end up with an unbalanced transaction. Note that while Journal Entry Lines can be created with a new Journal Entry, they cannot be added or removed from an existing Journal Entry.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for JournalEntries are Id, Date, TimeModified, ReferenceNumber, LineEntityName, LineEntityId, LineAccount, and LineAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM JournalEntryLines WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a JournalEntry, at least one Credit and one Debit Line must be added. Both types of lines are denoted by the Line columns. Debit Lines have a LineType of Debit while Credit Lines have a LineType of Credit. For example, to insert a JournalEntry:
INSERT Into JournalEntryLines#TEMP (ReferenceNumber, LineType, LineAccount, LineAmount) VALUES ('12345', 'Credit', 'Retained Earnings','100') INSERT Into JournalEntryLines#TEMP (ReferenceNumber, LineType, LineAccount, LineAmount) VALUES ('12345', 'Credit', 'Note Payable - Bank of Anycity','20') INSERT Into JournalEntryLines#TEMP (ReferenceNumber, LineType, LineAccount, LineAmount) VALUES ('12345', 'Debit', 'Checking', '120') INSERT Into JournalEntryLines (ReferenceNumber, LineType, LineAccount, LineAmount) SELECT ReferenceNumber, LineType, LineAccount, LineAmount FROM JournalEntryLines#TEMP
To delete a JournalEntry, simply perform a DELETE statement and set the Id equal to the JournalEntryId you wish to delete. For example:
DELETE From JournalEntries WHERE Id='16336-1450196662'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format JournalEntryId|ItemLineId. | |
JournalEntryID | String | False |
The journal entry Id. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The transaction date. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
CreditLineCount | Integer | False |
Number of credit lines. | |
DebitLineCount | Integer | False |
Number of debit lines. | |
LineId | String | True |
The line item identifier. | |
LineType | String | False |
Type of line: credit or debit. | |
LineAccount | String | False |
Accounts.FullName |
Account name of a credit or debit line. |
LineAccountId | String | False |
Accounts.ID |
Account Id of a credit or debit line. |
LineAmount | Double | False |
Amount of a credit or debit line. | |
LineEntityName | String | False |
Entity name of a credit or debit line. | |
LineEntityId | String | False |
Entity Id of a credit or debit line. | |
LineMemo | String | False |
Memo for a credit or debit line. | |
LineClass | String | False |
Class.FullName |
Class name of a credit or debit line. |
LineClassId | String | False |
Class.ID |
Class Id of a credit or debit line. |
LineStatus | String | False |
Billing status of a credit or debit line. 使用できる値は次のとおりです。EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED | |
LineTaxItem | String | False |
SalesTaxItems.Name |
The sales-tax item used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. Available in only CA, UK, and AU versions. |
LineTaxItemId | String | False |
Id of the sales-tax item used to calculate a single sales tax that is collected at a specified rate and paid to a single agency. Only available in CA, UK, and AU versions. | |
EditSequence | String | False |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | False |
When the journal entry was last modified. | |
TimeCreated | Datetime | False |
When the journal entry was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Other Name entities.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
Name | String | False |
The name of the other name. This is required to have a value when inserting. | |
IsActive | Boolean | False |
Whether or not the other name is active. | |
CompanyName | String | False |
The name of the customer, vendor, employee, or person on the other-names list. | |
Salutation | String | False |
A salutation, such as Mr., Mrs., etc. | |
FirstName | String | False |
The first name of a customer, vendor, employee, or person on the other-names list | |
MiddleName | String | False |
The middle name of a customer, vendor, employee, or person on the other-names list. | |
LastName | String | False |
The last name of a customer, vendor, employee, or person on the other-names list. | |
OtherNameAddress_Addr1 | String | False |
First line of the other-name address. | |
OtherNameAddress_Addr2 | String | False |
Second line of the other-name address. | |
OtherNameAddress_Addr3 | String | False |
Third line of the other-name address. | |
OtherNameAddress_Addr4 | String | False |
Fourth line of the other-name address. | |
OtherNameAddress_Addr5 | String | False |
Fifth line of the other-name address. | |
OtherNameAddress_City | String | False |
City name for the other-name address of the customer, vendor, employee, or person on the other-names list. | |
OtherNameAddress_State | String | False |
State name for the other-name address of the customer, vendor, employee, or person on the other-names list. | |
OtherNameAddress_PostalCode | String | False |
Postal code for the other name address of the customer, vendor, employee, or person on the other-names list. | |
OtherNameAddress_Country | String | False |
Country for the other-name address of the customer, vendor, employee, or person on the other-names list. | |
OtherNameAddress_Note | String | False |
Note for the other-name address of the customer, vendor, employee, or person on the other-names list. | |
Phone | String | False |
The main telephone number for the customer, vendor, employee, or person on the other-names list. | |
AltPhone | String | False |
The alternate telephone number for the customer, vendor, employee, or person on the other-names list. | |
Fax | String | False |
The fax number number for the customer, vendor, employee, or person on the other-names list. | |
String | False |
The email address for communicating with the customer, vendor, employee, or person on the other-names list. | ||
Contact | String | False |
The name of a contact person for the customer, vendor, employee, or person on the other-names list. | |
AltContact | String | False |
The name of an alternate contact person for the customer, vendor, employee, or person on the other-names list. | |
AccountNumber | String | False |
The account number for the other-name. | |
Notes | String | False |
Notes on this customer, vendor, employee, or person on the other-names list. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeCreated | Datetime | True |
The datetime the other name was made. | |
TimeModified | Datetime | True |
The last datetime the other name was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Create, update, delete, and query Reckon Payment Methods.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier of the payment method. | |
Name | String | False |
The name of the payment method. | |
IsActive | Boolean | False |
Boolean determining if the payment method is active. | |
EditSequence | String | True |
A string indicating the revision of the payment method. | |
TimeCreated | Datetime | True |
The time the payment method was created. | |
TimeModified | Datetime | True |
The last time the payment method was modified. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format) |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format). |
NameMatch | String |
This pseudo column is deprecated and should no longer be used. The type of match to use if specifying the name. 使用できる値は次のとおりです。CONTAINS, EXACT, STARTSWITH, ENDSWITH |
ActiveStatus | String |
This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records. 使用できる値は次のとおりです。ACTIVE, INACTIVE, ALL, NA デフォルト値はALLです。 |
Query Reckon Non-Wage Payroll Items.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
Name | String | False |
The name of the payroll item. This is required to have a value when inserting. | |
IsActive | Boolean | False |
Whether or not the payroll item is active. | |
NonWageType | String | False |
The type of pay. 使用できる値は次のとおりです。Addition, CompanyContribution, Deduction, DirectDeposit, Tax | |
ExpenseAccountRef_FullName | String | False |
Accounts.FullName |
The expense account name for this nonwage payroll item. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAccountRef_ListID | String | False |
Accounts.ID |
The expense account id for this nonwage payroll item. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
LiabilityAccountRef_FullName | String | False |
Accounts.FullName |
The liability account name for this nonwage payroll item. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
LiabilityAccountRef_ListID | String | False |
Accounts.ID |
The liability account id for this nonwage payroll item. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
TimeCreated | Datetime | True |
The datetime the payroll item was made. | |
TimeModified | Datetime | True |
The last datetime the payroll item was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Create and query Reckon Wage Payroll Items.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
Name | String | False |
The name of the payroll item. This is required to have a value when inserting. | |
IsActive | Boolean | False |
Whether or not the payroll item is active. | |
WageType | String | False |
The type of pay. 使用できる値は次のとおりです。Bonus, Commission, HourlyOvertime, HourlyRegular, HourlySick, HourlyVacation, SalaryRegular, SalarySick, SalaryVacation | |
ExpenseAccountRef_FullName | String | False |
Accounts.FullName |
The expense account name for this wage payroll item. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
ExpenseAccountRef_ListID | String | False |
Accounts.ID |
The expense account Id for this wage payroll item. ExpenseAccount or ExpenseAccountId must have a value when inserting. |
TimeCreated | Datetime | True |
The datetime the payroll item was made. | |
TimeModified | Datetime | True |
The last datetime the payroll item was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Create and query Reckon Price Levels Per Item. Only Reckon Premier and Enterprise support Per-Item Price Levels. Note that while Price Levels can be added from this table, you may only add Per-Item Price Levels from this table. Price Levels may be deleted from the PriceLevels table.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
PriceLevelID | String | False |
PriceLevels.ID |
The unique identifier of the price level. |
Name | String | False |
The name of the price level. | |
PriceLevelType | String | True |
The type of price level. 使用できる値は次のとおりです。FixedPercentage, PerItem | |
IsActive | Boolean | False |
A boolean determining if the price level is active. | |
PriceLevelPerItemRet_ItemRef_ListID | String | False |
Items.ID |
A reference to the Id of the item. Either the Id or FullName property of the item is required on insertion. |
PriceLevelPerItemRet_ItemRef_FullName | String | False |
Items.FullName |
A reference to the name of the item. Either the Id or FullName property of the item is required on insertion. |
PriceLevelPerItemRet_CustomPrice | Double | False |
A fixed amount for the price. | |
PriceLevelPerItemRet_CustomPricePercent | Double | False |
A fixed discount percentage. | |
TimeCreated | Datetime | True |
The datetime the transaction was made. | |
TimeModified | Datetime | True |
The last datetime the transaction was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on name. 使用できる値は次のとおりです。EXACT, STARTSWITH, ENDSWITH, CONTAINS デフォルト値はCONTAINSです。 |
Create, delete, and query Reckon Price Levels. Note that while Price Levels can be added and deleted from this table, you may add only fixed-percentage Price Levels from this table. Per-Item Price Levels may be added via the PriceLevelPerItem table.
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
Name | String | False |
The name of the price level. | |
PriceLevelType | String | True |
The type of price level. 使用できる値は次のとおりです。FixedPercentage, PerItem | |
IsActive | Boolean | False |
A boolean determining if the price level is active. | |
PriceLevelFixedPercentage | Double | False |
A fixed discount percentage for the price level. | |
PriceLevelPerItemAggregate | String | False |
An aggregate of the per-item price level data. | |
TimeCreated | Datetime | True |
The datetime the transaction was made. | |
TimeModified | Datetime | True |
The last datetime the transaction was modified. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on name. 使用できる値は次のとおりです。EXACT, STARTSWITH, ENDSWITH, CONTAINS デフォルト値はCONTAINSです。 |
Create, update, delete, and query Reckon Purchase Order Line Items.
PurchaseOrders may be inserted, queried, or updated via the PurchaseOrders or PurchaseOrderLineItems tables. PurchaseOrders may be deleted by using the PurchaseOrders table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for PurchaseOrders are Id, Date, TimeModified, ReferenceNumber, VendorName, and VendorId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM PurchaseOrderLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a PurchaseOrder, specify the Vendor and at least one Line Item. All Line Item columns and can be used for inserting multiple Line Items for a new PurchaseOrder transaction. For example, the following will insert a new PurchaseOrder with two Line Items:
INSERT INTO PurchaseOrderLineItems#TEMP (VendorName, ItemName, ItemQuantity) VALUES ('A Cheung Limited', 'Repairs', 1) INSERT INTO PurchaseOrderLineItems#TEMP (VendorName, ItemName, ItemQuantity) VALUES ('A Cheung Limited', 'Removal', 2) INSERT INTO PurchaseOrderLineItems (VendorName, ItemName, ItemQuantity) SELECT VendorName, ItemName, ItemQuantity FROM PurchaseOrderLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format PurchaseOrderId|ItemLineId. | |
PurchaseOrderID | String | False |
The unique identifier of the purchase order. | |
VendorName | String | False |
Vendors.Name |
Vendor name this purchase order is issued to. Either VendorName or VendorId must have a value when inserting. |
VendorId | String | False |
Vendors.ID |
Vendor Id this purchase order is issued to. Either VendorName or VendorId must have a value when inserting. |
VendorMessage | String | False |
Message to appear to vendor. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
Transaction date. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
DueDate | Date | False |
Date when payment is due. | |
ShipMethod | String | False |
ShippingMethods.Name |
Shipping method. |
ShipMethodId | String | False |
Shipping method. | |
ExpectedDate | Date | False |
Date when the shipment is expected. | |
Memo | String | False |
Memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
Terms | String | False |
Payment terms. | |
TermsId | String | False |
Payment terms. | |
TotalAmount | Double | True |
Total amount for this purchase order. | |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item identifier. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemCustomer | String | False |
Customers.FullName |
A reference to a customer for whom this item was ordered. This may also be a customer job. |
ItemCustomerId | String | False |
Customers.ID |
A reference to a customer for whom this item was ordered. This may also be a customer job. |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemRate | Double | False |
The unit rate charged for this item. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemReceivedQuantity | Double | False |
The quantity of items that have been received against this purchase order. | |
ItemClass | String | False |
Class.FullName |
The class name of the item. |
ItemClassId | String | False |
Class.ID |
The class name of the item. |
ItemIsManuallyClosed | Boolean | False |
Whether or not the item is manually closed. | |
ItemPartNumber | String | False |
The part number used by the manufacturer of the item. | |
ItemOther1 | String | False |
The Other1 field of this line item. QBXML version must be set to 6.0 or higher to use this field. | |
ItemOther2 | String | False |
The Other2 field of this line item. QBXML version must be set to 6.0 or higher to use this field. | |
ItemCustomFields | String | False |
The custom fields for this line item. | |
IsFullyReceived | Boolean | True |
If IsFullyReceived is true, all the items in the purchase order have been received and none were closed manually. | |
IsManuallyClosed | Boolean | False |
Whether or not the purchase order is closed. | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. | |
IsToBeEmailed | Boolean | False |
Indicates whether the transaction is to be emailed. | |
IsTaxIncluded | Boolean | False |
Indicates whether the dollar amounts in the line items include tax or not. | |
SalesTaxCodeName | String | False |
SalesTaxCodes.Name |
The type of sales tax that will be charged for this purchase order. |
SalesTaxCodeId | String | False |
The type of sales tax that will be charged for this purchase order. | |
FOB | String | False |
Freight on board: The place to ship from. | |
VendorAddress | String | True |
Full vendor address returned by Reckon. | |
VendorLine1 | String | False |
First line of the vendor address. | |
VendorLine2 | String | False |
Second line of the vendor address. | |
VendorLine3 | String | False |
Third line of the vendor address. | |
VendorLine4 | String | False |
Forth line of the vendor address. | |
VendorLine5 | String | False |
Fifth line of the vendor address. | |
VendorCity | String | False |
City name for the vendor address of the vendor. | |
VendorState | String | False |
State name for the vendor address of the vendor. | |
VendorPostalCode | String | False |
Postal code for the vendor address of the vendor. | |
VendorCountry | String | False |
Country for the vendor address of the vendor. | |
VendorNote | String | False |
Note for the vendor address of the vendor. | |
ShipToEntityId | String | False |
A reference to an entity (a customer, a vendor or an employee) to whom shipment is to be made. This may also be a customer job. | |
ShipToEntityName | String | False |
A reference to an entity (a customer, a vendor or an employee) to whom shipment is to be made. This may also be a customer job. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
Note for the shipping address. | |
Other1 | String | False |
Predefined Reckon custom field. | |
Other2 | String | False |
Predefined Reckon custom field. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the purchase order was last modified. | |
TimeCreated | Datetime | True |
When the purchase order was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ItemPriceLevel | String |
Item price level name. Reckon will not return the price level. |
Create, update, delete, and query Reckon Purchase Orders.
Purchase orders may be inserted, queried, or updated via the PurchaseOrders or PurchaseOrderLineItems tables. PurchaseOrders may be deleted by using the PurchaseOrders table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for PurchaseOrders are Id, Date, TimeModified, VendorName, and VendorId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM PurchaseOrders WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a PurchaseOrder, specify the Vendor and at least one Line Item. The ItemAggregate columns 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 PurchaseOrderLineItems table and it starts with Item. For example, the following will insert a new PurchaseOrder with two Line Items:
INSERT INTO PurchaseOrders (VendorName, ItemAggregate) VALUES ('A Cheung Limited', '<PurchaseOrderLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </PurchaseOrderLineItems>')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format PurchaseOrderId. | |
VendorName | String | False |
Vendors.Name |
Vendor name this purchase order is issued to. Either VendorName or VendorId must have a value when inserting. |
VendorId | String | False |
Vendors.ID |
Vendor Id this purchase order is issued to. Either VendorName or VendorId must have a value when inserting. |
VendorMessage | String | False |
Message to appear to vendor. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
Transaction date. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
DueDate | Date | False |
Date when payment is due. | |
ShipMethod | String | False |
ShippingMethods.Name |
Shipping method. |
ShipMethodId | String | False |
Shipping method. | |
ExpectedDate | Date | False |
Date when the shipment is expected. | |
Memo | String | False |
Memo regarding this transaction. | |
Class | String | False |
Class.Name |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
Terms | String | False |
Payment terms. | |
TermsId | String | False |
Payment terms. | |
TotalAmount | Double | True |
Total amount for this purchase order. | |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
ItemCount | Integer | True |
The number of line items. | |
ItemAggregate | String | False |
An aggregate of the Line item data which can be used for adding a purchase orders and its line item data. | |
IsFullyReceived | Boolean | True |
If IsFullyReceived is true, all the items in the purchase order have been received and none were closed manually. | |
IsManuallyClosed | Boolean | False |
Whether or not the purchase order is closed. | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. | |
IsToBeEmailed | Boolean | False |
Indicates whether the transaction is to be emailed. | |
IsTaxIncluded | Boolean | False |
Indicates whether the dollar amounts in the line items include tax or not. | |
SalesTaxCodeName | String | False |
SalesTaxCodes.Name |
The type of sales tax that will be charged for this purchase order. |
SalesTaxCodeId | String | False |
The type of sales tax that will be charged for this purchase order. | |
FOB | String | False |
Freight on board: The place to ship from. | |
VendorAddress | String | True |
Full vendor address returned by Reckon. | |
VendorLine1 | String | False |
First line of the vendor address. | |
VendorLine2 | String | False |
Second line of the vendor address. | |
VendorLine3 | String | False |
Third line of the vendor address. | |
VendorLine4 | String | False |
Fourth line of the vendor address. | |
VendorLine5 | String | False |
Fifth line of the vendor address. | |
VendorCity | String | False |
City name for the vendor address of the vendor. | |
VendorState | String | False |
State name for the vendor address of the vendor. | |
VendorPostalCode | String | False |
Postal code for the vendor address of the vendor. | |
VendorCountry | String | False |
Country for the vendor address of the vendor. | |
VendorNote | String | False |
Note for the vendor address of the vendor. | |
ShipToEntityName | String | False |
A reference to an entity (a customer, a vendor or an employee) to whom shipment is to be made. This may also be a customer job. | |
ShipToEntityId | String | False |
A reference to an entity (a customer, a vendor or an employee) to whom shipment is to be made. This may also be a customer job. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
Note for the shipping address. | |
Other1 | String | False |
Predefined Reckon custom field. | |
Other2 | String | False |
Predefined Reckon custom field. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the purchase order was last modified. | |
TimeCreated | Datetime | True |
When the purchase order was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Receive Payment transactions.
ReceivePayments may be inserted, queried, or updated via the ReceivePayments or ReceivePaymentsAppliedTo tables. ReceivePayments may be deleted by using the ReceivePayments table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for ReceivePayments are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, DepositToAccountName, and DepositToAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM ReceivePayments WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a ReceivePayment, specify the Customer and Amount. The AppliedToAggregate column may be used to specify an XML aggregate of AppliedTo data. In a Receive Payment, each AppliedTo aggregate represents the transaction to which this part of the payment is being applied. The columns that may be used in these aggregates are defined in the ReceivePaymentsAppliedTo table and it starts with AppliedTo. To use the ApplyToAggregate column, set the AutoApply pseudo column to Custom. For example, the following will insert a new ReceivePayment with two AppliedTo entries:
INSERT INTO ReceivePayments (CustomerName, Amount, AutoApply, AppliedToAggregate) VALUES ('Cook, Brian', '300.00', 'Custom', '<ReceivePaymentsAppliedTo> <Row><AppliedToRefId>178C1-1450221347</AppliedToRefId><AppliedToPaymentAmount>200.00</AppliedToPaymentAmount></Row> <Row><AppliedToRefId>881-933371709</AppliedToRefId><AppliedToPaymentAmount>100.00</AppliedToPaymentAmount></Row> </ReceivePaymentsAppliedTo>')
If you would like to insert a ReceivePayment and let QuickBooks automatically determine which transaction to apply it to, you can use the AutoApply pseudo column to apply the transaction to an existing transaction. For example:
INSERT INTO ReceivePayments (CustomerName, Amount, AutoApply) VALUES ('Cook, Brian', '300.00', 'ExistingTransactions')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier for the transaction. | |
ReferenceNumber | String | False |
The transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The date of the transaction. | |
UnusedPayment | Double | True |
This property will contain the amount of the payment that was not applied to existing invoices. | |
Amount | Double | False |
The amount of the payment received from the Customer. | |
AccountsReceivableName | String | False |
Accounts.FullName |
A reference to the name of the accounts-receivable account where the money received from this transaction will be deposited. |
AccountsReceivableId | String | False |
Accounts.ID |
A reference to the Id of the accounts-receivable account where the money received from this transaction will be deposited. |
CustomerName | String | False |
Customers.FullName |
The name of the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerID does not. |
CustomerId | String | False |
Customers.ID |
The Id of the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerName does not. |
DepositToAccountName | String | False |
Accounts.FullName |
The account name that the payment should be deposited to. |
DepositToAccountId | String | False |
Accounts.ID |
The account Id that the payment should be deposited to. |
PaymentMethodName | String | False |
PaymentMethods.Name |
Name of the payment method that already exists in Reckon. |
PaymentMethodId | String | False |
Id of the payment method that already exists in Reckon. | |
Memo | String | False |
A memo to appear on internal reports. | |
AppliedToAggregate | String | False |
An aggregate of the applied-to data which can be used for adding a bill payment credit card and its applied-to data. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
TimeModified | Datetime | True |
When the receive payment was last modified. | |
TimeCreated | Datetime | True |
When the receive payment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
AutoApply | String |
How the payment should be applied. 使用できる値は次のとおりです。ExistingTransactions, FutureTransactions, Custom デフォルト値はExistingTransactionsです。 |
Create, update, and query Reckon Receive Payment AppliedTo aggregates. In a Receive Payment, each AppliedTo aggregate represents the transaction to which this part of the payment is being applied.
ReceivePayments may be inserted, queried, or updated via the ReceivePayments or ReceivePaymentsAppliedTo tables. ReceivePayments may be deleted by using the ReceivePayments table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for ReceivePayments are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, DepositToAccountName, and DepositToAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM ReceivePaymentsAppliedTo WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a ReceivePayment, specify the Customer and the Amount. All AppliedTo columns can be used to explicitly identify the transactions the payment is applied to. An AppliedTo entry must at the minimum specify the AppliedToRefId and AppliedToPaymentAmount. Optionally, the INSERT may specify the AutoApply behavior.
For example, the following will insert a new ReceivePayment with two AppliedTo entries:
INSERT INTO ReceivePaymentsAppliedTo#TEMP (CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount) VALUES ('Cook, Brian', '300.00', 'Custom','178C1-1450221347', '200.00') INSERT INTO ReceivePaymentsAppliedTo#TEMP (CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount) VALUES ('Cook, Brian', '300.00', 'Custom','881-933371709', '100.00') INSERT INTO ReceivePaymentsAppliedTo (CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount) SELECT CustomerName, AppliedToAmount, AutoApply, AppliedToRefId, AppliedToPaymentAmount FROM ReceivePaymentsAppliedTo#TEMP
If you would like to insert a ReceivePayment and let QuickBooks automatically determine which transaction to apply it to, you can use the AutoApply pseudo column to apply the transaction to an existing transaction. For example:
INSERT INTO ReceivePaymentsAppliedTo (CustomerName, Amount, AutoApply) VALUES ('Cook, Brian', '300.00', 'ExistingTransactions')
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format ReceivePaymentId|AppliedToRefId. | |
ReceivePaymentId | String | False |
The Id of the bill-payment transaction. | |
ReferenceNumber | String | False |
The transaction reference number. This may be set to refnumber*, *refnumber, and *refnumber* in the WHERE clause of a SELECT statement to search by StartsWith, EndsWith, and Contains. Refnum1:refnum2, refnum1:, and :refnum1 may also be used to denote a range. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
Date | Date | False |
The date of the transaction. | |
UnusedPayment | Double | True |
This property will contain the amount of the payment that was not applied to existing invoices. | |
Amount | Double | False |
The amount of the payment received from the Customer. | |
AccountsReceivableName | String | False |
Accounts.FullName |
A reference to the name of the accounts-receivable account where the money received from this transaction will be deposited. |
AccountsReceivableId | String | False |
Accounts.ID |
A reference to the Id of the accounts-receivable account where the money received from this transaction will be deposited. |
CustomerName | String | False |
Customers.FullName |
The name of the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerId is not defined. |
CustomerId | String | False |
Customers.ID |
The Id of the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerName is not defined. |
DepositToAccountName | String | False |
Accounts.FullName |
The account name that the payment should be deposited to. |
DepositToAccountId | String | False |
Accounts.ID |
The account Id that the payment should be deposited to. |
PaymentMethodName | String | False |
PaymentMethods.Name |
Name of a payment method that already exists in Reckon. |
PaymentMethodId | String | False |
Id of a payment method that already exists in Reckon. | |
Memo | String | False |
A memo to appear on internal reports. | |
AutoApply | String | False |
How the payment should be applied. 使用できる値は次のとおりです。ExistingTransactions, FutureTransactions, Custom デフォルト値はExistingTransactionsです。 | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
AppliedToRefId | String | False |
The applied-to reference identifier. This is the Id of an existing transaction that a payment can be applied to such as a JournalEntry, or an Invoice. | |
AppliedToAmount | Double | True |
The amount to be applied. | |
AppliedToBalanceRemaining | Double | True |
The balance remaining to be applied. | |
AppliedToCreditAppliedAmount | Double | False |
The credit applied amount to be applied. | |
AppliedToCreditMemoId | String | False |
CreditMemos.ID |
The credit memo Id to be applied. |
AppliedToDiscountAccountName | String | False |
Accounts.FullName |
The discount account name to be applied. |
AppliedToDiscountAccountId | String | False |
Accounts.ID |
The discount account Id to be applied. |
AppliedToDiscountAmount | Double | False |
The discount amount to be applied. | |
AppliedToPaymentAmount | Double | False |
The payment amount to be applied. | |
AppliedToReferenceNumber | String | True |
The ref number to be applied. | |
AppliedToTxnDate | Date | True |
The transaction date to be applied. | |
AppliedToTxnType | String | True |
The transaction type that was applied. | |
TimeModified | Datetime | True |
When the receive payment was last modified. | |
TimeCreated | Datetime | True |
When the receive payment was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
Earliest transaction date to search for. |
EndTxnDate | String |
Latest transaction date to search for. |
StartModifiedDate | String |
Earliest modified date to search for. |
EndModifiedDate | String |
Latest modified date to search for. |
Create, update, delete, and query Reckon Sales Order Line Items.
SalesOrders may be inserted, queried, or updated via the SalesOrders or SalesOrderLineItems table. SalesOrders may be deleted by using the SalesOrders table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for SalesOrders are Id, Date, TimeModified, ReferenceNumber, CustomerName, and CustomerId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM SalesOrderLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a SalesOrder, specify the Customer and at least one Line Item. All Line Item columns can be used for inserting multiple Line Items for a new SalesOrder transaction. For example, the following will insert a new SalesOrder with two Line Items:
INSERT INTO SalesOrderLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Cook, Brian', 'Repairs', 1) INSERT INTO SalesOrderLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Cook, Brian', 'Removal', 2) INSERT INTO SalesOrderLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM SalesOrderLineItems#TEMP
To add a SalesOrderLineItem to an existing SalesOrder, specify the SalesOrderId, the Item's name, and the Item's Quanitiy. For example:
INSERT INTO SalesOrderLineItems (SalesOrderId, ItemName, ItemQuantity) VALUES ('SalesOrderId', '01Item1', 1)
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format SalesOrderId|ItemLineId. | |
SalesOrderId | String | False |
SalesOrders.ID |
The item identifier. |
ReferenceNumber | String | False |
Transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
CustomerName | String | False |
Customers.Name |
Customer name this transaction is recorded under. This is required to have a value when inserting. |
CustomerId | String | False |
Customers.ID |
Customer Id this transaction is recorded under. |
Date | Date | False |
Transaction date. | |
ShipMethod | String | False |
ShippingMethods.Name |
Shipping method. |
ShipMethodId | String | False |
Shipping method. | |
ShipDate | Date | False |
Shipping date. | |
Memo | String | False |
Memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
TotalAmount | Double | False |
Total amount for this transaction. | |
DueDate | Date | False |
Date the payment is due. | |
Message | String | False |
CustomerMessages.Name |
Message to the customer. |
MessageId | String | False |
Message to the customer. | |
SalesRep | String | False |
SalesReps.Initial |
Reference to (the initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference to the sales rep. |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
ExchangeRate | Double | False |
Currency exchange rate for this sales order. | |
TotalAmountInHomeCurrency | Double | False |
Returned for transactions in currencies different from the merchant's home currency. | |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
Note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
Note for the shipping address. | |
Subtotal | Double | True |
Gross subtotal. This does not include tax or the amount already paid. | |
Tax | Double | True |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
PONumber | String | False |
Purchase order number. | |
Terms | String | False |
Payment terms. | |
TermsId | String | False |
Payment terms. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item identifier. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemRate | Double | False |
The unit rate charged for this item. | |
ItemRatePercent | Double | False |
The rate percent charged for this item. | |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or nontaxable). |
ItemTaxCodeId | String | False |
Sales tax information for this item (taxable or nontaxable). | |
ItemInvoicedAmount | Double | False |
The amount of this sales order line that has been invoiced. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemClass | String | False |
Class.FullName |
The class name of the item. |
ItemClassId | String | False |
Class.ID |
The class Id of the item. |
ItemManuallyClosed | Boolean | False |
Whether this sales order line is manually closed. | |
ItemOther1 | String | False |
The Other1 field of this line item. QBXML version must be set to 6.0 or higher. | |
ItemOther2 | String | False |
The Other2 field of this line item. QBXML version must be set to 6.0 or higher. | |
ItemCustomFields | String | False |
The custom fields for this line item. | |
ItemIsGetPrintItemsInGroup | String | False |
If true, a list of this group's individual items their amounts will appear on printed forms. | |
CustomerTaxCode | String | False |
SalesTaxCodes.Name |
The tax code specific to this customer. |
CustomerTaxCodeId | String | False |
The tax code specific to this customer. | |
IsToBePrinted | Boolean | False |
Whether this sales order is to be printed. | |
IsToBeEmailed | Boolean | False |
When true, if no email address is on file for the customer the transaction will fail. | |
IsManuallyClosed | Boolean | False |
Whether this sales order is manually closed. | |
IsFullyInvoiced | Boolean | True |
Whether this sales order is fully invoiced. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the sales order was last modified. | |
TimeCreated | Datetime | True |
When the sales order was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ItemPriceLevel | String |
Item price level name. Reckon will not return the price level. |
Create, update, delete, and query Reckon Sales Orders.
SalesOrders may be inserted, queried, or updated via the SalesOrders or SalesOrderLineItems table. SalesOrders may be deleted by using the SalesOrders table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for SalesOrders are Id, Date, TimeModified, ReferenceNumber, CustomerName, and CustomerId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM SalesOrders WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a SalesOrder, specify the Customer and at least one Line Item. The ItemAggregate 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 SalesOrderLineItems tables and it starts with Item. For example, the following will insert a new SalesOrder with two Line Items:
INSERT INTO SalesOrders (CustomerName, ItemAggregate) VALUES ('Cook, Brian', '<SalesOrderLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </SalesOrderLineItems>')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
ReferenceNumber | String | False |
Transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
CustomerName | String | False |
Customers.FullName |
Customer name this transaction is recorded under. This is required to have a value when inserting. |
CustomerId | String | False |
Customers.ID |
Customer Id this transaction is recorded under. |
Date | Date | False |
Transaction date. | |
ShipMethod | String | False |
ShippingMethods.Name |
Shipping method. |
ShipMethodId | String | False |
Shipping method. | |
ShipDate | Date | False |
Shipping date. | |
Memo | String | False |
Memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
TotalAmount | Double | False |
Total amount for this transaction. | |
DueDate | Date | False |
Date the payment is due. | |
Message | String | False |
CustomerMessages.Name |
Message to the customer. |
MessageId | String | False |
Message to the customer. | |
SalesRep | String | False |
SalesReps.Initial |
Reference to (the initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference to the sales rep. |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
Note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
Note for the shipping address. | |
Subtotal | Double | True |
Gross subtotal. This does not include tax or the amount already paid. | |
Tax | Double | True |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
PONumber | String | False |
Purchase order number. | |
Terms | String | False |
Payment terms. | |
TermsId | String | False |
Payment terms. | |
ItemCount | Integer | True |
The count of item entries for this transaction. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a SalesOrders and its Line Item data. | |
TransactionCount | Integer | True |
The count of related transactions to the bill. | |
TransactionAggregate | String | True |
An aggregate of the linked transaction data. | |
CustomerTaxCode | String | False |
SalesTaxCodes.Name |
The tax code specific to this customer. |
CustomerTaxCodeId | String | False |
The tax code specific to this customer. | |
IsPrinted | Boolean | True |
Whether this invoice is to be printed. | |
IsManuallyClosed | Boolean | False |
Whether this sales order is manually closed. | |
IsFullyInvoiced | Boolean | True |
Whether this sales order is fully invoiced. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. | |
IsToBePrinted | Boolean | False |
Whether this sales order is to be printed. | |
IsToBeEmailed | Boolean | False |
Whether this sales order is to be emailed. | |
Other | String | False |
A predefined Reckon custom field. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the sales order was last modified. | |
TimeCreated | Datetime | True |
When the sales order was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Sales Receipt Line Items.
SalesReceipts may be inserted, queried, or updated via the SalesReceipts or SalesReceiptLineItems tables. SalesReceipts may be deleted by using the SalesReceipts table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for SalesReceipts are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, DepositAccount, and DepositAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM SalesReceiptLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a SalesReceipt, specify the Customer column and at least one Line Item. All Line Item columns can be used for inserting multiple Line Items for a new SalesReceipt transaction. For example, the following will insert a new SalesReceipt with two Line Items:
INSERT INTO SalesReceiptLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Cook, Brian', 'Repairs', 1) INSERT INTO SalesReceiptLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Cook, Brian', 'Removal', 2) INSERT INTO SalesReceiptLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM SalesReceiptLineItems#TEMP
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier in the format SalesReceiptId|ItemLineId. | |
SalesReceiptId | String | False |
The item identifier. | |
ReferenceNumber | String | False |
Transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, but not the Reckon-generated Id. | |
CustomerName | String | False |
Customers.FullName |
Customer name this transaction is recorded under. |
CustomerId | String | False |
Customers.ID |
Customer Id this transaction is recorded under. |
Date | Date | False |
Transaction date. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ShipMethod | String | False |
ShippingMethods.Name |
Shipping method. |
ShipMethodId | String | False |
Shipping method. | |
ShipDate | Date | False |
Shipping date. | |
Memo | String | False |
Memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
DueDate | Date | False |
The date when payment is due. | |
TotalAmount | Double | True |
Total amount for this transaction. | |
Message | String | False |
CustomerMessages.Name |
Message to the customer. |
MessageId | String | False |
Message to the customer. | |
SalesRep | String | False |
SalesReps.Initial |
Reference to (the initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference to the sales rep. |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
ExchangeRate | Double | False |
Currency exchange rate for this sales receipt. | |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
Note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
Note for the shipping address. | |
Subtotal | Double | True |
Gross subtotal. This does not include tax or the amount already paid. | |
Tax | Double | True |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
IsPending | Boolean | False |
Transaction status (whether this transaction has been completed or it is still pending). | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. This is only available in the UK and CA editions. | |
IsToBeEmailed | Boolean | False |
When true, if no email address is on file for the customer the transaction will fail. | |
ItemLineId | String | True |
The line item identifier. | |
ItemName | String | False |
Items.FullName |
The item name. |
ItemId | String | False |
Items.ID |
The item identifier. |
ItemGroup | String | False |
Items.FullName |
Item group name. Reference to a group of line items this item is part of. |
ItemGroupId | String | False |
Items.ID |
Item group Id. Reference to a group of line items this item is part of. |
ItemDescription | String | False |
A description of the item. | |
ItemQuantity | Double | False |
The quantity of the item or item group specified in this line. | |
ItemRate | Double | False |
The unit rate charged for this item. | |
ItemRatePercent | Double | False |
The rate percent charged for this item. | |
ItemTaxCode | String | False |
SalesTaxCodes.Name |
Sales tax information for this item (taxable or nontaxable). |
ItemTaxCodeId | String | False |
Sales tax information for this item. | |
ItemAmount | Double | False |
Total amount for this item. | |
ItemClass | String | False |
Class.FullName |
The class name of the item. |
ItemClassId | String | False |
Class.ID |
The class Id of the item. |
ItemIsGetPrintItemsInGroup | String | False |
If true, a list of this group's individual items their amounts will appear on printed forms. | |
CheckNumber | String | False |
Check number. | |
PaymentMethod | String | False |
PaymentMethods.Name |
Payment method. |
PaymentMethodId | String | False |
Payment method. | |
DepositAccount | String | False |
Accounts.Name |
Account name where this payment is deposited. |
DepositAccountId | String | False |
Accounts.ID |
Account name where this payment is deposited. |
CustomerTaxCode | String | True |
SalesTaxCodes.Name |
The tax code specific to this customer. |
CustomerTaxCodeId | String | True |
The tax code specific to this customer. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the sales receipt was last modified. | |
TimeCreated | Datetime | True |
When the sales receipt was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
ItemPriceLevel | String |
Item price level name. Reckon will not return the price level. |
Create, update, delete, and query Reckon Sales Receipts.
SalesReceipts may be inserted, queried, or updated via the SalesReceipts or SalesReceiptLineItems tables. SalesReceipts may be deleted by using the SalesReceipts table.
This table has a Custom Fields column. See the Custom Fields page for more information.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for SalesReceipts are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, DepositAccount, and DepositAccountId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM SalesReceipts WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a SalesReceipt, specify the Customer and at least one Line Item. The ItemAggregate columns 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 SalesReceiptLineItems table and it starts with Item. For example, the following will insert a new SalesReceipt with two Line Items:
INSERT INTO SalesReceipts (CustomerName, ItemAggregate) VALUES ('Cook, Brian', '<SalesReceiptLineItems> <Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row> <Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row> </SalesReceiptLineItems>')
To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'
Name | Type | ReadOnly | References | Description |
ID [KEY] | String | True |
The unique identifier. | |
ReferenceNumber | String | False |
Transaction reference number. | |
TxnNumber | Integer | True |
The transaction number. An identifying number for the transaction, but not the Reckon-generated Id. | |
CustomerName | String | False |
Customers.FullName |
Customer name this transaction is recorded under. |
CustomerId | String | False |
Customers.ID |
Customer Id this transaction is recorded under. |
Date | Date | False |
Transaction date. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value. | |
ShipMethod | String | False |
ShippingMethods.Name |
Shipping method. |
ShipMethodId | String | False |
Shipping method. | |
ShipDate | Date | False |
Shipping date. | |
Memo | String | False |
Memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
DueDate | Date | False |
The date when payment is due. | |
TotalAmount | Double | True |
Total amount for this transaction. | |
Message | String | False |
CustomerMessages.Name |
Message to the customer. |
MessageId | String | False |
Message to the customer. | |
SalesRep | String | False |
SalesReps.Initial |
Reference to (the initials of) the sales rep. |
SalesRepId | String | False |
SalesReps.ID |
Reference to the sales rep. |
Template | String | False |
Templates.Name |
The name of an existing template to apply to the transaction. |
TemplateId | String | False |
Templates.ID |
The Id of an existing template to apply to the transaction. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
Note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
Note for the shipping address. | |
Subtotal | Double | True |
Gross subtotal. This does not include tax or the amount already paid. | |
Tax | Double | True |
Total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
Percentage charged for sales tax. | |
IsPending | Boolean | False |
Transaction status (whether this transaction has been completed or it is still pending). | |
IsToBePrinted | Boolean | False |
Whether this transaction is to be printed. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. This is only available in UK and CA editions. | |
IsToBeEmailed | Boolean | False |
When true, if no email address is on file for the customer the transaction will fail. | |
ItemCount | Integer | True |
The count of item entries for this transaction. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a sales receipt and its line item data. | |
CheckNumber | String | False |
Check number. | |
PaymentMethod | String | False |
PaymentMethods.Name |
Payment method. |
PaymentMethodId | String | False |
Payment method. | |
DepositAccount | String | False |
Accounts.FullName |
Account name where this payment is deposited. |
DepositAccountId | String | False |
Accounts.ID |
Account name where this payment is deposited. |
CustomerTaxCode | String | True |
SalesTaxCodes.Name |
The tax code specific to this customer. |
CustomerTaxCodeId | String | True |
The tax code specific to this customer. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the sales receipt was last modified. | |
TimeCreated | Datetime | True |
When the sales receipt was created. |
Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Item* | String |
All line-item-specific columns may be used in insertions. |
EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for. |
StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for. |
StartModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Earliest modified date to search for. |
EndModifiedDate | String |
This pseudo column is deprecated and should no longer be used. Latest modified date to search for. |
Create, update, delete, and query Reckon Sales Rep entities.
By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.
QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can only be used with the equals or = comparison. The available columns for SalesReps are Id, TimeModified, Initial, and IsActive. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:
SELECT * FROM SalesReps WHERE TimeModified > '1/1/20