Search LedgerEntries

GET

api

billing

ledgerentries

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

import requests

url = "https://spaces.nexudus.com/api/billing/ledgerentries"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/ledgerentries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the business linked to this record.

string

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

string

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

number

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

number

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

number

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

Range Filters

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.

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.

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.

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.

number

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

number

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

string

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

string

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

string

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

string

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

Code Examples

Simple listing

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/ledgerentries?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Code',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/ledgerentries',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Code',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Code

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/ledgerentries?' + new URLSearchParams({
    LedgerEntry_Code: 'example-value',
    orderBy: 'Code',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/ledgerentries',
    params={
        'LedgerEntry_Code': 'example-value',
        'orderBy': 'Code',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/ledgerentries?' + new URLSearchParams({
    from_LedgerEntry_UpdatedOn: '2025-01-01T00:00',
    to_LedgerEntry_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/ledgerentries',
    params={
        'from_LedgerEntry_UpdatedOn': '2025-01-01T00:00',
        'to_LedgerEntry_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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": "admin@example.com",
      "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
}

Get one LedgerEntryRetrieve a single LedgerEntry record by its Id.

Search LedgerEntries

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

import requests

url = "https://spaces.nexudus.com/api/billing/ledgerentries"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/ledgerentries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Code

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Code

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Code

Range filters

Response

200