Table of Contents

Hosted API - 22 June 2021

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.

Support for Gross Amount

8 Nov 2021 update:
A fix is now available. Learn more from this help article.

14 July 2021 update:
We've identified an issue where the custom value of the Rate object of an Item gets overwritten with the default value if you do not pass the <IsTaxIncluded> qbXML tag.

The current workarounds for this issue are as follows:
1. Include the <IsTaxIncluded> tag in the QBXML request with the value set to true or false as appropriate; Or
2. In Reckon Accounts navigate to the Edit > Preferences menu item and select the Tax option. In the Sales figures section, choose the Net (Exclusive of GST) option; Or
3. In Reckon Accounts navigate to the Edit > Preferences menu item and select the Tax option. Unselect the Allow tax inclusive (gross) prices and cost to be entered checkbox.

A fix for this issue is currently being investigated.

You can now pass Gross amount instead of Net amount for the below transaction types, in addition to the other transaction types that were added in SDK 6.1 2020 R1.

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 transaction 'Ret' aggregate, for example, for Invoice queries, within the <InvoiceRet>, even if you do not send this tag in your post. Please ensure that your app is able to handle the extra object in the response.

Supported transaction types

  1. Invoice
    1. Add
    2. Modify
    3. Query
  2. Sales Order
    1. Add
    2. Modify
    3. Query
  3. Sales Receipt
    1. Add
    2. Modify
    3. Query
  4. Credit Memo
    1. Add
    2. Modify
    3. Query
  5. Estimate
    1. Add
    2. Modify
    3. Query
  6. Bill
    1. Add
    2. Modify
    3. Query
  7. Purchase Order
    1. Add
    2. Modify
    3. Query
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

Invoice Add Request
<IsTaxIncluded>true</IsTaxIncluded> is included in the payload to tag the amount as Gross.
<?xml version="1.0"?>
<?qbxml version="6.1"?>
<QBXML>
    <QBXMLMsgsRq onError="stopOnError">
        <InvoiceAddRq requestID="1.1.1">
            <InvoiceAdd>
                <CustomerRef>
		            <FullName>Customer</FullName>
                </CustomerRef>
                <TxnDate>2021-02-09</TxnDate>
                <RefNumber>1.1.1</RefNumber>
                <Memo>1.1.1</Memo>
                <IsTaxIncluded>true</IsTaxIncluded>
                <InvoiceLineAdd>
                    <ItemRef>
		                <FullName>Item1</FullName>
                    </ItemRef>
                    <Quantity>1</Quantity>
                    <Amount>22.00</Amount>
                    <TaxAmount>2.00</TaxAmount>
		            <SalesTaxCodeRef>
			            <FullName>GST</FullName>
		            </SalesTaxCodeRef>
                </InvoiceLineAdd>
                <InvoiceLineAdd>
                    <ItemRef>
		                <FullName>Item2</FullName>
                    </ItemRef>
                    <Quantity>1</Quantity>
                    <Amount>22.00</Amount>
                    <TaxAmount>2.00</TaxAmount>
		            <SalesTaxCodeRef>
			            <FullName>GST</FullName>
		            </SalesTaxCodeRef>
                </InvoiceLineAdd>
            </InvoiceAdd>
        </InvoiceAddRq>
    </QBXMLMsgsRq>
</QBXML>

Invoice Modify Request
<IsTaxIncluded>true</IsTaxIncluded> is included in the payload to tag the amount as Gross.
<?xml version="1.0"?>
<?qbxml version="6.1"?>
<QBXML>
    <QBXMLMsgsRq onError="stopOnError">
        <InvoiceModRq requestID="1.2.1">
            <InvoiceMod>
                <CustomerRef>
                   <FullName>Customer</FullName>           
                </CustomerRef>
                <TxnDate>2021-02-09</TxnDate>
                <RefNumber>1.2.1</RefNumber>
                <Memo>1.2.1</Memo>
                <IsTaxIncluded>1</IsTaxIncluded> <!-- Value
changed from true to 1. Value can be 1/true or 0/false  -->

                <InvoiceLineMod>
                    <ItemRef>		                
                    </ItemRef>
                    <Quantity>1</Quantity>
                    <Amount>22.00</Amount>
                    <TaxAmount>2.00</TaxAmount>
		            <SalesTaxCodeRef>
            <FullName>GST</FullName>
		            </SalesTaxCodeRef>
                </InvoiceLineMod>
            </InvoiceMod>
        </InvoiceModRq>
    </QBXMLMsgsRq>
</QBXML>

Invoice Query Response
<IsTaxIncluded>true</IsTaxIncluded> is included in the payload to tag the amount as Gross.
<?xml version="1.0" ?>
<QBXML>
   <QBXMLMsgsRs>
      <InvoiceQueryRs requestID="1.3.1" statusCode="0" statusSeverity="Info" statusMessage="Status OK">
         <InvoiceRet>
            <TxnID>A-1612931342</TxnID>
            <TimeCreated>2021-02-10T04:29:02+00:00</TimeCreated>
            <TimeModified>2021-02-10T04:29:02+00:00</TimeModified>
            <EditSequence>1612931342</EditSequence>
            <TxnNumber>4</TxnNumber>
            <CustomerRef>
               <ListID>80000002-1612843508</ListID>
               <FullName>Customer</FullName>
            </CustomerRef>
            <ARAccountRef>
               <ListID>80000008-1612840420</ListID>
               <FullName>Accounts Receivable</FullName>
            </ARAccountRef>
            <TemplateRef>
               <ListID>80000002-1612836432</ListID>
               <FullName>Reckon Product Invoice</FullName>
            </TemplateRef>
            <TxnDate>2021-02-09</TxnDate>
            <RefNumber>1.1.1</RefNumber>
            <IsPending>false</IsPending>
            <IsFinanceCharge>false</IsFinanceCharge>
            <DueDate>2021-02-09</DueDate>
            <ShipDate>2021-02-09</ShipDate>
            <Subtotal>40.00</Subtotal>
            <SalesTaxPercentage>10.00</SalesTaxPercentage>
            <SalesTaxTotal>4.00</SalesTaxTotal>
            <AppliedAmount>0.00</AppliedAmount>
            <BalanceRemaining>44.00</BalanceRemaining>
            <Memo>1.1.1</Memo>
            <IsPaid>false</IsPaid>
            <IsToBePrinted>true</IsToBePrinted>
            <IsToBeEmailed>false</IsToBeEmailed>
            <IsTaxIncluded>true</IsTaxIncluded>
         </InvoiceRet>
      </InvoiceQueryRs>
   </QBXMLMsgsRs>
</QBXML>

Resolved SDK Bug

  • You could not import Purchase Order if it contained Tax Code info of an item. You can now post Purchase Order with Tax Code in your payload.

How did we do?

Hosted API - 22 March 2022

Hosted API - 23 June 2020

Related Articles

Hosted API - 23 June 2020
Hosted API - 22 March 2022
Hosted API - 20 April 2020
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)