Journals

Supported Endpoints and Methods
Sample

Supported Endpoints and Methods

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

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	Journals	/journalId	GET	https://api.reckon.com/R1/{BOOKID}/journals	Retrieve a specific journal using its unique ID	Portal	AU/NZ/UK
Core	Journals		GET	https://api.reckon.com/R1/{BOOKID}/journals	Retrieve the list of journals	Portal	AU/NZ/UK
Core	Journals		PUT	https://api.reckon.com/R1/{BOOKID}/journals	Update a journal	Portal	AU/NZ/UK
Core	Journals		POST	https://api.reckon.com/R1/{BOOKID}/journals	Create a journal	Portal	AU/NZ/UK
Core	Journals	/journalId	DELETE	https://api.reckon.com/R1/{BOOKID}/journals	Delete a specific journal	Portal	AU/NZ/UK

Sample

Sample GET response

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

Method: GET

[
{
 "AdjustingJournal":false,
 "AmountTaxStatus":1,
 "CashbookId":"ac5c6282-6ec2-4e32-85d3-141faa7418dc",
 "FullDescription":null, 
 "JournalDate":"2015-11-03T00:00:00+00:00",
 "JournalId":"55200fca-8a9c-43f9-a505-d0b47448ef7b",
 "JournalNumber":"00005",
 "JournalStatus":2,
 "JournalType":0,
 "JournalTypeRefId":"00000000-0000-0000-0000-000000000000", 
 "ReversedJournalId":"00000000-0000-0000-0000-000000000000",
 "Summary":"Simon_Test",
 "Transactions":
 [
  {
   "AccountingCategoryId":"fe19d6c0-2a71-410d-839a-3a45677f3edd",
   "Billable":false, 
   "ContactId":"00000000-0000-0000-0000-000000000000",
   "Credit":null,
   "Debit":0.0000,
   "IsReconciled":false,
   "JournalEntryId":"4e72a990-0a9f-42f3-a5bc-ef88afa6056d", 
   "JournalId":"55200fca-8a9c-43f9-a505-d0b47448ef7b",
   "Narration":null, 
   "ProjectId":"00000000-0000-0000-0000-000000000000",
   "TaxAmount":null, 
   "TaxGroupId":"00000000-0000-0000-0000-000000000000",
   "TaxModified":false,"TransType":0
  },
  {
   "AccountingCategoryId":"fe19d6c0-2a71-410d-839a-3a45677f3edd",
   "Billable":false,
   "ContactId":"00000000-0000-0000-0000-000000000000",
   "Credit":null,
   "Debit":0.0000, 
   "IsReconciled":false,
   "JournalEntryId":"b91b9d25-247a-4df2-b4ba-9f1aac9fbc53", 
   "JournalId":"55200fca-8a9c-43f9-a505-d0b47448ef7b",
   "Narration":null,"ProjectId":"00000000-0000-0000-0000-000000000000",
   "TaxAmount":null,
   "TaxGroupId":"00000000-0000-0000-0000-000000000000",
   "TaxModified":false,
   "TransType":0
  }
 ]
}
]

Sample post

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

Method: POST

{
"AmountTaxStatus":1,
"JournalStatus":2,
"JournalNumber":"66163",
"Summary":"Simon_Test",
"JournalDate":"11/03/2015",
"Transactions": 
 [
  {
    "AccountingCategoryId":"66AB5A2E-4BB5-41F9-AE90-F27911A3B7CD",
     "Debit":0.00
  },
  {
    "AccountingCategoryId":"66AB5A2E-4BB5-41F9-AE90-F27911A3B7CD",
    "Debit":0.00}
 ]
}

Sample minimum post

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

Method: POST

The below example payload will create a journal with $12 in both credit and debit for the same chart of account, set the amount to be Gross (Tax inclusive):

 {
     "AmountTaxStatus": 2,
     "JournalDate": "2018-12-13T00:00:00+00:00",
     "JournalStatus": 2,
     "Summary": "Expense Journal",
     "Transactions": 
       [
         {
             "AccountingCategoryId": "0682e269-ef88-4dd5-958f-76d7ea166cdc",
             "Credit": 12
         },
         {
             "AccountingCategoryId": "0682e269-ef88-4dd5-958f-76d7ea166cdc",
             "Debit": 12
         }
       ]
 }

Details of each object

Data Field	Description	Data Type	Mandatory?
AdjustingJournal	Whether the journal is adjusting or not	Boolean (True/False)	No
AmountTaxStatus	Whether the amounts on the journal include tax or not	Set data types: 0 - [currently not utilised] 1 - Non-Taxed 2 - Inclusive 3 - Exclusive	Yes
CashBookID	Unique ID of the Reckon One book (file)	GUID	No
FullDescription	Description entered for the journal	Alphanumeric	No
JournalDate	Date of the journal	UTC	Yes
JournalID	Unique ID of the journal within the Reckon One book (file)	GUID
JournalNumber	Number of the journal	Alphanumeric
JournalStatus	Whether the journal is posted or reversed. Note: A reversed journal is a posted journal that has been reversed in the UI. Therefore you should NOT create (Post) a REVERSED journal unless it relates to an existing POSTED journal. We would recommend NOT using reversed journals - just understand what status 3 relates to in your Get.	Set data types: 0 – Unknown [internal use only] 1 – Draft [currently not utilised] 2 – Posted 3 – Reversed	Yes
JournalType	Type of the journal (General, Bank Opening Balance or Money Transfers	Set data types: 0 – General 1 – Bank Opening Balance 2 – Money Transfers
JournalTypeRefId			No
ReversedJournalID	ID of the general which is reversed by this journal	GUID	No
Summary	Summary of the journal entered by the user	Alphanumeric	Yes
Transactions Array	Contains the individual line transactions for the journal		Yes
AccountingCategoryID	The Unique ID (from Chart of Accounts endpoint) of the account being used on that line. If you are intending to use a Bank account in a journal, use the Id that you GET from Chart of Accounts endpoint, NOT from Bank accounts endpoint as the IDs received from Bank Account endpoint are used for the specific type of transactions only (example: Bank transfers).	GUID	Yes
Billable	Whether the transaction line is billable or not	Boolean (True/False)	No
ContactID	The Unique ID of the contact being used on that line	GUID	No
Credit	The amount being credited on that line	Numeric	Yes
Debit	The amount being debited on that line	Numeric	Yes
IsReconciled	NOT in use anymore and is replaced by ReconciliationStatus (see the next one)	Boolean (True/False)	No
ReconciliationStatus	Sets the Cleared or Uncleared status of the transaction (applies only if a bank account is used in the Journal)	Set Status types: 0 - Uncleared 1 - Cleared	No. By default it is 0 if the value isn't passed
JournalEntryId	The unique GUID assigned to that entry on the journal	GUID	No
Narration	The narration entered for that line transaction on the journal	Alphanumeric	No
Project ID	The unique GUID of the project assigned to that entry on the journal	GUID	No
TaxAmount	The amount of tax assigned to that line in the journal	Numeric	No
TaxGroupID	The unique id of the tax code assigned to that line in the journal	GUID	No
TaxModified	Whether the tax has been modified from the books calculation	Boolean (True/False)	No
TransType	The type of transaction that the journal line entry is	Set data types: 0- NotSet 1- Sale 2- Purchase 3- Transfer	No

Table of Contents