Control API (v1)

URL: https://aritma.com/general-inquiry/

The Control API automatically retrieves and reconciles transactions from banks and ERP-systems. Most banks in the nordics and a large amount of ERP-integrations are supported.

The automatic reconciliations are done with a wide variety of customizable rules that cover most reconciliation use-cases. Transactions that are not reconciled can be manually reconciled in a user-friendly UI, or via the API.

Introduction

The Control REST API is organized around setting up automatic synchronization and reconciliation of Bank- and ERP-transactions.

Our API uses resource-oriented endpoint paths, accepts Json-Encoded request bodies, returns Json-Encoded responses, and uses standard HTTP response codes and verbs.

Accounts

An account represents either a bank or ERP account. Accounts are automatically synchronized from the Open Banking- and ERP Hub APIs when a reconcile agreement is created.

Get an account.

Retrieves a bank- or ERP account.
The optional sumBalanceDate parameter can be used to get the sum of all transactions in the account older than the date.

Securityclient_credentials or code or client_credentials_dev or code_dev
Request
path Parameters
accountId
required
string <uuid>

The account id.

query Parameters
sumBalanceDate
string <date-time>

The sum balance date.

Responses
200

Returns an account response.

400

Bad request

401

Unauthorized

404

Not Found

get/api/v1/accounts/{accountId}
Request samples 
Response samples 
No sample
Get linked accounts.
Retrieves a list of bank- and ERP accounts that are in the same reconcile groups as the accountId.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
accountId
required
string <uuid> 
The account id.


 
Responses 
200
Returns a list of accounts.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/accounts/{accountId}/linked
Request samples 
Response samples 
No sample
Get account balance by date.
Retrieves the balance of the bank- and ERP for the given date.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
accountId
required
string <uuid> 
The account id.


 
date
required
string <date-time> 
The balance date.


 
Responses 
200
Returns a list of accounts.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/accounts/{accountId}/balance/{date}
Request samples 
Response samples 
No sample
Get accounts for reconcile group.
Retrieves a list of bank- and ERP accounts for the reconcileGroupId. 

The optional sumBalanceDate parameter can be used to get the sum of all transactions in the accounts older than the date.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
query Parameters
accountType
string (AccountType) 
Type of the account.


 Enum: "BankAccount" "ErpAccount"  
sumBalanceDate
string <date-time> 
The sum balance date.


 
Responses 
200
Returns a list of accounts.


400
Bad request


401
Unauthorized


get/api/v1/reconcilegroups/{reconcileGroupId}/accounts
Request samples 
Response samples 
No sample
Get accounts for company.
Retrieves a list of bank- and ERP accounts for the companyId.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
query Parameters
accountType
string (AccountType) 
Type of the account.


 Enum: "BankAccount" "ErpAccount"  
Responses 
200
Returns a list of accounts.


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/accounts
Request samples 
Response samples 
No sample
Create an account.
This endpoint should only be used if the account synchronization from bank or ERP is not sufficient.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
Request Body schema: 
The request with account details.


accountNumber
string or null
 
description
string or null
 
accountType
string (AccountType) 
 Enum: "BankAccount" "ErpAccount"  
currency
string or null
 
Responses 
201
Created


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/companies/{companyId}/accounts
Request samples 
{
  • "accountNumber": "string",
  • "description": "string",
  • "accountType": "BankAccount",
  • "currency": "string"
}
Approval
An approval represents an approved period for the reconciliations of a reconcile group.


Get approvals for reconcile group.
Retrieves a list approvals for the reconcileGroupId. 


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcilegroup id.


 
Responses 
200
Returns a list of approvals.


400
Bad request


401
Unauthorized


get/api/v1/reconcilegroups/{reconcileGroupId}/approvals
Request samples 
Response samples 
No sample
Get approvals for all reconcile groups that the current user has access to.
Retrieves a list of approvals for user. 


Securityclient_credentials or code or client_credentials_dev or code_dev 
Responses 
200
Returns a list of approvals.


401
Unauthorized


get/api/v1/reconcilegroups/approvals
Request samples 
Response samples 
No sample
Get an approval.
Retrieves an approval.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
approvalId
required
string <uuid> 
The approval id.


 
Responses 
200
Returns an approval response.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/approvals/{approvalId}
Request samples 
Response samples 
No sample
Delete an approval
Deletes an approval, and reports for approval if deleteReport is true.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
approvalId
required
string <uuid> 
The approval id.


 
query Parameters
deleteReport
boolean
Delete report for approval.


 
Responses 
202
Accepted


400
Bad Request


404
Not Found


delete/api/v1/approvals/{approvalId}
Request samples 
Response samples 
No sample
Create an approval.
Creates an approval.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
Request Body schema: 
The request with approval details.


reconcileGroupId
string <uuid> 
 
period
string or null
 
createReport
boolean
 
skipClosePeriod
boolean
Set this to true to skip closing period in erp-system


 
Responses 
201
Created


400
Bad request


401
Unauthorized


post/api/v1/approvals
Request samples 
{
  • "reconcileGroupId": "eb9397a6-1672-4c59-9568-be660d1aef38",
  • "period": "string",
  • "createReport": true,
  • "skipClosePeriod": true
}
Erp
Represents endpoints for communicating with the ERP Hub API.


Get customers and invoices in a client.
Search for customers and invoices in a client from a ERP-system


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The companyId the client is connetected to.


 
query Parameters
query
string
Name of customers or invoices


 
invoiceStartDate
string <date-time> 
Invoices from date


 
invoiceEndDate
string <date-time> 
Invoices to date


 
Responses 
200
Returns a lookup result.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/companies/{companyId}/client/lookup
Request samples 
Response samples 
No sample
Register vouchers.
Registers vouchers in the ERP-system.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
accountId
required
string <uuid> 
The account id.


 
Request Body schema: 
A collection of vouchers to be registered in the ERP-system.


accountNumber
string or null
 
autoUpdate
boolean
 
Array of objects or null (RegisterVoucherLineDto) 
 
Responses 
200
Returns a list of status responses.


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/accounts/{accountId}/transactions/vouchers
Request samples 
{
  • "accountNumber": "string",
  • "autoUpdate": true,
  • "lines": [
    ]
}
Response samples 
[
  • {
    }
]
Post voucher attachments.
Adds file attachments to a voucher in the ERP-system.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
accountId
required
string <uuid> 
The account id.


 
voucherId
required
string <uuid> 
The account id.


 
Request Body schema: multipart/form-data
files
Array of strings <binary> 
 
Responses 
200
OK, or a list of status responses if any of the vocher registrations fail.


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/accounts/{accountId}/vouchers/{voucherId}/attachments
Request samples 
Files
Import transactions from files.

Supported formats include: camt.053, camt.054, pain.001, pain.001, csv, crystal, MT940, AutoGiro, BankGirot, TBWK, Telepay, Teller,


Get the file import history for a company.
Gets the file import history for a company: a list of file import metadata.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
Responses 
200
Returns a list of file import metadata


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/files/companies/{companyId}/imports
Request samples 
Response samples 
No sample
Parse and import a file.
Parses a file to the Control API transaction format and persists the transactions.

If the preview is set to true the file parse result will not be persisted.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
query Parameters
preview
boolean
Decides if a file should be persisted. Won't persist if set to true.


 
Request Body schema: multipart/form-data
ContentType
string
 
ContentDisposition
string
 
object
 
Length
integer <int64> 
 
Name
string
 
FileName
string
 
Responses 
200
Returns a file parse result


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/files/companies/{companyId}/imports
Request samples 
Response samples 
No sample
Get file import metadata.
Gets the file import metadata and imported transactions for a previous file import.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
fileImportId
required
string <uuid> 
The file import id.


 
Responses 
200
Returns a file import


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/files/companies/{companyId}/imports/{fileImportId}
Request samples 
Response samples 
No sample
Revert file import.
Reverts a file import: removes the imported transactions, and the file import history.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
fileImportId
required
string <uuid> 
The file import id.


 
Responses 
204
No Content


400
Bad request


401
Unauthorized


404
Not Found


delete/api/v1/files/companies/{companyId}/imports/{fileImportId}/revert
Request samples 
Reconcile
Manage reconcile links and manually start reconcilliations. A reconcile link represents two collections of transactions that have matching sums.


Start a reconciliation.
Starts a reconciliation.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
Request Body schema: 
The details for the reconcile group, and when the to date for the reconciliation.


toDate
string <date-time> 
 
reconcileGroupId
string <uuid> 
 
companyId
string <uuid> 
 
reconciliationType
string (ReconciliationType) 
 Enum: "Bank" "Interim"  
Responses 
202
Accepted


400
Bad request


401
Unauthorized


post/api/v1/reconciliation/start
Request samples 
{
  • "toDate": "2019-08-24T14:15:22Z",
  • "reconcileGroupId": "eb9397a6-1672-4c59-9568-be660d1aef38",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "reconciliationType": "Bank"
}
ReconcileGroups
Manage and create reconcile groups. A reconcile group represents a group of accounts that should be reconciled against each other.


Get a reconcile group.
Retrieves a reconcile group, and the ids of accounts in the group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Responses 
200
Returns a recocncile group response.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/reconcilegroups/{reconcileGroupId}
Request samples 
Response samples 
No sample
Delete a reconcile group.
Deletes a reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Responses 
200
Success


204
No Content


400
Bad Request


401
Unauthorized


404
Not Found


delete/api/v1/reconcilegroups/{reconcileGroupId}
Request samples 
Get reconcile groups for a company.
Retrieves list of reconcile groups for a company.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
Responses 
200
A list of reconcile groups.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/companies/{companyId}/reconcilegroups
Request samples 
Response samples 
No sample
Create a reconcile group.
Creates a reconcile group for the provider accounts.

Each account requires details about its reconciliation start state.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
Request Body schema: 
The request with reconcile group and account details.


name
string or null
 
startDate
string <date-time> 
 
Array of objects or null (ReconcileAccountDto) 
 
reconciliationType
string (ReconciliationType) 
 Enum: "Bank" "Interim"  
Responses 
201
Created


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/companies/{companyId}/reconcilegroups
Request samples 
{
  • "name": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "accounts": [
    ],
  • "reconciliationType": "Bank"
}
Get reconcile groups for a company with additional details.
Retrieves list of reconcile groups for a company with additional details about the group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
Responses 
200
A list of reconcile groups with additional details.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/companies/{companyId}/reconcilegroups/detailed
Request samples 
Response samples 
No sample
Get all reconcile groups your token has access to.
Retrieves list of reconcile groups your token has access to, with additional details about the group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Responses 
200
A list of reconcile groups with additional details.


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/reconcilegroups/detailed
Request samples 
Response samples 
No sample
Check if period can be closed.
Determines a period can be closed for a reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
period
required
string
The period.


 
Responses 
200
true if period can be closed


400
Bad Request


401
Unauthorized


404
Not Found


get/api/v1/reconcilegroups/{reconcileGroupId}/period/{period}/validate
Request samples 
Report
Manage and create reports for reconcile groups.


Get a reconciliation report.
Gets a reconciliation report. Produces either a application/json or application/pdf response.

Example: for a PDF report you must specify Accept: application/pdf in the request header.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reportId
required
string <uuid> 
The report id.


 
Responses 
200
Returns a reconciliation report data response or a PDF file response


401
Unauthorized


404
Not Found


406
Not Acceptable


get/api/v1/reports/{reportId}
Request samples 
Response samples 
{
  • "reconciliationType": "Bank",
  • "header": {
    },
  • "accounts": [
    ],
  • "deposits": {
    },
  • "withdrawals": {
    },
  • "balance": {
    }
}
Delete a report.
Deletes a reconciliation report.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reportId
required
string <uuid> 
The report id.


 
Responses 
204
No Content


400
Bad Request


401
Unauthorized


404
Not Found


delete/api/v1/reports/{reportId}
Request samples 
Get a report thumbnail.
Gets the thumbnail png image of a reconciliation report.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reportId
required
string <uuid> 
The report id.


 
Responses 
200
Returns a thumbnail image for the report


400
Bad Request


401
Unauthorized


404
Not Found


get/api/v1/reports/{reportId}/thumbnail
Request samples 
Get reports for a company.
Retrieves list of reconcile reports for a company.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id.


 
Responses 
200
A list of reconcile reports


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/companies/{companyId}/reports
Request samples 
Response samples 
No sample
Get reports for a user.
Retrieves list of reconcile reports for a user.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
query Parameters
take
integer <int32> 
 Default:  10
The maximum number of reports to return (default is 10, maximum is 100).


 
Responses 
200
A list of reconcile reports


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/reports
Request samples 
Response samples 
No sample
Create a report.
Creates a reconcile report for the reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
Request Body schema: 
The request with the report creation details.


name
string or null
 
reconcileGroupId
string <uuid> 
 
fromDate
string or null <date-time> 
 
toDate
string <date-time> 
 
Responses 
201
Created


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/reports
Request samples 
{
  • "name": "string",
  • "reconcileGroupId": "eb9397a6-1672-4c59-9568-be660d1aef38",
  • "fromDate": "2019-08-24T14:15:22Z",
  • "toDate": "2019-08-24T14:15:22Z"
}
Get reports for a reconcile group.
Retrieves list of reconcile reports for a reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Responses 
200
A list of reconcile reports


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/reconcilegroups/{reconcileGroupId}/reports
Request samples 
Response samples 
No sample
Resource
Retrieve resources for extenal APIs.


Get company resources for a user.
Retrieves a list of company resorces your token has access to.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Responses 
200
Success


get/api/v1/resources/company
Request samples 
Response samples 
No sample
Rules
Manage and create rules for reconcilliation.


Get rules for a reconcile group.
Retrieves a list of reconcile rule configurations for a reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Responses 
200
Returns a list of rule configurations


400
Bad request


401
Unauthorized


get/api/v1/reconcilegroups/{reconcileGroupId}/rules
Request samples 
Response samples 
No sample
Create a rule.
Creates a reconcile rule for the reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Request Body schema: 
The request with the rule configuration.


id
string or null
 
ruleType
string or null
 
deleted
boolean
 
config
object or null
 
Responses 
201
Created


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/reconcilegroups/{reconcileGroupId}/rules
Request samples 
{
  • "id": "string",
  • "ruleType": "string",
  • "deleted": true,
  • "config": { }
}
Patch rules.
Partially updates the confiugration of multiple existing rules.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Request Body schema: 
A list of rule configurations to update.


 Array 
id
string or null
 
ruleType
string or null
 
deleted
boolean
 
config
object or null
 
Responses 
204
No Content


400
Bad request


401
Unauthorized


404
Not Found


patch/api/v1/reconcilegroups/{reconcileGroupId}/rules
Request samples 
[
  • {
    }
]
Get a rule.
Retrieves the configuration for a reconciliation rule.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
ruleId
required
string
The rule id.


 
Responses 
200
Returns a rule configuration


400
Bad request


401
Unauthorized


404
Not Found


get/api/v1/reconcilegroups/{reconcileGroupId}/rules/{ruleId}
Request samples 
Response samples 
No sample
Update a rule.
Updates the confiugration of an existing rule.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
ruleId
required
string
The rule id.


 
Request Body schema: 
The request with the rule configuration.


id
string or null
 
ruleType
string or null
 
deleted
boolean
 
config
object or null
 
Responses 
204
No Content


400
Bad request


401
Unauthorized


404
Not Found


put/api/v1/reconcilegroups/{reconcileGroupId}/rules/{ruleId}
Request samples 
{
  • "id": "string",
  • "ruleType": "string",
  • "deleted": true,
  • "config": { }
}
Delete rule.
Deletes a rule.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
ruleId
required
string
The rule id.


 
Responses 
204
No Content


400
Bad request


401
Unauthorized


404
Not Found


delete/api/v1/reconcilegroups/{reconcileGroupId}/rules/{ruleId}
Request samples 
Reset rules
Resets all rule configurations for a reconcile group to the default configuration.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Responses 
204
No Content


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/reconcilegroups/{reconcileGroupId}/rules/resetdefault
Request samples 
Transactions
Manage and create transactions.


Get open ERP transactions for a reconcile group.
Retrieves a list of open ERP transactions for a reconcile group. An open transaction is a transaction that is not reconciled.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
query Parameters
from
string <date-time> 
The from date.


 
to
string <date-time> 
The to date.


 
filterByReconcileLinkDate
boolean
 Default:  false
If true, transactions with a reconcile link that has 
            not been created between the from and to dates are included in the response.


 
Responses 
200
Returns a list of ERP transactions


400
Bad request


401
Unauthorized


get/api/v1/reconcilegroups/{reconcileGroupId}/transactions/erp/open
Request samples 
Response samples 
No sample
Get open Bank transactions for a reconcile group.
Retrieves a list of open Bank transactions for a reconcile group. An open transaction is a transaction that is not reconciled.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
query Parameters
from
string <date-time> 
The from date.


 
to
string <date-time> 
The to date.


 
filterByReconcileLinkDate
boolean
 Default:  false
If true, transactions with a reconcile link that has 
            not been created between the from and to dates are included in the response.


 
Responses 
200
Returns a list of Bank transactions


400
Bad request


401
Unauthorized


get/api/v1/reconcilegroups/{reconcileGroupId}/transactions/bank/open
Request samples 
Response samples 
No sample
Get reconciled ERP transactions for a reconcile group.
Retrieves a list of reconciled ERP transactions for a reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
query Parameters
from
string <date-time> 
The from date.


 
to
string <date-time> 
The to date.


 
Responses 
200
Returns a list of ERP transactions


400
Bad request


401
Unauthorized


get/api/v1/reconcilegroups/{reconcileGroupId}/transactions/erp/reconciled
Request samples 
Response samples 
No sample
Get reconciled Bank transactions for a reconcile group.
Retrieves a list of reconciled Bank transactions for a reconcile group.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
query Parameters
from
string <date-time> 
The from date.


 
to
string <date-time> 
The to date.


 
Responses 
200
Returns a list of Bank transactions


400
Bad request


401
Unauthorized


get/api/v1/reconcilegroups/{reconcileGroupId}/transactions/bank/reconciled
Request samples 
Response samples 
No sample
Get transactions in reconcile link.
Retrieves a transactions in a reconcile link.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileLinkId
required
string <uuid> 
The reconcile link id.


 
Responses 
200
A list of Bank transactions and a list of ERP transactions


400
Bad request


401
Unauthorized


get/api/v1/reconcilelinks/{reconcileLinkId}/transactions
Request samples 
Response samples 
No sample
Add a note to a transaction.
Adds a note to a transaction.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
transactionId
required
string <uuid> 
The transaction id.


 
Request Body schema: 
The note.


note
string or null
 
Responses 
200
Successful Response


400
Bad request


401
Unauthorized


put/api/v1/transactions/{transactionId}/note
Request samples 
{
  • "note": "string"
}
Add open ERP transactions.
Adds open ERP transactions to an account.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
accountId
required
string <uuid> 
The account id.


 
Request Body schema: 
A list of ERP transactions.


 Array 
id
string <uuid> 
 
accountId
string or null <uuid> 
 
accountNumber
string or null
 
amount
number <double> 
 
voucherNumber
string or null
 
companyId
string <uuid> 
 
currency
string or null
 
description
string or null
 
note
string or null
 
name
string or null
 
reconcileLinkId
string or null <uuid> 
 
chainLinkId
string or null <uuid> 
 
type
string (TransactionType) 
 Enum: "Default" "StartTransaction" "ChainLink" "Voucher" "ManualTransaction"  
bookingDate
string or null <date-time> 
 
period
string or null
 
postingDate
string or null <date-time> 
 
createdDate
string <date-time> 
 
Responses 
200
Successful Response


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/accounts/{accountId}/transactions/erp/open
Request samples 
[
  • {
    }
]
Add open Bank transactions.
Adds open Bank transactions to an account.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
accountId
required
string <uuid> 
The account id.


 
Request Body schema: 
A list of Bank transactions.


 Array 
id
string <uuid> 
 
accountId
string or null <uuid> 
 
accountNumber
string or null
 
amount
number <double> 
 
archiveReference
string or null
 
companyId
string <uuid> 
 
currency
string or null
 
name
string or null
 
description
string or null
 
note
string or null
 
reconcileLinkId
string or null <uuid> 
 
chainLinkId
string or null <uuid> 
 
type
string (TransactionType) 
 Enum: "Default" "StartTransaction" "ChainLink" "Voucher" "ManualTransaction"  
bookingDate
string or null <date-time> 
 
postingDate
string or null <date-time> 
 
createdDate
string <date-time> 
 
Responses 
200
Successful Response


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/accounts/{accountId}/transactions/bank/open
Request samples 
[
  • {
    }
]
Create a chain link.
Creates a chain link by bundling together lists of transactions.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
reconcileGroupId
required
string <uuid> 
The reconcile group id.


 
Request Body schema: 
The request containing ids of erp and bank transactions.


bankTransactionIds
Array of strings or null <uuid> 
 
erpTransactionIds
Array of strings or null <uuid> 
 
Responses 
201
Created


400
Bad request


401
Unauthorized


404
Not Found


post/api/v1/reconcilegroups/{reconcileGroupId}/transactions/chain
Request samples 
{
  • "bankTransactionIds": [
    ],
  • "erpTransactionIds": [
    ]
}
Delete a transaction.
Deletes a transaction.


Securityclient_credentials or code or client_credentials_dev or code_dev 
Request 
path Parameters
transactionId
required
string <uuid> 
The transaction id.


 
Responses 
204
No Content


400
Bad request


401
Unauthorized


404
Not Found


delete/api/v1/transactions/{transactionId}
Request samples