Search LedgerEntries

Search and list LedgerEntry records with filtering, sorting, and pagination.

GET /api/billing/ledgerentries

Search LedgerEntries

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/ledgerentries \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A LedgerEntry is a credit or debit record in the financial ledger for invoices issued by Nexudus to the operator (the business running the coworking space).

Each entry records either a debit or a credit against a location. Entries are identified by an optional Code for grouping or reconciliation and a free-text Description explaining the transaction.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the LedgerEntry-List role.

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

LedgerEntry_Business · integer

Filter by iD of the business linked to this record.

LedgerEntry_Code · string

Filter by short reference code for grouping or reconciliation (e.g. an external accounting reference).

LedgerEntry_Description · string

Filter by free-text description explaining the purpose of this ledger entry.

LedgerEntry_Debit · number

Filter by debit amount in the location’s default currency. Use 0 if this entry is a credit-only record.

LedgerEntry_Credit · number

Filter by credit amount in the location’s default currency. Use 0 if this entry is a debit-only record.

LedgerEntry_Balance · number

Filter by account balance after this transaction. Read-only.

Range Filters

from_LedgerEntry_Debit · number

Filter by debit amount in the location’s default currency. Use 0 if this entry is a credit-only record greater than or equal to this value.

to_LedgerEntry_Debit · number

Filter by debit amount in the location’s default currency. Use 0 if this entry is a credit-only record less than or equal to this value.

from_LedgerEntry_Credit · number

Filter by credit amount in the location’s default currency. Use 0 if this entry is a debit-only record greater than or equal to this value.

to_LedgerEntry_Credit · number

Filter by credit amount in the location’s default currency. Use 0 if this entry is a debit-only record less than or equal to this value.

from_LedgerEntry_Balance · number

Filter by account balance after this transaction. Read-only greater than or equal to this value.

to_LedgerEntry_Balance · number

Filter by account balance after this transaction. Read-only less than or equal to this value.

from_LedgerEntry_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_LedgerEntry_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_LedgerEntry_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_LedgerEntry_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/ledgerentries?page=1&size=15&orderBy=Code&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Code

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/ledgerentries?LedgerEntry_Code=example-value&orderBy=Code&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/ledgerentries?from_LedgerEntry_UpdatedOn=2025-01-01T00:00&to_LedgerEntry_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · LedgerEntry[]

The list of LedgerEntry records matching the query. See the Get one LedgerEntry endpoint for the full list of properties returned for each record.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Code": "",
      "Description": "",
      "Debit": 0,
      "Credit": 0,
      "Balance": 0,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "LedgerEntry Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Code",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}