Skip to content
API Reference
/
/
Create a connection for a...

ErpHub API (1)

API for ErpHub

Download OpenAPI description
erphub-openapi.json
erphub-openapi.yaml
Overview
URL
https://aritma.com/general-inquiry/
Languages
Servers
Mock server
https://developer.aritma.com/_mock/apis/accounting/erp-hub/openapi/erphub-openapi
ErpHub API
https://erphub-api.aritma.io
ErpHub API (Dev)
https://erphub-api.dev.aritma.io

Account

Handles account related operations.

Operations

Bookkeeping

Handles the bookkeeping for the client

Operations

Clients

Handles ERP client related operations

Operations

Connection

Handles the connection between the ERPHub and the ERP

Operations

Integrations

Operations

Create a connection for an API integrator

Request

Body

The connection request

namestringrequired

The name of the new connection.

parentResourceUristringrequired

The parent resource URI of the connection.

clientsArray of objects(AddClientDto)

The initial clients to add to the connection.

emailstring or null

Email address to associate with the connection.

{
  "name": "string",
  "parentResourceUri": "string",
  "clients": [
    { … }
  ],
  "email": "string"
}

Responses

OK

Bodyapplication/json
idstring(uuid)required

The unique identifier of the connection

emailstringrequired

The email address that is associated with the connection

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string"
}

Add a single client to an ERPHubConnection

Request

Path
connectionIdstring(uuid)required

The connection id

Body

The client to add

namestringrequired

The name of the client to add, must be unique for the connection.

organizationNumberstringrequired

The organization number of the client to add, must be unique for the connection.

currencystring or null

The currency of the client to add, must be a valid ISO 4217 currency code. Will be made required in future versions.

{
  "name": "string",
  "organizationNumber": "string",
  "currency": "string"
}

Responses

OK

Bodyapplication/json
successbooleanrequired

Indicates whether the request was successful

errorstring or null

Error message, if the request was not successful

clientobject(ClientDto)

Represents a client.

Response
application/json
{
  "success": true,
  "error": "string",
  "client": {
    "clientId": "string",
    "name": "string",
    "erpSystemType": "Unknown",
    "externalCompanyId": "string",
    "organizationNumber": "string",
    "accountingPeriodDeviation": 0,
    "currency": "string"
  }
}

Add accounts to a client

Request

Path
clientIdstring(uuid)required

The id of the client

Body

The list of clients to add

Array [
accountNumberstringrequired

The account number, must be unique for the client.

currencystringrequired

The currency of the account. 3-letter ISO currency code.

descriptionstringrequired

Description of the account.

bankAccountNumberstring

Optional bank account number associated with the account.

]
[
  {
    "accountNumber": "string",
    "currency": "string",
    "description": "string",
    "bankAccountNumber": "string"
  }
]

Responses

OK

Bodyapplication/json
successbooleanrequired

Indicates whether the request was successful

errorstring or null

Error message, if the request was not successful

accountsArray of objects or null(AccountDto)

List of the added accounts

Response
application/json
{
  "success": true,
  "error": "string",
  "accounts": [
    { … }
  ]
}

Add transactions to an account

Request

Path
clientIdstring(uuid)required

The id of the client

Body

The list of transactions to add

Array [
accountNumberstringrequired

The account number to add this transaction to.

currencystringrequired

The currency of the transaction.

sourceReferenceIdstringrequired

Unique reference for the transaction.

batchNumberstring or null

Batch number of the transaction.

voucherNumberstring or null

Voucher number of the transaction.

voucherLineinteger(int32)

Voucher line of the transaction.

descriptionstring or null

Description of the transaction.

invoiceNumberstring or null

Invoice number of the transaction.

commentstring or null

Comment of the transaction.

voucherDatestring(date-time)

The date of the transaction.

valueDatestring(date-time)

The value date of the transaction.

periodstring

The period the transaction belongs to.

debitAmountnumber(double)

The debit amount of the transaction.

debitAmountInCurrencynumber(double)

The debit amount of the transaction in the currency.

creditAmountnumber(double)

The credit amount of the transaction.

creditAmountInCurrencynumber(double)

The credit amount of the transaction in the currency.

ratenumber(double)

The exchange rate of the currency on this transaction.

yearinteger(int32)

The year of the transaction. mostly same as period.

]
[
  {
    "accountNumber": "string",
    "currency": "string",
    "sourceReferenceId": "string",
    "batchNumber": "string",
    "voucherNumber": "string",
    "voucherLine": 0,
    "description": "string",
    "invoiceNumber": "string",
    "comment": "string",
    "voucherDate": "2019-08-24T14:15:22Z",
    "valueDate": "2019-08-24T14:15:22Z",
    "period": "string",
    "debitAmount": 0.1,
    "debitAmountInCurrency": 0.1,
    "creditAmount": 0.1,
    "creditAmountInCurrency": 0.1,
    "rate": 0.1,
    "year": 0
  }
]

Responses

OK

Bodyapplication/json
successbooleanrequired

Indicates whether the request was successful

errorsArray of objects or null(AddTransactionErrorDto)

A list of error messages, if the request was not successful

batchIdstring or null(uuid)

The unique batch id of the added transactions

Response
application/json
{
  "success": true,
  "errors": [
    { … }
  ],
  "batchId": "5579c111-9c50-47e2-af92-f16d52e63189"
}

Mandates

Controller for managing mandates.

Operations

Pay

Handles pay related operations.

Operations

Transaction

Handles ERP transaction related operations

Operations

Voucher

Controller responsible for handling voucher operations in the ERP Hub.

Operations