Table of Contents

SDK 6.1 2020 R1

Overview

We've released exciting new features and enhancements to v6.1 of the SDK that will help you get the best out of Reckon Accounts.


New Transfer request endpoint

You can now send Transfer request to Reckon Accounts to transfer funds from one account to another.

Available with the Desktop versions from Reckon Accounts 2020 R1 onwards.

Supported Request Types

  1. Add
  2. Mod
  3. Query

For detailed documentation, please visit this link and choose:

  • Max SDK version: 13
  • Format: qbXML
  • Select Message: Transfer Add/Mod/Query

Sample Payloads

Add
<?xml version="1.0"?>
<?qbxml version="6.1"?>
<QBXML>
    <QBXMLMsgsRq onError="continueOnError">
        <TransferAddRq>
            <TransferAdd>
                <TxnDate >2020-02-26</TxnDate>
                <TransferFromAccountRef>
                    <ListID >800001FD-1582685808</ListID>
                    <FullName >Suspense Account</FullName>
                </TransferFromAccountRef>
                <TransferToAccountRef>
                    <ListID >800001FE-1582685814</ListID>
                    <FullName >Bank Account</FullName>
                </TransferToAccountRef>
                <Amount >3000.00</Amount>
                <Memo >Fund transfer</Memo>
            </TransferAdd>
        </TransferAddRq>
    </QBXMLMsgsRq>
</QBXML>
Mod
<?xml version="1.0"?>
<?qbxml version="6.1"?>
<QBXML>
    <QBXMLMsgsRq onError="continueOnError">
        <TransferModRq>
            <TransferMod>
                <TxnID >FD-1582687473</TxnID>
                <EditSequence >1582687473</EditSequence>
                <TxnDate >2020-02-26</TxnDate>
                <TransferFromAccountRef>
                    <ListID >800001FD-1582685808</ListID>
                    <FullName >Suspense Account</FullName>
                </TransferFromAccountRef>
                <TransferToAccountRef>
                    <ListID >800001FE-1582685814</ListID>
                    <FullName>Bank Account</FullName>
                </TransferToAccountRef>
                <Amount >12000.00</Amount>
                <Memo >Edited Bannk Transfer 4</Memo>
            </TransferMod>
        </TransferModRq>
    </QBXMLMsgsRq>
</QBXML>
Query
<?xml version="1.0"?>
<?qbxml version="6.1"?>
<QBXML>
    <QBXMLMsgsRq onError="continueOnError">
        <TransferQueryRq />
    </QBXMLMsgsRq>
</QBXML>

Supported Account Types

Just like the UI of Reckon Accounts application, below are the supported Account types which can be used for Transfer request via Hosted API.

  1. Bank
  2. Other current asset
  3. Fixed asset
  4. Other asset
  5. Credit card
  6. Other current liability
  7. Long term liability
  8. Equity

Support for Gross Amount

You can now pass Gross amount instead of Net amount for the below transaction types.

To be able to send Gross amounts, you will need to send <IsTaxIncluded> true </IsTaxIncluded> with your payload.

<IsTaxIncluded> is optional when you post your request to the supported transaction types. In the responses from the supported transaction types, you will notice the <IsTaxIncluded> qbXML tag within the JournalEntryRet , even if you do not send this tag in your post.
Supported transaction types
  1. Journal
  2. Cheque
  3. Credit Card Charges
  4. Credit Card Credit

To be able to post Gross amount, you will need to enable Allow tax inclusive (gross) prices and costs to be entered from Edit > Preferences > Tax > Company Preferences.

Sample payload - Journal Add Request
<?xml version="1.0"?>
<?qbxml version="6.1"?>
<QBXML>
    <QBXMLMsgsRq onError="stopOnError">
        <JournalEntryAddRq requestID = "4.1.1">
            <JournalEntryAdd>
                <TxnDate>2019-08-06</TxnDate>
                <RefNumber>4.1.1</RefNumber>
                <IsAdjustment>false</IsAdjustment>

                <IsTaxIncluded>true</IsTaxIncluded>
                <JournalCreditLine>
                    <AccountRef>
                        <ListID>80000041-1210240662</ListID>
                        <FullName>Accounts Receivable</FullName>
                    </AccountRef>
                    <Amount>110.00</Amount>
                    <Memo>Accounts Receivable Credit Line</Memo>
                    <EntityRef>
                        <ListID>80000009-1210244039</ListID>
                        <FullName>ICU Investments</FullName>
                    </EntityRef>
                    <ItemSalesTaxRef>
                        <ListID>80000009-1210234750</ListID>
                        <FullName>GST</FullName>
                    </ItemSalesTaxRef>
                </JournalCreditLine>
                <JournalDebitLine>
                    <AccountRef>
                        <ListID>80000038-1210240392</ListID>
                        <FullName>Bank Cheque Account</FullName>
                    </AccountRef>
                    <Amount>110.00</Amount>
                    <Memo>CBank Cheque Account Debit Line</Memo>
                </JournalDebitLine>
            </JournalEntryAdd>
        </JournalEntryAddRq>
    </QBXMLMsgsRq>
</QBXML>


Sample Response - Journal Query Request
<?xml version=\"1.0\" ?>
<QBXML>
    <QBXMLMsgsRs>
        <JournalEntryQueryRs statusCode=\"0\" statusSeverity=\"Info\" statusMessage=\"Status OK\">
            <JournalEntryRet>
                <TxnID>2F-1585523926</TxnID>
                <TimeCreated>2020-03-30T10:18:46+11:00</TimeCreated>
                <TimeModified>2020-03-30T11:45:08+11:00</TimeModified>
                <EditSequence>1585529108</EditSequence>
                <TxnNumber>12</TxnNumber>
                <TxnDate>2020-03-30</TxnDate>
                <RefNumber>1</RefNumber>
                <IsAdjustment>false</IsAdjustment>

                <IsTaxIncluded>false</IsTaxIncluded>
            </JournalEntryRet>
        </JournalEntryQueryRs>
    </QBXMLMsgsRs>
</QBXML>


Sample Response - Check Query Request
<?xml version=\"1.0\" ?>
<QBXML>
    <QBXMLMsgsRs>
        <CheckQueryRs statusCode=\"0\" statusSeverity=\"Info\" statusMessage=\"Status OK\">
            <CheckRet>
                <TxnID>5FC-1585534299</TxnID>
                <TimeCreated>2020-03-30T02:11:39+00:00</TimeCreated>
                <TimeModified>2020-03-30T02:11:39+00:00</TimeModified>
                <EditSequence>1585534299</EditSequence>
                <TxnNumber>338</TxnNumber>
                <AccountRef>
                    <ListID>8000000B-1516597905</ListID>
                    <FullName>Bank</FullName>
                </AccountRef>
                <PayeeEntityRef>
                    <ListID>80000004-1517192278</ListID>
                    <FullName>Supplier</FullName>
                </PayeeEntityRef>
                <RefNumber>1</RefNumber>
                <TxnDate>2020-03-30</TxnDate>
                <Amount>200.00</Amount>
                <Address>
                    <Addr1>Supplier</Addr1>
                </Address>
                <AddressBlock>
                    <Addr1>Supplier</Addr1>
                </AddressBlock>
                <IsToBePrinted>false</IsToBePrinted>

                <IsTaxIncluded>false</IsTaxIncluded>
            </CheckRet>
        </CheckQueryRs>
    </QBXMLMsgsRs>
</QBXML>

Sample Response - Credit Card Charge Query
<?xml version=\"1.0\" ?>
<QBXML>
    <QBXMLMsgsRs>
        <CreditCardChargeQueryRs statusCode=\"0\" statusSeverity=\"Info\" statusMessage=\"Status OK\">
            <CreditCardChargeRet>
                <TxnID>5F9-1585534191</TxnID>
                <TimeCreated>2020-03-30T02:09:51+00:00</TimeCreated>
                <TimeModified>2020-03-30T02:09:51+00:00</TimeModified>
                <EditSequence>1585534191</EditSequence>
                <TxnNumber>337</TxnNumber>
                <AccountRef>
                    <ListID>80000022-1585534175</ListID>
                    <FullName>Credit Card</FullName>
                </AccountRef>
                <TxnDate>2020-03-30</TxnDate>
                <Amount>500.00</Amount>

                <IsTaxIncluded>false</IsTaxIncluded>
            </CreditCardChargeRet>
        </CreditCardChargeQueryRs>
    </QBXMLMsgsRs>
</QBXML>


Sample Response - Credit Card Credit Query
<?xml version=\"1.0\" ?>
<QBXML>
    <QBXMLMsgsRs>
        <CreditCardCreditQueryRs statusCode=\"0\" statusSeverity=\"Info\" statusMessage=\"Status OK\">
            <CreditCardCreditRet>
                <TxnID>5F9-1585534191</TxnID>
                <TimeCreated>2020-03-30T02:09:51+00:00</TimeCreated>
                <TimeModified>2020-03-30T02:25:16+00:00</TimeModified>
                <EditSequence>1585535116</EditSequence>
                <TxnNumber>337</TxnNumber>
                <AccountRef>
                    <ListID>80000022-1585534175</ListID>
                    <FullName>Credit Card</FullName>
                </AccountRef>
                <TxnDate>2020-03-30</TxnDate>
                <Amount>750.00</Amount>

                <IsTaxIncluded>false</IsTaxIncluded>
            </CreditCardCreditRet>
        </CreditCardCreditQueryRs>
    </QBXMLMsgsRs>
</QBXML>



If you have any questions, please get in touch with the Reckon API Support team by emailing apisupport@reckon.com.

How did we do?

SDK 6.1 2020 R2
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)