Skip to content
API Reference
/
/
Retrieves the list of boo...

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

Creates a new bookkeeping rule for the specified client. The rule defines how transactions are processed and mapped to generate vouchers based on the client's requirements.

Request

Path
clientIdstring(uuid)required
Body
displayNamestring

Sets the display name for the bookkeeping rule.

bookkeepingSettingIdstring(uuid)

Specifies the ID of the settings to link to. If no settings exist, create them before proceeding.

autoUpdateboolean

Sets if the voucher is automatically updated in the erp-system.

isFeeRuleboolean

True if the rule is a fee rule, false otherwise.

minOptionalMatchesinteger(int32)

Gets or sets the minimum number of filters that must match for the bookkeeping rule to apply. This property works in combination with the 'at least FilterCriteria' logic to determine applicability.

transactionPostingModestring(TransactionPostingMode)
Enum"CombineIntoSingleVoucher""PostAsSeparateVouchers""MultiLinedVoucher""MultiLinedVoucherWithUnmatched"
filtersArray of objects(TransactionFilterDto)

Gets or sets the collection of filters applied to the bookkeeping rule. These filters are used to determine the conditions under which the rule is applied.

fieldMappingsArray of objects(FieldMappingDto)

Defines a set of dynamic mappings that extract values from transaction fields and apply them to batch line fields.

unitsArray of objects(BookkeepingUnitDto)

Gets or sets the collection of units associated with the bookkeeping rule.

{
  "displayName": "string",
  "bookkeepingSettingId": "07af9850-9db1-4b77-ba9e-74c705771ff8",
  "autoUpdate": true,
  "isFeeRule": true,
  "minOptionalMatches": 0,
  "transactionPostingMode": "CombineIntoSingleVoucher",
  "filters": [
    { … }
  ],
  "fieldMappings": [
    { … }
  ],
  "units": [
    { … }
  ]
}

Responses

OK

Bodyapplication/json
linksobjectread-only
clientIdstring(uuid)
ruleIdstring(uuid)
Response
application/json
{
  "links": {
    "property1": { … },
    "property2": { … }
  },
  "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac"
}

Retrieves the list of bookkeeping rules for a specified client. This endpoint returns all bookkeeping rules associated with the provided client ID. Each rule includes details such as the rule's ID, priority, and conditions.

Request

Path
clientIdstring(uuid)required
No request payload

Responses

OK

Bodyapplication/jsonArray [
linksobjectread-only
clientIdstring(uuid)
ruleIdstring(uuid)
priorityinteger(int32)
minMatchingFiltersinteger(int32)
transactionPostingModestring(TransactionPostingMode)
Enum"CombineIntoSingleVoucher""PostAsSeparateVouchers""MultiLinedVoucher""MultiLinedVoucherWithUnmatched"
createdAtstring(date-time)
lastUpdatedAtstring or null(date-time)
filtersArray of objects(BookkeepingFilterDto)
]
Response
application/json
[
  {
    "links": { … },
    "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
    "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
    "priority": 0,
    "minMatchingFilters": 0,
    "transactionPostingMode": "CombineIntoSingleVoucher",
    "createdAt": "2019-08-24T14:15:22Z",
    "lastUpdatedAt": "2019-08-24T14:15:22Z",
    "filters": [ … ]
  }
]

Retrieves the details of a specific bookkeeping rule for the specified client. This rule is identified by its unique rule ID.

Request

Path
clientIdstring(uuid)required
ruleIdstring(uuid)required
No request payload

Responses

OK

Bodyapplication/json
linksobjectread-only
clientIdstring(uuid)
ruleIdstring(uuid)
priorityinteger(int32)
minMatchingFiltersinteger(int32)
transactionPostingModestring(TransactionPostingMode)
Enum"CombineIntoSingleVoucher""PostAsSeparateVouchers""MultiLinedVoucher""MultiLinedVoucherWithUnmatched"
createdAtstring(date-time)
lastUpdatedAtstring or null(date-time)
filtersArray of objects(BookkeepingFilterDto)
Response
application/json
{
  "links": {
    "property1": { … },
    "property2": { … }
  },
  "clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
  "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
  "priority": 0,
  "minMatchingFilters": 0,
  "transactionPostingMode": "CombineIntoSingleVoucher",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastUpdatedAt": "2019-08-24T14:15:22Z",
  "filters": [
    { … }
  ]
}

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