Skip to content
/Account

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

Get accounts for a client.

Request

Path
clientIdstring(uuid)required
Query
includeDisabledAccountsboolean

Indicate if the response should include accounts that is not active in the erp system.

Default true
No request payload

Responses

Returns an array of account dto.

Bodyapplication/jsonArray [
accountIdstringrequired

Account ID

accountNumberstringrequired

Account number

currencystring or null

Currency

clientIdstringrequired

Client ID

descriptionstring or null

Description

bankAccountNumberstring or null

Bank account number

isSyncTransactionEnabledboolean

Is enabled for transaction sync

isActiveInErpboolean

Indicates if the account is active in the ERP system

]
Response
application/json
[
  {
    "accountId": "string",
    "accountNumber": "string",
    "currency": "string",
    "clientId": "string",
    "description": "string",
    "bankAccountNumber": "string",
    "isSyncTransactionEnabled": true,
    "isActiveInErp": true
  }
]

Get account balance

Request

Path
clientIdstring(uuid)required
accountIdstringrequired
Query
financialPeriodstring
isCurrencyAccountboolean
Default false
No request payload

Responses

Returns an account balance dto.

Bodyapplication/json
accountNumberstringrequired

Account number

balanceOutnumber(double)

Balance out

balanceInnumber(double)

Balance in

startDatestring(date-time)

Start date

endDatestring(date-time)

End date

messagestring

Message received from the Erp integration

Response
application/json
{
  "accountNumber": "string",
  "balanceOut": 0.1,
  "balanceIn": 0.1,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "message": "string"
}

Enable an account for transactions sync

Request

Path
clientIdstring(uuid)required
accountIdstringrequired
Query
transactionSyncStartstring

The date from which to start the transaction sync

No request payload

Responses

Account transaction sync enabled.

Disable an account for transactions sync

Request

Path
clientIdstring(uuid)required
accountIdstringrequired
No request payload

Responses

Account transaction sync disabled.

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

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