CData Cloud offers access to Reckon 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 Reckon through CData Cloud.
CData Cloud allows you to standardize and configure connections to Reckon as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to Reckon in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Reckon and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Reckon through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Reckon 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 Reckon through the Remote Connector. The Remote Connector runs on the same machine as Reckon 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 Reckon. For more information, refer to our Using the QuickBooks Gateway guide.
Follow the steps below to authorize with Reckon and connect to a company file when both Reckon and the Cloud are running on your local machine.
If you want to connect to the company file when Reckon is closed, set the CompanyFile connection option when you execute commands. Reckon will open automatically in the background with the file specified.
Note that if Reckon is open through the application UI, only that CompanyFile can be used.
The Remote Connector can be used to read and write to Reckon in situations where direct COM access to Reckon is not available (e.g., ASP.NET, Java, or Reckon on a remote machine). Follow the procedure below to connect to Reckon 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 Reckon; the User and Password properties authenticate the user to the Remote Connector. Authentication to Reckon is handled based on the ApplicationName property.
Note that if the Reckon 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 Reckon 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 Reckon 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 Reckon is installed. The server supports SSL/TLS, enabling users to connect securely from remote machines.
The first time you connect to Reckon, you must authorize your application. Complementing the per-application authentication of Reckon, the QuickBooks Gateway has per-user authentication. Before connecting to Reckon for the first time, configure at least one QuickBooks Gateway user.
You can configure users through the UI on the Users tab. You can then follow the procedure in "Getting Started" to connect an application to Reckon. After connecting, you can monitor Reckon connections on the Status 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 Reckon, but you can configure almost every aspect of how users connect to Reckon 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 Reckon.
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. Reckon data cannot be modified. |
The Test Connection button provides a quick way to verify the application can connect with Reckon.
When a user is added the QuickBooks Gateway will prompt you to authorize the application with Reckon 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 Reckon as well as configuration settings specifying how the connection is to be opened. The QuickBooks Gateway then communicates with Reckon via COM and returns the Reckon response (or an error message) in the HTTP reply.
This chapter details how to control each of these aspects of connecting to Reckon 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 Reckon company files must first go through Reckon. If Reckon is closed, this means that for each attempt to connect to the company file, Reckon 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 Reckon while a persistent connection is opened, Reckon 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 Reckon. |
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. |
You can start the MySQL daemon from the command line, as shown below:
java -jar cdata.jdbc.reckon.jar [ options ]The following command-line options are available:
| Option | Description | |
| -h, --help | Display help for available options and exit. | |
| -f, --config-file | The configuration file for the daemon. | |
| -u, --user | The user allowed to connect. Use a configuration file to configure multiple users. If a user is specified on the command line, then only that user is given access. | |
| -p, --password | The password for the user specified with the user option. If both user and password are set on the command line, the users section in the config file is ignored. | |
| -d, --database | The database that clients will use to connect. If multiple databases are specified in the config file, connections are allowed to only the database specified on the command line. | |
| -c, --connection | The connection string used to connect to the data source being surfaced. If no connection string is specified on the command line, the connection string is read from the config file. | |
| -P, --port | The port number to use to listen for TCP/IP connections. The default port is 3306. | |
| -m, --max-connections | The maximum number of allowed TCP/IP connections. The default value is 25 connections. | |
| --session-timeout | The session timeout time in seconds. The default timeout is 20 seconds. | |
| -t, --protocol | The protocol used for remoting. The default value is MySQL. | |
| -g, --logfile | The full path of the log file. | |
| -F, --logrotationscheme | The interval at which to truncate the logs. The options are 1 (daily in the format [MyFileName]_2016_3_21.txt), 2 (weekly in the format [MyFileName]_Week_5.txt, where 5 is the fifth week in the year), and 3 (monthly in the format [MyFileName]_2016_3_21.txt). | |
| -v, --verbosity | The verbosity of the log. 1 is informational. Levels up to 5 add the following subsequent details: (2) HTTP headers, (3) the HTTP body, (4) transport-level communication including SSL, and (5) interface commands and other data source communication. | |
| --test | The database to test the connection with. If this property is not specified, the default database is used. | |
| --ssl-cert | The path to the SSL certificate. | |
| --ssl-subject | The subject of the SSL certificate. | |
| --ssl-password | The password of the SSL certificate. | |
| -n, --nodeid | Displays the NodeId of this machine. | |
| -l, --license | Installs the license on this machine. This option will prompt you for the type of license and other details. |
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 Reckon 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 Reckon 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 Reckon the application will attempt to stop the Reckon 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 Reckon to be established. The default value is 30 (seconds). If the timeout is reached, the Reckon 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 Reckon 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 Reckon, the application will stop the Reckon 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 Reckon error codes on which to retry a connection. If Reckon returns an error code listed in this property, the Reckon 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 Reckon installation. For instance: "C:\ProgramData\Intuit\Reckon\QBINSTANCEFINDER17.INI". This setting is only applicable when CloseAndRetryConnect is set to True. If the connection retry logic stops the Reckon process the specified QBINSTANCEFINDER file will be cleared of any previous entries. Reckon 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 Reckon. The default is 0 (False), meaning that your code controls when the connection to Reckon is opened and closed by calling the Open and Close methods. However, when this setting is enabled, a persistent connection to Reckon 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 Reckon 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 Reckon 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 Reckon company file (.qbw). If this is not set, the currently open company file is used. When Reckon 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 Reckon is already open in. Possible values are the following:
|
| ReadOnly | DWORD | Specifies whether the user has read-only (1) or full access (0). |
| Date | Build Number | Change Type | Description |
| 12/14/2022 | 8383 | General | Changed
|
| 09/30/2022 | 8308 | General | Changed
|
| 09/29/2022 | 8307 | Reckon | Added
|
| 08/17/2022 | 8264 | General | Changed
|
| 09/02/2021 | 7915 | General | Added
|
| 08/07/2021 | 7889 | General | Changed
|
| 08/06/2021 | 7888 | General | Changed
|
| 07/23/2021 | 7874 | General | Changed
|
| 07/08/2021 | 7859 | General | Added
|
| 04/23/2021 | 7785 | General | Added
|
| 04/23/2021 | 7783 | General | Changed
|
| 04/16/2021 | 7776 | General | Added
Changed
|
| 04/15 /2021 | 7775 | General | Changed
|
This section details a selection of advanced features of the Reckon Cloud.
The Cloud allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Cloud handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Cloud for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Cloud offloads as much of the SELECT statement processing as possible to Reckon and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
The CData Cloud allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from a tool. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Cloud.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Customers WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
SELECT * FROM Customers WHERE City = 'Raleigh';An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
When inserting records, often there is a need to fill in details about child records that have a dependency on a parent.
For instance, when dealing with a CRM system, Invoices often may not be entered without at least one line item.
Invoices may have many line items, with each line item made up of several fields. This presents a unique challenge when offering the data as relational tables.
When reading the data, it is easy enough to model an Invoice and an InvoiceLineItem table with a foreign key connecting the two.
But during inserts, the CRM system will require both the Invoice and the InvoiceLineItems to be created in a single submission.
To solve this sort of problem, our tools offer child collection columns on the parent.
These columns may be used to submit insert statements that include details of both the parent and the child records.
From our example, the Invoice table may have a column called InvoiceLineItems.
During the insert, we can pass in the details of the records that would need to be inserted to the InvoiceLineItems table into the InvoiceLineItems column of the Invoice record.
This can be done using the following methods:
The Cloud facilitates two methods for inserting parent/child records: temporary table insertion and XML/JSON aggregate insertion.
The simplest way to enter data would be to use a #TEMP table, or temporary table, which the Cloud will store in memory.
Reference the #TEMP table with the following syntax:
TableName#TEMP
#TEMP tables are stored in memory for the duration of a connection.
Therefore, in order to use them, you cannot close the connection between submitting inserts to them, and they cannot be used in environments where a different connection may be used for each query.
Within that single connection, the table remains in memory until the bulk insert is successful, at which point the temporary table will be wiped from memory.
For example:
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)
Once the InvoiceLineItems table is populated, the #TEMP table may be referenced during an insert into the Invoice table:
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', 'InvoiceLineItems#TEMP')
Under the hood, the Cloud will read in values from the #TEMP table.
Notice that the ReferenceNumber was used to identify what Invoice the lines are tied to.
This is because the #TEMP table may be populated and used with a bulk insert, where you will have different lines for different Invoices.
This allows the #TEMP tables to be used with a bulk insert. For example:
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
In this case, we are inserting two different Invoices. The ReferenceNumber is how we determine which Lines go with which Invoice.
Note: The tables and columns presented here are an example of how the Cloud works in general. The specific table and column names may be different in the Cloud.
As an alternative to #TEMP tables, direct XML/JSON may be used. Since #TEMP tables are not used to construct them, it does not matter if you use the same connection or close the connection after insert.
For example:
[
{
"Item", "Basketball",
"Quantity": 10
"Amount": 9.99
},
{
"Item", "Football",
"Quantity": 5
"Amount": 12.99
}
]
OR
<Row> <Item>Basketball</Item> <Quantity>10</Quantity> <Amount>9.99</Amount> </Row> <Row> <Item>Football</Item> <Quantity>5</Quantity> <Amount>12.99</Amount> </Row>
Note that the ReferenceNumber is not present in these examples.
That is because the XML/JSON by its nature is not being passed by reference, but passed in full per insert against the parent record.
There is no need to provide something to tie the child back to the parent since the complete XML/JSON must be constructed and submitted for each row.
Then, insert the values:
INSERT INTO Invoices (ReferenceNumber, Customer, InvoiceLines) VALUES ('INV001', 'John Doe', '{...}')
OR
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 Reckon, 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
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
For sources that do not support SQL-92, the Cloud offloads as much of SQL statement processing as possible to Reckon and then processes the rest of the query in memory (client-side). This results in optimal performance.
For data sources with limited query capabilities, the Cloud handles transformations of the SQL query to make it simpler for the Cloud. The goal is to make smart decisions based on the query capabilities of the data source to push down as much of the computation as possible. The Reckon Query Evaluation component examines SQL queries and returns information indicating what parts of the query the Cloud is not capable of executing natively.
The Reckon Query Slicer component is used in more specific cases to separate a single query into multiple independent queries. The client-side Query Engine makes decisions about simplifying queries, breaking queries into multiple queries, and pushing down or computing aggregations on the client-side while minimizing the size of the result set.
There's a significant trade-off in evaluating queries, even partially, client-side. There are always queries that are impossible to execute efficiently in this model, and some can be particularly expensive to compute in this manner. CData always pushes down as much of the query as is feasible for the data source to generate the most efficient query possible and provide the most flexible query capabilities.
Capturing Cloud logging can be very helpful when diagnosing error messages or other unexpected behavior.
You will simply need to set two connection properties to begin capturing Cloud logging.
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are described in the following list:
| 1 | Setting Verbosity to 1 will log the query, the number of rows returned by it, the start of execution and the time taken, and any errors. |
| 2 | Setting Verbosity to 2 will log everything included in Verbosity 1 and additional information about the request. |
| 3 | Setting Verbosity to 3 will additionally log HTTP headers, as well as the body of the request and the response. |
| 4 | Setting Verbosity to 4 will additionally log transport-level communication with the data source. This includes SSL negotiation. |
| 5 | Setting Verbosity to 5 will additionally log communication with the data source and additional details that may be helpful in troubleshooting problems. This includes interface commands. |
The Verbosity should not be set to greater than 1 for normal operation. Substantial amounts of data can be logged at higher verbosities, which can delay execution times.
To refine the logged content further by showing/hiding specific categories of information, see LogModules.
Best Practices for Data Security
Although we mask sensitive values, such as passwords, in the connection string and any request in the log, it is always best practice to review the logs for any sensitive information before sharing outside your organization.
You may want to refine the exact information that is recorded to the log file. This can be accomplished using the LogModules property.
This property allows you to filter the logging using a semicolon-separated list of logging modules.
All modules are four characters long. Please note that modules containing three letters have a required trailing blank space. The available modules are:
LogModules=INFO;EXEC;SSL ;SQL ;META;
Note that these modules refine the information as it is pulled after taking the Verbosity into account.
The CData Cloud supports several operations on data, including querying, deleting, modifying, and inserting.
See SELECT Statements for a syntax reference and examples.
See Data Model for information on the capabilities of the Reckon API.
See INSERT Statements for a syntax reference and examples, as well as retrieving the new records' Ids.
The primary key Id is required to update a record. See UPDATE Statements for a syntax reference and examples.
The primary key Id is required to delete a record. See DELETE Statements for a syntax reference and examples.
GETDELETED statements return the Ids of deleted records. See GETDELETED Statements for a syntax reference and examples.
Use EXECUTE or EXEC statements to execute stored procedures. See EXECUTE Statements for a syntax reference and examples.
A SELECT statement can consist of the following basic clauses.
The following syntax diagram outlines the syntax supported by the SQL engine of the Cloud:
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 NameSee Aggregate Functions for details.
SELECT i.ReferenceNumber, c.AccountNumber FROM Invoices i INNER JOIN Customers c ON i.CustomerId=c.IDSee JOIN Queries for details.
SELECT Id, Name FROM Customers ORDER BY Name ASC
SELECT Id, Name FROM Customers LIMIT 10
SELECT * FROM Customers WHERE Name = @param
Some input-only fields are available in SELECT statements. These fields, called pseudo columns, do not
appear as regular columns in the results, yet may be specified as part of the WHERE clause. You can use pseudo columns to access additional features from Reckon.
SELECT * FROM Customers WHERE IncludeJobs = 'TRUE'
Returns the number of rows matching the query criteria.
SELECT COUNT(*) FROM Customers WHERE Name = 'Cook, Brian'
Returns the number of distinct, non-null field values matching the query criteria.
SELECT COUNT(DISTINCT Id) AS DistinctValues FROM Customers WHERE Name = 'Cook, Brian'
Returns the average of the column values.
SELECT Name, AVG(AnnualRevenue) FROM Customers WHERE Name = 'Cook, Brian' GROUP BY Name
Returns the minimum column value.
SELECT MIN(AnnualRevenue), Name FROM Customers WHERE Name = 'Cook, Brian' GROUP BY Name
Returns the maximum column value.
SELECT Name, MAX(AnnualRevenue) FROM Customers WHERE Name = 'Cook, Brian' GROUP BY Name
Returns the total sum of the column values.
SELECT SUM(AnnualRevenue) FROM Customers WHERE Name = 'Cook, Brian'
The CData Cloud supports standard SQL joins like the following examples.
An inner join selects only rows from both tables that match the join condition:
SELECT i.ReferenceNumber, c.AccountNumber FROM Invoices i INNER JOIN Customers c ON i.CustomerId=c.ID
A left join selects all rows in the FROM table and only matching rows in the JOIN table:
SELECT i.ReferenceNumber, c.AccountNumber FROM Invoices i LEFT JOIN Customers c ON i.CustomerId=c.ID
The following date literal functions can be used to filter date fields using relative intervals. Note that while the <, >, and = operators are supported for these functions, <= and >= are not.
The current day.
SELECT * FROM MyTable WHERE MyDateField = L_TODAY()
The previous day.
SELECT * FROM MyTable WHERE MyDateField = L_YESTERDAY()
The following day.
SELECT * FROM MyTable WHERE MyDateField = L_TOMORROW()
Every day in the preceding week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_WEEK()
Every day in the current week.
SELECT * FROM MyTable WHERE MyDateField = L_THIS_WEEK()
Every day in the following week.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_WEEK()Also available:
The previous n days, excluding the current day.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_DAYS(3)
The following n days, including the current day.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_DAYS(3)Also available:
Every day in every week, starting n weeks before current week, and ending in the previous week.
SELECT * FROM MyTable WHERE MyDateField = L_LAST_N_WEEKS(3)
Every day in every week, starting the following week, and ending n weeks in the future.
SELECT * FROM MyTable WHERE MyDateField = L_NEXT_N_WEEKS(3)Also available:
You can use the SELECT INTO statement to export formatted data to a file.
The following query exports data into a file formatted in comma-separated values (CSV):
SELECT Id, Name INTO [csv://Customers.txt] FROM [Customers] WHERE Name = 'Cook, Brian'You can specify other formats in the file URI. The possible delimiters are tab, semicolon, and comma with the default being a comma. The following example exports tab-separated values:
SELECT Id, Name INTO [csv://Customers.txt;delimiter=tab] FROM [Customers] WHERE Name = 'Cook, Brian'You can specify other file formats in the URI. The following example exports tab-separated values:
The Cloud provides functions that are similar to those that are available with most standard databases. These functions are implemented in the CData provider engine and thus are available across all data sources with the same consistent API. Three categories of functions are available: string, date, and math.
The Cloud interprets all SQL function inputs as either strings or column identifiers, so you need to escape all literals as strings, with single quotes. For example, contrast the SQL Server syntax and Cloud syntax for the DATENAME function:
SELECT DATENAME(yy,GETDATE())
SELECT DATENAME('yy',GETDATE())
These functions perform string manipulations and return a string value. See STRING Functions for more details.
SELECT CONCAT(firstname, space(4), lastname) FROM Customers WHERE Name = 'Cook, Brian'
These functions perform date and date time manipulations. See DATE Functions for more details.
SELECT CURRENT_TIMESTAMP() FROM Customers
These functions provide mathematical operations. See MATH Functions for more details.
SELECT RAND() FROM Customers
SELECT CONCAT('Mr.', SPACE(2), firstname, SPACE(4), lastname) FROM Customers
Returns the ASCII code value of the left-most character of the character expression.
SELECT ASCII('0');
-- Result: 48
Converts the integer ASCII code to the corresponding character.
SELECT CHAR(48);
-- Result: '0'
Returns the starting position of the specified expression in the character string.
SELECT CHARINDEX('456', '0123456');
-- Result: 4
SELECT CHARINDEX('456', '0123456', 5);
-- Result: -1
Returns the number of UTF-8 characters present in the expression.
SELECT CHAR_LENGTH('sample text') FROM Account LIMIT 1
-- Result: 11
Returns the string that is the concatenation of two or more string values.
SELECT CONCAT('Hello, ', 'world!');
-- Result: 'Hello, world!'
Returns 1 if expressionToFind is found within expressionToSearch; otherwise, 0.
SELECT CONTAINS('0123456', '456');
-- Result: 1
SELECT CONTAINS('0123456', 'Not a number');
-- Result: 0
Returns 1 if character_expression ends with character_suffix; otherwise, 0.
SELECT ENDSWITH('0123456', '456');
-- Result: 1
SELECT ENDSWITH('0123456', '012');
-- Result: 0
Returns the number of bytes present in the file at the specified file path.
SELECT FILESIZE('C:/Users/User1/Desktop/myfile.txt');
-- Result: 23684
Returns the value formatted with the specified format.
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'
Returns a representation of the unix_timestamp argument as a value in YYYY-MM-DD HH:MM:SS expressed in the current time zone.
SELECT FROM_UNIXTIME(1540495231, 1);
-- Result: 2018-10-25 19:20:31
SELECT FROM_UNIXTIME(1540495357385, 0);
-- Result: 2018-10-25 19:22:37
Returns the hash of the input value as a byte array using the given algorithm. The supported algorithms are MD5, SHA1, SHA2_256, SHA2_512, SHA3_224, SHA3_256, SHA3_384, and SHA3_512.
SELECT HASHBYTES('MD5', 'Test');
-- Result (byte array): 0x0CBC6611F5540BD0809A388DC95A615B
Returns the starting position of the specified expression in the character string.
SELECT INDEXOF('0123456', '456');
-- Result: 4
SELECT INDEXOF('0123456', '456', 5);
-- Result: -1
Replaces null with the specified replacement value.
SELECT ISNULL(42, 'Was NULL');
-- Result: 42
SELECT ISNULL(NULL, 'Was NULL');
-- Result: 'Was NULL'
Computes the average value of a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or 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
Returns the number of elements in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or 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
Selects any value in a JSON array or object. The path to the array is specified in the jsonpath argument. Return value is numeric or 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
Gets the maximum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or 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
Gets the minimum value in a JSON array within a JSON object. The path to the array is specified in the jsonpath argument. Return value is numeric or 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
Computes the summary value in JSON according to the JSONPath expression. Return value is numeric or 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
Returns the specified number of characters counting from the left of the specified string.
SELECT LEFT('1234567890', 3);
-- Result: '123'
Returns the number of characters of the specified string expression.
SELECT LEN('12345');
-- Result: 5
Returns an integer representing how many characters into the string the substring appears.
SELECT LOCATE('sample','XXXXXsampleXXXXX');
-- Result: 6
Returns the character expression with the uppercase character data converted to lowercase.
SELECT LOWER('MIXED case');
-- Result: 'mixed case'
Returns the character expression with leading blanks removed.
SELECT LTRIM(' trimmed');
-- Result: 'trimmed'
Replaces the characters between start_index and end_index with the mask_character within the string.
SELECT MASK('1234567890','*',);
-- Result: '**********'
SELECT MASK('1234567890','*', 4);
-- Result: '1234******'
SELECT MASK('1234567890','*', 4, 2);
-- Result: '1234****90'
Returns the Unicode character with the specified integer code as defined by the Unicode standard.
Returns the number of bytes present in the expression.
SELECT OCTET_LENGTH('text') FROM Account LIMIT 1
-- Result: 4
Returns the starting position of the first occurrence of the pattern in the expression. Returns 0 if the pattern is not found.
SELECT PATINDEX('123%', '1234567890');
-- Result: 1
SELECT PATINDEX('%890', '1234567890');
-- Result: 8
SELECT PATINDEX('%456%', '1234567890');
-- Result: 4
Returns the starting position of the specified expression in the character string.
SELECT POSITION('456' IN '123456');
-- Result: 4
SELECT POSITION('x' IN '123456');
-- Result: 0
Returns a valid SQL Server-delimited identifier by adding the necessary delimiters to the specified Unicode string.
SELECT QUOTENAME('table_name');
-- Result: '[table_name]'
SELECT QUOTENAME('table_name', '"');
-- Result: '"table_name"'
SELECT QUOTENAME('table_name', '[');
-- Result: '[table_name]'
Replaces all occurrences of a string with another string.
SELECT REPLACE('1234567890', '456', '|');
-- Result: '123|7890'
SELECT REPLACE('123123123', '123', '.');
-- Result: '...'
SELECT REPLACE('1234567890', 'a', 'b');
-- Result: '1234567890'
Repeats the string value the specified number of times.
SELECT REPLACE('x', 5);
-- Result: 'xxxxx'
Returns the reverse order of the string expression.
SELECT REVERSE('1234567890');
-- Result: '0987654321'
Returns the right part of the string with the specified number of characters.
SELECT RIGHT('1234567890', 3);
-- Result: '890'
Returns the character expression after it removes trailing blanks.
SELECT RTRIM('trimmed ');
-- Result: 'trimmed'
Returns the four-character Soundex code, based on how the string sounds when spoken.
SELECT SOUNDEX('smith');
-- Result: 'S530'
Returns the string that consists of repeated spaces.
SELECT SPACE(5);
-- Result: ' '
Returns a section of the string between to delimiters.
SELECT SPLIT('a/b/c/d', '/', 1);
-- Result: 'a'
SELECT SPLIT('a/b/c/d', '/', -2);
-- Result: 'c'
Returns 1 if character_expression starts with character_prefix; otherwise, 0.
SELECT STARTSWITH('0123456', '012');
-- Result: 1
SELECT STARTSWITH('0123456', '456');
-- Result: 0
Returns the character data converted from the numeric data. For example, STR(123.45, 6, 1) returns 123.5.
SELECT STR('123.456');
-- Result: '123'
SELECT STR('123.456', 2);
-- Result: '**'
SELECT STR('123.456', 10, 2);
-- Result: '123.46'
Inserts a string into another string. It deletes the specified length of characters in the first string at the start position and then inserts the second string into the first string at the start position.
SELECT STUFF('1234567890', 3, 2, 'xx');
-- Result: '12xx567890'
Returns the part of the string with the specified length; starts at the specified index.
SELECT SUBSTRING('1234567890' FROM 3 FOR 2);
-- Result: '34'
SELECT SUBSTRING('1234567890' FROM 3);
-- Result: '34567890'
Converts the value of this instance to its equivalent string representation.
SELECT TOSTRING(123);
-- Result: '123'
SELECT TOSTRING(123.456);
-- Result: '123.456'
SELECT TOSTRING(null);
-- Result: ''
Returns the character expression with leading and/or trailing blanks removed.
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'
Returns the integer value defined by the Unicode standard of the first character of the input expression.
Returns the character expression with lowercase character data converted to uppercase.
SELECT UPPER('MIXED case');
-- Result: 'MIXED CASE'
Extracts an XML document using the specified XPath to flatten the XML. A comma is used to separate the outputs by default, but this can be changed by specifying the third parameter.
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'
Returns the current date value.
SELECT CURRENT_DATE();
-- Result: 2018-02-01
Returns the current time stamp of the database system as a datetime value. This value is equal to GETDATE and SYSDATETIME, and is always in the local timezone.
SELECT CURRENT_TIMESTAMP();
-- Result: 2018-02-01 03:04:05
Returns the datetime value that results from adding the specified number (a signed integer) to the specified date part of the date.
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
Returns the difference (a signed integer) of the specified time interval between the specified start date and end date.
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
Returns the datetime value for the specified year, month, and day.
SELECT DATEFROMPARTS(2018, 2, 1);
-- Result: 2018-02-01
Returns the character string that represents the specified date part of the specified date.
SELECT DATENAME('yy', '2018-02-01');
-- Result: '2018'
SELECT DATENAME('dw', '2018-02-01');
-- Result: 'Thursday'
Returns a character string that represents the specified date part of the specified date.
SELECT DATEPART('yy', '2018-02-01');
-- Result: 2018
SELECT DATEPART('dw', '2018-02-01');
-- Result: 5
Returns the datetime value for the specified date parts.
SELECT DATETIME2FROMPARTS(2018, 2, 1, 1, 2, 3, 456, 3);
-- Result: 2018-02-01 01:02:03.456
Returns the datetime value for the specified date parts.
SELECT DATETIMEFROMPARTS(2018, 2, 1, 1, 2, 3, 456);
-- Result: 2018-02-01 01:02:03.456
Truncates the date to the precision of the given date part. Modeled after the Oracle TRUNC function.
SELECT DATE_TRUNC('05-04-2005', 'YY');
-- Result: '1/1/2005'
SELECT DATE_TRUNC('05-04-2005', 'MM');
-- Result: '5/1/2005'
Truncates the date to the precision of the given date part. Modeled after the PostgreSQL date_trunc function.
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
Returns the integer that specifies the day component of the specified 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
Returns the last day of the month that contains the specified date with an optional offset.
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
Returns the time stamp associated with the Date Modified of the relevant file.
SELECT FILEMODIFIEDTIME('C:/Documents/myfile.txt');
-- Result: 6/25/2019 10:06:58 AM
Returns a date derived from the number of days after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL FROM_DAYS function.
SELECT FROM_DAYS(736000); -- Result: 2/6/2015
Returns the current time stamp of the database system as a datetime value. This value is equal to CURRENT_TIMESTAMP and SYSDATETIME, and is always in the local timezone.
SELECT GETDATE();
-- Result: 2018-02-01 03:04:05
Returns the current time stamp of the database system formatted as a UTC datetime value. This value is equal to SYSUTCDATETIME.
SELECT GETUTCDATE();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the hour component from the provided datetime.
SELECT HOUR('02-02-2020 11:30:00');
-- Result: 11
Returns 1 if the value is a valid date, time, or datetime value; otherwise, 0.
SELECT ISDATE('2018-02-01', 'yyyy-MM-dd');
-- Result: 1
SELECT ISDATE('Not a date');
-- Result: 0
Returns a time stamp equivalent to exactly one week before the current date.
SELECT LAST_WEEK(); //Assume the date is 3/17/2020 -- Result: 3/10/2020
Returns a time stamp equivalent to exactly one month before the current date.
SELECT LAST_MONTH(); //Assume the date is 3/17/2020 -- Result: 2/17/2020
Returns a time stamp equivalent to exactly one year before the current date.
SELECT LAST_YEAR(); //Assume the date is 3/17/2020 -- Result: 3/10/2019
Returns the last day of the provided week.
SELECT LDWEEK('02-02-2020');
-- Result: 2/8/2020
Returns the last day of the provided month.
SELECT LDMONTH('02-02-2020');
-- Result: 2/29/2020
Returns the last day of the provided quarter.
SELECT LDQUARTER('02-02-2020');
-- Result: 3/31/2020
Returns a date value from a year and a number of days.
SELECT MAKEDATE(2020, 1);
-- Result: 2020-01-01
Returns the minute component from the provided datetime.
SELECT MINUTE('02-02-2020 11:15:00');
-- Result: 15
Returns the month component from the provided datetime.
SELECT MONTH('02-02-2020');
-- Result: 2
Returns the quarter associated with the provided datetime.
SELECT QUARTER('02-02-2020');
-- Result: 1
Returns the second component from the provided datetime.
SELECT SECOND('02-02-2020 11:15:23');
-- Result: 23
Returns the datetime value for the specified date and time.
SELECT SMALLDATETIMEFROMPARTS(2018, 2, 1, 1, 2);
-- Result: 2018-02-01 01:02:00
Parses the provided string value and returns the corresponding datetime.
SELECT STRTODATE('03*04*2020','dd*MM*yyyy');
-- Result: 4/3/2020
Returns the current time stamp as a datetime value of the database system. It is equal to GETDATE and CURRENT_TIMESTAMP, and is always in the local timezone.
SELECT SYSDATETIME();
-- Result: 2018-02-01 03:04:05
Returns the current system date and time as a UTC datetime value. It is equal to GETUTCDATE.
SELECT SYSUTCDATETIME();
-- For example, if the local timezone is Eastern European Time (GMT+2)
-- Result: 2018-02-01 05:04:05
Returns the time value for the specified time and with the specified precision.
SELECT TIMEFROMPARTS(1, 2, 3, 456, 3);
-- Result: 01:02:03.456
Returns the number of days since 0000-00-01. This will only return a value for dates on or after 1582-10-15 (based upon the Gregorian calendar). This will be equivalent to the MYSQL TO_DAYS function.
SELECT TO_DAYS('02-06-2015');
-- Result: 736000
Returns the week (of the year) associated with the provided datetime.
SELECT WEEK('02-17-2020 11:15:23');
-- Result: 8
Returns the integer that specifies the year of the specified date.
SELECT YEAR('2018-02-01');
-- Result: 2018
Returns the absolute (positive) value of the specified numeric expression.
SELECT ABS(15);
-- Result: 15
SELECT ABS(-15);
-- Result: 15
Returns the arc cosine, the angle in radians whose cosine is the specified float expression.
SELECT ACOS(0.5);
-- Result: 1.0471975511966
Returns the arc sine, the angle in radians whose sine is the specified float expression.
SELECT ASIN(0.5);
-- Result: 0.523598775598299
Returns the arc tangent, the angle in radians whose tangent is the specified float expression.
SELECT ATAN(10);
-- Result: 1.47112767430373
Returns the angle in radians between the positive x-axis and the ray from the origin to the point (y, x) where x and y are the values of the two specified float expressions.
SELECT ATN2(1, 1);
-- Result: 0.785398163397448
Returns the smallest integer greater than or equal to the specified numeric expression.
SELECT CEILING(1.3);
-- Result: 2
SELECT CEILING(1.5);
-- Result: 2
SELECT CEILING(1.7);
-- Result: 2
Returns the trigonometric cosine of the specified angle in radians in the specified expression.
SELECT COS(1);
-- Result: 0.54030230586814
Returns the trigonometric cotangent of the angle in radians specified by float_expression.
SELECT COT(1);
-- Result: 0.642092615934331
Returns the angle in degrees for the angle specified in radians.
SELECT DEGREES(3.1415926);
-- Result: 179.999996929531
Returns the exponential value of the specified float expression. For example, EXP(LOG(20)) is 20.
SELECT EXP(2);
-- Result: 7.38905609893065
Evaluates the expression.
SELECT EXPR('1 + 2 * 3');
-- Result: 7
SELECT EXPR('1 + 2 * 3 == 7');
-- Result: true
Returns the largest integer less than or equal to the numeric expression.
SELECT FLOOR(1.3);
-- Result: 1
SELECT FLOOR(1.5);
-- Result: 1
SELECT FLOOR(1.7);
-- Result: 1
Returns the greatest of the supplied integers.
SELECT GREATEST(3,5,8,10,1) -- Result: 10
Returns a the equivalent hex for the input value.
SELECT HEX(866849198);
-- Result: 33AB11AE
SELECT HEX('Sample Text');
-- Result: 53616D706C652054657874
Returns the least of the supplied integers.
SELECT LEAST(3,5,8,10,1) -- Result: 1
Returns the natural logarithm of the specified float expression.
SELECT LOG(7.3890560);
-- Result: 1.99999998661119
Returns the base-10 logarithm of the specified float expression.
SELECT LOG10(10000);
-- Result: 4
Returns the integer value associated with the remainder when dividing the dividend by the divisor.
SELECT MOD(10,3); -- Result: 1
Returns the opposite to the real number input.
SELECT NEGATE(10); -- Result: -10 SELECT NEGATE(-12.4) --Result: 12.4
Returns the constant value of pi.
SELECT PI()
-- Result: 3.14159265358979
Returns the value of the specified expression raised to the specified power.
SELECT POWER(2, 10);
-- Result: 1024
SELECT POWER(2, -2);
-- Result: 0.25
Returns the angle in radians of the angle in degrees.
SELECT RADIANS(180);
-- Result: 3.14159265358979
Returns a pseudorandom float value from 0 through 1, exclusive.
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
Returns the numeric value rounded to the specified length or precision.
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
Returns the positive sign (1), 0, or negative sign (-1) of the specified expression.
SELECT SIGN(0);
-- Result: 0
SELECT SIGN(10);
-- Result: 1
SELECT SIGN(-10);
-- Result: -1
Returns the trigonometric sine of the angle in radians.
SELECT SIN(1);
-- Result: 0.841470984807897
Returns the square root of the specified float value.
SELECT SQRT(100);
-- Result: 10
Returns the square of the specified float value.
SELECT SQUARE(10);
-- Result: 100
SELECT SQUARE(-10);
-- Result: 100
Returns the tangent of the input expression.
SELECT TAN(1);
-- Result: 1.5574077246549
Returns the supplied decimal number truncated to have the supplied decimal precision.
SELECT TRUNC(10.3423,2); -- Result: 10.34
To create new records, use INSERT statements.
The INSERT statement specifies the columns to be inserted and the new column values. You can specify the column values in a comma-separated list in the VALUES clause, as shown in the following example:
INSERT INTO <table_name>
( <column_reference> [ , ... ] )
VALUES
( { <expression> | NULL } [ , ... ] )
<expression> ::=
| @ <parameter>
| ?
| <literal>
The following is an example query:
INSERT INTO Customers (Name) VALUES ('Hook, Captain')
To modify existing records, use UPDATE statements.
The UPDATE statement takes as input a comma-separated list of columns and new column values as name-value pairs in the SET clause, as shown in the following example:
UPDATE <table_name> SET { <column_reference> = <expression> } [ , ... ] WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
The following is an example query:
UPDATE Customers SET Name='Hook, Captain' WHERE Id = @myId
To delete information from a table, use DELETE statements.
The DELETE statement requires the table name in the FROM clause and the row's primary key in the WHERE clause, as shown in the following example:
<delete_statement> ::= DELETE FROM <table_name> WHERE { Id = <expression> } [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
The following is an example query:
DELETE FROM Customers WHERE Id = @myId
You can issue the GETDELETED query to retrieve all records deleted from the live data for the time range specified. This query accepts a datetime value as a filter, as shown in the following example:
GETDELETED FROM <table_name> WHERE <search_condition>
<search_condition> ::=
{
<expression> { = | < | <= | > | >= } [ <expression> ]
} [ { AND | OR } ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
The following is an example query:
GETDELETED FROM Customers WHERE TimeModified >='2013-01-01' AND TimeModified <='2013-02-01'
To execute stored procedures, you can use EXECUTE or EXEC statements.
EXEC and EXECUTE assign stored procedure inputs, referenced by name, to values or parameter names.
To execute a stored procedure as an SQL statement, use the following syntax:
{ EXECUTE | EXEC } <stored_proc_name>
{
[ @ ] <input_name> = <expression>
} [ , ... ]
<expression> ::=
| @ <parameter>
| ?
| <literal>
Reference stored procedure inputs by name:
EXECUTE my_proc @second = 2, @first = 1, @third = 3;
Execute a parameterized stored procedure statement:
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)
To perform multiple inserts in a single request to Reckon, use the INSERT INTO SELECT syntax to insert a temporary table of data into Reckon. This works by first populating a temporary table with the data you are going to submit to Reckon. Once you have all of the data you want to insert, the temporary table is then passed into the table in Reckon.
The temporary table you are populating is dynamic and is created at run time the first time you insert to it. Temporary tables are denoted by a # appearing in their name. When using a temporary table to insert, the temporary table must be named in the format [TableName]#TEMP, where TableName is the
name of the table you will be inserting to. For example:
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');
This creates a temporary table called Customers#TEMP with two columns and three rows of data. Since type cannot be determined on the temporary table itself, all values are stored in memory as strings. They are later converted to the proper type when they are submitted to the Customers table.
Once your temporary table is populated, it is now time to insert to the actual table in Reckon. You can do this by performing an INSERT to the actual table and selecting the input data from the temporary table. For example:
INSERT INTO Customers (Name, MyCustomField__c) SELECT Name, MyCustomField__c FROM Customers#TEMPIn this example, the full contents of the Customers#TEMP table are passed into the Customers table. This results in fewer requests being submitted to Reckon since multiple inserts may be submitted with each request, which is much better for performance if you have many records to insert.
The results of the query are stored in the LastResultInfo#TEMP temporary table. This table is cleared and repopulated the next time data is modified by passing in a temporary table. Please be aware that the LastResultInfo#TEMP table has no predefined schema. You need to check its metadata at run time before reading data.
Temporary tables only last as long as the connection remains open. When the connection to Reckon is closed, all temporary tables are cleared, including the LastResultInfo#TEMP table.
The CData Cloud models entities in the Reckon API as tables, views, and stored procedures. There are three parts to the Data Model: Tables, Views, and Stored Procedures. These are defined in schema files, which are simple, text-based configuration files.
API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.
The CData Cloud models the data in Tables so that it can be easily queried and updated.
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.
Views are tables that cannot be modified. Typically, read-only data are shown as views.
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
The Cloud models the data in Reckon into a list of tables that can be queried using standard SQL statements.
Generally, querying Reckon tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.
| 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.
Reckon 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. The allowed values are 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. The allowed values are 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is ALL. |
| NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on name. The allowed values are EXACT, STARTSWITH, ENDSWITH, CONTAINS. The default value is 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.
Reckon 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. The allowed values are 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. The allowed values are ALL, PAID, UNPAID, NA. The default value is 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.
Reckon 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. The allowed values are 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. The allowed values are ALL, PAID, UNPAID, NA. The default value is 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.
Reckon 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. The default value is 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.
Reckon 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. The default value is 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.
Reckon 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. The default value is 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.
Reckon 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. The default value is 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.
Reckon 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. The allowed values are ALL, PAID, UNPAID, NA. The default value is 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.
Reckon 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. The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED. The default value is 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. The default value is 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.
Reckon 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. The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED. The default value is 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. The default value is 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.
Reckon 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. The default value is 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.
Reckon 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. The allowed values are 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. The allowed values are ACTIVE, INACTIVE, ALL, NA. The default value is 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.
Reckon 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. The allowed values are 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.
Reckon 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. The allowed values are 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.
Reckon 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.
Reckon 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. The allowed values are 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.
Reckon 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. The allowed values are 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.
Reckon 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.
Reckon 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.
Reckon 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. The allowed values are 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. The allowed values are ACTIVE, INACTIVE, ALL, NA. The default value is 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.
Reckon 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. The allowed values are 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. The allowed values are CONTAINS, EXACT, STARTSWITH, ENDSWITH. The default value is CONTAINS. |
| IncludeJobs | Boolean |
Whether or not to include job information in the results. The default value is 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. The allowed values are ACTIVE, INACTIVE, ALL, NA. The default value is 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.
Reckon 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. The allowed values are EXACT, STARTSWITH, CONTAINS, ENDSWITH. The default value is 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.
Reckon 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.
Reckon 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, Reckon 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 Reckon. 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 Reckon 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.
Reckon 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 The allowed values are 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. The allowed values are ACTIVE, INACTIVE, ALL, NA. The default value is 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.
Reckon 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. The allowed values are Regular, Unspecified, Officer, Statutory, Owner. | |
| Gender | String | False |
The gender of the employee. The allowed values are 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. The allowed values are 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. The allowed values are NotSet, UseTimeData, DoNotUseTimeData. | |
| SickTimeAccrualPeriod | String | False |
Sick-time hours accrual period. The allowed values are 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. The allowed values are 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is ALL. |
| NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on name. The allowed values are EXACT, STARTSWITH, ENDSWITH, CONTAINS. The default value is 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.
Reckon 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.
Reckon 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.
Reckon 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.
Reckon 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.
Reckon 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. The allowed values are NotSet, IsFinanceCharge, NotFinanceCharge. The default value is 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.
Reckon 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. The allowed values are NotSet, IsFinanceCharge, NotFinanceCharge. The default value is 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. The allowed values are ALL, PAID, UNPAID, NA. The default value is 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.
Reckon 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. The default value is 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is 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.
Reckon 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. The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED. The default value is 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.
Reckon 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. The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED. The default value is 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.
Reckon 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.
Reckon 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. The allowed values are Unknown, Service, Inventory, NonInventory, Payment, Discount, SalesTax, SubTotal, OtherCharge, InventoryAssembly, Group, SalesTaxGroup, FixedAsset. The default value is 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. The allowed values are 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. The allowed values are 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is 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.
Reckon 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.
Reckon 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. The allowed values are 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. The allowed values are 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. The allowed values are ACTIVE, INACTIVE, ALL, NA. The default value is 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. The allowed values are 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. The allowed values are 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. The allowed values are 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. The allowed values are EXACT, STARTSWITH, ENDSWITH, CONTAINS. The default value is 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. The allowed values are 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. The allowed values are EXACT, STARTSWITH, ENDSWITH, CONTAINS. The default value is 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.
Reckon 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.
Reckon 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.
Reckon 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 Reckon 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. The allowed values are ExistingTransactions, FutureTransactions, Custom. The default value is 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.
Reckon 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 Reckon 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. The allowed values are ExistingTransactions, FutureTransactions, Custom. The default value is 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.
Reckon 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.
Reckon 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.
Reckon 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.
Reckon 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.
Reckon 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/2011' AND TimeModified < '2/1/2011' AND Initial LIKE '%12345%'
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The Id of the sales rep. | |
| Initial | String | False |
The initials of the sales rep. These must be unique for each record. | |
| IsActive | Boolean | False |
Boolean indicating if the sales rep is active. | |
| SalesRepEntityRef_FullName | String | False |
Refers to the sales rep's full name on the employee, vendor, or other-name list. You may specify either SalesRepEntityRef_FullName or SalesRepEntityRef_ListId on insert/update statements, but not both. | |
| SalesRepEntityRef_ListId | String | False |
Refers to the sales rep's Id on the employee, vendor, or other-name list. You may specify either SalesRepEntityRef_FullNamee or SalesRepEntityRef_ListId on insert/update statements, but not both. | |
| EditSequence | String | True |
A string indicating the revision of the sales rep. | |
| TimeCreated | Datetime | True |
The time the sales rep was created. | |
| TimeModified | Datetime | True |
The time the sales rep 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 |
| 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is ALL. |
| 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). |
| MaxResults | String |
Maximum number of results to return. |
Create, update, delete, and query Reckon Sales Tax Codes.
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The unique identifier. | |
| Name | String | False |
The name of the sales tax code. | |
| Description | String | False |
The description of the sales tax code. | |
| IsActive | Boolean | False |
Whether or not the other name is active. | |
| IsTaxable | Boolean | False |
Whether or not the other name is taxable. | |
| ItemPurchaseTaxRef_FullName | String | False |
Refers to the purchase tax item. Only available in international versions of Reckon. | |
| ItemPurchaseTaxRef_ListId | String | False |
Refers to the purchase tax item. Only available in international versions of Reckon. | |
| ItemSalesTaxRef_FullName | String | False |
SalesTaxItems.Name |
Refers to the sales tax item. Only available in international versions of Reckon. |
| ItemSalesTaxRef_ListId | String | False |
Refers to the sales tax item. Only available in international versions of Reckon. | |
| TimeCreated | Datetime | True |
The datetime the sales tax code was made. | |
| TimeModified | Datetime | True |
The last datetime the sales tax code was modified. | |
| EditSequence | String | True |
An identifier used for versioning for this copy of the object. |
Create, update, delete, and query Reckon Sales Tax Items.
| 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. | |
| ItemDesc | String | False |
A description for the sales tax item. | |
| TaxRate | Double | False |
The tax rate. If a nonzero TaxRate is specified, then TaxVendorRef is required. | |
| TaxVendorRef_FullName | String | False |
Vendors.Name |
Refers to the tax agency to whom collected taxes are owed. This will be a vendor on the vendor list. |
| TaxVendorRef_ListID | String | False |
Vendors.ID |
Refers to the tax agency to whom collected taxes are owed. This will be a vendor on the vendor list. |
| 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 tax item was last modified. | |
| TimeCreated | Datetime | True |
When the sales tax item was created. |
Create, update, delete, and query Reckon Shipping Methods.
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.
Reckon 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 ShippingMethods are Id, TimeModified, 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 ShippingMethods WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Name LIKE '%12345%'
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The unique identifier of the shipping method. | |
| Name | String | False |
The name of the shipping method. | |
| IsActive | Boolean | False |
Boolean determining if the shipping method is active. | |
| EditSequence | String | True |
A string indicating the revision of the shipping method. | |
| TimeCreated | Datetime | True |
The time the shipping method was created. | |
| TimeModified | Datetime | True |
The last time the shipping 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 |
| 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is ALL. |
| 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. The allowed values are CONTAINS, EXACT, STARTSWITH, ENDSWITH. |
Create, update, delete, and query Reckon Standard 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.
Reckon 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 StandardTerms records are Id, TimeModified, 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 StandardTerms WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Name LIKE '%12345%'
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The Id of the standard term. | |
| Name | String | False |
The name of the standard term. | |
| IsActive | Boolean | False |
Boolean indicating if the standard term is active. | |
| StdDueDays | Integer | False |
The number of days until payment is due. | |
| StdDiscountDays | Integer | False |
If payment is received within StdDiscountDays number of the days, then DiscountPct will apply to the payment. | |
| DiscountPct | Double | False |
If payment is received within StdDiscountDays number of days, 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 standard term. | |
| TimeCreated | Datetime | True |
The time the standard term was created. | |
| TimeModified | Datetime | True |
The time the standard term 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 |
| 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is ALL. |
| 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). |
| MaxResults | String |
Maximum number of results to return. |
| NameMatch | String |
This pseudo column is deprecated and should no longer be used. The type of match to use when searching with the Name. The allowed values are EXACT, STARTSWITH, CONTAINS, ENDSWITH. The default value is EXACT. |
Create, update, delete, and query Reckon Statement Charges.
To add a StatementCharge, specify the CustomerName or CustomerId and the ItemName or ItemId.
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.
Reckon 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 StatementCharges are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, IsPaid, 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 StatementCharges WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
| 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. | |
| ReferenceNumber | String | False |
Transaction reference number. | |
| CustomerName | String | False |
Customers.FullName |
Customer name this transaction is recorded under. Either CustomerName or CustomerId must have a value when inserting. |
| CustomerId | String | False |
Customers.ID |
Customer Id this transaction is recorded under. Either CustomerName or CustomerId must have a value when inserting. |
| Date | Date | False |
Transaction date. | |
| ItemName | String | False |
Items.FullName |
A reference to the item for the transaction. |
| ItemId | String | False |
Items.ID |
A reference to the item for the transaction. |
| Quantity | Double | False |
Quantity in stock for this inventory item. | |
| Rate | Double | False |
The unit rate charged for this item. | |
| Amount | Double | False |
Amount of the transaction. | |
| Balance | Double | True |
The balance remaining on the transaction. | |
| Description | String | False |
A textual description of the StatementCharge. | |
| 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. |
| 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. |
| BilledDate | Date | False |
Date when the customer was billed. | |
| DueDate | Date | False |
Date when the payment is due. | |
| IsPaid | Boolean | True |
Indicates whether this statement charge has been paid. | |
| 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 statement charge was last modified. | |
| TimeCreated | Datetime | True |
When the statement charge was created. |
Create, update, delete, and query Reckon Time Tracking events.
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.
Reckon 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 TimeTracking entries are Id, TimeModified, Date, EmployeeName, and EmployeeId. 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 TimeTracking WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To insert a TimeTracking entry, specify the Employee and Duration columns.
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
An Id is an alphanumerical identifier assigned by the server whenever an object is added to Reckon. It is guaranteed to be unique across all objects of the same type. | |
| BillableStatus | String | False |
The billing status of this line item. If the billing status is empty (that is, if no billing status appears in Reckon), then no BillableStatus value will be returned. The allowed values are Empty, Billable, NotBillable, HasBeenBilled. | |
| Date | Date | False |
The date of the transaction. The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format. This is required to have a value when inserting. | |
| CustomerName | String | False |
Customers.FullName |
The Customer property indicates the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerID is empty and BillableStatus is not NotBillable. |
| CustomerId | String | False |
Customers.ID |
The Customer property indicates the customer who has purchased goods or services from the company. This is required to have a value when inserting if CustomerName is empty and BillableStatus is not NotBillable. |
| Duration | String | False |
The duration of time being tracked. 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'. | |
| EmployeeName | String | False |
Employees.Name |
A reference to the employee or subcontractor whose time is being tracked. The person is typically an employee but may be a vendor or defined in an other-name record as well. This is required to have a value when inserting if EmployeeId is empty. |
| EmployeeId | String | False |
Employees.ID |
A reference to the employee or subcontractor whose time is being tracked. The person is typically an employee but may be a vendor or defined in an other-name record as well. This is required to have a value when inserting if EmployeeName is empty. |
| Notes | String | False |
Notes about 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. |
| PayrollWageItemName | String | False |
PayrollWageItems.Name |
A payment scheme, such as Regular Pay, Overtime Pay, etc. This property may only be specified if (1) the employee specified refers to an employee, and not a vendor or subcontractor, and (2) the 'Use time data to create paychecks' option is selected for this employee (from within the Reckon UI.) |
| PayrollWageItemId | String | False |
A payment scheme, such as Regular Pay, Overtime Pay, etc. This property may only be specified if (1) the employee specified refers to an employee, and not a vendor or subcontractor, and (2) the 'Use time data to create paychecks' option is selected for this employee from within the Reckon UI. | |
| ServiceItemName | String | False |
Items.Name |
The type of work being performed. If a Customer is not specified, ServiceItem is not needed. If BillableStatus is set to Billable, then both ServiceItem and Customer are required. This is required to have a value when inserting if ServiceItemID is empty. |
| ServiceItemId | String | False |
Items.ID |
The type of work being performed. If a Customer is not specified, ServiceItem is not needed. If BillableStatus is set to Billable, then both ServiceItem and Customer are required. This is required to have a value when inserting if ServiceItemName is empty. |
| 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 time-tracking event was last modified. | |
| TimeCreated | Datetime | True |
When the time-tracking event 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 To Do entries.
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The unique identifier of the vendor type. | |
| Notes | String | False |
Notes on this to do entry. | |
| IsActive | Boolean | False |
Boolean determining if the vendor type is active. | |
| IsDone | Boolean | False |
Whether or not this to do entry is complete. | |
| ReminderDate | Datetime | False |
Reminder date for this to do entry. | |
| EditSequence | String | True |
A string indicating the revision of the payment method. | |
| TimeCreated | Datetime | True |
The time the vendor type was created. | |
| TimeModified | Datetime | True |
The last time the vendor type was modified. |
Create, update, delete, and query Reckon Vehicle Mileage 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.
Reckon 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 the VehicleMileage table are Id, Name, 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 VehicleMileage WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Name LIKE '%12345%'
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The Id of the vehicle mileage. | |
| VehicleRef_FullName | String | False |
The vehicle for use in vehicle mileage transactions. Each vehicle name must be unique. | |
| VehicleRef_ListID | String | False |
The reference Id for the vehicle mileage transaction. | |
| CustomerRef_FullName | String | False |
Customers.FullName |
The full name of a referenced customer in Reckon. You may specify only CustomerRef_FullName or CustomerRef_ListId on insert/update statements and not both. |
| CustomerRef_ListID | String | False |
Customers.ID |
The Id of the referenced customer in Reckon. You may specify only CustomerRef_FullName or CustomerRef_ListId on insert/update statements and not both. |
| ItemRef_FullName | String | False |
Items.FullName |
A reference to the full name of an item in Reckon. You may specify only ItemRef_FullName or ItemRef_ListId on insert/update statements and not both. |
| ItemRef_ListID | String | False |
Items.ID |
A reference to the Id of an item in Reckon. You may specify only ItemRef_FullName or ItemRef_ListId on insert/update statements and not both. |
| ClassRef_FullName | String | False |
Class.FullName |
A reference to the full name of a class in Reckon. You may specify only ClassRef_FullName or ClassRef_ListId on insert/update statements and not both. |
| ClassRef_ListID | String | False |
Class.ID |
A reference to the Id of a class in Reckon. You may specify only ClassRef_FullName or ClassRef_ListId on insert/update statements and not both. |
| TripStartDate | String | False |
Date the trip began. If left blank on an insert, the current date at the time of the transaction will be used. | |
| TripEndDate | String | False |
The date the trip ended. If left blank on an insert, the current date at the time of the transaction will be used. | |
| OdometerStart | Integer | False |
Odometer reading at the start of the trip. If TotalMiles is specified, you cannot specify OdometerStart and OdometerEnd. | |
| OdometerEnd | Integer | False |
Odometer reading at the end of the trip. If TotalMiles is specified, you cannot specify OdometerStart and OdometerEnd. | |
| TotalMiles | Double | False |
Total trip miles. If TotalMiles is specified, you cannot specify OdometerStart and OdometerEnd. | |
| Notes | String | False |
Additional information. | |
| BillableStatus | String | False |
The billig status of the vehicle mileage. The allowed values are Billable, NotBillable, HasBeenBilled. | |
| StandardMileageRate | Double | False |
The mileage rate currently allowed by the tax authority for vehicle expenses. | |
| StandardMileageTotalAmount | Double | False |
Amount calculated by multiplying the total trip miles in the current vehicle mileage transaction by the standard mileage rate currently in use. | |
| BillableRate | Double | False |
In a billable vehicle mileage transaction, refers to the rate being used to charge mileage to a customer. The rate is specified in the service item or the other charge item that is referenced in the ItemRef columns. | |
| BillableAmount | Double | False |
In a billable vehicle mileage transaction, this refers to the total charge that Reckon calculates by by multiplying the trip total mileage by the rate specified in the item referenced by the ItemRef columns. | |
| EditSequence | String | True |
A string indicating the revision of the vehicle mileage transaction. | |
| TimeCreated | Datetime | True |
When the vehicle mileage was last modified. | |
| TimeModified | Datetime | True |
When the vehicle mileage 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 (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). |
| StartTxnDate | String |
This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format) |
| EndTxnDate | String |
This pseudo column is deprecated and should no longer be used. Latest transaction date to search for (in yyyy-MM-dd, MM-dd-yy, MM-dd-yyyy, MM/dd/yy, or MM/dd/yyyy format). |
| MaxResults | String |
Maximum number of results to return. |
Create, update, delete, and query Reckon Vendor Credit Expense Line Items.
VendorCredits may be inserted, updated, or queried via the VendorCredits, VendorCreditExpenseItems, or VendorCreditLineItems tables. VendorCredits may be deleted by using the VendorCredits 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.
Reckon 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 the VendorCredits table are Id, Date, TimeModified, VendorName, VendorId, AccountsPayableId, and AccountsPayableName. 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 VendorCreditExpenseItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a VendorCredit, specify the Vendor 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 VendorCredit transaction. For example, the following will insert a new VendorCredit with two Expense Line Items:
INSERT INTO VendorCreditExpenseItems#TEMP (VendorName, ExpenseAccount, ExpenseAmount) VALUES ('A Cheung Limited', 'Utilities:Telephone', 52.25)
INSERT INTO VendorCreditExpenseItems#TEMP (VendorName, ExpenseAccount, ExpenseAmount) VALUES ('A Cheung Limited', 'Professional Fees:Accounting', 235.87)
INSERT INTO VendorCreditExpenseItems (VendorName, ExpenseAccount, ExpenseAmount) SELECT VendorName, ExpenseAccount, ExpenseAmount FROM VendorCreditExpenseItems#TEMP
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The unique identifier in the format VendorCreditId|ExpenseLineId. | |
| VendorCreditId | String | False |
The Id of the VendorCredit transaction. | |
| VendorName | String | False |
Vendors.Name |
Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| VendorId | String | False |
Vendors.ID |
Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| 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. | |
| ReferenceNumber | String | False |
Reference number for the transaction. | |
| AccountsPayable | String | False |
Accounts.FullName |
Reference to the accounts-payable account. |
| AccountsPayableId | String | False |
Accounts.ID |
Reference to the accounts-payable account. |
| Amount | Double | True |
Amount of the transaction. | |
| Memo | String | False |
Memo for the transaction. | |
| 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. 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. The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED. The default value is 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 (taxable or non-taxable). |
| ExpenseTaxCodeId | String | False |
Sales tax information for this item (taxable or non-taxable). | |
| ExpenseMemo | String | False |
A memo for this expense line. | |
| TimeModified | Datetime | True |
When the inventory assembly was last modified. | |
| TimeCreated | Datetime | True |
When the inventory assembly 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. The allowed values are ALL, PAID, UNPAID, NA. The default value is ALL. |
Create, update, delete, and query Reckon Vendor Credit Line Items.
VendorCredits may be inserted, updated, or queried via the VendorCredits, VendorCreditExpenseItems, or VendorCreditLineItems tables. VendorCredits may be deleted by using the VendorCredits 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.
Reckon 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 the VendorCredits table are Id, Date, TimeModified, VendorName, VendorId, AccountsPayableId, and AccountsPayableName. 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 VenderCreditLineItems WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a VendorCredit, specify a Vendor and at least one Expense or Line Item. All Line Item columns can be used for inserting multiple Line Items for a new VendorCredit transaction. For example, the following will insert a new VendorCredit with two Line Items:
INSERT INTO VendorCreditLineItems#TEMP (VendorName, ItemName, ItemQuantity) VALUES ('A Cheung Limited', 'Repairs', 1)
INSERT INTO VendorCreditLineItems#TEMP (VendorName, ItemName, ItemQuantity) VALUES ('A Cheung Limited', 'Removal', 2)
INSERT INTO VendorCreditLineItems (VendorName, ItemName, ItemQuantity) SELECT VendorName, ItemName, ItemQuantity FROM VendorCreditLineItems#TEMP
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The unique identifier in the format VendorCreditId|ItemLineId. | |
| VendorCreditId | String | False |
The Id of the VendorCredit transaction. | |
| VendorName | String | False |
Vendors.Name |
Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| VendorId | String | False |
Vendors.ID |
Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| 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. | |
| ReferenceNumber | String | False |
Reference number for the transaction. | |
| AccountsPayable | String | False |
Accounts.Name |
Reference to the accounts-payable account. |
| AccountsPayableId | String | False |
Accounts.ID |
Reference to the accounts-payable account. |
| Amount | Double | True |
Amount of the transaction. | |
| Memo | String | False |
Memo for the transaction. | |
| ItemLineId | String | True |
The line item identifier. | |
| ItemAmount | Double | False |
The total amount of this vendor credit line item. This should be a positive number. | |
| ItemClass | String | False |
Class.FullName |
Specifies the class of the vendor credit line item. |
| ItemClassId | String | False |
Class.ID |
Specifies the class of the vendor credit line 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). | |
| 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 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. | |
| ItemBillableStatus | String | False |
Billing status of the item. The allowed values are EMPTY, BILLABLE, NOTBILLABLE, HASBEENBILLED. The default value is 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. |
| 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 vendor credit was last modified. | |
| TimeCreated | Datetime | True |
When the vendor 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. |
| PaidStatus | String |
The paid status of the vendor credit. The allowed values are ALL, PAID, UNPAID, NA. The default value is ALL. |
Create, update, delete, and query Reckon Vendor Credits.
VendorCredits may be inserted, updated, or queried via the VendorCredits, VendorCreditExpenseItems, or VendorCreditLineItems tables. VendorCredits may be deleted by using the VendorCredits 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.
Reckon 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 VendorCredits are Id, Date, TimeModified, VendorName, VendorId, AccountsPayableId, and AccountsPayableName. 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 VendorCredits WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'
To add a VendorCredit, specify a Vendor 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 VendorCreditLineItems and VendorCreditExpenseItems tables and it starts with Item and Expense. For example, the following will insert a new VendorCredit with two Line Items:
INSERT INTO VendorCredits (VendorName, ItemAggregate)
VALUES ('A Cheung Limited',
'<VendorCreditLineItems>
<Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row>
<Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row>
</VendorCreditLineItems>')
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 refId of the record. | |
| VendorName | String | False |
Vendors.Name |
Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| VendorId | String | False |
Vendors.ID |
Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| 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. | |
| ReferenceNumber | String | False |
Reference number for the transaction. | |
| AccountsPayable | String | False |
Accounts.FullName |
Reference to the accounts-payable account. |
| AccountsPayableId | String | False |
Accounts.ID |
Reference to the accounts-payable account. |
| Amount | Double | True |
Amount of the transaction. | |
| Memo | String | False |
Memo 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 vendor credit and its line item data. | |
| ExpenseItemCount | Integer | True |
The count of expense line items. | |
| ExpenseItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a VendorCredit 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 vendor credit was last modified. | |
| TimeCreated | Datetime | True |
When the vendor 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. |
| PaidStatus | String |
The paid status of the vendor credit. The allowed values are ALL, PAID, UNPAID, NA. The default value is ALL. |
Create, update, delete, and query Reckon Vendors.
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.
Reckon 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 the Vendors table are Id, TimeModified, Balance, and Name. 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 Vendors WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Name LIKE '%12345%'
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The unique identifier of the Vendor. | |
| Name | String | False |
The vendor's name. This is required to have a value when inserting. | |
| Salutation | String | False |
A salutation, such as Mr., Mrs., etc. | |
| FirstName | String | False |
A first name. | |
| MiddleInitial | String | False |
The middle initial. | |
| LastName | String | False |
A last name. | |
| Company | String | False |
The vendor's company name. | |
| Contact | String | False |
The contact's name. | |
| AccountNumber | String | False |
The account number for this vendor. | |
| Type | String | False |
The type of vendor, predefined in Reckon. | |
| TypeId | String | False |
The type of vendor, predefined in Reckon. | |
| CreditLimit | Double | False |
The credit limit for this vendor. | |
| TaxIdentity | String | False |
String that identifies the vendor to the IRS. | |
| AlternateContact | String | False |
The alternate contact's name. | |
| Phone | String | False |
The vendor's telephone number. | |
| Fax | String | False |
The vendor's fax number. | |
| AlternatePhone | String | False |
The vendor's alternate telephone number. | |
| String | False |
The vendor's email address. | ||
| Notes | String | False |
Notes on this vendor. | |
| 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 vendor. | |
| State | String | False |
State name for the address of the vendor. | |
| PostalCode | String | False |
Postal code for the address of the vendor. | |
| Country | String | False |
Country for the address of the vendor. | |
| Note | String | False |
Note for the address of the vendor. | |
| Balance | Double | True |
Open balance for this vendor. | |
| Terms | String | False |
A reference to terms of payment for this vendor. 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 vendor. | |
| EligibleFor1099 | Boolean | False |
Whether this vendor is eligible for 1099. | |
| NameOnCheck | String | False |
The name to be printed on checks. | |
| IsActive | Boolean | False |
Whether or not the vendor is active. | |
| 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 vendor was last modified. | |
| TimeCreated | Datetime | True |
When the vendor was created. | |
| PrefillAccountId1 | String | False |
Id of an Account Prefill defined for this vendor. | |
| PrefillAccountName1 | String | False |
Name of an Account Prefill defined for this vendor. | |
| PrefillAccountId2 | String | False |
Id of an Account Prefill defined for this vendor. | |
| PrefillAccountName2 | String | False |
Name of an Account Prefill defined for this vendor. | |
| PrefillAccountId3 | String | False |
Id of an Account Prefill defined for this vendor. | |
| PrefillAccountName3 | String | False |
Name of an Account Prefill defined for this vendor. |
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. |
| 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. The allowed values are ALL, ACTIVE, INACTIVE, NA. The default value is ALL. |
| NameMatchType | String |
This pseudo column is deprecated and should no longer be used. Type of match to perform on name. The allowed values are EXACT, STARTSWITH, ENDSWITH, CONTAINS. The default value is CONTAINS. |
| MaxBalance | String |
The maximum balance amount to return results for. Cannot be specified is MinBalance is specified. |
| MinBalance | String |
The minimum balance amount to return results for. Cannot be specified if MaxBalance is specified. |
Create, update, delete, and query Reckon Vendor Types.
| Name | Type | ReadOnly | References | Description |
| ID [KEY] | String | True |
The unique identifier of the vendor type. | |
| Name | String | False |
The name of the vendor type. | |
| FullName | String | False |
The name of the vendor type. | |
| IsActive | Boolean | False |
Boolean determining if the vendor type is active. | |
| ParentRef_FullName | String | False |
VendorTypes.FullName |
Full name of the parent for the vendor type. You may specify only ParentRef_FullName or ParentRef_ListId on INSERT/UPDATE statements and not both. |
| ParentRef_ListId | String | False |
VendorTypes.ID |
Id for the parent of the vendor type. You may specify only ParentRef_FullName or ParentRef_ListId on INSERT/UPDATE statements and not both. |
| Sublevel | Integer | True |
How many parents the vendor type has. | |
| EditSequence | String | True |
A string indicating the revision of the payment method. | |
| TimeCreated | Datetime | True |
The time the vendor type was created. | |
| TimeModified | Datetime | True |
The last time the vendor type was modified. |
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.
Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.
| Name | Description |
| BillLinkedTransactions | Query Reckon Bill Linked Transactions. |
| CompanyInfo | Query the company information from Reckon. |
| CreditMemoLinkedTransactions | Query Reckon Credit Memo Linked Transactions. |
| CustomColumns | Query Reckon Custom Columns. |
| DeletedEntities | Query deleted Entities. |
| DeletedTransactions | Query deleted Transactions. |
| EstimateLinkedTransactions | Query Reckon Estimate Linked transactions. |
| Host | Query the Reckon host process. The Host represents information about the Reckon process currently being executed. |
| InvoiceLinkedTransactions | Query Reckon Invoice Linked Transactions. |
| ItemReceiptLinkedTransactions | Query Reckon Item Receipt Linked Transactions. |
| Preferences | Query information about many of the preferences the Reckon user has set in the company file. |
| PurchaseOrderLinkedTransactions | Query Reckon Purchase Order Linked Transactions. |
| SalesOrderLinkedTransactions | Query Reckon Sales Order Linked Transactions. |
| StatementChargeLinkedTransactions | Query Reckon Statement Charge Linked Transactions. |
| Templates | Query Reckon templates. |
| Transactions | Query Reckon transactions. You may search the Transactions using a number of values including Type, Entity, Account, ReferenceNumber, Item, Class, Date, and TimeModified. |
| VendorCreditLinkedTransactions | Query Reckon Vendor Credit Linked Transactions. |
Query Reckon Bill Linked Transactions.
Linked transactions are transactions that have been associated with the Bill specified by the BillId column.
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.
Reckon 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%'
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format BillId|ItemLineId. | |
| BillId | String |
Bills.ID | The item identifier. |
| TransactionId | String | The Id of the linked transaction. | |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the bill and the linked transaction. | |
| TimeModified | Datetime | When the bill was last modified. | |
| TimeCreated | Datetime | 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.
The allowed values are ALL, PAID, UNPAID, NA. The default value is ALL. |
Query the company information from Reckon.
| Name | Type | References | Description |
| ID [KEY] | String | The employer identification number of the company. | |
| Name | String | The company name. | |
| Type | String | The type of company. | |
| Address | String | Full address returned by Reckon. | |
| Line1 | String | First line of the address. | |
| Line2 | String | Second line of the address. | |
| Line3 | String | Third line of the address. | |
| Line4 | String | Fourth line of the address. | |
| Line5 | String | Fifth line of the address. | |
| City | String | City name for the address of the company. | |
| State | String | State name for the address of the company. | |
| PostalCode | String | Postal code for the address of the company. | |
| Country | String | Country for the address of the company. | |
| Note | String | Note for the address of the company. | |
| String | Company email address. | ||
| Phone | String | Company phone number. | |
| Fax | String | Company fax number. | |
| SSN | String | The SSN of the company. | |
| Taxform | String | The tax form used by the company. | |
| Website | String | Company website URL. | |
| FirstMonthFiscal | String | The first month in the fiscal year for the company. | |
| FirstMonthTax | String | The first month in the taxable year for the company. | |
| LegalAddress | String | Full legal address of the company. | |
| LegalCity | String | Legal city name for the company. | |
| LegalCountry | String | Legal country name for the company. | |
| LegalState | String | Legal state name for the company. | |
| LegalZip | String | Legal zip code for the company. | |
| LegalName | String | Legal company name. | |
| ShippingAddress | String | Full shipping address returned by Reckon. | |
| ShippingLine1 | String | First line of the shipping address. | |
| ShippingLine2 | String | Second line of the shipping address. | |
| ShippingLine3 | String | Third line of the shipping address. | |
| ShippingLine4 | String | Fourth line of the shipping address. | |
| ShippingLine5 | String | Fifth line of the shipping address. | |
| ShippingCity | String | City name for the shipping address of the company. | |
| ShippingState | String | State name for the shipping address of the company. | |
| ShippingPostalCode | String | Postal code for the shipping address of the company. | |
| ShippingCountry | String | Country for the shipping address of the company. | |
| ShippingNote | String | Note for the shipping address of the company. | |
| OpenedCompanyFile | String | The path to the currently opened company file in Reckon. |
Query Reckon Credit Memo Linked Transactions.
Linked transactions are transactions that have been associated with the CreditMemo specified by the CreditMemoId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format CreditMemoId|ItemLineId. | |
| CreditMemoId | String |
CreditMemos.ID | The credit memo identifier. |
| ReferenceNumber | String | The transaction reference number. | |
| TxnNumber | Integer | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| Date | Date | 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 | The name of the customer on the credit memo. | |
| TransactionId | String | The Id of the linked transaction. | |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the credit memo and linked transaction. | |
| TimeModified | Datetime | When the credit memo was last modified. | |
| TimeCreated | Datetime | 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. |
Query Reckon Custom Columns.
| Name | Type | References | Description |
| DataExtID [KEY] | String | The Id of a data extension. | |
| OwnerID | String | The owner of a data extension. | |
| DataExtName | String | The name of the data extension. | |
| DataExtType | String | The field's data type. | |
| AssignToObject | String | The object associated with the result. | |
| DataExtListRequire | Boolean | ||
| DataExtTxnRequire | Boolean | ||
| DataExtFormatString | String |
Query deleted Entities.
| Name | Type | References | Description |
| ListID [KEY] | String | The unique identifier. | |
| ListDelType | String | The owner of a data extension. | |
| FullName | String | The entity full name. | |
| TimeCreated | Datetime | The time the object was created. | |
| TimeDeleted | Datetime | The time the object was deleted. |
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 | Earliest modified date to search for. | |
| EndModifiedDate | String | Latest modified date to search for. |
Query deleted Transactions.
| Name | Type | References | Description |
| TxnID [KEY] | String | The unique identifier. | |
| TxnDelType | String | The owner of a data extension. | |
| ReferenceNumber | String | The entity full name. | |
| TimeCreated | Datetime | The time the object was created. | |
| TimeDeleted | Datetime | The time the object was deleted. |
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 modified date to search for. | |
| EndTxnDate | String | Latest modified date to search for. |
Query Reckon Estimate Linked transactions.
Linked transactions are transactions that have been associated with the Estimate specified by the EstimateId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format EstimateId|ItemLineId. | |
| EstimateId | String |
Estimates.ID | The estimate identifier. |
| ReferenceNumber | String | Transaction reference number. | |
| TxnNumber | Integer | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| CustomerName | String |
Customers.FullName | Customer name this transaction is recorded under. |
| CustomerId | String |
Customers.ID | Customer Id this transaction is recorded under. |
| Date | Date | Transaction date. | |
| TransactionId | String | The Id of the linked transaction. | |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the estimate and linked transaction. | |
| TimeModified | Datetime | When the credit memo was last modified. | |
| TimeCreated | Datetime | 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. |
Query the Reckon host process. The Host represents information about the Reckon process currently being executed.
| Name | Type | References | Description |
| ProductName [KEY] | String | The name of the Reckon version being used. | |
| MajorVersion | String | The major version of Reckon. | |
| MinorVersion | String | The minor version of Reckon. | |
| Country | String | Country the Reckon edition was designed for. | |
| SupportedQBXMLVersion | String | A comma separated list of QBXML versions supported by the version of Reckon. | |
| IsAutomaticLogin | Boolean | A boolean indicating if the currently running .exe for Reckon is using automatic login. If true, this means that the Reckon UI is currently closed and the Reckon .exe was launched in the background to interact with the company file. | |
| QBFileMode | String | The company file mode currently in use. For instance, SingleUser or MultiUser. |
Query Reckon Invoice Linked Transactions.
Linked transactions are transactions that have been associated with the Invoice specified by the InvoiceId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format InvoiceId|ItemLineId. | |
| InvoiceId | String |
Invoices.ID | The invoice identifier. |
| ReferenceNumber | String | The transaction reference number. | |
| TxnNumber | Integer | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| CustomerName | String |
Customers.FullName | The name of the customer on the invoice. Either CustomerName or CustomerId must have a value when inserting. |
| CustomerId | String |
Customers.ID | The Id of the customer on the invoice. Alternatively give this field a value when inserting instead of CustomerName. |
| Account | String |
Accounts.FullName | A reference to the accounts-receivable account where the money received from this transaction will be deposited. |
| AccountId | String |
Accounts.ID | A reference to the accounts-receivable account where the money received from this transaction will be deposited. |
| Date | Date | 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. | |
| TransactionId | String | The Id of the linked transaction. | |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the invoice and linked transaction. | |
| TimeModified | Datetime | When the invoice was last modified. | |
| TimeCreated | Datetime | 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. |
Query Reckon Item Receipt Linked Transactions.
Linked transactions are transactions that have been associated with the ItemReceipts specified by the ItemReceiptId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format ItemReceiptId|ItemReceiptLineId. | |
| ItemReceiptId | String |
ItemReceipts.ID | The item identifier for the item receipt. This is obtained from the ItemReceipts table. |
| VendorName | String |
Vendors.Name | The name of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
| VendorId | String |
Vendors.ID | The unique Id of the vendor. Either VendorName or VendorId must be specified when inserting an item receipt. |
| Date | Date | The transaction date. | |
| ReferenceNumber | String | The transaction reference number. | |
| AccountsPayable | String |
Accounts.FullName | A reference to the name of the account the item receipt is payable to. |
| AccountsPayableId | String |
Accounts.ID | A reference to the unique Id of the account the item receipt is payable to. |
| Memo | String | A memo regarding the item receipt. | |
| Amount | Double | Total amount of the item receipt. | |
| TxnNumber | Integer | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| TransactionId | String | The Id of the linked transaction. | |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the item receipt and linked transaction. | |
| CustomFields | String | Custom fields returned from Reckon and formatted into XML. | |
| EditSequence | String | An identifier used for versioning for this copy of the object. | |
| TimeModified | Datetime | When the item receipt was last modified. | |
| TimeCreated | Datetime | 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. |
Query information about many of the preferences the Reckon user has set in the company file.
| Name | Type | References | Description |
| ID [KEY] | String | Key for the table.
The default value is 1. | |
| AccountingPreferences_IsUsingAccountNumbers | Boolean | If true, an account number can be recorded for new accounts. If you include an account numnber in the AccountAdd object when this preference is false, the account number will be set but will not be visible in the user interface. | |
| AccountingPreferences_IsRequiringAccounts | Boolean | If true, a transaction cannot be recorded in the user interface unless it is assigned to an account. (However, transactions affected by this preference always require an account to be specified when added through the SDK). | |
| AccountingPreferences_IsUsingClassTracking | Boolean | If true, Reckon will include a class field on all transactions. | |
| AccountingPreferences_IsUsingAuditTrail | Boolean | If true, Reckon will log all transaction changes in the audit trail report. if false, Reckon logs only the most recent versions of each transaction. | |
| AccountingPreferences_IsAssigningJournalEntryNumbers | Boolean | If true, Reckon will automatically assign a number to each journal entry. | |
| AccountingPreferences_ClosingDate | Date | The company closing date set within the company file. (The Reckon admin can assign a password restricting access to transactions that occurred before this date). | |
| FinanceChargePreferences_AnnualInterestRate | Double | The interest rate, set by the Reckon user, that Reckon will use to calculate finance charges. The default is 0. | |
| FinanceChargePreferences_MinFinanceCharge | Double | The minimum finance charge that will be applied regardless of the amount overdue. MinFinanceCharge is set by the Reckon user, and has a default value (within Reckon) of 0. | |
| FinanceChargePreferences_GracePeriod | Integer | The number of days before finance charges apply to customers' overdue invoices. GracePeriod is set by the Reckon user and has a default value (within Reckon) of 0. | |
| FinanceChargePreferences_FinanceChargeAccountRef_ListID | String |
Accounts.ID | Refers to the Id of the account used to track finance charges that the customers pay. This is usually an income account. In a request, if a FinanceChargeAccountRef aggregate includes both FullName and ListId, FullName will be ignored. |
| FinanceChargePreferences_FinanceChargeAccountRef_FullName | String |
Accounts.FullName | Refers to the full name of the account used to track finance charges that the customers pay. This is usually an income account. In a request, if a FinanceChargeAccountRef aggregate includes both FullName and ListId, FullName will be ignored. |
| FinanceChargePreferences_IsAssessingForOverdueCharges | Boolean | If true, finance charges are assessed on overdue finance charges. This preference is set by the Reckon user, and has a default value (within Reckon) of false. (Note that laws vary about whether a company can charge interest on overdue interest payments.) | |
| FinanceChargePreferences_CalculateChargesFrom | String | This preference is set by the Reckon user. Unless they change the value within Reckon, it will be DueDate. If set to DueDate, finance charges are assessed from the day the invoice or statement is due. If set to InvoiceOrBilledDate, finance charges are assessed from the transaction dates.
The allowed values are DueDate, InvoiceOrBilledDate. | |
| FinanceChargePreferences_IsMarkedToBePrinted | Boolean | If true, all newly created finance charge invoices will be marked to be printed. (This makes it easier for the Reckon user to print a selection of invoices all at once.) This preference is set by the Reckon user and has a default value within Reckon of false. | |
| JobsAndEstimatesPreferences_IsUsingEstimates | Boolean | If true, this user is set up to create estimates for jobs. | |
| JobsAndEstimatesPreferences_IsUsingProgressInvoicing | Boolean | If true, this Reckon user can create an invoice for only a portion of an estimate. | |
| JobsAndEstimatesPreferences_IsPrintingItemsWithZeroAmounts | Boolean | If true, line items with an amount of 0 will print on progress invoices. (IsPrintingItemsWithZeroAmounts is not relevant unless IsUsingProgressInvoices is true). | |
| PurchasesAndVendorsPreferences_IsUsingInventory | Boolean | If true, the inventory-related features of Reckon are available. | |
| PurchasesAndVendorsPreferences_DaysBillsAreDue | Integer | By default, bills are due this many days after receipt. | |
| PurchasesAndVendorsPreferences_IsAutomaticallyUsingDiscounts | Boolean | If true, Reckon will automatically apply available vendor discounts or credits to a bill that is being paid. | |
| PurchasesAndVendorsPreferences_DefaultDiscountAccountRef_ListID | String |
Accounts.ID | Id of the account where vendor discounts are tracked. In a request, if a DefaultDiscountAccountRef aggregate includes both FullName and ListId, FullName will be ignored. |
| ReportsPreferences_AgingReportBasis | String | AgeFromDueDate means that the overdue days shown in these reports will begin with the due date on the invoice. AgeFromTransactionDate means that the overdue days shown in these reports will begin with the date the transaction was created.
The allowed values are AgeFromDueDate, AgeFromTransactionDate. | |
| ReportsPreferences_SummaryReportBasis | String | Indicates whether summary reports are cash-basis or accrual-basis bookkeeping.
The allowed values are Accrual, Cash. | |
| SalesAndCustomersPreferences_DefaultShipMethodRef_ListID | String | Id that references to a ship method that will be used as the default value in all ShipVia fields. | |
| SalesAndCustomersPreferences_DefaultShipMethodRef_FullName | String |
ShippingMethods.Name | Full name of a ship method that will be used as the default value in all ShipVia fields. |
| SalesAndCustomersPreferences_DefaultFOB | String | Default FOB (freight on board: the site from which invoiced products are shipped). | |
| SalesAndCustomersPreferences_DefaultMarkup | Double | Default percentage that an inventory item will be marked up from its cost. | |
| SalesAndCustomersPreferences_IsTrackingReimbursedExpensesAsIncome | Boolean | If true, an expense and the customers reimbursement for that expense can be tracked in separate accounts. | |
| SalesAndCustomersPreferences_IsAutoApplyingPayments | Boolean | If true, a customers' payment will automatically be applied to the outstanding invoices for that customer, beginning with the oldest invoice. | |
| SalesAndCustomersPreferences_PriceLevels_IsUsingPriceLevels | Boolean | If true, price levels have been turned on for the company file (under Sales and Customers preferences), which enables the creation and use of price levels. | |
| SalesAndCustomersPreferences_PriceLevels_IsRoundingSalesPriceUp | Boolean | If true, amounts are rounded up to the nearest whole dollar for fixed percentage price levels (not for per-item price levels). | |
| SalesTaxPreferences_DefaultItemSalesTaxRef_ListID | String | Id reference to the default tax code for sales. (Refers to a sales tax code on the SalesTaxCode list). | |
| SalesTaxPreferences_DefaultItemSalesTaxRef_FullName | String |
SalesTaxItems.Name | Full name for the default tax code for sales. (Refers to a sales tax code on the SalesTaxCode list). |
| SalesTaxPreferences_PaySalesTax | String | The frequency of sales tax reports.
The allowed values are Monthly, Quarterly, Annually. | |
| SalesTaxPreferences_DefaultTaxableSalesTaxCodeRef_ListID | String | Id reference to the default tax code for taxable sales. (Refers to a sales tax code in the SalesTaxCode list). | |
| SalesTaxPreferences_DefaultTaxableSalesTaxCodeRef_FullName | String |
SalesTaxCodes.Name | Full name of a default tax code for taxable sales. (Refers to a sales tax code in the SalesTaxCode list). |
| SalesTaxPreferences_DefaultNonTaxableSalesTaxCodeRef_ListID | String | Id reference to the default tax code for nontaxable sales. (Refers to a sales tax code in the SalesTaxCode list). | |
| SalesTaxPreferences_DefaultNonTaxableSalesTaxCodeRef_FullName | String |
SalesTaxCodes.Name | Full name of a default tax code for nontaxable sales. (Refers to a sales tax code in the SalesTaxCode list). |
| SalesTaxPreferences_IsUsingVendorTaxCode | Boolean | Boolean indicating if the vendor's tax codes are being used. | |
| SalesTaxPreferences_IsUsingCustomerTaxCode | Boolean | Boolean indicating if the customer's tax codes are being used. | |
| SalesTaxPreferences_IsUsingAmountsIncludeTax | Boolean | Boolean indicating if total amounts include sales tax. | |
| TimeTrackingPreferences_FirstDayOfWeek | String | The first day of a weekly timesheet period.
The allowed values are Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. | |
| CurrentAppAccessRights_IsAutomaticLoginAllowed | Boolean | If true, then applications can use autologin to access this Reckon company file. | |
| CurrentAppAccessRights_AutomaticLoginUserName | String | If autologin is allowed for this Reckon company file, then this field gives the username that is allowed to use autologin. | |
| CurrentAppAccessRights_IsPersonalDataAccessAllowed | Boolean | If true, then access is allowed to sensitive (personal) data in this Reckon company file. |
Query Reckon Purchase Order Linked Transactions.
Linked transactions are transactions that have been associated with the PurchaseOrder specified by the PurchaseOrderId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format PurchaseOrderId|ItemLineId. | |
| PurchaseOrderId | String | The purchase order identifier. | |
| VendorName | String |
Vendors.Name | Vendor name this purchase order is issued to. Either VendorName or VendorId must have a value when inserting. |
| VendorId | String |
Vendors.ID | Vendor Id this purchase order is issued to. Either VendorName or VendorId must have a value when inserting. |
| VendorMessage | String | Message to appear to vendor. | |
| ReferenceNumber | String | The transaction reference number. | |
| TxnNumber | Integer | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| Date | Date | 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. | |
| TransactionId | String | The Id of the linked transaction. | |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the purchase order and linked transaction. | |
| TimeModified | Datetime | When the purchase order was last modified. | |
| TimeCreated | Datetime | 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. |
Query Reckon Sales Order Linked Transactions.
Linked transactions are transactions that have been associated with the SalesOrder specified by the SalesOrderId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format SalesOrderId|ItemLineId. | |
| SalesOrderId | String |
SalesOrders.ID | The item identifier. |
| ReferenceNumber | String | Transaction reference number. | |
| TxnNumber | Integer | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| CustomerName | String |
Customers.FullName | Customer name this transaction is recorded under. |
| CustomerId | String |
Customers.ID | Customer Id this transaction is recorded under. |
| Date | Date | Transaction date. | |
| TransactionId | String |
Invoices.ID | The Id of the linked transaction. |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the sales order and linked transaction. | |
| TimeModified | Datetime | When the sales order was last modified. | |
| TimeCreated | Datetime | 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. |
Query Reckon Statement Charge Linked Transactions.
Linked transactions are transactions that have been associated with the StatementCharge specified by the StatementChargeId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format StatementChargeId|TransactionLineId. | |
| StatementChargeId | String | The item identifier. | |
| ReferenceNumber | String | Transaction reference number. | |
| TxnNumber | Integer | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| CustomerName | String |
Customers.FullName | Customer name this transaction is recorded under. |
| CustomerId | String |
Customers.ID | Customer Id this transaction is recorded under. |
| Date | Date | Transaction date. | |
| TransactionId | String | The Id of the linked transaction. | |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the statement charge and linked transaction. | |
| TimeModified | Datetime | When the statement charge was last modified. | |
| TimeCreated | Datetime | When the statement charge was created. |
Query Reckon templates.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier of the template. | |
| Name | String | The name of the template. | |
| IsActive | Boolean | Boolean determining if the template is active. | |
| TemplateType | String | The type of template. This may be BuildAssembly, CreditMemo, Estimate, Invoice, PurchaseOrder, SalesOrder, or SalesReceipt. | |
| EditSequence | String | A string indicating the revision of the template. | |
| TimeCreated | Datetime | The time the template was created. | |
| TimeModified | Datetime | The last time the template 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.
The allowed values are 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.
The allowed values are ACTIVE, INACTIVE, ALL, NA. The default value is ALL. |
Query Reckon transactions. You may search the Transactions using a number of values including Type, Entity, Account, ReferenceNumber, Item, Class, Date, and TimeModified.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier of the transaction. | |
| TxnLineId | String | The id of the individual line item. | |
| Type | String | The transaction type of the result. | |
| Date | Datetime | The date of the transaction. | |
| Entity | String | The name of the entity associated with the transaction. For example, the name of a customer, vendor, employee, or other name. | |
| EntityId | String | The Id of the entity associated with the transaction. For example, the name of a customer, vendor, employee, or other name. | |
| AccountName | String |
Accounts.Name | The name of the account associated with the transaction. |
| AccountId | String |
Accounts.ID | The Id of the account associated with the transaction. |
| ReferenceNumber | String | The reference number of the transaction, if applicable. | |
| Amount | String | The amount of the transaction. | |
| Memo | String | The memo appearing on the transaction. | |
| TimeModified | Datetime | When the transaction was last modified. | |
| TimeCreated | Datetime | 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 | |
| ItemName | String | The item name appearing in the transaction. | |
| ItemId | String | The item Id appearing in the transaction. | |
| ClassName | String | The class name applied to the transaction. | |
| ClassId | String | The class Id applied to the transaction. | |
| PostingStatus | String | The posting status of transactions to return.
The allowed values are Either, NonPosting, Posting. The default value is Either. | |
| IsPaid | String | The paid status of transactions to return. Enter either true or false. | |
| DetailLevel | String | The level of detail to use when filtering objects.
The allowed values are All, AllExceptSummary, SummaryOnly. The default value is SummaryOnly. |
Query Reckon Vendor Credit Linked Transactions.
Linked transactions are transactions that have been associated with the VendorCredit specified by the VendorCreditId column.
| Name | Type | References | Description |
| ID [KEY] | String | The unique identifier in the format VendorCreditId|ItemLineId. | |
| VendorCreditId | String | The Id of the VendorCredit transaction. | |
| VendorName | String |
Vendors.Name | Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| VendorId | String |
Vendors.ID | Vendor for this transaction. Either VendorName or VendorId is required to have a value when inserting. |
| Date | Date | 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 | The transaction number. An identifying number for the transaction, different from the Reckon-generated Id. | |
| ReferenceNumber | String | Reference number for the transaction. | |
| TransactionId | String |
Bills.ID | The Id of the linked transaction. |
| TransactionAmount | Double | The amount of the linked transaction. | |
| TransactionDate | Date | The date of the linked transaction. | |
| TransactionReferenceNumber | String | The reference number of the linked transaction. | |
| TransactionType | String | The type of linked transaction. | |
| TransactionLinkType | String | The link type between the vendor credit and linked transaction. | |
| TimeModified | Datetime | When the vendor credit was last modified. | |
| TimeCreated | Datetime | When the vendor 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. | |
| PaidStatus | String | The paid status of the vendor credit.
The allowed values are ALL, PAID, UNPAID, NA. The default value is ALL. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Reckon.
Stored procedures accept a list of parameters, perform their intended function, and then return, if applicable, any relevant response data from Reckon, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CreateReportSchema | Generates a report schema file. |
| CreateSimpleReportSchema | Generates a simple report schema file. |
| ReportAging | Generates Reckon aging reports. |
| ReportBudgetSummary | Generates budget reports. |
| ReportCustomDetail | Generates a custom transaction detail report. |
| ReportCustomSummary | Generates a custom summary report. |
| ReportGeneralDetail | Generates a general detail report. |
| ReportGeneralSummary | Generate a general summary report. |
| ReportJob | Generates job reports. |
| ReportPayrollDetail | Generates payroll reports. |
| ReportPayrollSummary | Generates payroll summary reports. |
| ReportTime | Generates summary and detail reports related by time. |
| SearchEntities | Search entities in Reckon. |
| SendQBXML | Sends the provided QBXML directly to Reckon. |
| VoidTransaction | Voids a given transaction in Reckon. |
Generates a report schema file.
CreateReportSchema creates a schema file based on the specified report. This schema adds a table to your existing list that corresponds with the results of your report which can be queried like other tables. Reports from the Reckon are not modeled by Cloud as queryable tables by default.
The generated schema file outlines the metadata for the report, such as columns and column data types. You can edit the file to adjust data types, rename columns, and include or exclude columns.
| Name | Type | Accepts Output Streams | Description |
| ReportName | String | False | The name of the report. If this is not specified the ReportType will be used as the name. |
| ReportDescription | String | False | A description for the report. If one is not specified, a description based on the ReportType will be selected. |
| ReportType | String | False | The type of report to create a schema for.
The allowed values are 1099DETAIL, APAGINGDETAIL, APAGINGSUMMARY, ARAGINGDETAIL, ARAGINGSUMMARY, AUDITTRAIL, BALANCESHEETBUDGETOVERVIEW, BALANCESHEETBUDGETVSACTUAL, BALANCESHEETDETAIL, BALANCESHEETPREVYEARCOMP, BALANCESHEETSTANDARD, BALANCESHEETSUMMARY, CHECKDETAIL, COLLECTIONSREPORT, CUSTOMDETAIL, CUSTOMERBALANCEDETAIL, CUSTOMERBALANCESUMMARY, DEPOSITDETAIL, EMPLOYEEEARNINGSSUMMARY, EMPLOYEESTATETAXESDETAIL, ESTIMATESBYJOB, EXPENSEBYVENDORDETAIL, EXPENSEBYVENDORSUMMARY, GENERALLEDGER, INCOMEBYCUSTOMERDETAIL, INCOMEBYCUSTOMERSUMMARY, INCOMETAXDETAIL, INCOMETAXSUMMARY, INVENTORYSTOCKSTATUSBYITEM, INVENTORYSTOCKSTATUSBYVENDOR, INVENTORYVALUATIONDETAIL, INVENTORYVALUATIONSUMMARY, ITEMESTIMATESVSACTUALS, ITEMPROFITABILITY, JOBESTIMATESVSACTUALSDETAIL, JOBESTIMATESVSACTUALSSUMMARY, JOBPROFITABILITYDETAIL, JOBPROFITABILITYSUMMARY, JOBPROGRESSINVOICESVSESTIMATES, JOURNAL, MISSINGCHECKS, OPENINVOICES, OPENPOS, OPENPOSBYJOB, OPENSALESORDERBYCUSTOMER, OPENSALESORDERBYITEM, PAYROLLITEMDETAIL, PAYROLLLIABILITYBALANCES, PAYROLLREVIEWDETAIL, PAYROLLSUMMARY, PAYROLLTRANSACTIONDETAIL, PAYROLLTRANSACTIONSBYPAYEE, PENDINGSALES, PHYSICALINVENTORYWORKSHEET, PROFITANDLOSSBUDGETOVERVIEW, PROFITANDLOSSBUDGETPERFORMANCE, PROFITANDLOSSBUDGETVSACTUAL, PROFITANDLOSSBYCLASS, PROFITANDLOSSBYJOB, PROFITANDLOSSDETAIL, PROFITANDLOSSPREVYEARCOMP, PROFITANDLOSSSTANDARD, PROFITANDLOSSYTDCOMP, PURCHASEBYITEMDETAIL, PURCHASEBYITEMSUMMARY, PURCHASEBYVENDORDETAIL, PURCHASEBYVENDORSUMMARY, SALESBYCUSTOMERDETAIL, SALESBYCUSTOMERSUMMARY, SALESBYITEMDETAIL, SALESBYITEMSUMMARY, SALESBYREPDETAIL, SALESBYREPSUMMARY, SALESTAXLIABILITY, SALESTAXREVENUESUMMARY, TIMEBYITEM, TIMEBYJOBDETAIL, TIMEBYJOBSUMMARY, TIMEBYNAME, TRIALBALANCE, TXNDETAILBYACCOUNT, TXNLISTBYCUSTOMER, TXNLISTBYDATE, TXNLISTBYVENDOR, UNBILLEDCOSTSBYJOB, UNPAIDBILLSDETAIL, VENDORBALANCEDETAIL, VENDORBALANCESUMMARY. |
| IncludeRowtype | Boolean | False | A boolean determining if the rowtype column should be included in the output schema.
The default value is FALSE. |
| ReportPeriod | String | False | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| ReportDateRangeMacro | String | False | A macro that can be specified for the report date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. |
| AccountType | String | False | The specific type of account to request in the report.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. |
| AccountList | String | False | A comma separated list of account names or IDs. Also specify a value for AccountListType if specifying a value for this input. For instance AccountName,AccountId2,AccountId3. |
| AccountListType | String | False | Allows the user to query for specific list accounts.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| EntityType | String | False | The specific type of entity to request in the report.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. |
| EntityList | String | False | A comma separated list of entity names or IDs. Also specify a value for EntityListType if specifying a value for this input. |
| EntityListType | String | False | Allows the user to query for specific list of entities.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ItemType | String | False | The specific type of item to request in the report.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. |
| ItemList | String | False | A comma separated list of item names or IDs. Also specify a value for ItemListType if specifying a value for this input. |
| ItemListType | String | False | Allows the user to query for specific list of items.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ClassList | String | False | A comma separated list of class names or IDs. Also specify a value for ClassListType if specifying a value for this input. |
| ClassListType | String | False | Allows the user to query for specific list of classes.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ModifiedDateRange | String | False | Date modified range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| ModifiedDateRangeMacro | String | False | A predefined date modified range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. |
| DetailLevel | String | False | The level of detail to include in the report. |
| SummarizeColumnsBy | String | False | Determines which data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. |
| IncludeSubColumns | String | False | A boolean indicating if subcolumns should be included. |
| IncludeColumns | String | False | A comma separated list of columns to include. Supported values include ACCOUNT,AGING,AMOUNT,AMOUNTDIFFERENCE,AVERAGECOST,BILLEDDATE,BILLINGSTATUS,CALCULATEDAMOUNT,CLASS,CLEAREDSTATUS,COSTPRICE,CREDIT,CURRENCY,DATE,DEBIT,DELIVERYDATE,DUEDATE,ESTIMATEACTIVE,EXCHANGERATE,FOB,INCOMESUBJECTTOTAX,INVOICED,ITEM,ITEMDESC,LASTMODIFIEDBY,LATESTORPRIORSTATE,MEMO,MODIFIEDTIME,NAME,NAMEACCOUNTNUMBER,NAMEADDRESS,NAMECITY,NAMECONTACT,NAMEEMAIL,NAMEFAX,NAMEPHONE,NAMESTATE,NAMEZIP,OPENBALANCE,ORIGINALAMOUNT,PAIDAMOUNT,PAIDSTATUS,PAIDTHROUGHDATE,PAYMENTMETHOD,PAYROLLITEM,PONUMBER,PRINTSTATUS,PROGRESSAMOUNT,PROGRESSPERCENT,QUANTITY,QUANTITYAVAILABLE,QUANTITYONHAND,QUANTITYONSALESORDER,RECEIVEDQUANTITY,REFNUMBER,RUNNINGBALANCE,SALESREP,SALESTAXCODE,SHIPDATE,SHIPMETHOD,SOURCENAME,SPLITACCOUNT,SSNORTAXID,TAXLINE,TAXTABLEVERSION,TERMS,TXNID,TXNNUMBER,TXNTYPE,UNITPRICE,USEREDIT,VALUEONHAND,WAGEBASE,WAGEBASETIPS |
| IncludeAccounts | String | False | Indicates whether this report should include all accounts or just those that are currently in use.
The allowed values are ALL, INUSE. |
| SummarizeRowsBy | String | False | Determines along with includecolumnlist, in most cases, what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to Account, the report's row labels might be Checking, Savings, and so on.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. |
| ReportCalendar | String | False | Specifies the type of year that will be used for this report.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. |
| ReturnRows | String | False | Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. |
| ReturnColumns | String | False | Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. |
| PostingStatus | String | False | Allows you to query for posting reports, nonposting reports, or reports that are either one.
The allowed values are EITHER, NONPOSTING, POSTING. |
| ReportAsOf | String | False | The report will return open balance information up to the reportopenbalanceasof date.
The allowed values are REPORTENDDATE, TODAY. |
| TransactionTypes | String | False | A comma separated list of the transaction types you want the report to cover. Values include ALL,ARREFUNDCREDITCARD,BILL,BILLPAYMENTCHECK,BILLPAYMENTCREDITCARD,BUILDASSEMBLY,CHARGE,CHECK,CREDITCARDCHARGE,CREDITCARDCREDIT,CREDITMEMO,DEPOSIT,ESTIMATE,INVENTORYADJUSTMENT,INVOICE,ITEMRECEIPT,JOURNALENTRY,LIABILITYADJUSTMENT,PAYCHECK,PAYROLLLIABILITYCHECK,PURCHASEORDER,RECEIVEPAYMENT,SALESORDER,SALESRECEIPT,SALESTAXPAYMENTCHECK,TRANSFER,VENDORCREDIT,YTDADJUSTMENT. |
| ReportBasis | String | False | If reportbasis is Cash, the report bases income and expenses on the dates when money changed hands. If Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. If None, the report uses the default report basis, which is either the Reckon preference setting or the Reckon default for a given type of report. In a report response, the SDK returns None for reports that do not support a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. |
| FiscalYear | String | False | The fiscal year of the budget to be queried. For example, 2014. |
| BudgetCriterion | String | False | Specifies what this budget covers.
The allowed values are NONE, ACCOUNTS, ACCOUNTSANDCLASSES, ACCOUNTSANDCUSTOMERS. |
| SummarizeBudgetColumnsBy | String | False | The data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, CLASS, CUSTOMER, DATE. |
| SummarizeBudgetRowsBy | String | False | How rows are to be labeled in the report. For example, if you set the value to Account, the row labels of the report might be Checking, Savings, and so on.
The allowed values are NONE, CLASS, CUSTOMER, ACCOUNT. |
| FileStream | String | True | An instance of an output stream where file data is written to. |
| Name | Type | Description |
| Result | String | Success or Failure. |
| SchemaFile | String | The generated schema file. |
| Columns | String | The number of columns found. |
Generates a simple report schema file.
Generates a simple report schema file using specified database characteristic.
Create Simple Reports are used to make a report based on a wide range of inputs based in the data source.
| Name | Type | Accepts Output Streams | Description |
| ReportName | String | False | The name of the report. If this is not specified the ReportType will be used as the name. |
| ReportDescription | String | False | A description for the report. If one is not specified, a description based on the ReportType will be selected. |
| ReportType | String | False | The type of report to create a schema for.
The allowed values are 1099DETAIL, APAGINGDETAIL, APAGINGSUMMARY, ARAGINGDETAIL, ARAGINGSUMMARY, AUDITTRAIL, BALANCESHEETBUDGETOVERVIEW, BALANCESHEETBUDGETVSACTUAL, BALANCESHEETDETAIL, BALANCESHEETPREVYEARCOMP, BALANCESHEETSTANDARD, BALANCESHEETSUMMARY, CHECKDETAIL, COLLECTIONSREPORT, CUSTOMERBALANCEDETAIL, CUSTOMERBALANCESUMMARY, DEPOSITDETAIL, EMPLOYEEEARNINGSSUMMARY, EMPLOYEESTATETAXESDETAIL, ESTIMATESBYJOB, EXPENSEBYVENDORDETAIL, EXPENSEBYVENDORSUMMARY, GENERALLEDGER, INCOMEBYCUSTOMERDETAIL, INCOMEBYCUSTOMERSUMMARY, INCOMETAXDETAIL, INCOMETAXSUMMARY, INVENTORYSTOCKSTATUSBYITEM, INVENTORYSTOCKSTATUSBYVENDOR, INVENTORYVALUATIONDETAIL, INVENTORYVALUATIONSUMMARY, ITEMESTIMATESVSACTUALS, ITEMPROFITABILITY, JOBESTIMATESVSACTUALSSUMMARY, JOBPROFITABILITYSUMMARY, JOBPROGRESSINVOICESVSESTIMATES, JOURNAL, OPENINVOICES, OPENPOS, OPENPOSBYJOB, OPENSALESORDERBYCUSTOMER, OPENSALESORDERBYITEM, PAYROLLITEMDETAIL, PAYROLLLIABILITYBALANCES, PAYROLLREVIEWDETAIL, PAYROLLSUMMARY, PAYROLLTRANSACTIONDETAIL, PAYROLLTRANSACTIONSBYPAYEE, PENDINGSALES, PHYSICALINVENTORYWORKSHEET, PROFITANDLOSSBUDGETOVERVIEW, PROFITANDLOSSBUDGETPERFORMANCE, PROFITANDLOSSBUDGETVSACTUAL, PROFITANDLOSSBYCLASS, PROFITANDLOSSBYJOB, PROFITANDLOSSDETAIL, PROFITANDLOSSPREVYEARCOMP, PROFITANDLOSSSTANDARD, PROFITANDLOSSYTDCOMP, PURCHASEBYITEMDETAIL, PURCHASEBYITEMSUMMARY, PURCHASEBYVENDORDETAIL, PURCHASEBYVENDORSUMMARY, SALESBYCUSTOMERDETAIL, SALESBYCUSTOMERSUMMARY, SALESBYITEMDETAIL, SALESBYITEMSUMMARY, SALESBYREPDETAIL, SALESBYREPSUMMARY, SALESTAXLIABILITY, SALESTAXREVENUESUMMARY, TIMEBYITEM, TIMEBYJOBDETAIL, TIMEBYJOBSUMMARY, TIMEBYNAME, TRIALBALANCE, TXNDETAILBYACCOUNT, TXNLISTBYCUSTOMER, TXNLISTBYDATE, TXNLISTBYVENDOR, UNBILLEDCOSTSBYJOB, UNPAIDBILLSDETAIL, VENDORBALANCEDETAIL, VENDORBALANCESUMMARY. |
| IncludeRowtype | Boolean | False | A boolean determining if the rowtype column should be included in the output schema.
The default value is FALSE. |
| ReportPeriod | String | False | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| ReportDateRangeMacro | String | False | A macro that can be specified for the report date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. |
| AccountType | String | False | The specific type of account to request in the report.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. |
| AccountList | String | False | A comma separated list of account names or IDs. Also specify a value for AccountListType if specifying a value for this input. For instance AccountName,AccountId2,AccountId3. |
| AccountListType | String | False | Allows the user to query for specific list accounts.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| EntityType | String | False | The specific type of entity to request in the report.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. |
| EntityList | String | False | A comma separated list of entity names or IDs. Also specify a value for EntityListType if specifying a value for this input. |
| EntityListType | String | False | Allows the user to query for specific list of entities.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ItemType | String | False | The specific type of item to request in the report.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. |
| ItemList | String | False | A comma separated list of item names or IDs. Also specify a value for ItemListType if specifying a value for this input. |
| ItemListType | String | False | Allows the user to query for specific list of items.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ClassList | String | False | A comma separated list of class names or IDs. Also specify a value for ClassListType if specifying a value for this input. |
| ClassListType | String | False | Allows the user to query for specific list of classes.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. |
| ModifiedDateRange | String | False | Date modified range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| ModifiedDateRangeMacro | String | False | A predefined date modified range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. |
| DetailLevel | String | False | The level of detail to include in the report. |
| SummarizeColumnsBy | String | False | Determines which data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. |
| IncludeSubColumns | String | False | A boolean indicating if subcolumns should be included. |
| IncludeColumns | String | False | A comma separated list of columns to include. Supported values include ACCOUNT,AGING,AMOUNT,AMOUNTDIFFERENCE,AVERAGECOST,BILLEDDATE,BILLINGSTATUS,CALCULATEDAMOUNT,CLASS,CLEAREDSTATUS,COSTPRICE,CREDIT,CURRENCY,DATE,DEBIT,DELIVERYDATE,DUEDATE,ESTIMATEACTIVE,EXCHANGERATE,FOB,INCOMESUBJECTTOTAX,INVOICED,ITEM,ITEMDESC,LASTMODIFIEDBY,LATESTORPRIORSTATE,MEMO,MODIFIEDTIME,NAME,NAMEACCOUNTNUMBER,NAMEADDRESS,NAMECITY,NAMECONTACT,NAMEEMAIL,NAMEFAX,NAMEPHONE,NAMESTATE,NAMEZIP,OPENBALANCE,ORIGINALAMOUNT,PAIDAMOUNT,PAIDSTATUS,PAIDTHROUGHDATE,PAYMENTMETHOD,PAYROLLITEM,PONUMBER,PRINTSTATUS,PROGRESSAMOUNT,PROGRESSPERCENT,QUANTITY,QUANTITYAVAILABLE,QUANTITYONHAND,QUANTITYONSALESORDER,RECEIVEDQUANTITY,REFNUMBER,RUNNINGBALANCE,SALESREP,SALESTAXCODE,SHIPDATE,SHIPMETHOD,SOURCENAME,SPLITACCOUNT,SSNORTAXID,TAXLINE,TAXTABLEVERSION,TERMS,TXNID,TXNNUMBER,TXNTYPE,UNITPRICE,USEREDIT,VALUEONHAND,WAGEBASE,WAGEBASETIPS |
| IncludeAccounts | String | False | Indicates whether this report should include all accounts or just those that are currently in use.
The allowed values are ALL, INUSE. |
| SummarizeRowsBy | String | False | Determines along with includecolumnlist, in most cases, what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to Account, the report's row labels might be Checking, Savings, and so on.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. |
| ReportCalendar | String | False | Specifies the type of year that will be used for this report.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. |
| ReturnRows | String | False | Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. |
| ReturnColumns | String | False | Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. |
| PostingStatus | String | False | Allows you to query for posting reports, nonposting reports, or reports that are either one.
The allowed values are EITHER, NONPOSTING, POSTING. |
| ReportAsOf | String | False | The report will return open balance information up to the reportopenbalanceasof date.
The allowed values are REPORTENDDATE, TODAY. |
| TransactionTypes | String | False | A comma separated list of the transaction types you want the report to cover. Values include ALL,ARREFUNDCREDITCARD,BILL,BILLPAYMENTCHECK,BILLPAYMENTCREDITCARD,BUILDASSEMBLY,CHARGE,CHECK,CREDITCARDCHARGE,CREDITCARDCREDIT,CREDITMEMO,DEPOSIT,ESTIMATE,INVENTORYADJUSTMENT,INVOICE,ITEMRECEIPT,JOURNALENTRY,LIABILITYADJUSTMENT,PAYCHECK,PAYROLLLIABILITYCHECK,PURCHASEORDER,RECEIVEPAYMENT,SALESORDER,SALESRECEIPT,SALESTAXPAYMENTCHECK,TRANSFER,VENDORCREDIT,YTDADJUSTMENT. |
| ReportBasis | String | False | If reportbasis is Cash, the report bases income and expenses on the dates when money changed hands. If Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. If None, the report uses the default report basis, which is either the Reckon preference setting or the Reckon default for a given type of report. In a report response, the SDK returns None for reports that do not support a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. |
| FiscalYear | String | False | The fiscal year of the budget to be queried. For example, 2014. |
| BudgetCriterion | String | False | Specifies what this budget covers.
The allowed values are NONE, ACCOUNTS, ACCOUNTSANDCLASSES, ACCOUNTSANDCUSTOMERS. |
| SummarizeBudgetColumnsBy | String | False | The data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, CLASS, CUSTOMER, DATE. |
| SummarizeBudgetRowsBy | String | False | How rows are to be labeled in the report. For example, if you set the value to Account, the row labels of the report might be Checking, Savings, and so on.
The allowed values are NONE, CLASS, CUSTOMER, ACCOUNT. |
| FileStream | String | True | An instance of an output stream where file data is written to. |
| Name | Type | Description |
| Result | String | Success or Failure. |
| SchemaFile | String | The generated schema file. |
| Columns | String | The number of columns found. |
Generates Reckon aging reports.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are APAGINGDETAIL, APAGINGSUMMARY, ARAGINGDETAIL, ARAGINGSUMMARY, COLLECTIONSREPORT. The default value is APAGINGDETAIL. |
| Reportperiod | String | Report date range in the format fromdate:todate. Either value may be omitted to define an open ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Transactiontypes | String | A list of the transaction types you want the report to cover. Available values include: ALL,ARREFUNDCREDITCARD,BILL,BILLPAYMENTCHECK,BILLPAYMENTCREDITCARD,BUILDASSEMBLY,CHARGE,CHECK,CREDITCARDCHARGE,CREDITCARDCREDIT,CREDITMEMO,DEPOSIT,ESTIMATE,INVENTORYADJUSTMENT,INVOICE,ITEMRECEIPT,JOURNALENTRY,LIABILITYADJUSTMENT,PAYCHECK,PAYROLLLIABILITYCHECK,PURCHASEORDER,RECEIVEPAYMENT,SALESORDER,SALESRECEIPT,SALESTAXPAYMENTCHECK,TRANSFER,VENDORCREDIT,YTDADJUSTMENT
The default value is ALL. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate. Either value may be omitted for an open ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Postingstatus | String | Allows you to query for posting reports, non-posting reports, or reports that are either one.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Includecolumns | String | A list of enum values showing which columns you want the report to return. Available values include: ACCOUNT,AGING,AMOUNT,AMOUNTDIFFERENCE,AVERAGECOST,BILLEDDATE,BILLINGSTATUS,CALCULATEDAMOUNT,CLASS,CLEAREDSTATUS,COSTPRICE,CREDIT,CURRENCY,DATE,DEBIT,DELIVERYDATE,DUEDATE,ESTIMATEACTIVE,EXCHANGERATE,FOB,INCOMESUBJECTTOTAX,INVOICED,ITEM,ITEMDESC,LASTMODIFIEDBY,LATESTORPRIORSTATE,MEMO,MODIFIEDTIME,NAME,NAMEACCOUNTNUMBER,NAMEADDRESS,NAMECITY,NAMECONTACT,NAMEEMAIL,NAMEFAX,NAMEPHONE,NAMESTATE,NAMEZIP,OPENBALANCE,ORIGINALAMOUNT,PAIDAMOUNT,PAIDSTATUS,PAIDTHROUGHDATE,PAYMENTMETHOD,PAYROLLITEM,PONUMBER,PRINTSTATUS,PROGRESSAMOUNT,PROGRESSPERCENT,QUANTITY,QUANTITYAVAILABLE,QUANTITYONHAND,QUANTITYONSALESORDER,RECEIVEDQUANTITY,REFNUMBER,RUNNINGBALANCE,SALESREP,SALESTAXCODE,SHIPDATE,SHIPMETHOD,SOURCENAME,SPLITACCOUNT,SSNORTAXID,TAXLINE,TAXTABLEVERSION,TERMS,TXNID,TXNNUMBER,TXNTYPE,UNITPRICE,USEREDIT,VALUEONHAND,WAGEBASE,WAGEBASETIPS
The default value is ACCOUNT. |
| Reportasof | String | The report will return open balance information up to the reportopenbalanceasof date.
The allowed values are REPORTENDDATE, TODAY. The default value is TODAY. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates budget reports.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are BALANCESHEETBUDGETOVERVIEW, BALANCESHEETBUDGETVSACTUAL, PROFITANDLOSSBUDGETOVERVIEW, PROFITANDLOSSBUDGETPERFORMANCE, PROFITANDLOSSBUDGETVSACTUAL. The default value is BALANCESHEETBUDGETOVERVIEW. |
| Fiscalyear | String | The fiscal year of the budget to be queried. For example, 2014. |
| Budgetcriterion | String | Specifies what this budget covers.
The allowed values are NONE, ACCOUNTS, ACCOUNTSANDCLASSES, ACCOUNTSANDCUSTOMERS. The default value is NONE. |
| Summarizebudgetcolumnsby | String | The data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, CLASS, CUSTOMER, DATE. The default value is NONE. |
| Summarizebudgetrowsby | String | How rows are to be labeled in the report. For example, if you set the value to Account, the row labels of the report might be Checking, Savings, and so on.
The allowed values are NONE, CLASS, CUSTOMER, ACCOUNT. The default value is NONE. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates a custom transaction detail report.
| Name | Type | Description |
| Reportperiod | String | Report date range in the format fromdate:todate. Either value may be omitted for an open ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Transactiontypes | String | A list of the transaction types you want the report to cover. Available values include: ALL,ARREFUNDCREDITCARD,BILL,BILLPAYMENTCHECK,BILLPAYMENTCREDITCARD,BUILDASSEMBLY,CHARGE,CHECK,CREDITCARDCHARGE,CREDITCARDCREDIT,CREDITMEMO,DEPOSIT,ESTIMATE,INVENTORYADJUSTMENT,INVOICE,ITEMRECEIPT,JOURNALENTRY,LIABILITYADJUSTMENT,PAYCHECK,PAYROLLLIABILITYCHECK,PURCHASEORDER,RECEIVEPAYMENT,SALESORDER,SALESRECEIPT,SALESTAXPAYMENTCHECK,TRANSFER,VENDORCREDIT,YTDADJUSTMENT
The default value is ALL. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate. Either value may be omitted for an open ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Postingstatus | String | Allows the user to query for posting reports, nonposting reports, or either.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Summarizerowsby | String | Determines along with includecolumnlist, in most cases, what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to Account, the report's row labels might be Checking, Savings, and so on.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is NONE. |
| Includecolumns | String | A list of enum values showing which columns you want the report to return. Available values include: ACCOUNT,AGING,AMOUNT,AMOUNTDIFFERENCE,AVERAGECOST,BILLEDDATE,BILLINGSTATUS,CALCULATEDAMOUNT,CLASS,CLEAREDSTATUS,COSTPRICE,CREDIT,CURRENCY,DATE,DEBIT,DELIVERYDATE,DUEDATE,ESTIMATEACTIVE,EXCHANGERATE,FOB,INCOMESUBJECTTOTAX,INVOICED,ITEM,ITEMDESC,LASTMODIFIEDBY,LATESTORPRIORSTATE,MEMO,MODIFIEDTIME,NAME,NAMEACCOUNTNUMBER,NAMEADDRESS,NAMECITY,NAMECONTACT,NAMEEMAIL,NAMEFAX,NAMEPHONE,NAMESTATE,NAMEZIP,OPENBALANCE,ORIGINALAMOUNT,PAIDAMOUNT,PAIDSTATUS,PAIDTHROUGHDATE,PAYMENTMETHOD,PAYROLLITEM,PONUMBER,PRINTSTATUS,PROGRESSAMOUNT,PROGRESSPERCENT,QUANTITY,QUANTITYAVAILABLE,QUANTITYONHAND,QUANTITYONSALESORDER,RECEIVEDQUANTITY,REFNUMBER,RUNNINGBALANCE,SALESREP,SALESTAXCODE,SHIPDATE,SHIPMETHOD,SOURCENAME,SPLITACCOUNT,SSNORTAXID,TAXLINE,TAXTABLEVERSION,TERMS,TXNID,TXNNUMBER,TXNTYPE,UNITPRICE,USEREDIT,VALUEONHAND,WAGEBASE,WAGEBASETIPS,
The default value is ACCOUNT. |
| Includeaccounts | String | Indicates whether this report should include all accounts or only those that are currently in use.
The allowed values are ALL, INUSE. The default value is ALL. |
| Reportasof | String | The report will return open balance information up to the reportopenbalanceasof date.
The allowed values are REPORTENDDATE, TODAY. The default value is TODAY. |
| Reportbasis | String | If this field is set to Cash, the report bases income and expenses on the dates when money changed hands. If Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. If None, the report uses the default report basis, which is either the Reckon preference setting or the Reckon default for a given type of report. In a report response, the SDK returns None for reports that do not support a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. The default value is NONE. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates a custom summary report.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are BALANCESHEETPREVYEARCOMP, BALANCESHEETSTANDARD, BALANCESHEETSUMMARY, CUSTOMERBALANCESUMMARY, EXPENSEBYVENDORSUMMARY, INCOMEBYCUSTOMERSUMMARY, INVENTORYSTOCKSTATUSBYITEM, INVENTORYSTOCKSTATUSBYVENDOR, INCOMETAXSUMMARY, INVENTORYVALUATIONSUMMARY, PHYSICALINVENTORYWORKSHEET, PROFITANDLOSSBYCLASS, PROFITANDLOSSBYJOB, PROFITANDLOSSPREVYEARCOMP, PROFITANDLOSSSTANDARD, PROFITANDLOSSYTDCOMP, PURCHASEBYITEMSUMMARY, PURCHASEBYVENDORSUMMARY, SALESBYCUSTOMERSUMMARY, SALESBYITEMSUMMARY, SALESBYREPSUMMARY, SALESTAXLIABILITY, SALESTAXREVENUESUMMARY, TRIALBALANCE, VENDORBALANCESUMMARY. The default value is BALANCESHEETPREVYEARCOMP. |
| Reportperiod | String | Report date range in the format fromdate:todate. Either value may be omitted for an open ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Transactiontypes | String | A list of the transaction types you want the report to cover. Available values include: ALL,ARREFUNDCREDITCARD,BILL,BILLPAYMENTCHECK,BILLPAYMENTCREDITCARD,BUILDASSEMBLY,CHARGE,CHECK,CREDITCARDCHARGE,CREDITCARDCREDIT,CREDITMEMO,DEPOSIT,ESTIMATE,INVENTORYADJUSTMENT,INVOICE,ITEMRECEIPT,JOURNALENTRY,LIABILITYADJUSTMENT,PAYCHECK,PAYROLLLIABILITYCHECK,PURCHASEORDER,RECEIVEPAYMENT,SALESORDER,SALESRECEIPT,SALESTAXPAYMENTCHECK,TRANSFER,VENDORCREDIT,YTDADJUSTMENT
The default value is ALL. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate. Either value may be omitted for an open ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Summarizecolumnsby | String | Determines which data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is ACCOUNT. |
| Summarizerowsby | String | Determines along with IncludeColumnList, in most cases, what data is calculated for this report and controls how the rows are organized and labeled.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is ACCOUNT. |
| Includesubcolumns | String | Determines whether to include any subcolumn information.
The allowed values are TRUE, FALSE. The default value is FALSE. |
| Reportcalendar | String | Specifies the type of year that will be used for this report.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. The default value is NONE. |
| Returnrows | String | Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Returncolumns | String | Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Postingstatus | String | Allows you to query for posting reports, nonposting reports, or reports that are either.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Reportbasis | String | If reportbasis is Cash, the report bases income and expenses on the dates when money changed hands. If Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. If None, the report uses the default report basis, which is either the Reckon preference setting or the Reckon default for a given type of report. In a report response, the SDK returns None for reports that do not support a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. The default value is NONE. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates a general detail report.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are 1099DETAIL, AUDITTRAIL, BALANCESHEETDETAIL, CHECKDETAIL, CUSTOMERBALANCEDETAIL, DEPOSITDETAIL, ESTIMATESBYJOB, EXPENSEBYVENDORDETAIL, GENERALLEDGER, INCOMEBYCUSTOMERDETAIL, INCOMETAXDETAIL, INVENTORYVALUATIONDETAIL, JOBPROGRESSINVOICESVSESTIMATES, JOURNAL, MISSINGCHECKS, OPENINVOICES, OPENPOS, OPENPOSBYJOB, OPENSALESORDERBYCUSTOMER, OPENSALESORDERBYITEM, PENDINGSALES, PROFITANDLOSSDETAIL, PURCHASEBYITEMDETAIL, PURCHASEBYVENDORDETAIL, SALESBYCUSTOMERDETAIL, SALESBYITEMDETAIL, SALESBYREPDETAIL, TXNDETAILBYACCOUNT, TXNLISTBYCUSTOMER, TXNLISTBYDATE, TXNLISTBYVENDOR, UNPAIDBILLSDETAIL, UNBILLEDCOSTSBYJOB, VENDORBALANCEDETAIL. The default value is 1099DETAIL. |
| Reportperiod | String | Report date range in the format fromdate:todate. Either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Transactiontypes | String | A list of the transaction types you want the report to cover. Available values include: ALL, ARREFUNDCREDITCARD, BILL, BILLPAYMENTCHECK, BILLPAYMENTCREDITCARD, BUILDASSEMBLY, CHARGE, CHECK, CREDITCARDCHARGE, CREDITCARDCREDIT, CREDITMEMO, DEPOSIT, ESTIMATE, INVENTORYADJUSTMENT, INVOICE, ITEMRECEIPT, JOURNALENTRY, LIABILITYADJUSTMENT, PAYCHECK, PAYROLLLIABILITYCHECK, PURCHASEORDER, RECEIVEPAYMENT, SALESORDER, SALESRECEIPT, SALESTAXPAYMENTCHECK, TRANSFER, VENDORCREDIT, YTDADJUSTMENT
The default value is ALL. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate. Either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Postingstatus | String | Allows you to query for posting reports, nonposting reports, or reports that are either.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Summarizerowsby | String | Determines along with includecolumnlist, in most cases, what data is calculated for this report and controls how the rows are organized and labeled.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is NONE. |
| Includecolumns | String | A list of enum values showing which columns you want the report to return. Available values include: ACCOUNT, AGING, AMOUNT, AMOUNTDIFFERENCE, AVERAGECOST, BILLEDDATE, BILLINGSTATUS, CALCULATEDAMOUNT, CLASS, CLEAREDSTATUS, COSTPRICE, CREDIT, CURRENCY, DATE, DEBIT, DELIVERYDATE, DUEDATE, ESTIMATEACTIVE, EXCHANGERATE, FOB, INCOMESUBJECTTOTAX, INVOICED, ITEM, ITEMDESC, LASTMODIFIEDBY, LATESTORPRIORSTATE, MEMO, MODIFIEDTIME, NAME, NAMEACCOUNTNUMBER, NAMEADDRESS, NAMECITY, NAMECONTACT, NAMEEMAIL, NAMEFAX, NAMEPHONE, NAMESTATE, NAMEZIP, OPENBALANCE, ORIGINALAMOUNT, PAIDAMOUNT, PAIDSTATUS, PAIDTHROUGHDATE, PAYMENTMETHOD, PAYROLLITEM, PONUMBER, PRINTSTATUS, PROGRESSAMOUNT, PROGRESSPERCENT, QUANTITY, QUANTITYAVAILABLE, QUANTITYONHAND, QUANTITYONSALESORDER, RECEIVEDQUANTITY, REFNUMBER, RUNNINGBALANCE, SALESREP, SALESTAXCODE, SHIPDATE, SHIPMETHOD, SOURCENAME, SPLITACCOUNT, SSNORTAXID, TAXLINE, TAXTABLEVERSION, TERMS, TXNID, TXNNUMBER, TXNTYPE, UNITPRICE, USEREDIT, VALUEONHAND, WAGEBASE, WAGEBASETIPS
The default value is ACCOUNT. |
| Includeaccounts | String | Indicates whether this report should include all accounts or only those that are currently in use.
The allowed values are ALL, INUSE. |
| Reportasof | String | The report will return open balance information up to the reportopenbalanceasof date.
The allowed values are REPORTENDDATE, TODAY. The default value is TODAY. |
| Reportbasis | String | If reportbasis is Cash, the report bases income and expenses on the dates when money changed hands. If Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. If None, the report uses the default report basis, which is either the Reckon preference setting or the Reckon default for a given type of report. In a report response, the SDK returns None for reports that do not support a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. The default value is NONE. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generate a general summary report.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are BALANCESHEETPREVYEARCOMP, BALANCESHEETSTANDARD, BALANCESHEETSUMMARY, CUSTOMERBALANCESUMMARY, EXPENSEBYVENDORSUMMARY, INCOMEBYCUSTOMERSUMMARY, INVENTORYSTOCKSTATUSBYITEM, INVENTORYSTOCKSTATUSBYVENDOR, INCOMETAXSUMMARY, INVENTORYVALUATIONSUMMARY, PHYSICALINVENTORYWORKSHEET, PROFITANDLOSSBYCLASS, PROFITANDLOSSBYJOB, PROFITANDLOSSPREVYEARCOMP, PROFITANDLOSSSTANDARD, PROFITANDLOSSYTDCOMP, PURCHASEBYITEMSUMMARY, PURCHASEBYVENDORSUMMARY, SALESBYCUSTOMERSUMMARY, SALESBYITEMSUMMARY, SALESBYREPSUMMARY, SALESTAXLIABILITY, SALESTAXREVENUESUMMARY, TRIALBALANCE, VENDORBALANCESUMMARY. The default value is BALANCESHEETPREVYEARCOMP. |
| Reportperiod | String | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Transactiontypes | String | A list of the transaction types you want the report to cover. Available values include: ALL, ARREFUNDCREDITCARD, BILL, BILLPAYMENTCHECK, BILLPAYMENTCREDITCARD, BUILDASSEMBLY, CHARGE, CHECK, CREDITCARDCHARGE, CREDITCARDCREDIT, CREDITMEMO, DEPOSIT, ESTIMATE, INVENTORYADJUSTMENT, INVOICE, ITEMRECEIPT, JOURNALENTRY, LIABILITYADJUSTMENT, PAYCHECK, PAYROLLLIABILITYCHECK, PURCHASEORDER, RECEIVEPAYMENT, SALESORDER, SALESRECEIPT, SALESTAXPAYMENTCHECK, TRANSFER, VENDORCREDIT, YTDADJUSTMENT
The default value is ALL. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Summarizecolumnsby | String | Determines which data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is NONE. |
| Includesubcolumns | String | Determines whether to include any subcolumn information.
The allowed values are TRUE, FALSE. The default value is FALSE. |
| Reportcalendar | String | Specifies the type of year that will be used for this report.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. The default value is NONE. |
| Returnrows | String | Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Returncolumns | String | Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Postingstatus | String | Allows you to query for posting reports, nonposting reports, or reports that are either.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Reportbasis | String | If this field is set to Cash, the report bases income and expenses on the dates when money changed hands. If Accrual, the report bases income on the dates when customers were invoiced and bases expenses on the dates when bills were entered. If None, the report uses the default report basis, which is either the Reckon preference setting or the Reckon default for a given type of report. In a report response, the SDK returns None for reports that do not support a report basis. (The 1099 report, for example, has its own basis for generation.)
The allowed values are ACCRUAL, CASH, NONE. The default value is NONE. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates job reports.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are ITEMESTIMATESVSACTUALS, ITEMPROFITABILITY, JOBESTIMATESVSACTUALSDETAIL, JOBESTIMATESVSACTUALSSUMMARY, JOBPROFITABILITYDETAIL, JOBPROFITABILITYSUMMARY. The default value is ITEMESTIMATESVSACTUALS. |
| Reportperiod | String | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Transactiontypes | String | A list of the transaction types you want the report to cover. Available values include: ALL,ARREFUNDCREDITCARD,BILL,BILLPAYMENTCHECK,BILLPAYMENTCREDITCARD,BUILDASSEMBLY,CHARGE,CHECK,CREDITCARDCHARGE,CREDITCARDCREDIT,CREDITMEMO,DEPOSIT,ESTIMATE,INVENTORYADJUSTMENT,INVOICE,ITEMRECEIPT,JOURNALENTRY,LIABILITYADJUSTMENT,PAYCHECK,PAYROLLLIABILITYCHECK,PURCHASEORDER,RECEIVEPAYMENT,SALESORDER,SALESRECEIPT,SALESTAXPAYMENTCHECK,TRANSFER,VENDORCREDIT,YTDADJUSTMENT
The default value is ALL. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Summarizecolumnsby | String | Determines which data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is NONE. |
| Includesubcolumns | String | Determines whether to include any subcolumn information.
The allowed values are TRUE, FALSE. The default value is FALSE. |
| Postingstatus | String | Allows you to query for posting reports, non-posting reports, or reports that are either.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates payroll reports.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are EMPLOYEESTATETAXESDETAIL, PAYROLLITEMDETAIL, PAYROLLREVIEWDETAIL, PAYROLLTRANSACTIONDETAIL, PAYROLLTRANSACTIONSBYPAYEE. The default value is EMPLOYEESTATETAXESDETAIL. |
| Reportperiod | String | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Postingstatus | String | Allows the user to query for posting reports, non-posting reports, or reports that are either one.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Summarizerowsby | String | Determines along with includecolumnlist, in most cases, what data is calculated for this report and controls how the rows are organized and labeled. For example, if you set the value to Account, the report's row labels might be Checking, Savings, and so on.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TAXLINE, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is NONE. |
| Includecolumn | String | A list of enum values showing which columns you want the report to return.
The allowed values are ACCOUNT, AGING, AMOUNT, AMOUNTDIFFERENCE, AVERAGECOST, BILLEDDATE, BILLINGSTATUS, CALCULATEDAMOUNT, CLASS, CLEAREDSTATUS, COSTPRICE, CREDIT, CURRENCY, DATE, DEBIT, DELIVERYDATE, DUEDATE, ESTIMATEACTIVE, EXCHANGERATE, FOB, INCOMESUBJECTTOTAX, INVOICED, ITEM, ITEMDESC, LASTMODIFIEDBY, LATESTORPRIORSTATE, MEMO, MODIFIEDTIME, NAME, NAMEACCOUNTNUMBER, NAMEADDRESS, NAMECITY, NAMECONTACT, NAMEEMAIL, NAMEFAX, NAMEPHONE, NAMESTATE, NAMEZIP, OPENBALANCE, ORIGINALAMOUNT, PAIDAMOUNT, PAIDSTATUS, PAIDTHROUGHDATE, PAYMENTMETHOD, PAYROLLITEM, PONUMBER, PRINTSTATUS, PROGRESSAMOUNT, PROGRESSPERCENT, QUANTITY, QUANTITYAVAILABLE, QUANTITYONHAND, QUANTITYONSALESORDER, RECEIVEDQUANTITY, REFNUMBER, RUNNINGBALANCE, SALESREP, SALESTAXCODE, SHIPDATE, SHIPMETHOD, SOURCENAME, SPLITACCOUNT, SSNORTAXID, TAXLINE, TAXTABLEVERSION, TERMS, TXNID, TXNNUMBER, TXNTYPE, UNITPRICE, USEREDIT, VALUEONHAND, WAGEBASE, WAGEBASETIPS. The default value is ACCOUNT. |
| Includeaccounts | String | Indicates whether this report should include all accounts or just those that are currently in use.
The allowed values are ALL, INUSE. The default value is ALL. |
| Reportasof | String | The report will return open balance information up to the reportopenbalanceasof date.
The allowed values are REPORTENDDATE, TODAY. The default value is TODAY. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates payroll summary reports.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are EMPLOYEEEARNINGSSUMMARY, PAYROLLLIABILITYBALANCES, PAYROLLSUMMARY. The default value is EMPLOYEEEARNINGSSUMMARY. |
| Reportperiod | String | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Accounttype | String | Allows the user to query for a specified account type.
The allowed values are NONE, ACCOUNTSPAYABLE, ACCOUNTSRECEIVABLE, ALLOWEDFOR1099, APANDSALESTAX, APORCREDITCARD, ARANDAP, ASSET, BALANCESHEET, BANK, BANKANDARANDAPANDUF, BANKANDUF, COSTOFSALES, CREDITCARD, CURRENTASSET, CURRENTASSETANDEXPENSE, CURRENTLIABILITY, EQUITY, EQUITYANDINCOMEANDEXPENSE, EXPENSEANDOTHEREXPENSE, FIXEDASSET, INCOMEANDEXPENSE, INCOMEANDOTHERINCOME, LIABILITY, LIABILITYANDEQUITY, LONGTERMLIABILITY, NONPOSTING, ORDINARYEXPENSE, ORDINARYINCOME, ORDINARYINCOMEANDCOGS, ORDINARYINCOMEANDEXPENSE, OTHERASSET, OTHERCURRENTASSET, OTHERCURRENTLIABILITY, OTHEREXPENSE, OTHERINCOME, OTHERINCOMEOREXPENSE. The default value is NONE. |
| Accountlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Accountlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Modifieddaterange | String | Modified date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Modifieddaterangemacro | String | Use a predefined modified date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Detaillevel | String | The level of detail to include in the report.
The allowed values are ALL, ALLEXCEPTSUMMARY, SUMMARYONLY. The default value is ALL. |
| Summarizecolumnsby | String | Determines which data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is NONE. |
| Includesubcolumns | String | Determines whether to include any subcolumn information.
The allowed values are TRUE, FALSE. The default value is FALSE. |
| Reportcalendar | String | Specifies the type of year that will be used for this report.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. The default value is NONE. |
| Returnrows | String | Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Returncolumns | String | Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Postingstatus | String | Allows you to query for posting reports, nonposting reports, or reports that are either one.
The allowed values are EITHER, NONPOSTING, POSTING. The default value is EITHER. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Generates summary and detail reports related by time.
| Name | Type | Description |
| Reporttype | String | The type of the report.
The allowed values are TIMEBYITEM, TIMEBYJOBDETAIL, TIMEBYJOBSUMMARY, TIMEBYNAME. The default value is TIMEBYITEM. |
| Reportperiod | String | Report date range in the format fromdate:todate where either value may be omitted for an open-ended range (e.g., 2009-12-25:). Supported date format: yyyy-MM-dd. |
| Reportdaterangemacro | String | Use a predefined date range.
The allowed values are ALL, TODAY, THISWEEK, THISWEEKTODATE, THISMONTH, THISMONTHTODATE, THISQUARTER, THISQUARTERTODATE, THISYEAR, THISYEARTODATE, YESTERDAY, LASTWEEK, LASTWEEKTODATE, LASTMONTH, LASTMONTHTODATE, LASTQUARTER, LASTQUARTERTODATE, LASTYEAR, LASTYEARTODATE, NEXTWEEK, NEXTFOURWEEKS, NEXTMONTH, NEXTQUARTER, NEXTYEAR. The default value is ALL. |
| Entitytype | String | Allows the user to query for a specified name type.
The allowed values are NONE, CUSTOMER, EMPLOYEE, OTHERNAME, VENDOR. The default value is NONE. |
| Entitylisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Entitylists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Itemtype | String | Allows the user to query for a specified item type.
The allowed values are NONE, ALLEXCEPTFIXEDASSET, ASSEMBLY, DISCOUNT, FIXEDASSET, INVENTORY, INVENTORYANDASSEMBLY, NONINVENTORY, OTHERCHARGE, PAYMENT, SALES, SALESTAX, SERVICE. The default value is NONE. |
| Itemlisttype | String | Allows the user to query for specific list elements.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Itemlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Classlisttype | String | Allows the user to query for a specified class.
The allowed values are LISTID, FULLNAME, LISTIDWITHCHILDREN, FULLNAMEWITHCHILDREN. The default value is FULLNAME. |
| Classlists | String | The list elements to report on. For LISTIDLIST and FULLNAMELIST, use a comma-separated list. |
| Summarizecolumnsby | String | Determines which data the report calculates and how the columns will be labeled across the top of the report.
The allowed values are NONE, ACCOUNT, BALANCESHEET, CLASS, CUSTOMER, CUSTOMERTYPE, DAY, EMPLOYEE, FOURWEEK, HALFMONTH, INCOMESTATEMENT, ITEMDETAIL, ITEMTYPE, MONTH, PAYEE, PAYMENTMETHOD, PAYROLLITEMDETAIL, QUARTER, SALESREP, SALESTAXCODE, SHIPMETHOD, TERMS, TOTALONLY, TWOWEEK, VENDOR, VENDORTYPE, WEEK, YEAR. The default value is NONE. |
| Includesubcolumns | String | Determines whether to include any subcolumn information.
The allowed values are TRUE, FALSE. The default value is FALSE. |
| Reportcalendar | String | Specifies the type of year that will be used for this report.
The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. The default value is NONE. |
| Returnrows | String | Specifies whether you want the report to include only rows with active information, only rows with nonzero values, or all rows regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Returncolumns | String | Specifies whether you want the report to include only columns with active information, only columns with nonzero values, or all columns regardless of their content or active status.
The allowed values are NONE, ACTIVEONLY, NONZERO, All. The default value is NONE. |
| Delimiter | String | Set the delimiter character for the fields
The default value is ;. |
| Name | Type | Description |
| Rowtype | String | The type of row being output. For example, TitleRow, TextRow, DataRow, SubtotalRow, or TotalRow. |
| Column_value | String | The data in this row in a semicolon separated list of the report. |
Search entities in Reckon.
| Name | Type | Description |
| Entity | String | The entity to search.
The allowed values are Vendor, Employee, Bill, Invoice, CreditMemo, VendorCredit, SalesReceipt, PurchaseOrder, CCCredit, CCCharge, Customer, Estimate, SalesOrder, TimeTracking, ReceivePayment, JournalEntry, Item, Account, Deposit, InventoryAdjustment, PriceLevel, Class, CustomerType, JobType, PaymentMethod, PayrollItemWage, SalesTaxCode, ShipMethod, SalesRep, VendorType, BillToPay, ItemAssembliesCanBuild, ListDeleted, Preferences, ReceivePaymentToDeposit, SalesTaxPaymentCheck, TxnDeleted, ItemReceipt, BillPaymentCheck, BillPaymentCharge, StatementCharge, VehicleMileage, OtherTransaction, OtherList. The default value is Vendor. |
| Name | String | The name to search for. Use in conjunction with MatchType for more granular control over the entries returned. |
| NameMatch | String | This pseudo column is deprecated and should no longer be used. The type of match to use for this entity.
The allowed values are EXACT, CONTAINS, STARTSWITH, ENDSWITH, RANGEEND, RANGESTART. The default value is EXACT. |
| StartModifiedDate | String | Earliest modified date to search for. Limits the search to records modified on or after this date. When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format. |
| EndModifiedDate | String | This pseudo column is deprecated and should no longer be used. Latest modified date to search for. Limits the search to records modified on or before this date. When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format. |
| MinBalance | String | The minimum balance that returned records should have. Limits the search to records with balances greater than or equal to MinBalance. |
| MaxBalance | String | The maximum balance that returned records should have. Limits the search to records with balances less than or equal to MaxBalance. |
| MaxResults | String | Maximum number of results to be returned from this search. |
| OtherEntity | String | To search for other entities not included in the entity input; for example ItemService. When searching for other entities the entity input should be set to OtherList. |
| Name | Type | Description |
| QbXMLEntry | String | A entry in the result collection encoded in XML from Reckon. |
| Qb* | String | Output varies based upon the type of entity queried. |
Sends the provided QBXML directly to Reckon.
| Name | Type | Description |
| RawXML | String | The QBXML to be sent to Reckon. |
| OutputRawResponse | String | Determines whether or not to output the raw response or the parsed response. The default behavior is to return the parsed response.
The default value is false. |
| Name | Type | Description |
| * | String | Output varies depending on the supplied QBXML request. |
Voids a given transaction in Reckon.
| Name | Type | Description |
| TransactionType | String | The type of transaction to void.
The allowed values are ARRefundCreditCard, Bill, BillPaymentCheck, BillPaymentCreditCard, Charge, Check, CreditCardCharge, CreditCardCredit, CreditMemo, Deposit, InventoryAdjustment, Invoice, ItemReceipt, JournalEntry, SalesReceipt, VendorCredit. |
| TxnID | String | The Id of the transaction to be voided. This should be the Id of an invoice, bill, check, or other such transaction. |
| Name | Type | Description |
| * | String | Output varies depending on the supplied QBXML request. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Reckon:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Customers table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customers'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the ClearTransaction stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='ClearTransaction' AND Direction=1 OR Direction=2
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataTypeName | String | The name of the data type. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Customers table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customers'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:reckon:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the Cloud can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
| Reckon | CData Schema |
| AMTTYPE | float |
| BOOLTYPE | bool |
| DATETIMETYPE | datetime |
| DATETYPE | date |
| FLOATTYPE | float |
| IDTYPE | string |
| INTTYPE | int |
| PERCENTTYPE | float |
| QUANTYPE | float |
| STRTYPE | string |
| TIMEINTERVALTYPE | datetime |
Some of the tables in Reckon allow you to define your own fields. These fields are represented as the Custom Fields column. You can use this column to modify all your custom fields.
Custom fields are a special case with the Cloud. Reckon will only return custom fields if they have a value, and will return nothing if no custom fields are set. Custom fields are represented in XML like so:
<CustomField><Name>Custom Field Name</Name><Value>Custom Field Value</Value></CustomField>
To clear a custom field, submit the custom field name without a value. For instance:
<CustomField><Name>Custom Field Name</Name><Value></Value></CustomField>
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
| Property | Description |
| CompanyFile | The name of the CompanyFile to open. |
| ApplicationName | The name of the developer's application. |
| Property | Description |
| User | A username for the QuickBooks Gateway connection. |
| Password | A password for the QuickBooks Gateway connection. |
| URL | The URL for the QuickBooks Gateway. For example, http://localhost:8166. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| CustomFieldMode | How custom fields should display. |
| DelayAfterClose | A delay in milliseconds to be applied each time a connection to Reckon is closed. |
| IncludeLineItems | Whether or not to request Line Item responses from Reckon when retrieving a base transaction, such as Invoices. |
| IncludeLinkedTxns | Whether or not to request Linked Transactions from Reckon when retrieving a base transaction, such as Invoices. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from Reckon. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Readonly | You can use this property to enforce read-only access to Reckon from the provider. |
| RTK | The runtime key used for licensing. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseRDS | Whether the provider will connect using Remote Data Sharing (RDS). Cannot be used together with the QuickBooks Gateway. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| CompanyFile | The name of the CompanyFile to open. |
| ApplicationName | The name of the developer's application. |
The name of the CompanyFile to open.
string
""
If Reckon is not currently open with a CompanyFile, Reckon will be automatically opened in the background with the file specified. Do not set CompanyFile when Reckon is open. If Reckon is open through the application UI, only the currently opened CompanyFile may be used. If you are connecting to a remote company file, the CompanyFile parameter will be ignored. Specify the company file when you create a QuickBooks Gateway user.
The name of the developer's application.
string
"CData Reckon Connector"
This name will appear when the application first connects to Reckon. Reckon will display this name and prompt the user to grant or refuse access to the application.
This section provides a complete list of the Remote properties you can configure in the connection string for this provider.
| Property | Description |
| User | A username for the QuickBooks Gateway connection. |
| Password | A password for the QuickBooks Gateway connection. |
| URL | The URL for the QuickBooks Gateway. For example, http://localhost:8166. |
A username for the QuickBooks Gateway connection.
string
""
The QuickBooks Gateway must require user authentication before this property is used.
A password for the QuickBooks Gateway connection.
string
""
The QuickBooks Gateway must require user authentication before this property is used.
The URL for the QuickBooks Gateway. For example, http://localhost:8166.
string
""
The URL where the QuickBooks Gateway is running. For example, http://localhost:8166. The QuickBooks Gateway is a lightweight HTTP server that proxies requests from the Cloud to Reckon. The address is the name or IP address of the machine where Reckon is running. By default, the QuickBooks Gateway runs on port 8166.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the QuickBooks Gateway. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | The protocol used by a proxy-based firewall. |
| FirewallServer | The name or IP address of a proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based firewall. |
| FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
string
"NONE"
This property specifies the protocol that the Cloud will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Cloud connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
| Type | Default Port | Description |
| TUNNEL | 80 | When this is set, the Cloud opens a connection to Reckon and traffic flows back and forth through the proxy. |
| SOCKS4 | 1080 | When this is set, the Cloud sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
| SOCKS5 | 1080 | When this is set, the Cloud sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
string
""
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Cloud uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
int
0
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
string
""
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
string
""
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is running on. |
| ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
| ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
bool
true
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
string
""
The hostname or IP address of a proxy to route HTTP traffic through. The Cloud can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Cloud uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
int
80
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
string
"BASIC"
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Cloud will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
string
""
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
string
""
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Cloud uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
string
"AUTO"
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
| AUTO | Default setting. If the URL is an HTTPS URL, the Cloud will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
string
""
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Cloud uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
A filepath which designates the name and location of the log file.
string
""
Once this property is set, the Cloud will populate the log file as it carries out various tasks, such as when authentication is performed or queries are executed. If the specified file doesn't already exist, it will be created.
Connection strings and version information are also logged, though connection properties containing sensitive information are masked automatically.
If a relative filepath is supplied, the location of the log file will be resolved based on the path found in the Location connection property.
For more control over what is written to the log file, you can adjust the Verbosity property.
Log contents are categorized into several modules. You can show/hide individual modules using the LogModules property.
To edit the maximum size of a single logfile before a new one is created, see MaxLogFileSize.
If you would like to place a cap on the number of logfiles generated, use MaxLogFileCount.
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
Core modules to be included in the log file.
string
""
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
A string specifying the maximum size in bytes for a log file (for example, 10 MB).
string
"100MB"
When the limit is hit, a new log is created in the same folder with the date and time appended to the end. The default limit is 100 MB. Values lower than 100 kB will use 100 kB as the value instead.
Adjust the maximum number of logfiles generated with MaxLogFileCount.
A string specifying the maximum file count of log files.
int
-1
When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
The minimum supported value is 2. A value of 0 or a negative value indicates no limit on the count.
Adjust the maximum size of the logfiles generated with MaxLogFileSize.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
string
"%APPDATA%\\CData\\Reckon Data Provider\\Schema"
The path to a directory which contains the schema files for the Cloud (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Reckon Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
string
""
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Cloud.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
string
""
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Cloud.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Caching properties you can configure in the connection string for this provider.
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
bool
false
When AutoCache = true, the Cloud automatically maintains a cache of your table's data in the database of your choice.
When AutoCache = true, the Cloud caches to a simple, file-based cache. You can configure its location or cache to a different database with the following properties:
Specifies the path to the cache when caching to a file.
string
"%APPDATA%\\CData\\Reckon Data Provider"
The CacheLocation is a simple, file-based cache.
If left unspecified, the default location is "%APPDATA%\\CData\\Reckon Data Provider" with %APPDATA% being set to the user's configuration directory:
The tolerance for stale data in the cache specified in seconds when using AutoCache .
int
600
The tolerance for stale data in the cache specified in seconds. This only applies when AutoCache is used. The Cloud checks with the data source for newer records after the tolerance interval has expired. Otherwise, it returns the data directly from the cache.
Use offline mode to get the data from the cache instead of the live source.
bool
false
When Offline = true, all queries execute against the cache as opposed to the live data source. In this mode, certain queries like INSERT, UPDATE, DELETE, and CACHE are not allowed.
This property determines whether or not to cache the table metadata to a file store.
bool
false
As you execute queries with this property set, table metadata in the Reckon catalog are cached to the file store specified by CacheLocation if set or the user's home directory otherwise. A table's metadata will be retrieved only once, when the table is queried for the first time.
The Cloud automatically persists metadata in memory for up to two hours when you first discover the metadata for a table or view and therefore, CacheMetadata is generally not required. CacheMetadata becomes useful when metadata operations are expensive such as when you are working with large amounts of metadata or when you have many short-lived connections.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| CustomFieldMode | How custom fields should display. |
| DelayAfterClose | A delay in milliseconds to be applied each time a connection to Reckon is closed. |
| IncludeLineItems | Whether or not to request Line Item responses from Reckon when retrieving a base transaction, such as Invoices. |
| IncludeLinkedTxns | Whether or not to request Linked Transactions from Reckon when retrieving a base transaction, such as Invoices. |
| MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
| Other | These hidden properties are used only in specific use cases. |
| Pagesize | The maximum number of results to return per page from Reckon. |
| PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
| Readonly | You can use this property to enforce read-only access to Reckon from the provider. |
| RTK | The runtime key used for licensing. |
| Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
| UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
| UseRDS | Whether the provider will connect using Remote Data Sharing (RDS). Cannot be used together with the QuickBooks Gateway. |
How custom fields should display.
string
"XML"
XML is the traditional way of displaying custom fields and will be compatible with older implementations. However, JSON is more compact and may be more appropriate if the values are being saved to a database or other tool that cannot easily traverse the XML structure.
A delay in milliseconds to be applied each time a connection to Reckon is closed.
string
""
If Reckon is generating internal errors (in particular with automatic login), setting this delay to a positive value may solve the problem.
Whether or not to request Line Item responses from Reckon when retrieving a base transaction, such as Invoices.
bool
false
Whether or not to request Line Item responses from Reckon when retrieving a base transaction, such as Invoices. This will not affect Line Item tables, only base transaction tables. Setting this value to false will typically result in better performance.
Whether or not to request Linked Transactions from Reckon when retrieving a base transaction, such as Invoices.
bool
false
Whether or not to request Linked Transactions from Reckon when retrieving a base transaction, such as Invoices. This will not affect Linked Transaction tables, only base transaction tables. Setting this value to false will typically result in better performance.
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
int
-1
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
These hidden properties are used only in specific use cases.
string
""
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
The maximum number of results to return per page from Reckon.
int
500
The Pagesize property affects the maximum number of results to return per page from Reckon. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
You can use this property to enforce read-only access to Reckon from the provider.
bool
false
If this property is set to true, the Cloud will allow only SELECT queries. INSERT, UPDATE, DELETE, and stored procedure queries will cause an error to be thrown.
The runtime key used for licensing.
string
""
The RTK property may be used to license a build.
The value in seconds until the timeout error is thrown, canceling the operation.
int
300
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
string
""
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Cloud automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Cloud.
This User Defined View configuration file is formatted as follows:
For example:
{
"MyView": {
"query": "SELECT * FROM Customers WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"
Whether the provider will connect using Remote Data Sharing (RDS). Cannot be used together with the QuickBooks Gateway.
bool
false
Whether the Cloud will connect using Remote Data Sharing (RDS). If set to True, the Cloud will attempt to connect using the RDS client installed on the machine. The RDS client and server must be configured separately. Cannot be used together with the QuickBooks Gateway.