Table of Contents

Receipts (Receive Money) API v1

Overview

Reckon One API v2 is now available.
Receipts API v2 endpoints provides you with more information about your Receipts.

The Receipts endpoint can be found at:  https://api.reckon.com/R1/{BOOKID}/receipts

Methods supported:   GET, PUT, POST, DELETE

The Book ID represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401

Reckon One Module

Endpoint

Additional Parameter(s)

HTTP Method

Request URL

Description

API Portal

Countries

Core

Receipts

/receipts

GET

https://api.reckon.com/R1/{BOOKID}/receipts

Retrieve a list of receipts (money in)

Portal

AU/NZ/UK

Core

Receipts

/receipts

POST

https://api.reckon.com/R1/{BOOKID}/receipts

Create a receipt (money in)

Portal

AU/NZ/UK

Core

Receipts

/receiptId

PUT

https://api.reckon.com/R1/{BOOKID}/receipts

Allocate a receipt (money in) to an invoice

Portal

AU/NZ/UK

Core

Receipts

/receiptId

DELETE

https://api.reckon.com/R1/{BOOKID}/receipts

Deletes a receipt

Portal

AU/NZ/UK

 

Sample

 

Sample GET Response

Endpoint: https://api.reckon.com/R1/{BOOKID}/receipts

Method: GET

{
"Id":"0013ade2-80df-4fed-bac2-7fc1c43790d0", 
"CashbookId":"e17417ac-fc79-4d4d-9ee8-1780b3bc326f",
"BankAccountId":"00feb5c9-6da3-4603-87d8-d1ee7d6de894",
"Amount":11.0000,
"ContactName":"Desc_AE94D6FA-2BD82002-49BF-874F-48720B990E87",
"Details":"abc",
"PaymentMethodType":1,
"PaymentMethodName":"Cash",
"IsReconciled":true,
"Reference":"def",
"TransDate":"2016-08-25T00:00:00+00:00"
}

 

Sample POST

Endpoint: https://api.reckon.com/R1/{BOOKID}/receipts

Method: POST

     {
       'TransDate': '10/10/2015',
       'BankAccountId': '5b3a4f48-beb0-4e23-bf2f-2d7127239a00',
       'Amount': 100,
       'ContactId': '519403ea-bd33-4b7c-b71a-cd32b8fbe2c8',
       'AllocateFullAmount': false,
       'PaymentMethodId': '057ecf9c-b966-4fe5-93e5-edc8812344b3',
       'Details': 'abc',
       'Reference': 'def',
       'IsReconciled': true,
       'Narration': 'qqq',
       'Allocations': [ ],
       'AllocationSplit': [
         {
           'ProjectId': '24879c21-8e1f-4f50-b1a0-bb01d3447b7b',
           'ChargeableItemId': 'af848ea8-cfdb-4768-a6f9-c916a873985f',
           'LineNo': 1,
           'Description': null,
           'Quantity': 0,
           'UnitPriceExTax': 10,
           'UnitPriceTax': 1,
           'UnitPricePrecision': 2,
           'DiscountAmountExTax': null,
           'DiscountAmountTax': null,
           'DiscountAccuracy': null,
           'DiscountPercent': null,
           'TaxGroupId': 'fae4ba18-20db-4b35-a944-711f7c3273bb',
           'TaxIsModified': false,
           'AmountExTax': 10,
           'Amount': 0,
           'TaxAmount': 1,
           'AmountAccuracy': null,
           'InvoiceDiscountedAmountExTax': null,
           'InvoiceDiscountedTaxAmount': null,
           'HasDataForPosting': true,
           'IsSubTotal': false,
           'IsParent': false
         }
       ]
     }

Sample minimum POST

Endpoint: https://api.reckon.com/R1/{BOOKID}/receipts

Method: POST

The below example will create a new Receive Money transaction with an item called Chocolate Nutella, including 1 quantity and use tax code GST:

 {
   "TransDate": "12/17/2018",
   "BankAccountId": "4cd7c12f-1931-4938-a739-1fe758fbd633",
   "Amount": 11,
   "ContactId": "bf6c5017-3c3f-46bf-b8a8-af6eb31f9d98",
   "AllocateFullAmount": true,
   "AllocationSplit": 
   [
    {
     "ChargeableItemId": "53f23ccc-36e8-428c-b506-ca030df1f6ff",
     "LineNo": 1,
     "Quantity": 1,
     "TaxGroupId": "0933b89e-0a9a-4d41-8c5b-1ec21509bfb5",
     "AmountExTax": 10,
     "TaxAmount": 1,
     "HasDataForPosting": true
    }
   ]
 }

Sample PUT

Endpoint: https://api.reckon.com/R1/{BOOKID}/receipts/{id}

Methods supported:  PUT

Allocate the TOTAL amount to an invoice or bill

{
     "TransDate": "2017-11-27",
     "BankAccountId": "f05d775a-5ace-48bd-8223-2635f0e08161",
     "Amount": 1000,
     "ContactId": "97cffe31-f8a5-49b4-bb6b-501309f4a815",
     "AllocateFullAmount": false,
     "PaymentMethodId": "00000000-0000-0000-0000-000000000000",
     "Details": "details",
     "Reference": "reference",
     "IsReconciled": false,
     "Narration": "narration",
     "AccountsReceivableCategoryId": "1081463b-47f6-45a7-af51-815f1f0bf993",
     "Allocations": [{
         "AllocationAmount": 1000,
         "AllocationTypeId": 1,
         "RefId": "77aa026d-f731-4135-b40d-7f749de9f211"
       }],
     "AllocationSplit":[]
 }

Allocate a PARTIAL amount to an invoice or bill

{
   "AllocateFullAmount": false,
   "AllocationSplit": [
     {
       "AccountId": "00000000-0000-0000-0000-000000000000",
       "Amount": 0,
       "AmountAccuracy": null,
       "AmountExTax": 10,
       "ChargeableItemId": "af848ea8-cfdb-4768-a6f9-c916a873985f",
       "Description": null,
       "DiscountAccuracy": null,
       "DiscountAmountExTax": null,
       "DiscountAmountTax": null,
       "DiscountPercent": null,
       "HasDataForPosting": false,
       "InvoiceDiscountedAmountExTax": null,
       "InvoiceDiscountedTaxAmount": null,
       "IsParent": false,
       "IsSubTotal": false,
       "LineNo": 1,
       "ProjectId": "24879c21-8e1f-4f50-b1a0-bb01d3447b7b",
       "Quantity": 0,
       "TaxAmount": 1,
       "TaxGroupId": "fae4ba18-20db-4b35-a944-711f7c3273bb",
       "TaxIsModified": false,
       "UnitPriceExTax": 10,
       "UnitPricePrecision": 2,
       "UnitPriceTax": 1
     }
   ],
   "Allocations": [
     {
       "AllocationAmount": 11,
       "AllocationType": "Invoice",
       "AllocationTypeId": 1,
       "RefId": "5aa063b7-50d8-49cc-ac57-6ed8e775daf4"
     }
   ],
   "Amount": 100,
   "BankAccountId": "5b3a4f48-beb0-4e23-bf2f-2d7127239a00",
   "ContactId": "519403ea-bd33-4b7c-b71a-cd32b8fbe2c8",
   "Details": "Receipt ABC123",
   "Id": "c3ea5df1-7ff9-42dd-8dae-7b84561d3867",
   "IsReconciled": true,
   "Narration": "Allocate a Receipt",
   "PaymentMethodId": "057ecf9c-b966-4fe5-93e5-edc8812344b3",
   "Reference": "ABC123",
   "TransDate": "10/10/2015"
 }

Sample DELETE

Endpoint: https://api.reckon.com/R1/{BOOKID}/receipts/{id}

Methods supported:  DELETE

Details of each object  

Data Field

Description

Data Type

Mandatory?

TransDate

The transaction date for the receipt

Date/Time

Yes

BankAccountID

The GUID of the bank account to be associated with the receipt

GUID

Yes

Amount

The amount of the receipt to be posted

Numeric

Yes

ContactID

The id of the contact to be associated with the receipt

GUID

Yes

AllocateFullAmount

Whether the full amount is to be allocated to another transaction

Boolean  - true false

Yes

PaymentMethodID

The GUID of the payment method to be used with the transaction

GUID

No

Details

The description for the receipt

Alphanumeric

No

Reference

The reference for the transaction

Alphanumeric

No

Narration

The narration for the transaction

Alphanumeric

No

Allocations Array

Where the transaction should be allocated if it is to be associated with a transaction

Array

Depends if you're allocating to an invoice or just creating a new transaction

AllocationSplit Array

If the transaction is not to be associated with a previous transaction, how the amount should be allocated in the book

Array

Depends if you're allocating to an invoice or just creating a new transaction

ProjectID

If the transaction should be allocated to a project, the GUID of the project.

GUID

No

ChargeableItemId

If the transaction should be allocated to an item, the GUID of the item

GUID

Either ChargeableItemId or AccountId is required

AccountId

If the transaction should be allocated to a Chart of Account, the GUID of the account

GUID

Either ChargeableItemId or AccountId is required

LineNo

The line number in the transaction. Each line requires a separate entry in the AllocationSplit array

Numeric

No

Description

The description for the line in the transaction

Alphanumeric

No

Quantity

The quantity to be associated with the line

Numeric

No

UnitPriceExTax

The unit price to be allocated to the line without tax included

Numeric

No

UnitPriceTax

The tax amount to be allocated to the line

Numeric

No

UnitPricePrecision

The number of decimal places the tax should be calculated on up to 8.  is important for tax calcs by default will set to 2.0

Numeric

No

DiscountAmountExTax

The amount of the line with a discount applied minus tax

Numeric

No

DiscountAmountTax

The amount of tax for the line with a discount applied

Numeric

No

DiscountPercent

If a discount is to be applied via percentage, the percentage the discount should be

Numeric

No

TaxGroupId

The GUID of the tax code to be applied to the line in the transaction

GUID

No

TaxIsModified

If its false, your tax calculations will be compared against the Reckon One tax engine and if it does not match the transaction is blocked. If set to true, the engine is not checked and you can post any tax you desire. The UI also controls this function via SETTINGS for the same purpose.

Boolean - True/False

No

AutoCalcTax

Allows Reckon to calculate the tax. You send the net amounts to us including "autocalctax": true and a TaxGroupId in the payload, and our tax engine figures out what the tax should be. It also means that by using that you are always complying with and using the R1 tax engine. ** Was not available in early API versions.

Boolean: true/false

No

AmountExTax

The amount of the line without tax

Numeric

Yes

Amount

The amount of the line including tax

Numeric

No

TaxAmount

The amount of tax for the line

Numeric

Yes

AmountAccuracy

How many decimal points are associated with the amount for the total transaction up to 8. Is 2 by default and can be posted as null.

Numeric

No

InvoiceDiscountedAmountExTax

Always null

 

No

InvoiceDiscountedTaxAmount

Always null

 

No

HasDataForPosting

If not set to true this will post as a non-posting transaction which cannot be currently changed in the UI. ** POST AS TRUE.

Boolean - True/False

No

IsSubtotal

Whether this line is a subtotal

Boolean - True/False

No

IsParent

Whether this line is the parent of a group of other lines

Boolean - True/False

No

AccountsReceivableCategoryId

Accounts Receivable account's ID. You can get it either via GET Chart of Accounts or by going to Chart of Accounts > Assets within Reckon One webapp

GUID

No

 

How did we do?

Payments (Make Payment)

Estimates

Related Articles

Receipts API v2
Reckon One: Receive Money
Classifications API v1
Powered by HelpDocs (opens in a new tab)

Powered by HelpDocs (opens in a new tab)