API for ErpHub
API Reference
/- CreateBookkeepingSetting
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.
Deletes a specific bookkeeping rule for the specified client.
The rule to delete is identified by its unique rule ID.
Retrieves the details of a specific bookkeeping rule for the specified client.
This rule is identified by its unique rule ID.
Updates the details of an existing bookkeeping rule for the specified client.
The rule to update is identified by its unique rule ID.
Replaces the existing transaction filters of a specific bookkeeping rule for the given client.
The rule is identified by its unique rule ID.
All current filters will be removed and replaced with the filters provided in the request body.
GetBookkeepingSettings
UpdateBookkeepingSetting
DeleteBookkeepingSetting
GetBookkeepingSetting
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.
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.
Retrieves the details of a specific bookkeeping rule for the specified client.
This rule is identified by its unique rule ID.
Updates the details of an existing bookkeeping rule for the specified client.
The rule to update is identified by its unique rule ID.
Deletes a specific bookkeeping rule for the specified client.
The rule to delete is identified by its unique rule ID.
Updates the priority for all bookkeeping rules associated with the specified client.
All rules must be included in the request, identified by their unique rule IDs.
Missing or unknown rules will result in a validation error.
Replaces the existing transaction filters of a specific bookkeeping rule for the given client.
The rule is identified by its unique rule ID.
All current filters will be removed and replaced with the filters provided in the request body.
Replaces the existing transaction units of a specific bookkeeping rule for the given client.
The rule is identified by its unique rule ID.
All current units will be removed and replaced with the units provided in the request body.
Replaces the existing transaction units of a specific bookkeeping rule for the given client.
The rule is identified by its unique rule ID.
All current units will be removed and replaced with the units provided in the request body.
CreateBookkeepingSetting
ErpHub API (1)
Download OpenAPI description
Overview
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
BodyArray []
- application/json
- text/json
- application/*+json
Enum"Amount""Currency""ReferenceNumber""ArchiveReference""Description""InvoiceNumber""StructuredReference""AdditionalText""DebtorAddress""BookedAmount"
Enum"ExactText""ContainsText""StartsWithText""EndsWithText""ExactAmount""FromZeroToAmount""BelowAmount""AboveAmount"
- Mock serverhttps://developer.aritma.com/_mock/apis/accounting/erp-hub/openapi/erphub-openapi/api/v1/clients/{clientId}/bookkeeping/matching-rules/{ruleId}/filters
- ErpHub APIhttps://erphub-api.aritma.io/api/v1/clients/{clientId}/bookkeeping/matching-rules/{ruleId}/filters
- ErpHub API (Dev)https://erphub-api.dev.aritma.io/api/v1/clients/{clientId}/bookkeeping/matching-rules/{ruleId}/filters
- Payload
- cURL
- C#
- JavaScript
- Python
- Go
- PHP
- Java
- Java 8
- application/json
- text/json
- application/*+json
[ { "field": "Amount", "operation": "ExactText" } ]
Response
application/json
{ "links": { "property1": { … }, "property2": { … } }, "clientId": "5e505642-9024-474d-9434-e5a44f505cc5", "ruleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac" }
- Mock serverhttps://developer.aritma.com/_mock/apis/accounting/erp-hub/openapi/erphub-openapi/api/v1/clients/{clientId}/bookkeeping/settings
- ErpHub APIhttps://erphub-api.aritma.io/api/v1/clients/{clientId}/bookkeeping/settings
- ErpHub API (Dev)https://erphub-api.dev.aritma.io/api/v1/clients/{clientId}/bookkeeping/settings
- Payload
- cURL
- C#
- JavaScript
- Python
- Go
- PHP
- Java
- Java 8
- application/json
- text/json
- application/*+json
{ "bankAccountNumber": "string", "currency": "string", "ledgerAccount": "string", "offsetAccount": "string", "feeAccount": "string", "remittanceFeeAccount": "string", "fallbackLedgerAccount": "string", "fallbackOffsetAccount": "string", "voucherSeries": "string", "currencyNo": "string", "currencyNo2": "string", "voucherType": "string", "agioVoucherType": "string", "agioVoucherTypeForCurrency2": "string", "isDefault": true }
Response
application/json
{ "links": { "property1": { … }, "property2": { … } }, "clientId": "5e505642-9024-474d-9434-e5a44f505cc5", "settingId": "d95c2f35-4f41-47ad-8ae0-f642dbc3c5a6" }
- Mock serverhttps://developer.aritma.com/_mock/apis/accounting/erp-hub/openapi/erphub-openapi/api/v1/clients/{clientId}/bookkeeping/settings
- ErpHub APIhttps://erphub-api.aritma.io/api/v1/clients/{clientId}/bookkeeping/settings
- ErpHub API (Dev)https://erphub-api.dev.aritma.io/api/v1/clients/{clientId}/bookkeeping/settings
- Payload
- cURL
- C#
- JavaScript
- Python
- Go
- PHP
- Java
- Java 8
No request payloadResponse
application/json
[ { "links": { … }, "clientId": "5e505642-9024-474d-9434-e5a44f505cc5", "settingId": "d95c2f35-4f41-47ad-8ae0-f642dbc3c5a6", "bankAccountNumber": "string", "currency": "string", "ledgerAccount": "string", "offsetAccount": "string", "feeAccount": "string", "remittanceFeeAccount": "string", "fallbackLedgerAccount": "string", "fallbackOffsetAccount": "string", "voucherSeries": "string", "currencyNo": "string", "currencyNo2": "string", "voucherType": "string", "agioVoucherType": "string", "agioVoucherTypeForCurrency2": "string", "isDefault": true } ]