Skip to content
/Connection

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

Initializes the process of creating a new connection to an external ERP system

Request

Body

Aritma.ERPHub.Api.Common.Models.Requests.CreateConnectionDto

namestringrequired
parentResourceUristringrequired
connectionDetails(ApiIntegrationConnectionDetails (object or null)) or (VismaBusinessNXTConnectionDetails (object or null)) or (VismaNetConnectionDetails (object or null))
One of:
erpSystemTypestring(ErpSystemType)required
Enum"Unknown""VismaBusinessNXT""VismaNet""ApiIntegration"
emailstringrequired
redirectUrlstringrequired
{
  "name": "string",
  "parentResourceUri": "string",
  "connectionDetails": {
    "clients": [ … ],
    "connectionSystem": "None"
  },
  "erpSystemType": "Unknown",
  "email": "string",
  "redirectUrl": "string"
}

Responses

OK

Resync connection. This will import new clients connected to the given connection.

Request

Path
connectionIdstring(uuid)required

The connectionId.

Body

Optional resync request Aritma.ERPHub.Api.Common.Models.Requests.ResyncConnectionDto to support Aritma.ERPHub.Abstractions.Interfaces.IConnectionDetails in request

erpSystemTypestring(ErpSystemType)required
Enum"Unknown""VismaBusinessNXT""VismaNet""ApiIntegration"
connectionDetailsApiIntegrationConnectionDetails (object) or VismaBusinessNXTConnectionDetails (object) or VismaNetConnectionDetails (object)required
One of:
clientsArray of objects(ApiIntegrationClient)
connectionSystemstring(ConnectedSystemType)
Enum"None""Commerce""Control""Api""Pay""Aritma"
{
  "erpSystemType": "Unknown",
  "connectionDetails": {
    "clients": [ … ],
    "connectionSystem": "None"
  }
}

Responses

OK

Get clients for a connection

Request

Path
connectionIdstring(uuid)required

The connectionId

No request payload

Responses

Returns an array of client dto.

Integrations

Operations

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