Commerce API (v1)

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

The Commerce API automatically retrieves data from the settlement companies, and uses this to book card transactions, fees and returns in the customer's financial system. For online shop payments, we use reference numbers obtained from the settlement company to close and open entries in the ledger.

The solution can be described as "set it and forget it". When the integration is set up and ready, everything will take place in the background, and you will not have to spend unnecessary time and resources on manual reconciliation routines.

Introduction

The Commerce REST API is organized around retrieving settlement transactions from a large number of settlement providers, and booking them to any of our integrated accounting systems.

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

Agreements

An agreement represents a many-to-one relationship between your company/companies, and your ERP system credentials(e.g.access tokens). If your company manages multiple clients, you should create an agreement that connects them to ERP credentials that have access to the respective clients in your ERP system.
Example

An accountant has three clients in Visma.net that want to use Aritma Commerce. They have created an integration account in Visma.net(e.g.integration @accountant.com), and given it access to the three clients. To onboard the clients in the Settlement API, they should create an agreement for integration @accountant.com.Under that agreement, they may create one parent company representing themselves, or one company per client if they wish to keep transactions, settlement connections, and accounting rules seperate.

Get all agreements under a resource group

Retrieves all agreements under a resource group.

Securityimplicit or client_credentials or implicit_dev or client_credentials_dev
Request
query Parameters
resourceGroupId
string <uuid>

Resource group Id

pageNumber
integer <int32>
Default: 1

The page number

pageSize
integer <int32>
Default: 100

Amount of items on each page

Responses
200

Returns a list of available Agreements

400

Bad request

401

Unauthorized

get/api/v1/agreements
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Create an Agreement
Creates a new Agreement under a resourcegroup.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
Request Body schema: 
An object with resourceGroupId and name of the new agreement


resourceGroupId
string <uuid> 
Resource group id used in role-based access control. Read more about our access control at https://developer.aritma.com/apis/commerce/development/3-authorization


 
name
string
Name the new agreement resource


 
Responses 
201
Returns an AgreementResponse


400
Bad request


401
Unauthorized


post/api/v1/agreements
Request samples 
{
  • "resourceGroupId": "5f4549cf-750c-4f1c-890a-eb3a5c9eb711",
  • "name": "string"
}
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}
Get an Agreement
Retrieves an agreement.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
agreementId
required
string <uuid> 
Agreement Id


 
Responses 
200
Returns a AgreementResponse


400
Bad request


401
Unauthorized


get/api/v1/agreements/{agreementId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}
Update an Agreement
Updates an existing Agreement.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
agreementId
required
string <uuid> 
Agreement id


 
Request Body schema: 
Object containing updated agreement values


name
string
New name for the agreement


 
Responses 
200
Returns an Agreement


204
No Content


400
Bad request


401
Unauthorized


put/api/v1/agreements/{agreementId}
Request samples 
{
  • "name": "string"
}
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}
Delete a Agreement
Deletes an existing Agreement.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
agreementId
required
string <uuid> 
Agreement id


 
Responses 
204
400
Bad request


401
Unauthorized


delete/api/v1/agreements/{agreementId}
Request samples 
Companies
A company may contain multiple ConnectionLinks, SettlementConnections, ErpClientConnections, and AccountingRules.
If you are a single organization using the Settlement API for your own reconciliation, you would just create one company for yourself.
If you are an accountant or parent company handling multiple companies, you can create one parent company in Settlement if you want a single point of management.
You can also create a company for each client, if you wish to keep connections, accounting rules, and transactions seperate.


Get a paged list of all companies under an Agreement
Retrieves list of companies.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
agreementId
required
string <uuid> 
An agreement id


 
query Parameters
pageNumber
integer <int32> 
 Default:  1
A page number


 
pageSize
integer <int32> 
 Default:  100
Amount of items on each page


 
Responses 
200
Returns a paged result of companies


400
Bad request


401
Unauthorized


get/api/v1/agreements/{agreementId}/companies
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Create a company
Create a new company under the given agreement.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
agreementId
required
string <uuid> 
An agreement id


 
Request Body schema: 
The name of the new company


name
string
Name of the new company


 
Responses 
201
Returns the companyResponse


400
Bad request


401
Unauthorized


post/api/v1/agreements/{agreementId}/companies
Request samples 
{
  • "name": "string"
}
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}
Get a Company
Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
Company Id


 
Responses 
200
Success


201
Returns a company


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}
Request samples 
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}
Delete a company
Delete an existing company.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
A company id


 
Responses 
204
400
Bad request


401
Unauthorized


delete/api/v1/companies/{companyId}
Request samples 
Update a company
Updates an existing company.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
A company id


 
Request Body schema: 
new name for the company


name
string
New name for company


 
Responses 
200
Returns a company


204
No Content


400
Bad request


401
Unauthorized


put/api/v1/companies/{companyId}
Request samples 
{
  • "name": "string"
}
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}
ErpClientConnections
An ERP client connection represents the connection between the Settlement API and one of your ERP clients. 
To set up a connection, the ERP client must be accessible with the ERP credentials you provided when creating the Agreement.


Get a list of erp client connections
Retrieves list of erp client connections.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
query Parameters
pageNumber
integer <int32> 
 Default:  1
The page number


 
pageSize
integer <int32> 
 Default:  100
Amount of items on each page


 
Responses 
200
Returns a paged result of erp client connections responses


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/erp-client-connections
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Create a erp client connection
Creates a erp client connection and one or more accounting rules.
Erp client connection and accounting rules are used when posting data to a ERP-system


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
Request Body schema: 
An object used when creating a erp client connection and accounting rules


name
string
Name of the new ERP client connection.


 
erpHubClientId
string <uuid> 
ERPHub client id is used to connect to the ERP system. ERPHub client id can be found using . Id from a client equals ERPHub client id.


 
integrationType
string (IntegrationType) 
 Enum: "POS" "Invoice"  
postToLedger
boolean
If true transactions will be posted to the ledger. If false a draft post is created.


 
descriptionTemplate
string or null
Defines the description added to the transaction when posting to your Erp system.


 
department
string or null
Specify which department to post against.


 
project
string or null
Specify which project to post against.


 
Array of objects (CreateOrUpdateAccountingRuleRequest) 
An Enumerable with accounting rules connected to the ERP client connection. Read about accounting rules 


 
Responses 
201
Returns a erp client connection


400
Bad request


401
Unauthorized


post/api/v1/companies/{companyId}/erp-client-connections
Request samples 
{
  • "name": "string",
  • "erpHubClientId": "f6d486cf-81ac-4389-b980-dacd4c5d5992",
  • "integrationType": "POS",
  • "postToLedger": true,
  • "descriptionTemplate": "string",
  • "department": "string",
  • "project": "string",
  • "accountingRules": [
    ]
}
Response samples 
{
  • "id": 0,
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "erpHubClientId": "f6d486cf-81ac-4389-b980-dacd4c5d5992",
  • "integrationType": "POS",
  • "postToLedger": true,
  • "descriptionTemplate": "string",
  • "department": "string",
  • "project": "string",
  • "accountingRules": [
    ]
}
Get a erp client connection
Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection id


 
Responses 
200
Returns a erp client connection response


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}
Request samples 
Response samples 
{
  • "id": 0,
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "erpHubClientId": "f6d486cf-81ac-4389-b980-dacd4c5d5992",
  • "integrationType": "POS",
  • "postToLedger": true,
  • "descriptionTemplate": "string",
  • "department": "string",
  • "project": "string",
  • "accountingRules": [
    ]
}
Update a erp client connection
Updates an existing erp client connection.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection


 
Request Body schema: 
Object used to update an erp connection


name
string
New name for the ERP client connection.


 
erpHubClientId
string <uuid> 
ERPHub client id is used to connect to the ERP system. ERPHub client id can be found using . Id from a client equals ERPHub client id.


 
integrationType
string (IntegrationType) 
 Enum: "POS" "Invoice"  
postToLedger
boolean
If true transactions will be posted to the ledger. If false a draft post is created.


 
descriptionTemplate
string or null
Defines the description added to the transaction when posting to your ERP system.


 
department
string or null
Specify which department to post against.


 
project
string or null
Specify which project to post against.


 
Responses 
200
Returns the updated erp client connection response


204
No Content


400
Bad request


401
Unauthorized


put/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}
Request samples 
{
  • "name": "string",
  • "erpHubClientId": "f6d486cf-81ac-4389-b980-dacd4c5d5992",
  • "integrationType": "POS",
  • "postToLedger": true,
  • "descriptionTemplate": "string",
  • "department": "string",
  • "project": "string"
}
Response samples 
{
  • "id": 0,
  • "name": "string",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "erpHubClientId": "f6d486cf-81ac-4389-b980-dacd4c5d5992",
  • "integrationType": "POS",
  • "postToLedger": true,
  • "descriptionTemplate": "string",
  • "department": "string",
  • "project": "string",
  • "accountingRules": [
    ]
}
Delete a erp client connection and related accounting rules
Deletes an existing erp client connection


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection id


 
Responses 
204
400
Bad request


401
Unauthorized


delete/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}
Request samples 
SettlementConnections
A settlement connection represents the connection between the Settlement API and an external settlement provider (e.g. Stripe, Vipps). 
SettlementConnections are the source of all incoming transactions.


Get a settlement connection
Retrieves a settlement connection.

A settlement connection represents a connection to an external settlement provider.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
settlementConnectionId
required
integer <int32> 
The settlement connection id


 
Responses 
200
Returns a settlement connection response


401
Unauthorized


404
Not found


get/api/v1/companies/{companyId}/settlement-connections/{settlementConnectionId}
Request samples 
Response samples 
{
  • "id": 0,
  • "type": "PayPal",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "lastSyncDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "extendedProperties": {
    }
}
Update a settlement connection
Updates a settlement settlement connection.

The connection type must match the type of the existing settlement connection.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
settlementConnectionId
required
integer <int32> 
The settlement connection id


 
Request Body schema: 
A request with a connection type and connection details for the settlement provider


connectionType
string (SettlementConnectionType) 
 Enum: "PayPal" "Stripe" "Klarna" "Ftp" "Zettle" "NetsEasy" "SveaFinance" "NetsTeller" "Vipps" "QuickPay"  
startDate
string or null <date-time> 
The start date is when the API will sync data from the settlement company. For example, the settlement date is set to last week. The API will fetch and save all transactions from last week to today.


 
KlarnaConnectionDetails (object) or NetsEasyConnectionDetails (object) or NetsTellerConnectionDetails (object) or PayPalConnectionDetails (object) or StripeConnectionDetails (object) or VippsConnectionDetails (object)
The details needed to connect to your chosen settlement company.


 
Responses 
204
No Content


400
Bad Request


404
Not Found


put/api/v1/companies/{companyId}/settlement-connections/{settlementConnectionId}
Request samples 
{
  • "connectionType": "Klarna",
  • "startDate": "2023-05-29T22:08:44.8454766+00:00",
  • "connectionDetails": {
    }
}
Delete a settlement connection
Deletes a settlement settlement connection, and all related connection links.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
settlementConnectionId
required
integer <int32> 
The settlement connection id


 
Responses 
204
No Content


400
Bad Request


404
Not Found


delete/api/v1/companies/{companyId}/settlement-connections/{settlementConnectionId}
Request samples 
Get a list of settlement connections
Retrieves list of settlement connections.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
query Parameters
page
integer <int32> 
 Default:  1
The page number


 
limit
integer <int32> 
 Default:  100
The amount of items on each page


 
Responses 
200
Returns a paged result of settlement connection responses


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/settlement-connections
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Create a settlement connection
Creates a settlement settlement connection.

A settlement connection represents a connection to an external settlement provider.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
Request Body schema: 
The request with a connection type and connection details for the settlement provider


connectionType
string (SettlementConnectionType) 
 Enum: "PayPal" "Stripe" "Klarna" "Ftp" "Zettle" "NetsEasy" "SveaFinance" "NetsTeller" "Vipps" "QuickPay"  
startDate
string or null <date-time> 
The start date is when the API will sync data from the settlement company. For example, the settlement date is set to last week. The API will fetch and save all transactions from last week to today.


 
KlarnaConnectionDetails (object) or NetsEasyConnectionDetails (object) or NetsTellerConnectionDetails (object) or PayPalConnectionDetails (object) or StripeConnectionDetails (object) or VippsConnectionDetails (object)
The details needed to connect to your chosen settlement company.


 
Responses 
201
Returns a settlement settlement connection


400
Bad Request


401
Unauthorized


post/api/v1/companies/{companyId}/settlement-connections
Request samples 
{
  • "connectionType": "Klarna",
  • "startDate": "2023-05-29T22:08:44.9343739+00:00",
  • "connectionDetails": {
    }
}
Response samples 
{
  • "id": 0,
  • "type": "PayPal",
  • "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
  • "lastSyncDate": "2019-08-24T14:15:22Z",
  • "startDate": "2019-08-24T14:15:22Z",
  • "extendedProperties": {
    }
}
Transactions
A settlement transaction represents a transaction received from a settlement provider (SettlementConnection).


Get transactions for company
Retrieves a list of transactions for all settlement connections belonging to a company.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
query Parameters
fromDate
string <date-time> 
The oldest settlement date from which the transactions will be provided


 
toDate
string <date-time> 
The newest, most recent settlement date to which the transactions will be provided


 
page
integer <int32> 
 Default:  1
The page number


 
pageSize
integer <int32> 
 Default:  500
The amount of items on each page


 
Responses 
200
Returns a paged result of transactions


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/transactions
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Get transactions for settlement connection
Retrieves a list of transactions for a settlement connection.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
settlementConnectionId
required
integer <int32> 
The settlement connection id


 
query Parameters
fromDate
string <date-time> 
The oldest settlement date from which the transactions will be provided


 
toDate
string <date-time> 
The newest, most recent settlement date to which the transactions will be provided


 
page
integer <int32> 
 Default:  1
The page number


 
pageSize
integer <int32> 
 Default:  500
The amount of items on each page


 
Responses 
200
Returns a paged result of transactions


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/settlement-connections/{settlementConnectionId}/transactions
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Get transaction
Retrieves a transaction.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
settlementConnectionId
required
integer <int32> 
The settlement connection id


 
transactionId
required
integer <int64> 
The transaction


 
Responses 
200
Returns a transaction


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/settlement-connections/{settlementConnectionId}/transactions/{transactionId}
Request samples 
Response samples 
{
  • "id": 0,
  • "amount": 0,
  • "transactionType": "Payment",
  • "currency": "string",
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "settlementDate": "2019-08-24T14:15:22Z",
  • "externalTransactionId": "string",
  • "description": "string",
  • "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
  • "transactionsReference1": "string",
  • "transactionsReference2": "string",
  • "transactionGroupId": "string",
  • "settlementConnectionId": 0,
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "transactionStatus": "New"
}
AccountingRule
Accounting rules expand on the ErpClientConnection. 
Each ErpClientConnection has a default accounting rule which specifies the standard booking parameters (e.g.cash account, interim account...) for all incoming transactions.
You may also create additional AccountingRules to adjust booking parameters based on the transaction ISO currency code.

Example




Incoming transactions should be posted to currency-specific accounts in the main ledger. 
"USD" transactions should go to account 1510, while "NOK" transactions should go to account 1511. 
This can be achieved by creating an accounting rule for each currency.




Get an accounting rule
Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection id


 
accountingRuleId
required
integer <int32> 
The accounting rule id


 
Responses 
200
Returns an accounting rule response


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}/accounting-rules/{accountingRuleId}
Request samples 
Response samples 
{
  • "id": 0,
  • "erpClientConnectionId": 0,
  • "currency": "string",
  • "cashAccount": "string",
  • "interimAccount": "string",
  • "bankAccount": "string",
  • "feeCreditAccount": "string",
  • "feeDebitAccount": "string",
  • "defaultRule": true
}
Update an accounting rule
Updates an existing accounting rule.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection id


 
accountingRuleId
required
integer <int32> 
The accounting rule id


 
Request Body schema: 
Object used to update an accounting rule


currency
string
Three-letter ISO currency code representing the currency for the account.


 
cashAccount
string
Cash account number.


 
interimAccount
string
Interim account number.


 
bankAccount
string
Bank account number.


 
feeCreditAccount
string
Fee credit account number.


 
feeDebitAccount
string
Fee debit account number.


 
defaultRule
boolean
Use default rule.


 
Responses 
200
Returns a accounting rule response


400
Bad request


401
Unauthorized


put/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}/accounting-rules/{accountingRuleId}
Request samples 
{
  • "currency": "string",
  • "cashAccount": "string",
  • "interimAccount": "string",
  • "bankAccount": "string",
  • "feeCreditAccount": "string",
  • "feeDebitAccount": "string",
  • "defaultRule": true
}
Response samples 
{
  • "id": 0,
  • "erpClientConnectionId": 0,
  • "currency": "string",
  • "cashAccount": "string",
  • "interimAccount": "string",
  • "bankAccount": "string",
  • "feeCreditAccount": "string",
  • "feeDebitAccount": "string",
  • "defaultRule": true
}
Delete an accounting rule
Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection id


 
accountingRuleId
required
integer <int32> 
The accounting rule id


 
Responses 
204
400
Bad request


401
Unauthorized


delete/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}/accounting-rules/{accountingRuleId}
Request samples 
Get a list of accounting rules
Retrieves list of accounting rules under a erp connection.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection id


 
query Parameters
pageNumber
integer <int32> 
 Default:  1
The page number


 
pageSize
integer <int32> 
 Default:  100
Amount of items on each page


 
Responses 
200
Returns a paged result of accounting rules


400
Bad request


401
Unauthorized


get/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}/accounting-rules
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Create an accounting rule
Accounting rules are used to specify which accounts to use accounts, when posting transaction to a ERP system


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
companyId
required
string <uuid> 
The company id


 
erpClientConnectionId
required
integer <int32> 
The erp client connection id


 
Request Body schema: 
An object used to create a new accounting rule


currency
string
Three-letter ISO currency code representing the currency for the account.


 
cashAccount
string
Cash account number.


 
interimAccount
string
Interim account number.


 
bankAccount
string
Bank account number.


 
feeCreditAccount
string
Fee credit account number.


 
feeDebitAccount
string
Fee debit account number.


 
defaultRule
boolean
Use default rule.


 
Responses 
201
Returns a accounting rule response


400
Bad request


401
Unauthorized


post/api/v1/companies/{companyId}/erp-client-connections/{erpClientConnectionId}/accounting-rules
Request samples 
{
  • "currency": "string",
  • "cashAccount": "string",
  • "interimAccount": "string",
  • "bankAccount": "string",
  • "feeCreditAccount": "string",
  • "feeDebitAccount": "string",
  • "defaultRule": true
}
Response samples 
{
  • "id": 0,
  • "erpClientConnectionId": 0,
  • "currency": "string",
  • "cashAccount": "string",
  • "interimAccount": "string",
  • "bankAccount": "string",
  • "feeCreditAccount": "string",
  • "feeDebitAccount": "string",
  • "defaultRule": true
}
ErpConnection
Represents an api controller for managing erp connections.


Create an erp connection
Creates an erp connection which defines the connection to an erp system and user access to this connection.


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
Request Body schema: 
The request with a erp type and connection details for the erp system


resourceGroupId
string <uuid> 
The resource group id used in role-based access control. Read more about our access control at .


 
SoftrigConnectionDetails (object) or TripletexConnectionDetails (object)
The details used to connect to your ERP system.


 
erpSystem
string (ErpConnectionType) 
 Enum: "Softrig" "Tripletex"  
email
string
The Email address


 
Responses 
201
Returns an erp connection response


400
Bad Request


401
Unauthorized


post/api/v1/erp-connection
Request samples 
{
  • "erpSystem": "Softrig",
  • "resourceGroupId": "b23ef1f8-0283-496d-8798-5183d04dfaf3",
  • "email": "string",
  • "connectionDetails": {
    }
}
Response samples 
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "erpSystem": "string"
}
Get a list of erp connection
Retrieves list of erp connection


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
query Parameters
resourceGroupId
string <uuid> 
The resource group id


 
pageNumber
integer <int32> 
 Default:  1
The page number


 
pageSize
integer <int32> 
 Default:  100
The amount of items on each page


 
Responses 
200
Returns a paged result of erp connection responses


400
Bad request


401
Unauthorized


get/api/v1/erp-connection
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}
Get a list of clients
Retrieves list of clients. Clients are a one to one mapping between what Aritma call clients and companies from your erpsystem


Securityimplicit or client_credentials or implicit_dev or client_credentials_dev 
Request 
path Parameters
erpConnectionId
required
string <uuid> 
The erp connection id


 
query Parameters
pageNumber
integer <int32> 
 Default:  1
The page number


 
pageSize
integer <int32> 
 Default:  100
The amount of items on each page


 
Responses 
200
Returns a paged result of client responses


400
Bad request


401
Unauthorized


get/api/v1/erp-connection/{erpConnectionId}/clients
Request samples 
Response samples 
{
  • "values": [
    ],
  • "metadata": {
    },
  • "links": {}
}