Skip to content
/Bookkeeping

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.

autoUpdateboolean

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

applyTransactionFilterAfterMatchingboolean

Indicates whether transaction filters should be applied after matching, specifically to transactions not matched during the initial matching process.

filtersArray of objects(MatchingFilterDto)

Gets or sets the collection of filters applied to the bookkeeping rule. These filters are used to determine the matching criteria when finding open posts.

{
  "displayName": "string",
  "autoUpdate": true,
  "applyTransactionFilterAfterMatching": true,
  "filters": [
    { … }
  ]
}

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"
}

Deletes a specific bookkeeping rule for the specified client. The rule to delete is identified by its unique rule ID.

Request

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

Responses

No Content

Response
No content

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