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 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 |
The shipping method associated with the invoice. | |
ShipDate | Date | False |
The shipping date associated with the invoice. | |
Memo | String | False |
A memo regarding this transaction. | |
Class | String | False |
Class.FullName |
A reference to the class of the transaction. |
ClassId | String | False |
Class.ID |
A reference to the class of the transaction. |
Amount | Double | True |
The total amount for this invoice. | |
Message | String | False |
CustomerMessages.Name |
A message to vendor or customer to appear in the invoice. |
MessageId | String | False |
A message to vendor or customer to appear in the invoice. | |
SalesRep | String | False |
SalesReps.Initial |
A reference to the (initials of) sales rep. |
SalesRepId | String | False |
SalesReps.ID |
A reference to the sales rep. |
FOB | String | False |
Freight on board: The place to ship from. | |
BillingAddress | String | True |
Full billing address returned by Reckon. | |
BillingLine1 | String | False |
First line of the billing address. | |
BillingLine2 | String | False |
Second line of the billing address. | |
BillingLine3 | String | False |
Third line of the billing address. | |
BillingLine4 | String | False |
Fourth line of the billing address. | |
BillingLine5 | String | False |
Fifth line of the billing address. | |
BillingCity | String | False |
City name for the billing address. | |
BillingState | String | False |
State name for the billing address. | |
BillingPostalCode | String | False |
Postal code for the billing address. | |
BillingCountry | String | False |
Country for the billing address. | |
BillingNote | String | False |
A note for the billing address. | |
ShippingAddress | String | True |
Full shipping address returned by Reckon. | |
ShippingLine1 | String | False |
First line of the shipping address. | |
ShippingLine2 | String | False |
Second line of the shipping address. | |
ShippingLine3 | String | False |
Third line of the shipping address. | |
ShippingLine4 | String | False |
Fourth line of the shipping address. | |
ShippingLine5 | String | False |
Fifth line of the shipping address. | |
ShippingCity | String | False |
City name for the shipping address. | |
ShippingState | String | False |
State name for the shipping address. | |
ShippingPostalCode | String | False |
Postal code for the shipping address. | |
ShippingCountry | String | False |
Country for the shipping address. | |
ShippingNote | String | False |
A note for the shipping address. | |
Subtotal | Double | True |
The gross subtotal of the invoice. This does not include tax or the amount already paid. | |
Tax | Double | True |
The total sales tax applied to this transaction. | |
TaxItem | String | False |
SalesTaxItems.Name |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. |
TaxItemId | String | False |
A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency. | |
TaxPercent | Double | True |
The percentage charged for sales tax. | |
POnumber | String | False |
The purchase order number. | |
DueDate | Date | False |
The date when payment is due. | |
Terms | String | False |
The payment terms. | |
TermsId | String | False |
The payment terms. | |
ItemCount | Integer | True |
The count of item entries for this transaction. | |
ItemAggregate | String | False |
An aggregate of the line item data which can be used for adding a invoices and its line item data. | |
TransactionCount | Integer | True |
The count of related transactions to the invoice. | |
TransactionAggregate | String | True |
An aggregate of the linked transaction data. | |
AppliedAmount | Double | True |
The total amount of applied credits and payments. | |
Balance | Double | False |
The unpaid amount for this sale. | |
CustomerTaxCode | String | False |
SalesTaxCodes.Name |
The tax code specific to this customer. |
CustomerTaxCodeId | String | False |
The tax code specific to this customer. | |
IsToBePrinted | Boolean | False |
Whether this invoice is to be printed. | |
IsToBeEmailed | Boolean | False |
Whether this invoice is to be emailed. | |
IsPaid | Boolean | True |
Whether this invoice has been paid in full. | |
IsTaxIncluded | Boolean | False |
Determines if tax is included in the transaction amount. | |
IsPending | Boolean | False |
The transaction status (whether this transaction has been completed or it is still pending). | |
IsFinanceCharge | String | False |
Whether this invoice includes a finance charge. The allowed values are NotSet, IsFinanceCharge, NotFinanceCharge. The default value is NotSet. | |
Template | String | False |
Templates.Name |
A reference to a template specifying how to print the transaction. |
TemplateId | String | False |
Templates.ID |
A reference to a template specifying how to print the transaction. |
SuggestedDiscountAmount | Double | False |
A suggested discount amount for the invoice. | |
SuggestedDiscountDate | Date | False |
A suggested discount date for the invoice. | |
ExchangeRate | Double | False |
Currency exchange rate for this invoice. | |
BalanceInHomeCurrency | Double | False |
Balance remaining in units of the home currency. | |
Other | String | False |
Other data associated with the invoice. | |
CustomFields | String | False |
Custom fields returned from Reckon and formatted into XML. | |
EditSequence | String | True |
An identifier used for versioning for this copy of the object. | |
TimeModified | Datetime | True |
When the invoice was last modified. | |
TimeCreated | Datetime | True |
When the invoice was created. |
Pseudo-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. |