API Best Practices - Importing journal transactions

This article is part of this article series: API Best Practices - Introduction

Good to know: Please find the complete description of journal transactions here: https://accounting.twinfield.com/webservices/documentation/#/ApiReference/Transactions/JournalTransactions

Good to know: There are five transaction type categories. These are sales, purchase, bank, cashbook, and journal. This article will only explain how to import journal transactions.

In this article, we'll explain how you can import journal transactions to Twinfield. We ask you to follow this best practice because it supports our Fair Use Policy. You can read about our Fair Use Policy here: https://accounting.twinfield.com/webservices/documentation/#/GettingStarted/FUP

Good to know: There is a Postman collection in the attachment of this article with ready-to-use examples of the steps that are mentioned in this article.

The process of importing journal transactions has two steps:

1. Find the available transaction types
2. Import the new journal transaction into Twinfield

Find the available transaction types

To make sure that you are sending the journal transactions to the correct transaction type in Twinfield you can request the available transaction types first. To request the available transaction types you can use the Postman collection in the attachment of this article, specifically the request ‘Find the available transaction types’.

In this request, a few choices have to be made to request data from Twinfield and there are best practices to be followed:

Important: Please follow the best practices below while finding the available journal transaction types.

1. Limit the number of transaction types to 25 at a time. You can use the firstRow and maxRows parameters for this.



2. Only request the transaction types that are of the category journal. 


 

Import new journal transactions

To import new journal transactions into Twinfield you can use the Postman collection in the attachment of this article. You can use the request named ‘Import new journal transactions’.

Important: Please follow the best practices below while importing new journal transactions.

1. Limit the number of transactions to 25. You can insert multiple <transaction> blocks into <transactions>.



2. Limit a journal transaction to a maximum of 500 detail lines.



3. It's recommended to import transactions directly as final. The reasoning behind this to prevent differences between your software and Twinfield. 



4. The attribute ‘raisewarning’ is deliberately set to ‘false’ to make sure that data from your software is leading and Twinfield will not interfere.