Documentation Powered by ReDoc

enfore Ledger API (0.18.2)

Download OpenAPI specification:Download

enfore API for accessing ledger data such as accounts, booking periods and transactions

Balance Sheet Accounts

Iterate over balance sheet accounts.

Returns balance sheet accounts, sorted in ascending order by start date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/balance-sheet-accounts

Production

https://external.apis.enfore.com/ledger/org/{org-id}/balance-sheet-accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a balance-sheet account

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Responses

200

BalanceSheet account is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/balance-sheet-accounts/{account-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/balance-sheet-accounts/{account-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "BalanceSheetAccount",
  • "id": "string",
  • "nr": 0,
  • "name": "string",
  • "description": "string",
  • "currency": "AUD",
  • "is_active": true,
  • "current_booking_period_id": "string"
}

Cash Accounts

Iterate over cash accounts.

Returns cash accounts, sorted in ascending order by start date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

register-device-id
string [ 1 .. 256 ] characters

When specified, only the cash account owned by the specified register device will be returned (if one exists).

staff-member-id
string [ 1 .. 256 ] characters

When specified, only the cash accounts owned by the specified staff member device will be returned (if one exists).

service-location-id
string [ 1 .. 256 ] characters

When specified, only the cash accounts owned by the specified service location will be returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/cash-accounts

Production

https://external.apis.enfore.com/ledger/org/{org-id}/cash-accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a cash account

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Responses

200

Cash account is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/cash-accounts/{account-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/cash-accounts/{account-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "CashAccount",
  • "id": "string",
  • "nr": 0,
  • "name": "string",
  • "description": "string",
  • "currency": "AUD",
  • "is_active": true,
  • "current_booking_period_id": "string",
  • "container_type": "CASH_DRAWER",
  • "owner":
    {
    },
  • "service_location_id": "string",
  • "settings":
    {
    }
}

Load a cash account's settings

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Responses

200

Settings are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/cash-accounts/{account-id}/settings

Production

https://external.apis.enfore.com/ledger/org/{org-id}/cash-accounts/{account-id}/settings

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "thresholds":
    {
    },
  • "maintain_permanent_counting_protocol": false
}

Update a cash account's settings

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Request Body schema: application/json
thresholds
object (CashContainerAmountThresholds)

Defines threshold values regarding the amount of cash that the container should contain.

The limits will not be enforced by the platform but UI for the cash container and the UI for recording cash transactions will warn users when a limit has been/is going to be violated.

  • minimum_cash_threshold
    Specifies the minimum amount of cash that the container must contain. If a cash transaction would lead to a lower balance, the user will be warned.

    If this value is higher than maximum_cash_threshold, than maximum_cash_threshold applies.

  • maximum_cash_threshold
    Specifies the maximum amount of cash that the container may contain. If a cash transaction would lead to a higher balance, the user will be warned.

    If this value is lower than minimum_cash_threshold, than maximum_cash_threshold applies.

  • minimum_cash_threshold_when_starting_period
    Specifies the minimum amount of cash that the container must contain when a booking period is started. If the starting balance is lower than the configured value, the user will be warned or has to make a deposit.

    If this value is higher than maximum_cash_threshold_when_starting_period, than maximum_cash_threshold_when_starting_period applies. If this value is lower than minimum_cash_threshold, than minimum_cash_threshold applies. If this value is higher than maximum_cash_threshold, than maximum_cash_threshold applies.

  • maximum_cash_threshold_when_starting_period
    Specifies the maximum amount of cash that the container may contain when a booking period is started. This amount prevents a deposit above this amount.

    If this value is lower than minimum_cash_threshold_when_starting_period, than maximum_cash_threshold_when_starting_period applies. If this value is lower than minimum_cash_threshold, than minimum_cash_threshold applies. If this value is higher than maximum_cash_threshold, than maximum_cash_threshold applies.

  • minimum_cash_threshold_when_finishing_period
    Specifies the minimum amount of cash that the container may contain when a booking period is finished. This amount prevents a withdrawal below this amount.

    If this value is higher than maximum_cash_threshold_when_finishing_period, than maximum_cash_threshold_when_finishing_period applies. If this value is higher than maximum_cash_threshold or maximum_cash_threshold_when_starting_period, than the lowest value applies.

  • maximum_cash_threshold_when_finishing_period
    Specifies the maximum amount of cash that the container may contain when a booking period is finished. If the balance at finishing is higher than the configured value, the user will be warned or has to make a withdrawal.

    If this value is lower than minimum_cash_threshold_when_finishing_period, than maximum_cash_threshold_when_finishing_period applies. If this value is higher than maximum_cash_threshold or maximum_cash_threshold_when_starting_period, than the lowest value applies.

maintain_permanent_counting_protocol
required
boolean
Default: false

When set to true, each transaction on the cash container must contain a counting protocol and a counting protocol is required for every period finish. When this setting is switched ON, it becomes effective when the current period of the CashAccount is finished. When this setting is switched OFF, it becomes effective when the next transactions is recorded at the CashAccount that does not contain a protocol.

Responses

200

Settings are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/cash-accounts/{account-id}/settings

Production

https://external.apis.enfore.com/ledger/org/{org-id}/cash-accounts/{account-id}/settings

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "thresholds":
    {
    },
  • "maintain_permanent_counting_protocol": false
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "thresholds":
    {
    },
  • "maintain_permanent_counting_protocol": false
}

Get a list of registered consumers for cash account events. Deprecated

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/cash-account-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/cash-account-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API. Deprecated

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/cash-account-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/cash-account-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for cash accounts Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to act upon

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/cash-account-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/cash-account-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Creditor Accounts

Iterate over creditor accounts.

Returns creditor accounts, sorted in ascending order by start date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/creditor-accounts

Production

https://external.apis.enfore.com/ledger/org/{org-id}/creditor-accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a creditor account

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Responses

200

Creditor account is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/creditor-accounts/{account-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/creditor-accounts/{account-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "CreditorAccount",
  • "id": "string",
  • "nr": 0,
  • "name": "string",
  • "description": "string",
  • "currency": "AUD",
  • "is_active": true,
  • "current_booking_period_id": "string",
  • "creditor":
    {
    },
  • "kpis":
    {
    }
}

Debtor Accounts

Iterate over debtor accounts.

Returns debtor accounts, sorted in ascending order by start date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/debtor-accounts

Production

https://external.apis.enfore.com/ledger/org/{org-id}/debtor-accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a debtor account

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Responses

200

Debtor account is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/debtor-accounts/{account-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/debtor-accounts/{account-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "DebtorAccount",
  • "id": "string",
  • "nr": 0,
  • "name": "string",
  • "description": "string",
  • "currency": "AUD",
  • "is_active": true,
  • "current_booking_period_id": "string",
  • "debtor":
    {
    },
  • "kpis":
    {
    }
}

Expense Accounts

Iterate over expense accounts.

Returns expense accounts, sorted in ascending order by start date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/expense-accounts

Production

https://external.apis.enfore.com/ledger/org/{org-id}/expense-accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a expense account

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Responses

200

Expense account is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/expense-accounts/{account-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/expense-accounts/{account-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "ExpenseAccount",
  • "id": "string",
  • "nr": 0,
  • "name": "string",
  • "description": "string",
  • "currency": "AUD",
  • "is_active": true,
  • "current_booking_period_id": "string"
}

Tracking Accounts

Iterate over tracking accounts.

Returns tracking accounts, sorted in ascending order by start date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/tracking-accounts

Production

https://external.apis.enfore.com/ledger/org/{org-id}/tracking-accounts

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a tracking account

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

account-id
required
string

ID of the account to act upon

Responses

200

Tracking account is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/tracking-accounts/{account-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/tracking-accounts/{account-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "TrackingAccount",
  • "id": "string",
  • "nr": 0,
  • "name": "string",
  • "description": "string",
  • "currency": "AUD",
  • "is_active": true,
  • "current_booking_period_id": "string",
  • "purpose": "DEVICE",
  • "account_owner":
    {
    },
  • "service_location_id": "string"
}

Account Subscriptions

Get a list of registered consumers for account events.

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/account-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/account-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/account-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/account-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for accounts

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to act upon

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/account-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/account-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Booking Periods

Iterate over booking periods.

Returns booking periods, sorted in ascending order by start date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

status
Array of strings (BookingPeriodStatus)
Items Enum: "NEW" "OPEN" "IN_RECONCILIATION" "CLOSED"

When provided, only booking periods with one of the specified status values are returned

account_id
string <= 256 characters

When provided, only booking periods recorded for the specified account are returned. Using account_id makes account_type mandatory.

account_type
string (AccountType)
Enum: "BALANCE_SHEET_ACCOUNT" "BANK_ACCOUNT" "CASH_ACCOUNT" "CREDITOR_ACCOUNT" "DEBTOR_ACCOUNT" "EXPENSE_ACCOUNT" "INCOME_ACCOUNT" "STORED_VALUE_ACCOUNT" "TRACKING_ACCOUNT" "OTHER"

Kind of account. Mandatory if account_id is used.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/booking-periods

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-periods

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a booking period

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

booking-period-id
required
string

ID of the booking period to act upon

Responses

200

Booking period is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/booking-periods/{booking-period-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-periods/{booking-period-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "period_id": "string",
  • "description": "string",
  • "account":
    {
    },
  • "status": "NEW",
  • "status_log":
    [
    ],
  • "start_date_and_time": "2025-03-25T13:45:18Z",
  • "close_date_and_time": "2025-03-25T13:45:18Z",
  • "last_booking_date_and_time": "2025-03-25T13:45:18Z",
  • "balances":
    {
    },
  • "balancing_transaction":
    {
    },
  • "business_transaction_number_of_balancing_transaction": "string",
  • "was_started_automatically": false,
  • "was_activated_after_auto_start": false,
  • "activation_date_and_time": "2025-03-25T13:45:18Z"
}

Get a list of registered consumers for booking period events.

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/booking-period-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-period-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/booking-period-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-period-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for booking periods

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to act upon

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/booking-period-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-period-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

BP Counting Protocols

Iterate over all counting protocols of a booking period.

Returns counting protocols, sorted in ascending order by time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

booking-period-id
required
string

ID of the booking period to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/booking-periods/{booking-period-id}/counting-protocols/all

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-periods/{booking-period-id}/counting-protocols/all

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load the start counting protocol of a booking period

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

booking-period-id
required
string

ID of the booking period to act upon

Responses

200

Counting protocol is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/booking-periods/{booking-period-id}/counting-protocols/start

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-periods/{booking-period-id}/counting-protocols/start

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "counted_by": "string",
  • "counted_on": "2025-03-25T13:45:19Z",
  • "expected_amount":
    {
    },
  • "counted_amount":
    {
    },
  • "entries":
    [
    ]
}

Load the end counting protocol of a booking period

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

booking-period-id
required
string

ID of the booking period to act upon

Responses

200

Counting protocol is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/booking-periods/{booking-period-id}/counting-protocols/end

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-periods/{booking-period-id}/counting-protocols/end

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "counted_by": "string",
  • "counted_on": "2025-03-25T13:45:19Z",
  • "expected_amount":
    {
    },
  • "counted_amount":
    {
    },
  • "entries":
    [
    ]
}

BP Transactions

Iterate over all transactions of a booking period.

Returns transactions, sorted in ascending order by time.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

booking-period-id
required
string

ID of the booking period to act upon

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/booking-periods/{booking-period-id}/transactions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/booking-periods/{booking-period-id}/transactions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Expense Transactions

Iterate over expense transactions.

Returns expense transactions, sorted in ascending order by transaction timestamp.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

booking-period-id
string [ 1 .. 256 ] characters

When specified, only expense transactions that belong to the specified booking period will be returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/expense-transactions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/expense-transactions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load an expense transaction

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Expense transaction is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/expense-transactions/{transaction-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/expense-transactions/{transaction-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "ExpenseTransaction",
  • "id": "string",
  • "nr": 0,
  • "description": "string",
  • "business_transaction_number": "string",
  • "recorded_date_and_time": "2025-03-25T13:45:19Z",
  • "processed_date_and_time": "2025-03-25T13:45:19Z",
  • "booking_period_ids":
    [
    ],
  • "amount":
    {
    },
  • "recorded_at": "string",
  • "recorded_by": "string",
  • "created_by_process": true,
  • "reason":
    {
    },
  • "type": "CREDIT",
  • "expense_origin": "INVOICE",
  • "creditor":
    {
    },
  • "creditor_account":
    {
    },
  • "source_document_number": "string",
  • "source_document_date": "2025-03-25",
  • "items":
    [
    ],
  • "payments":
    [
    ]
}

Load the tags of an expense transaction

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Tags are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/expense-transactions/{transaction-id}/tags

Production

https://external.apis.enfore.com/ledger/org/{org-id}/expense-transactions/{transaction-id}/tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Income Transactions

Iterate over income transactions.

Returns income transactions, sorted in ascending order by transaction timestamp.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

booking-period-id
string [ 1 .. 256 ] characters

When specified, only income transactions that belong to the specified booking period will be returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/income-transactions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/income-transactions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load an income transaction

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Income transaction is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/income-transactions/{transaction-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/income-transactions/{transaction-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "IncomeTransaction",
  • "id": "string",
  • "nr": 0,
  • "description": "string",
  • "business_transaction_number": "string",
  • "recorded_date_and_time": "2025-03-25T13:45:19Z",
  • "processed_date_and_time": "2025-03-25T13:45:19Z",
  • "booking_period_ids":
    [
    ],
  • "amount":
    {
    },
  • "recorded_at": "string",
  • "recorded_by": "string",
  • "created_by_process": true,
  • "reason":
    {
    },
  • "type": "CREDIT",
  • "income_origin": "INVOICE",
  • "items":
    [
    ],
  • "payments":
    [
    ],
  • "invoice_or_credit_memo":
    {
    }
}

Load the tags of an income transaction

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Tags are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/income-transactions/{transaction-id}/tags

Production

https://external.apis.enfore.com/ledger/org/{org-id}/income-transactions/{transaction-id}/tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Money Transfers

Iterate over money transfers.

Returns money transfers, sorted in ascending order by transaction timestamp.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

booking-period-id
string [ 1 .. 256 ] characters

When specified, only money transfers that belong to the specified booking period will be returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/money-transfers

Production

https://external.apis.enfore.com/ledger/org/{org-id}/money-transfers

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a money transfer

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Money transfer is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/money-transfers/{transaction-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/money-transfers/{transaction-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "MoneyTransfer",
  • "id": "string",
  • "nr": 0,
  • "description": "string",
  • "business_transaction_number": "string",
  • "transaction_date_and_time": "2025-03-25T13:45:19Z",
  • "recorded_date_and_time": "2025-03-25T13:45:19Z",
  • "processed_date_and_time": "2025-03-25T13:45:19Z",
  • "booking_period_ids":
    [
    ],
  • "amount":
    {
    },
  • "recorded_at": "string",
  • "recorded_by": "string",
  • "created_by_process": true,
  • "reason":
    {
    },
  • "direction": "INCOMING",
  • "type": "SINGLE",
  • "counterpart": "string",
  • "purpose": "INITIAL_CASH_DEPOSIT",
  • "active_account":
    {
    },
  • "target_account":
    {
    },
  • "external_target_type": "BANK_ACCOUNT",
  • "counting_protocol":
    {
    },
  • "money_container_id": "string",
  • "safebag_id": "string"
}

Load the tags of a money transfer

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Tags are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/money-transfers/{transaction-id}/tags

Production

https://external.apis.enfore.com/ledger/org/{org-id}/money-transfers/{transaction-id}/tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Get a list of registered consumers for money transfer events. Deprecated

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/money-transfer-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/money-transfer-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API. Deprecated

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/money-transfer-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/money-transfer-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for money transfers Deprecated

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to act upon

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/money-transfer-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/money-transfer-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Payment Transactions

Iterate over payment transactions.

Returns payment transactions, sorted in ascending order by transaction timestamp.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

booking-period-id
string [ 1 .. 256 ] characters

When specified, only payment transactions that belong to the specified booking period will be returned.

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/payment-transactions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/payment-transactions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a payment transaction

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Payment transaction is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/payment-transactions/{transaction-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/payment-transactions/{transaction-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "@type": "PaymentTransaction",
  • "id": "string",
  • "nr": 0,
  • "description": "string",
  • "business_transaction_number": "string",
  • "recorded_date_and_time": "2025-03-25T13:45:19Z",
  • "processed_date_and_time": "2025-03-25T13:45:19Z",
  • "booking_period_ids":
    [
    ],
  • "amount":
    {
    },
  • "recorded_at": "string",
  • "recorded_by": "string",
  • "created_by_process": true,
  • "reason":
    {
    },
  • "type": "CREDIT",
  • "money_account":
    {
    },
  • "contact_account":
    {
    },
  • "payment_information":
    {
    },
  • "referenced_transactions":
    [
    ],
  • "tip":
    {
    }
}

Load the tags of a payment transaction

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

transaction-id
required
string

ID of the transaction to act upon

Responses

200

Tags are successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/payment-transactions/{transaction-id}/tags

Production

https://external.apis.enfore.com/ledger/org/{org-id}/payment-transactions/{transaction-id}/tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Transaction Tags

Iterate over transaction tags.

Returns transaction tags, sorted in ascending order by name.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

is_active
boolean

Controls whether the query shall return:

  • true -> only objects that are active
  • false -> only objects that are inactive
  • not specified -> both active and inactive objects

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/transaction-tags

Production

https://external.apis.enfore.com/ledger/org/{org-id}/transaction-tags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Create a new transaction tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

is_active
required
boolean
Default: true

Whether the tag is active or not.

Inactive tags are not presented for selection by users when assigning tags via UI. They are not removed from any object they have been assigned to before though and can be reactivated when necessary.

Responses

200

Tag successfully created

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

post/org/{org-id}/transaction-tags

Production

https://external.apis.enfore.com/ledger/org/{org-id}/transaction-tags

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "is_active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name":
    {
    },
  • "is_active": true
}

Load a transaction tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

tag-id
required
string

ID of the tag to act upon

Responses

200

Transaction tag is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/transaction-tags/{tag-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/transaction-tags/{tag-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name":
    {
    },
  • "is_active": true
}

Update a transation tag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

tag-id
required
string

ID of the tag to act upon

Request Body schema: application/json
name
required
object (LocalizedString)

Holds a text that is optionally localized to different languages.

is_active
required
boolean
Default: true

Whether the tag is active or not.

Inactive tags are not presented for selection by users when assigning tags via UI. They are not removed from any object they have been assigned to before though and can be reactivated when necessary.

Responses

200

Tag was updated successfully

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

put/org/{org-id}/transaction-tags/{tag-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/transaction-tags/{tag-id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name":
    {
    },
  • "is_active": true
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "name":
    {
    },
  • "is_active": true
}

Transaction Subscriptions

Get a list of registered consumers for transaction events.

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/transaction-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/transaction-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Register an event consumer with the API.

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/transaction-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/transaction-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for transactions

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to act upon

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/transaction-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/transaction-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}

Safebags

Iterate over safebags.

Returns safebags, sorted in ascending order by creation date.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

query Parameters
from
required
string <date-time>

Defines the time starting from which objects are to be returned. Objects with exactly this date are also returned - this means that the start of a left-closed interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

to
required
string <date-time>

Defines the time up to which objects are to be returned. Objects with exactly this date are not returned - this means that the end of a right-open interval is defined. Timestamp in UTC. The date-time notation as defined by RFC 3339 (https://www.ietf.org/rfc/rfc3339.txt), section 5.6, with the "Z" as time-offset. For example, 2017-07-21T17:32:28.123Z

limit
integer <int64> [ 1 .. 5000 ]

Max number of objects to be returned per page. Note that both the items as well as the problems arrays of the query response count towards this number to allow a simple, consistent paging over all items (and problems) of a given timeframe. If not given, defaults to 200.

offset
integer <int64> >= 0

Offset of items and problems of where to start the next page. Similar to limit and offset in SQL, one would obtain the second page with limit=10&offset=10. Note that this paging with limit and offset is within a time interval that is specified with from and to. If not given, defaults to 0.

status
Array of strings (SafebagStatus)
Items Enum: "IN_PREPARATION" "PREPARED" "READY_FOR_PICKUP" "PICKED_UP" "REJECTED"

When provided, only safebags with one of the specified status values are returned

Responses

200

Data successfully returned

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

get/org/{org-id}/safebags

Production

https://external.apis.enfore.com/ledger/org/{org-id}/safebags

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "items":
    [
    ],
  • "problems":
    []
}

Load a safebag

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

safebag-id
required
string

ID of the safebag to act upon

Responses

200

Safebag is successfully returned

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

422

Specified data is semantically incorrect.

get/org/{org-id}/safebags/{safebag-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/safebags/{safebag-id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "identifier": "string",
  • "status": "IN_PREPARATION",
  • "status_log":
    [
    ],
  • "service_location_id": "string",
  • "transfers":
    [
    ],
  • "amount":
    {
    },
  • "counting_protocol":
    {
    },
  • "rejection_transfer":
    {
    },
  • "verified_by": "string"
}

List subscriptions for safebags

Retrieve all currently active event subscriptions.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Responses

200

List of registrations

403

Credentials missing or not sufficient

get/org/{org-id}/safebag-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/safebag-subscriptions

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Create a subscription for safebags

If the callback URL is already registered, we return the original subscription ID. We will continue attempting to send new items to registered subscriptions until they are deleted. In case we cannot reach the endpoint, we will apply an exponential backoff.

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

Request Body schema: application/json
callback_url
required
string <uri>

The callback URL where event notifications are to be delivered. It must be HTTPS to prevent man-in-the-middle attacks.

Responses

201

Registration of subscription successful (or already subscribed)

400

Invalid parameters were sent by the client

403

Credentials missing or not sufficient

Callbacks

post<no summary>
post/org/{org-id}/safebag-subscriptions

Production

https://external.apis.enfore.com/ledger/org/{org-id}/safebag-subscriptions

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{}

Callback payload samples

Callback
POST: <no summary>
Content type
application/json
Copy
 Expand all Collapse all
{
  • "org_id": "string",
  • "items":
    [
    ],
  • "problems":
    []
}

Delete a subscription for safebags

path Parameters
org-id
required
string

ID of the organization whose data is being accessed.

subscription-id
required
string

ID of the subscription to act upon

Responses

204

Subscription was successfully deleted

403

Credentials missing or not sufficient

404

Resource(s) not found or invalid identifier

delete/org/{org-id}/safebag-subscriptions/{subscription-id}

Production

https://external.apis.enfore.com/ledger/org/{org-id}/safebag-subscriptions/{subscription-id}

Response samples

Content type
application/problem+json
Copy
 Expand all Collapse all
{}