Reckon Accounts Hosted Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 23.0.8804 of the connector.
Get Started¶
Reckon Accounts Hosted Version Support
The connector supports v2 of the Reckon Premier, Professional, Enterprise, and Simple Start APIs. All Reckon editions are supported.
Establish a Connection¶
Connect to Reckon Accounts Hosted¶
Reckon Accounts Hosted supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme
to OAuth
.
The following subsections describe how to authenticate to Reckon Accounts Hosted from three common authentication flows:
Desktop
: a connection to a server on the user's local machine, frequently used for testing and prototyping. Authenticated via either embedded OAuth or custom OAuth.Web
: access to data via a shared website. Authenticated via custom OAuth only.Headless Server
: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard. Authenticated via embedded OAuth or custom OAuth.
For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that have embedded OAuth credentials, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Reckon Accounts Hosted, see Connection.
Desktop Applications¶
provides an embedded OAuth application that simplifies authentication at the desktop; that is, in situations where the user is using a local server not connected to the internet.
You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Reckon Accounts Hosted console. For further information, see Creating a Custom OAuth Application.
Before you connect, set these properties:
InitiateOAuth
:GETANDREFRESH
. Used to automatically get and refresh theOAuthAccessToken
.Custom OAuth applications only
:OAuthClientId
: The client ID assigned when you registered your custom OAuth application.OAuthClientSecret
: The client secret assigned when you registered your custom OAuth application.CallbackURL
: The redirect URI defined when you registered your custom OAuth application.
When you connect, the connector opens Reckon Accounts Hosted's OAuth endpoint in your default browser. Log in and grant permissions to the application.
After you grant permissions to the application, the connector completes the OAuth process:
- The connector obtains an access token from Reckon Accounts Hosted and uses it to request data.
- The OAuth values are saved in the path specified in
OAuthSettingsLocation
. These values persist across connections.
When the access token expires, the connector refreshes it automatically.
Automatic refresh of the OAuth access token:
To have the connector automatically refresh the OAuth access token, do the following:
- The first time you connect to data, set these connection parameters:
InitiateOAuth
:REFRESH
.OAuthClientId
: The client ID in your application settings.OAuthClientSecret
: The client secret in your application settings.OAuthAccessToken
: The access token returned by GetOAuthAccessToken.OAuthSettingsLocation
: The path where you want the connector to save the OAuth values, which persist across connections.
- On subsequent data connections, set:
InitiateOAuth
OAuthSettingsLocation
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAUth access token is the OAuth refresh token.
- To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
- Set these connection properties:
OAuthClientId
: The Client ID in your application settings.OAuthClientSecret
: The Client Secret in your application settings.
- Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
- After the new tokens have been retrieved, set the
OAuthAccessToken
property to the value returned by RefreshOAuthAccessToken. This opens a new connection.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
Create a Custom OAuth Application¶
Create a Custom OAuth Application¶
embeds OAuth Application Credentials with branding that can be used when connecting to Reckon Accounts Hosted via a desktop application or a headless machine. If you want to use the embedded OAuth application, all you need to do to connect is to:
- set
AuthScheme
toOAuth
, - get and set the
OAuthAccessToken
, and - set the necessary configuration parameters.
(For information on getting and setting the OAuthAccessToken
and other configuration parameters, see the Desktop Authentication section of "Connecting to Reckon Accounts Hosted".)
However, you must create a custom OAuth application to connect to Reckon Accounts Hosted via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.
Custom OAuth applications are useful if you want to:
- control branding of the authentication dialog;
- control the redirect URI that the application redirects the user to after the user authenticates; or
- customize the permissions that you are requesting from the user.
Procedure¶
To register a custom OAuth application and obtain the OAuthClientId
and OAuthClientSecret
:
-
Got to the ReckonAccountsHosted Developer Portal.
-
To create a developer account, click
Sign Up
.The Reckon Accounts Hosted Developer site displays a series of prompts that you can use to register a custom OAuth application.
-
Complete the registration. If this will be a web application, set
CallbackURL
to a trusted URL where users return after they authorize your application.
Note theredirectURI
for future use. -
Submit the application form.
The Reckon Accounts Hosted Developer site sends an email containing the Client ID and Client Secret to the user whose login was specified during application creation. The Client ID and Client Secret are used to configure theOAuthClientId
andOAuthClientSecret
properties.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Reckon Accounts Hosted connector.
User Defined Views
The connector 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.
SSL Configuration
Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
Query Processing
The connector offloads as much of the SELECT statement processing as possible to Reckon Accounts Hosted and then processes the rest of the query in memory (client-side).
User Defined Views¶
The Reckon Accounts Hosted connector 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 Jitterbit. 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:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector 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 connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
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"
Define Views Using DDL Statements¶
The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.
Create a View¶
To create a new view using DDL statements, provide the view name and query as follows:
CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;
If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews
connection property.
Alter a View¶
To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:
ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';
The view is then updated in the JSON configuration file.
Drop a View¶
To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.
DROP LOCAL VIEW [MyViewName]
This removes the view from the JSON configuration file. It can no longer be queried.
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
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.
Insert Parent and Child Records¶
Use Case¶
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 cannot be entered without at least one line item. Since invoice line items can have 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. However, during inserts, the CRM system requires 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 can be used to submit insert statements that include details of both the parent and the child records.
For example, let's say that the Invoice table contains a single column called InvoiceLineItems. During the insert, we can pass the details of the records that must be inserted to the InvoiceLineItems table into Invoice record's InvoiceLineItems column.
The following subsection describes how this might be done.
Methods for Inserting Parent/Child Records¶
The connector facilitates two methods for inserting parent/child records: temporary table insertion and XML aggregate insertion.
Temporary (#TEMP) tables¶
The simplest way to enter data would be to use a #TEMP table, or temporary table, which the connector 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 connector 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 there are separate lines for each invoice. This enables 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 connector works in general. The specific table and column names may be different in the connector.
Direct XML Insertion¶
Direct XML can be used as an alternative to #TEMP tables. 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 because the XML, by its nature, is passed against the parent record in full per insert. Since the complete XML must be constructed and submitted for each row, there is no need to provide something to tie the child back to the parent.
Now 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>')
Note
The connector also supports the use of XML/JSON aggregates.
Example for Reckon Accounts Hosted¶
For a working example of how temp tables can be used for bulk insert in Reckon Accounts Hosted, 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
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector 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.
Data Model¶
The Reckon Accounts Hosted connector models entities in the Reckon Accounts Hosted 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.
Tables
The Reckon Accounts Hosted connector models the data in Tables so that it can be easily queried and updated.
Note
In case of Bulk insert operation, the connector supports multiple values only for the aggregate columns whereas for the other columns only single value is supported.
Views
Views are tables that cannot be modified. Typically, read-only data are shown as views.
Stored Procedures
Stored Procedures are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.
Tables¶
The connector models the data in Reckon Accounts Hosted as a list of tables in a relational database that can be queried using standard SQL statements.
Reckon Accounts Hosted Connector Tables¶
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 ReckonAccountsHosted Inventory Adjustment Line Items. |
InventoryAdjustments | Create, query, and delete ReckonAccountsHosted 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. |
Accounts¶
Create, update, delete, and query Reckon Accounts.
Table Specific Information¶
Select¶
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 Accounts Hosted 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'
Insert¶
To add an Account, specify the Name and Type fields.
Columns¶
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-Columns¶
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. |
BillExpenseItems¶
Create, update, delete, and query Reckon Bill Expense Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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-Columns¶
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. |
BillLineItems¶
Create, update, delete, and query Reckon Bill Line Items.
Table Specific Information¶
Bills may be inserted, queried, or updated via the Bills, BillExpenseItems, or BillLineItems tables. Bills may be deleted by using the Bills table.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
BillPaymentChecks¶
Create, update, delete, and query Reckon Bill Payment Checks.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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.
Columns¶
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-Columns¶
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. |
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.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format BillPaymentId|AppliedToId. | |
BillPaymentId | String | False | BillPaymentChecks.ID | 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 | False | The applied-to reference identifier. This is a reference to a bill Id, which can be found in the Bills table. | |
AppliedToAmount | Double | False | 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-Columns¶
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. |
BillPaymentCreditCards¶
Create, update, delete, and query Reckon Bill Payments.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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.
Columns¶
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. | |
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-Columns¶
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. |
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.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format BillPaymentId|AppliedToId. | |
BillPaymentId | String | False | BillPaymentCreditCards.ID | 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-Columns¶
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. |
Bills¶
Create, update, delete, and query Reckon Bills.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
BuildAssemblies¶
Delete and query Reckon Build Assembly transactions.
Columns¶
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-Columns¶
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. |
BuildAssemblyLineItems¶
Create and query Reckon Build Assembly transactions.
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier. | |
BuildAssemblyId | String | False | BuildAssemblies.ID | 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-Columns¶
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. |
CheckExpenseItems¶
Create, update, delete, and query Reckon Check Expense Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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-Columns¶
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. |
CheckLineItems¶
Create, update, delete, and query Reckon Check Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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-Columns¶
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. |
Checks¶
Create, update, delete, and query Reckon Checks.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
Class¶
Create, delete, and query Reckon Classes.
Table Specific Information¶
Select¶
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 Accounts Hosted 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.
Insert¶
To insert a Class, specify the Name field.
Columns¶
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-Columns¶
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. |
CreditCardChargeExpenseItems¶
Create, update, delete, and query Reckon Credit Card Charge Expense Line Items.
Table Specific Information¶
CreditCardCharges may be inserted, queried, or updated via the CreditCardCharges, CreditCardChargeExpenseItems, or CreditCardChargeLineItems tables. CreditCardCharges may be deleted by using the CreditCardCharges table.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format CCChargeId|ItemLineId. | |
CCChargeId | String | False | CreditCardCharges.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
CreditCardChargeLineItems¶
Create, update, delete, and query Reckon Credit Card Charge Line Items.
Table Specific Information¶
CreditCardCharges may be inserted, queried, or updated via the CreditCardCharges, CreditCardChargeExpenseItems, or CreditCardChargeLineItems tables. CreditCardCharges may be deleted by using the CreditCardCharges table.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format CCChargeId|ItemLineId. | |
CCChargeId | String | False | CreditCardCharges.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
CreditCardCharges¶
Create, update, delete, and query Reckon Credit Card Charges.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
CreditCardCreditExpenseItems¶
Create, update, delete, and query Reckon Credit Card Credit Expense Line Items.
Table Specific Information¶
CreditCardCredits may be inserted, queried, or updated via the CreditCardCredits, CreditCardCreditExpenseItems, or CreditCardCreditLineItems tables. CreditCardCredits may be deleted by using the CreditCardCredits table.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format CCCreditId|ItemLineId. | |
CCCreditId | String | False | CreditCardCredits.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
CreditCardCreditLineItems¶
Create, update, delete, and query Reckon Credit Card Credit Line Items.
Table Specific Information¶
CreditCardCredits may be inserted, queried, or updated via the CreditCardCredits, CreditCardCreditExpenseItems, or CreditCardCreditLineItems tables. CreditCardCredits may be deleted by using the CreditCardCredits table.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format CCCreditId|ItemLineId. | |
CCCreditId | String | False | CreditCardCredits.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
CreditCardCredits¶
Create, update, delete, and query Reckon Credit Card Credits.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
CreditMemoLineItems¶
Create, update, delete, and query Reckon Credit Memo Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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 | SalesTaxItems.ID | 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 | Boolean | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
CreditMemos¶
Create, update, delete, and query Reckon Credit Memos.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
CustomerMessages¶
Create, delete, and query Customer Messages.
Columns¶
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-Columns¶
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. |
Customers¶
Create, update, delete, and query Reckon Customers.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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
Columns¶
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 | CustomerTypes.ID | 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. | |
Email | 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 | SalesTaxCodes.ID | 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 | SalesTaxItems.ID | 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 | PaymentMethods.ID | 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-Columns¶
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. |
CustomerTypes¶
Create, update, delete, and query Reckon Customer Types.
Columns¶
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 | CustomerTypes.ID | 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. |
DateDrivenTerms¶
Create, delete, and query Reckon Date Driven Terms.
Table Specific Information¶
Select¶
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 Accounts Hosted 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.
Insert¶
To insert DateDrivenTerms, specify the Name and DayOfMonthDue.
Columns¶
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-Columns¶
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. |
DepositLineItems¶
Create, update, delete, and query Reckon Deposit Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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'
Insert¶
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')
Columns¶
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 | PaymentMethods.ID | 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-Columns¶
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. |
Deposits¶
Create, update, delete, and query Reckon Deposits.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
EmployeeEarnings¶
Create, update, delete, and query Reckon Employee Earnings.
Table Specific Information¶
The Ids for the EmployeeEarnings table operate a bit differently than Line Items. Unlike Line Items, Reckon Accounts Hosted 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 Accounts Hosted. 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 Accounts Hosted UI (or another application between a SELECT and an UPDATE call) are handled.
Select¶
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 Accounts Hosted 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'
Insert¶
To add an EmployeeEarnings entry, specify the EmployeeId field in the INSERT statement. If you instead specify the Employee Name, the connector will attempt to add a new Employee. For example:
INSERT INTO EmployeeEarnings (Name, EarningsWageName, EarningsRate) VALUES ('370000-933272659', 'Regular Pay', 21.32)
Columns¶
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 | Double | 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-Columns¶
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. |
Employees¶
Create, update, delete, and query Reckon Employees.
Table Specific Information¶
This table has a Custom Fields column. See the Custom Fields page for more information.
Select¶
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 Accounts Hosted 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'
Columns¶
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. | |
Email | 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-Columns¶
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. |
EstimateLineItems¶
Create, update, delete, and query Reckon Estimate Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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 | Boolean | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
Estimates¶
Create, update, delete, and query Reckon Estimates.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
InventoryAdjustmentLineItems¶
Create and query ReckonAccountsHosted Inventory Adjustment Line Items.
Table Specific Information¶
InventoryAdjustments may be inserted, queried, or deleted via the InventoryAdjustments or InventoryAdjustmentLineItems tables. InventoryAdjustments may be deleted by using the InventoryAdjustments table.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format InventoryAdjustmentId|ItemLineId. | |
InventoryAdjustmentID | String | True | InventoryAdjustments.ID | 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-Columns¶
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 |
InventoryAdjustments¶
Create, query, and delete ReckonAccountsHosted Inventory Adjustments.
Table Specific Information¶
InventoryAdjustments may be inserted, queried, or deleted via the InventoryAdjustments or InventoryAdjustmentLineItems tables. InventoryAdjustments may be deleted by using the InventoryAdjustments table.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
InvoiceLineItems¶
Create, update, delete, and query Reckon Invoice Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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 | Boolean | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
Invoices¶
Create, update, delete, and query Reckon Invoices.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemLineItems¶
Create, update, delete, and query Reckon Item Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemReceiptExpenseItems¶
Create, update, delete, and query Reckon Item Receipt Expense Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemReceiptLineItems¶
Create, update, delete, and query Reckon Item Receipt Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
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 | SalesTaxCodes.ID | 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. | |
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-Columns¶
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. This is only available during inserts and requires a minimum QBXML Version 6.0 |
ItemLinkToTxnLineId | String | Link this individual line item to another transaction line item. This is only available during inserts and requires a minimum QBXML Version 6.0 |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
ItemReceipts¶
Create, update, delete, and query Reckon Item Receipts.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
Items¶
Create, update, delete, and query Reckon Items.
Table Specific Information¶
This table has a Custom Fields column. See the Custom Fields page for more information.
Select¶
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 Accounts Hosted 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%'
Insert¶
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:
- FixedAsset: Requires Name, Type, AcquiredAs, PurchaseDesc, and PurchaseDate.
- SalesTaxGroup: Requires Name, Type, and at least one SalesTax Line Item. SalesTaxGroups must be inserted via the ItemLineItems table.
Columns¶
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 | SalesTaxCodes.ID | 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 | SalesTaxCodes.ID | 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 | PaymentMethods.ID | 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 | SalesTaxItems.ID | 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-Columns¶
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. |
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.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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-1450191232'
Columns¶
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-Columns¶
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. |
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.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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-1450191232'
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format JournalEntryId|ItemLineId. | |
JournalEntryID | String | False | JournalEntries.ID | 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 | SalesTaxItems.ID | 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-Columns¶
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. |
OtherNames¶
Create, update, delete, and query Reckon Other Name entities.
Columns¶
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. | |
Email | 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. |
PaymentMethods¶
Create, update, delete, and query Reckon Payment Methods.
Columns¶
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-Columns¶
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. |
PayrollNonWageItems¶
Query Reckon Non-Wage Payroll Items.
Columns¶
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. |
PayrollWageItems¶
Create and query Reckon Wage Payroll Items.
Columns¶
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. |
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.
Columns¶
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-Columns¶
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. |
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.
Columns¶
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-Columns¶
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. |
PurchaseOrderLineItems¶
Create, update, delete, and query Reckon Purchase Order Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format PurchaseOrderId|ItemLineId. | |
PurchaseOrderID | String | False | PurchaseOrders.ID | 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 | ShippingMethods.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
PurchaseOrders¶
Create, update, delete, and query Reckon Purchase Orders.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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 | ShippingMethods.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ReceivePayments¶
Create, update, delete, and query Reckon Receive Payment transactions.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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 Accounts Hosted 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>'
Columns¶
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 | PaymentMethods.ID | 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-Columns¶
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. |
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.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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 Accounts Hosted 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')
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format ReceivePaymentId|AppliedToRefId. | |
ReceivePaymentId | String | False | ReceivePayments.ID | 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 | PaymentMethods.ID | 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-Columns¶
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. |
SalesOrderLineItems¶
Create, update, delete, and query Reckon Sales Order Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Inserting Into an Existing SalesOrder¶
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)
Columns¶
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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | Sales tax information for this item (taxable or nontaxable). |
ItemInvoicedAmount | Double | True | 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 | Boolean | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
SalesOrders¶
Create, update, delete, and query Reckon Sales Orders.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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. | |
ShippingDetailTrackingID | Integer | True | The Tracking ID of Sales order which is already shipped. | |
ShippingDetailCarrierName | String | True | The Carries Name of Sales Order which is already shipped. | |
ShippingDetailShippingMethod | String | True | The Shipping Method of Sales Order which is already shipped. | |
ShippingDetailShippingCharges | Decimal | True | The Shipping Charges of Sales Order which is already shipped. | |
FulfillmentStatus | String | True | The Sales order Fulfillment Status details. | |
SOChannel | String | True | Sales Channel Name. | |
StoreName | String | True | Sales Store Name. | |
StoreType | String | True | Sales Store type. |
Pseudo-Columns¶
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. |
SalesReceiptLineItems¶
Create, update, delete, and query Reckon Sales Receipt Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format SalesReceiptId|ItemLineId. | |
SalesReceiptId | String | False | SalesReceipts.ID | 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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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 | Boolean | 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 | PaymentMethods.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
SalesReceipts¶
Create, update, delete, and query Reckon Sales Receipts.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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 | ShippingMethods.ID | 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 | CustomerMessages.ID | 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 | SalesTaxItems.ID | 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 | PaymentMethods.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
SalesReps¶
Create, update, delete, and query Reckon Sales Rep entities.
Table Specific Information¶
Select¶
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 Accounts Hosted 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%'
Insert¶
To insert a SalesRep, specify the Initial column and an existing SalesRepEntityRef. The SalesRepEntityRef can be taken from an existing entity (Employee, Vendor, or OtherName).
Columns¶
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-Columns¶
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. |
SalesTaxCodes¶
Create, update, delete, and query Reckon Sales Tax Codes.
Columns¶
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 | SalesTaxItems.ID | 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. |
SalesTaxItems¶
Create, update, delete, and query Reckon Sales Tax Items.
Columns¶
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. |
ShippingMethods¶
Create, update, delete, and query Reckon Shipping Methods.
Table Specific Information¶
Select¶
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 Accounts Hosted 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%'
Insert¶
To insert a ShippingMethod, specify the Name column.
Columns¶
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-Columns¶
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. |
StandardTerms¶
Create, update, delete, and query Reckon Standard Terms.
Table Specific Information¶
Select¶
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 Accounts Hosted 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%'
Insert¶
To insert a StandardTerm, specify the Name column.
Columns¶
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-Columns¶
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. |
StatementCharges¶
Create, update, delete, and query Reckon Statement Charges.
Table Specific Information¶
To add a StatementCharge, specify the CustomerName or CustomerId and the ItemName or ItemId.
Select¶
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 Accounts Hosted 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%'
Columns¶
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. |
TimeTracking¶
Create, update, delete, and query Reckon Time Tracking events.
Table Specific Information¶
This table has a Custom Fields column. See the Custom Fields page for more information.
Select¶
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 Accounts Hosted 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%'
Insert¶
To insert a TimeTracking entry, specify the Employee and Duration columns.
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 | PayrollWageItems.ID | 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. |
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-Columns¶
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. |
ToDo¶
Create, update, delete, and query Reckon To Do entries.
Columns¶
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. |
VehicleMileage¶
Create, update, delete, and query Reckon Vehicle Mileage entities.
Table Specific Information¶
Select¶
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 Accounts Hosted 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%'
Insert¶
To insert a VehicleMileage entry, specify an existing VehicleRef and either TotalMiles or both OdometerStart and OdometerEnd.
Columns¶
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 | Datetime | False | Date the trip began. If left blank on an insert, the current date at the time of the transaction will be used. | |
TripEndDate | Datetime | 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-Columns¶
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. |
VendorCreditExpenseItems¶
Create, update, delete, and query Reckon Vendor Credit Expense Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format VendorCreditId|ExpenseLineId. | |
VendorCreditId | String | False | VendorCredits.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
VendorCreditLineItems¶
Create, update, delete, and query Reckon Vendor Credit Line Items.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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
Columns¶
Name | Type | ReadOnly | References | Description |
---|---|---|---|---|
ID [KEY] | String | True | The unique identifier in the format VendorCreditId|ItemLineId. | |
VendorCreditId | String | False | VendorCredits.ID | 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 | SalesTaxCodes.ID | 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-Columns¶
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. |
ItemOverrideAccount | String | The Account Name used to override the default Account for the Item. This is only available during inserts and updates. |
ItemOverrideAccountId | String | The Account ID used to override the default Account for the Item. This is only available during inserts and updates. |
VendorCredits¶
Create, update, delete, and query Reckon Vendor Credits.
Table Specific Information¶
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.
Select¶
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 Accounts Hosted 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%'
Insert¶
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>'
Columns¶
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-Columns¶
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. |
Vendors¶
Create, update, delete, and query Reckon Vendors.
Table Specific Information¶
This table has a Custom Fields column. See the Custom Fields page for more information.
Select¶
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 Accounts Hosted 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%'
Insert¶
To add a Vendor, specify the Name column.
Columns¶
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. | |
Email | 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-Columns¶
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. |
VendorTypes¶
Create, update, delete, and query Reckon Vendor Types.
Columns¶
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¶
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Reckon Accounts Hosted Connector Views¶
Name | Description |
---|---|
BillLinkedTransactions | Query Reckon Bill Linked Transactions. |
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. |
SupportedVersions | Query Reckon SupportedVersions. |
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. |
UserFiles | Query Reckon UserFiles. |
VendorCreditLinkedTransactions | Query Reckon Vendor Credit Linked Transactions. |
BillLinkedTransactions¶
Query Reckon Bill Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the Bill specified by the BillId column.
Select¶
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 Accounts Hosted 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%'
Columns¶
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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String | |
PaidStatus | String |
CreditMemoLinkedTransactions¶
Query Reckon Credit Memo Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the CreditMemo specified by the CreditMemoId column.
Columns¶
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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String | |
ItemPriceLevel | String |
CustomColumns¶
Query Reckon Custom Columns.
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 |
DeletedEntities¶
Query deleted Entities.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ListID [KEY] | String | The unique identifier. | |
ListDelType | String | The entity type. Valid values are Account, BillingRate, Class, Currency, Customer, CustomerMsg, CustomerType, DateDrivenTerms, Employee, InventorySite, ItemDiscount, ItemFixedAsset, ItemGroup, ItemInventory, ItemInventoryAssembly, ItemNonInventory, ItemOtherCharge, ItemPayment, ItemSalesTax, ItemSalesTaxGroup, ItemService, ItemSubtotal, JobType, OtherName, PaymentMethod, PayrollItemNonWage, PayrollItemWage, PriceLevel, SalesRep, SalesTaxCode, ShipMethod, StandardTerms, ToDo, UnitOfMeasureSet, Vehicle, Vendor, VendorType, WorkersCompCode | |
FullName | String | The entity full name. | |
TimeCreated | Datetime | The time the object was created. | |
TimeDeleted | Datetime | The time the object was deleted. |
Pseudo-Columns¶
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 |
---|---|---|
TimeModified | String |
DeletedTransactions¶
Query deleted Transactions.
Columns¶
Name | Type | References | Description |
---|---|---|---|
TxnID [KEY] | String | The unique identifier. | |
TxnDelType | String | The transaction type. Valid values are ARRefundCreditCard, Bill, BillPaymentCheck, BillPaymentCreditCard, BuildAssembly, Charge, Check, CreditCardCharge, CreditCardCredit, CreditMemo, Deposit, Estimate, InventoryAdjustment, Invoice, ItemReceipt, JournalEntry, PurchaseOrder, ReceivePayment, SalesOrder, SalesReceipt, SalesTaxPaymentCheck, TimeTracking, TransferInventory, VehicleMileage, VendorCredit | |
ReferenceNumber | String | The entity full name. | |
TimeCreated | Datetime | The time the object was created. | |
TimeDeleted | Datetime | The time the object was deleted. |
Pseudo-Columns¶
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 |
---|---|---|
TimeModified | String |
EstimateLinkedTransactions¶
Query Reckon Estimate Linked transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the Estimate specified by the EstimateId column.
Columns¶
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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String | |
ItemPriceLevel | String |
Host¶
Query the Reckon host process. The Host represents information about the Reckon process currently being executed.
Columns¶
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. |
InvoiceLinkedTransactions¶
Query Reckon Invoice Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the Invoice specified by the InvoiceId column.
Columns¶
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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String |
ItemReceiptLinkedTransactions¶
Query Reckon Item Receipt Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the ItemReceipts specified by the ItemReceiptId column.
Columns¶
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 | PurchaseOrders.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 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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String |
Preferences¶
Query information about many of the preferences the Reckon user has set in the company file.
Columns¶
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 | ShippingMethods.ID | 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 | SalesTaxItems.ID | 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 | SalesTaxCodes.ID | 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 | SalesTaxCodes.ID | 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. |
PurchaseOrderLinkedTransactions¶
Query Reckon Purchase Order Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the PurchaseOrder specified by the PurchaseOrderId column.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ID [KEY] | String | The unique identifier in the format PurchaseOrderId|ItemLineId. | |
PurchaseOrderId | String | PurchaseOrders.ID | 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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String | |
ItemPriceLevel | String |
SalesOrderLinkedTransactions¶
Query Reckon Sales Order Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the SalesOrder specified by the SalesOrderId column.
Columns¶
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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String | |
ItemPriceLevel | String |
StatementChargeLinkedTransactions¶
Query Reckon Statement Charge Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the StatementCharge specified by the StatementChargeId column.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ID [KEY] | String | The unique identifier in the format StatementChargeId|TransactionLineId. | |
StatementChargeId | String | StatementCharges.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 | 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. |
SupportedVersions¶
Query Reckon SupportedVersions.
Columns¶
Name | Type | References | Description |
---|---|---|---|
CountryVersion | String | The Country Version which the API currently supports. This is useful for the connection property CountryVersion. | |
Country | String | The name of the country. | |
Version | String | The version which the API supports. | |
Description | String | The description for the version. | |
EndDate | Date | The end date of the support for the version. |
Templates¶
Query Reckon templates.
Columns¶
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-Columns¶
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 | |
EndModifiedDate | String | |
NameMatch | String | |
ActiveStatus | String |
Transactions¶
Query Reckon transactions. You may search the Transactions using a number of values including Type, Entity, Account, ReferenceNumber, Item, Class, Date, and TimeModified.
Columns¶
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 | Double | 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-Columns¶
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 | |
ItemId | String | |
ClassName | String | |
ClassId | String | |
PostingStatus | String | |
IsPaid | String | |
DetailLevel | String |
UserFiles¶
Query Reckon UserFiles.
Columns¶
Name | Type | References | Description |
---|---|---|---|
FileName | String | The name of the company file. | |
FilePath | String | The path to the company file. This is useful for the connection property CompanyFile. | |
LastModified | Datetime | The time when the company file was last modified. |
VendorCreditLinkedTransactions¶
Query Reckon Vendor Credit Linked Transactions.
Table Specific Information¶
Linked transactions are transactions that have been associated with the VendorCredit specified by the VendorCreditId column.
Columns¶
Name | Type | References | Description |
---|---|---|---|
ID [KEY] | String | The unique identifier in the format VendorCreditId|ItemLineId. | |
VendorCreditId | String | VendorCredits.ID | 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-Columns¶
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 | |
EndTxnDate | String | |
StartModifiedDate | String | |
EndModifiedDate | String | |
PaidStatus | String |
Stored Procedures¶
Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Reckon Accounts Hosted.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Reckon Accounts Hosted, along with an indication of whether the procedure succeeded or failed.
Reckon Accounts Hosted Connector Stored Procedures¶
Name | Description |
---|---|
CreateReportSchema | Generates a report schema file. |
CreateSimpleReportSchema | Generates a simple report schema file. |
GetOAuthAccessToken | Gets the OAuth access token from Reckon Accounts Hosted. |
GetOAuthAuthorizationURL | Gets the Reckon Accounts Hosted authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to Reckon Accounts Hosted. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with Reckon Accounts Hosted. |
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. |
CreateReportSchema¶
Generates a report schema file.
CreateReportSchema¶
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 then be queried like other tables.
(Reports from the Reckon Accounts Hosted are not modeled by connector 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.
Updating a Report Schema¶
In the following example, the SP CreateReportSchema
creates a new report using TestReportTest1
as a base template. It appends new columns to TestReportTest1
and creates a new report, named TestReport2
. The new report is saved as ...\TestReportTest2.rsd
.
EXECUTE [CreateReportSchema]
[ReportName] = "TestReportTest2",
[CustomFieldIdsPrimitive] = "1459925,1459928",
[CustomFieldIdsDropdown] = "1469785",
[CustomDimensionKeyIds] = "13539564",
[BaseReportName] = "TestReportTest1",
[FileName] = "...\TestReportTest2.rsd"
Input¶
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. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Result | String | Success or Failure. |
SchemaFile | String | The generated schema file. |
Columns | String | The number of columns found. |
CreateSimpleReportSchema¶
Generates a simple report schema file.
CreateSimpleReportsSchema¶
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.
Input¶
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. |
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. |
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. |
ReportCalendar | String | False | Specifies the type of year that will be used for this report. The allowed values are NONE, CALENDARYEAR, FISCALYEAR, TAXYEAR. |
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. |
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. |
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. |
FileStream | String | True | An instance of an output stream where file data is written to. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Result | String | Success or Failure. |
SchemaFile | String | The generated schema file. |
Columns | String | The number of columns found. |
GetOAuthAccessToken¶
Gets the OAuth access token from Reckon Accounts Hosted.
Input¶
Name | Type | Description |
---|---|---|
AuthMode | String | The type of authentication mode to use. Select App for getting authentication tokens via a windows forms app. Select Web for getting authentication tokens via a web app. The allowed values are APP, WEB. The default value is APP. |
CallbackUrl | String | The URL the user will be redirected to after authorizing your application. |
Verifier | String | The verifier code returned by Reckon Accounts Hosted after permissions have been granted for the app to connect. WEB AuthMode only. |
State | String | This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to ReckonAccountsHosted authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The OAuth token. |
OAuthRefreshToken | String | The OAuth refresh token. |
ExpiresIn | String | The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL¶
Gets the Reckon Accounts Hosted authorization URL. Access the URL returned in the output in an Internet browser. This requests the access token that can be used as part of the connection string to Reckon Accounts Hosted.
Input¶
Name | Type | Description |
---|---|---|
CallbackUrl | String | The URL that Reckon Accounts Hosted will return to after the user has authorized your app. |
State | String | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Reckon Accounts Hosted authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The URL to be entered into a Web browser to obtain the verifier token and authorize the connector with. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with Reckon Accounts Hosted.
Input¶
Name | Type | Description |
---|---|---|
OAuthRefreshToken | String | The refresh token returned with the previous access token. |
CallbackUrl | String | The URL used when the oauth access token was created. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from ReckonAccountsHosted. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | A token that may be used to obtain a new access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
ReportAging¶
Generates Reckon aging reports.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportBudgetSummary¶
Generates budget reports.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportCustomDetail¶
Generates a custom transaction detail report.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportCustomSummary¶
Generates a custom summary report.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportGeneralDetail¶
Generates a general detail report.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportGeneralSummary¶
Generate a general summary report.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportJob¶
Generates job reports.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportPayrollDetail¶
Generates payroll reports.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportPayrollSummary¶
Generates payroll summary reports.
Input¶
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 ;. |
Result Set Columns¶
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. |
ReportTime¶
Generates summary and detail reports related by time.
Input¶
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 ;. |
Result Set Columns¶
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. |
SearchEntities¶
Search entities in Reckon.
Input¶
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. |
Result Set Columns¶
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. |
SendQBXML¶
Sends the provided QBXML directly to Reckon.
Input¶
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. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
\* | String | Output varies depending on the supplied QBXML request. |
VoidTransaction¶
Voids a given transaction in Reckon.
Input¶
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. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
\* | String | Output varies depending on the supplied QBXML request. |
System Tables¶
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables¶
The following tables return database metadata for Reckon Accounts Hosted:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables¶
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries, including batch operations:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
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. |
sys_tablecolumns¶
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'
Columns¶
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. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
sys_procedures¶
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Columns¶
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. |
sys_procedureparameters¶
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
Columns¶
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. |
sys_keycolumns¶
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'
Columns¶
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. |
sys_foreignkeys¶
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'
Columns¶
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. |
sys_primarykeys¶
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Columns¶
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. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
sys_indexes¶
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'
Columns¶
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. |
sys_connection_props¶
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:reckonaccountshosted: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 <> ''
Columns¶
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. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. 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 |
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 Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The 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.
Columns¶
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. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
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. |
Data Type Mapping¶
Data Type Mappings¶
The connector maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.
Reckon Accounts Hosted | Schema |
---|---|
AMTTYPE | float |
BOOLTYPE | bool |
DATETIMETYPE | datetime |
DATETYPE | date |
FLOATTYPE | float |
IDTYPE | string |
INTTYPE | int |
PERCENTTYPE | float |
QUANTYPE | float |
STRTYPE | string |
TIMEINTERVALTYPE | datetime |
Custom Fields¶
Some of the tables in Reckon Accounts Hosted 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 connector. Reckon Accounts Hosted 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>
Advanced Configurations Properties¶
The advanced configurations 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. Click the links for further details.
Property | Description |
---|---|
User | The company file's username. |
Password | The company file's password. |
CompanyFile | The path to the company file. |
SubscriptionKey | The subscription key used to authenticate to Reckon Accounts Hosted. |
CountryVersion | To connect to a Hosted company file, you will need to pass the appropriate value in the CountryVersion. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
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 |
---|---|
PollingInterval | This determines the polling interval in milliseconds to check whether the result is ready to be retrieved. |
AsyncTimeout | The value in seconds until the timeout error is thrown, canceling the operation. |
CustomFieldMode | Which nested data format (XML, JSON) custom fields should be displayed in. |
IncludeLineItems | Whether or not to request Line Item responses from Reckon Accounts Hosted when retrieving a base transaction, such as Invoices. |
IncludeLinkedTxns | Whether or not to request Linked Transactions from Reckon Accounts Hosted when retrieving a base transaction, such as Invoices. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Reckon Accounts Hosted. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
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. |
Connection¶
This section provides a complete list of connection properties you can configure.
Property | Description |
---|---|
User | The company file's username. |
Password | The company file's password. |
CompanyFile | The path to the company file. |
SubscriptionKey | The subscription key used to authenticate to Reckon Accounts Hosted. |
CountryVersion | To connect to a Hosted company file, you will need to pass the appropriate value in the CountryVersion. |
User¶
The company file's username.
Data Type¶
string
Default Value¶
""
Remarks¶
Ensure the user has Full Access as the assigned role. This is due to the nature of the Accounts SDK which is being used. Setting a user who is not Admin also enables the 'always on' Reckon Accounts audit trail to capture all posts by the driver. This is very helpful when proving what the integrated app did versus changes made by other users.
Password¶
The company file's password.
Data Type¶
string
Default Value¶
""
Remarks¶
Despite what it displays in the Reckon Accounts UI, a password is not optional and must be set when using the driver. This password can be changed at any time by those with Admin Rights to the company file.
CompanyFile¶
The path to the company file.
Data Type¶
string
Default Value¶
""
Remarks¶
The simplest way is to query the UserFiles view: SELECT * FROM UserFiles. Copy the value from the FilePath column and paste it here. Alternatively, you can get the path by opening your company file in Reckon Accounts Hosted and pressing Ctrl 1 (Product Info). You can then click the Copy button and paste it here.
SubscriptionKey¶
The subscription key used to authenticate to Reckon Accounts Hosted.
Data Type¶
string
Default Value¶
""
Remarks¶
If you have signed up for the Reckon Accounts Hosted API you should have received an email inviting you to join the Reckon portal on the Azure platform http://reckonproduction.portal.azure-api.net/
. Once you have signed in, in your profile you will have access to two API Keys. Copy one of them here.
CountryVersion¶
To connect to a Hosted company file, you will need to pass the appropriate value in the CountryVersion.
Data Type¶
string
Default Value¶
2021.R2.AU
Remarks¶
You can get this value by querying the view SupportedVersions: SELECT * FROM SupportedVersions
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
OAuthSettingsLocation | The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://' . |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
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 |
Schema¶
This section provides a complete list of schema properties you can configure.
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. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\ReckonAccountsHosted Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.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%\ReckonAccountsHosted Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
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.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
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.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
PollingInterval | This determines the polling interval in milliseconds to check whether the result is ready to be retrieved. |
AsyncTimeout | The value in seconds until the timeout error is thrown, canceling the operation. |
CustomFieldMode | Which nested data format (XML, JSON) custom fields should be displayed in. |
IncludeLineItems | Whether or not to request Line Item responses from Reckon Accounts Hosted when retrieving a base transaction, such as Invoices. |
IncludeLinkedTxns | Whether or not to request Linked Transactions from Reckon Accounts Hosted when retrieving a base transaction, such as Invoices. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Reckon Accounts Hosted. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
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. |
PollingInterval¶
This determines the polling interval in milliseconds to check whether the result is ready to be retrieved.
Data Type¶
string
Default Value¶
1000
Remarks¶
This property determines how long to wait between checking whether or not the query's results are ready. Very large resultsets or complex queries may take longer to process, and a low polling interval may result in many unnecessary requests being made to check the query status.
AsyncTimeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
300
Remarks¶
The operations run until they complete successfully or until they encounter an error condition.
If AsyncTimeout expires and the operation is not yet complete, the driver throws an exception.
CustomFieldMode¶
Which nested data format (XML,JSON) custom fields should be displayed in.
Possible Values¶
XML
, JSON
Data Type¶
string
Default Value¶
XML
Remarks¶
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.
IncludeLineItems¶
Whether or not to request Line Item responses from Reckon Accounts Hosted when retrieving a base transaction, such as Invoices.
Data Type¶
bool
Default Value¶
false
Remarks¶
This will not affect Line Item tables, only base transaction tables. Setting this value to false will typically result in better performance.
IncludeLinkedTxns¶
Whether or not to request Linked Transactions from Reckon Accounts Hosted when retrieving a base transaction, such as Invoices.
Data Type¶
bool
Default Value¶
false
Remarks¶
This will not affect Linked Transaction tables, only base transaction tables. Setting this value to false will typically result in better performance.
MaxRows¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
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.
Integration and Formatting¶
Property | Description |
---|---|
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. |
Pagesize¶
The maximum number of results to return per page from Reckon Accounts Hosted.
Data Type¶
int
Default Value¶
500
Remarks¶
The Pagesize
property affects the maximum number of results to return per page from Reckon Accounts Hosted. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
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, "*=*".
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
300
Remarks¶
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 connector throws an exception.
UserDefinedViews¶
A filepath pointing to the JSON configuration file containing your custom views.
Data Type¶
string
Default Value¶
""
Remarks¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector 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 connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
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
Note that the specified path is not embedded in quotation marks.