Book demo
DataCollect Documentation 1.0
About this document – Click here
Contact information – Click here
About this document
This document provides a complete overview of the DataCollect API and how data can be integrated into Verarca.
It offers guidelines for getting started with data loading and how this process should be followed.
It is important that you read the entire document and send any questions in advance to rene@verarca.com before starting the integration.
Contact information
Contact the following addresses if you have any questions:
Technical support: rene@verarca.com
Other enquiries: contact@verarca.com
Introduction
The first integration with our API is done via an account on Verarca.com. To gain access to a test account, please contact rene@verarca.com.
The DataCollect API consists of two environments: staging and production, available through the following endpoints:
Staging: https://staging.datacollect.verarca.com/swagger
Production: https://datacollect.verarca.com/swagger
Both environments run various security checks to ensure stability. One of these is rate limiting. If you experience issues, please contact technical support.
The API uses versioning. It is strongly recommended to use the versioned endpoints to minimise disruptions. The version is visible in the Swagger documentation.
The following chapters describe the workflow for uploading data into DataCollect in specific data regions.
Book-keeping
The basic data in Verarca consists of ERP/accounting data used to calculate CO2 based on various purchases/invoices.
The following workflow must always be followed:
1. The customer receives a token from Verarca.com.
2. The customer enters this token or passes it on to the client application (integration partner).
3. When entering the token in the client application, the application must submit a complete chart of accounts.
4. Once the chart of accounts has been submitted to DataCollect, the customer must tick the relevant accounts in Verarca.com.
– This ensures that only CO2-related data is processed.
5. On a daily basis, the client application must submit the following data to DataCollect:
-
- Retrieve which accounts are ticked in Verarca.com. Endpoint: /api/Accounts/Enabled
- Create/update chart of accounts: /api/Accounts
- Create/update bookings: /api/AccountEntries
- Link/upload documents to bookings: /api/Documents
During the first synchronisation, data from the current year + previous year must always be submitted. Daily submissions must include all updates/new data.
When submitting bookings, the type of booking must be specified via the “type” parameter. DataCollect supports the following formats:
Supplier = Invoice from a supplier
Payment = Payment to a supplier
Credit = Credit note from a supplier
Error handling
If issues occur with the DataCollect API, the API will return a JSON result such as the one below:
If you have questions, please contact technical support and include the errorId for faster handling.
Change history
| Date | Changes | Type |
