Search CoworkerLedgerEntries

GET

api

billing

coworkerledgerentries

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

import requests

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

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/coworkerledgerentries', 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 CoworkerLedgerEntry, shown as a ledger entry, records a payment, charge, credit, or adjustment in a customer’s financial ledger for a location and can be applied to an invoice.

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 CoworkerLedgerEntry-List role.

Enums

ePaymentProvider

Value	Name
1	PayPalStandard
2	PaypalStandardSubscription
3	GoCardless
4	Stripe
5	AuthorizeNetDirect
6	UsaEPay
7	AuthorizeNetSubscription
8	Adyen
9	MultiGateway
11	Manual
12	Forte
13	PayPalAdaptive
14	GoCardlessPro
15	CreditCard
16	EPay
17	Braintree
18	MidTrans
19	EziDebit
20	LiqPay
21	RazorPay
22	SquareCash
23	SquareCreditCard
24	StripeACH
25	StripeDirectDebit
26	IZettleCreditCard
27	PeachPayments
28	Klarna
29	StripeTerminal
30	PayPalStandardRest
401	HostedPaymentPage1
402	HostedPaymentPage2
403	HostedPaymentPage3
500	Xero
501	Quickbooks
986	VirtualCard
987	PosTerminal
988	BankDraft
989	ManualDirectDebit
990	BadDebt
991	CreditCardManual1
992	CreditCardManual2
993	CreditCardManual3
994	Credit
995	Gift
996	Bank
997	Cash
998	Check
999	Other

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 location that owns this ledger entry..

string

Filter by display value for Business.Name..

string

Filter by display value for Business.Currency.Code..

integer

Filter by iD of the customer whose ledger contains this entry..

string

Filter by display value for Coworker.FullName..

integer

Filter by optional ID of the invoice this payment, charge, or credit is applied to..

string

Filter by display value for CoworkerInvoice.InvoiceNumber..

number

Filter by display value for CoworkerInvoice.TotalAmount..

string

Filter by display value for CoworkerInvoice.BillToName..

boolean

Filter by display value for CoworkerInvoice.Paid..

string

Filter by display value for CoworkerInvoice.PaidOn..

boolean

Filter by display value for CoworkerInvoice.Refunded..

string

Filter by display value for CoworkerInvoice.RefundedOn..

string

Filter by display value for CoworkerInvoice.DueDate..

boolean

Filter by display value for CoworkerInvoice.Draft..

boolean

Filter by display value for CoworkerInvoice.WaitingForInvoiceNumber..

string

Filter by required free-text explanation of the payment, charge, credit, or adjustment..

string

Filter by required ledger reference code; payment and invoice workflows commonly generate codes such as PAYM-, CASH-, CRED-, REFD-, or INVC-..

number

Filter by debit amount in the location currency, rounded to two decimal places when saved; positive debits are invoice charges and negative debits are credit notes. Debit and Credit are mutually exclusive, so set the other amount to zero..

number

Filter by credit amount in the location currency, rounded to two decimal places when saved; positive credits are received payments and negative credits are refunded payments. Credit and Debit are mutually exclusive, so set the other amount to zero..

integer

Filter by payment provider or payment method for this transaction; choosing a connected gateway such as Stripe or Spreedly attempts to collect payment and creation can fail if collection fails. Manual payments cannot use GoCardless, GoCardlessPro, StripeDirectDebit, Xero, Forte, or StripeACH..

string

Filter by payment-method detail supplied by the payment processor; hidden because it can contain sensitive payment information..

string

Filter by date and time of the transaction in UTC; defaults to the current UTC time when omitted and cannot be before the location billing lock date..

number

Filter by read-only running ledger balance calculated by the database as cumulative credits minus debits, ordered by transaction date and entry ID..

boolean

Filter by internal flag tracking whether Nexudus has billed this transaction to the operator; hidden because it is managed by billing workflows..

string

Filter by internal localized copy of TransactionDate derived using the owning location’s time zone; hidden because TransactionDate is the supported input..

string

Filter by internal identifier linking related ledger transactions so that deletion can reverse the connected payment; hidden because it is managed by payment workflows..

Range Filters

number

Filter by display value for CoworkerInvoice.TotalAmount. greater than or equal to this value.

number

Filter by display value for CoworkerInvoice.TotalAmount. less than or equal to this value.

string

Filter by display value for CoworkerInvoice.PaidOn. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.PaidOn. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.RefundedOn. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.RefundedOn. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.DueDate. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.DueDate. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

string

Filter by date and time of the transaction in UTC; defaults to the current UTC time when omitted and cannot be before the location billing lock date. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date and time of the transaction in UTC; defaults to the current UTC time when omitted and cannot be before the location billing lock date. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by read-only running ledger balance calculated by the database as cumulative credits minus debits, ordered by transaction date and entry ID. greater than or equal to this value.

number

Filter by read-only running ledger balance calculated by the database as cumulative credits minus debits, ordered by transaction date and entry ID. less than or equal to this value.

string

Filter by internal localized copy of TransactionDate derived using the owning location’s time zone; hidden because TransactionDate is the supported input. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by internal localized copy of TransactionDate derived using the owning location’s time zone; hidden because TransactionDate is the supported input. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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/coworkerledgerentries?page=1&size=15&orderBy=Description&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by Description

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerledgerentries?' + new URLSearchParams({
    from_CoworkerLedgerEntry_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerLedgerEntry_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/coworkerledgerentries',
    params={
        'from_CoworkerLedgerEntry_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerLedgerEntry_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CoworkerLedgerEntry[]

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

Partial records — The listing endpoint returns a summary representation of each CoworkerLedgerEntry. The following fields are not populated in the Records[] response: PaymentMethodNumber.To get all fields, fetch the full record using the Get one CoworkerLedgerEntry endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

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,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "CoworkerInvoiceId": null,
      "CoworkerInvoiceInvoiceNumber": null,
      "CoworkerInvoiceTotalAmount": null,
      "CoworkerInvoiceBillToName": null,
      "CoworkerInvoicePaid": null,
      "CoworkerInvoicePaidOn": null,
      "CoworkerInvoiceRefunded": null,
      "CoworkerInvoiceRefundedOn": null,
      "CoworkerInvoiceDueDate": null,
      "CoworkerInvoiceDraft": null,
      "CoworkerInvoiceWaitingForInvoiceNumber": null,
      "Description": "",
      "Code": "",
      "Debit": 0,
      "Credit": 0,
      "PaymentGatewayName": 0,
      "TransactionDate": null,
      "Balance": 0,
      "Billed": false,
      "TransactionDateLocal": null,
      "ConnectedTransactionGuid": null,
      "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": "CoworkerLedgerEntry Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Description",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search CoworkerLedgerEntries

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

import requests

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

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/coworkerledgerentries', 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

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Description

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Description

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Description

Range filters

Response

200