Search CoworkerLedgerEntries - Nexudus Platform

GET

api

billing

coworkerledgerentries

Search CoworkerLedgerEntries

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

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

A CoworkerLedgerEntry is an individual financial transaction line in a customer’s ledger. Ledger entries record debits, credits, and the running balance between a location and a customer. Each entry can be linked to a CoworkerInvoice and carries a PaymentGatewayName that identifies which payment provider processed the transaction. The ledger balance reflects the net financial position between the location and the customer:

A positive balance means the customer owes money (unpaid invoices).
A negative balance means the customer has credited payments that will be applied to future invoices.
A balance of 0 means the account is settled with no outstanding invoices or credits.

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

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

CoworkerLedgerEntry_Business

integer

Filter by iD of the business linked to this record.

CoworkerLedgerEntry_Business_Name

string

Filter by location name.

CoworkerLedgerEntry_Business_Currency_Code

string

Filter by location currency code.

CoworkerLedgerEntry_Coworker

integer

Filter by iD of the coworker linked to this record.

CoworkerLedgerEntry_Coworker_FullName

string

Filter by coworker full name.

CoworkerLedgerEntry_CoworkerInvoice

integer

Filter by iD of the coworker invoice linked to this record.

CoworkerLedgerEntry_CoworkerInvoice_InvoiceNumber

string

Filter by invoice number.

CoworkerLedgerEntry_CoworkerInvoice_TotalAmount

string

Filter by invoice total amount.

CoworkerLedgerEntry_CoworkerInvoice_BillToName

string

Filter by invoice bill-to name.

CoworkerLedgerEntry_CoworkerInvoice_Paid

boolean

Filter by whether the invoice has been paid.

CoworkerLedgerEntry_CoworkerInvoice_PaidOn

string

Filter by date the invoice was paid.

CoworkerLedgerEntry_CoworkerInvoice_Refunded

boolean

Filter by whether the invoice has been refunded.

CoworkerLedgerEntry_CoworkerInvoice_RefundedOn

string

Filter by date the invoice was refunded.

CoworkerLedgerEntry_CoworkerInvoice_DueDate

string

Filter by invoice due date.

CoworkerLedgerEntry_CoworkerInvoice_Draft

boolean

Filter by whether the invoice is a draft.

CoworkerLedgerEntry_CoworkerInvoice_WaitingForInvoiceNumber

boolean

Filter by whether the invoice is waiting to be assigned an invoice number.

CoworkerLedgerEntry_Description

string

Filter by free-text description of this coworker ledger entry.

CoworkerLedgerEntry_Code

string

Filter by ledger entry code.

CoworkerLedgerEntry_Debit

number

Filter by debit amount.

CoworkerLedgerEntry_Credit

number

Filter by credit amount.

CoworkerLedgerEntry_PaymentGatewayName

integer

Filter by payment gateway name.

CoworkerLedgerEntry_PaymentMethodNumber

string

Filter by payment method number.

CoworkerLedgerEntry_TransactionDate

string

Filter by transaction date.

CoworkerLedgerEntry_Balance

number

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

CoworkerLedgerEntry_Billed

boolean

Filter by whether this entry has been billed.

CoworkerLedgerEntry_TransactionDateLocal

string

Filter by transaction date in the location’s local time.

CoworkerLedgerEntry_ConnectedTransactionGuid

string

Filter by connected transaction GUID.

Range Filters

from_CoworkerLedgerEntry_CoworkerInvoicePaidOn

string

Filter by date the invoice was paid greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerLedgerEntry_CoworkerInvoicePaidOn

string

Filter by date the invoice was paid less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerLedgerEntry_CoworkerInvoiceRefundedOn

string

Filter by date the invoice was refunded greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerLedgerEntry_CoworkerInvoiceRefundedOn

string

Filter by date the invoice was refunded less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerLedgerEntry_CoworkerInvoiceDueDate

string

Filter by invoice due date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerLedgerEntry_CoworkerInvoiceDueDate

string

Filter by invoice due date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerLedgerEntry_Debit

number

Filter by debit amount greater than or equal to this value.

to_CoworkerLedgerEntry_Debit

number

Filter by debit amount less than or equal to this value.

from_CoworkerLedgerEntry_Credit

number

Filter by credit amount greater than or equal to this value.

to_CoworkerLedgerEntry_Credit

number

Filter by credit amount less than or equal to this value.

from_CoworkerLedgerEntry_TransactionDate

string

Filter by transaction date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerLedgerEntry_TransactionDate

string

Filter by transaction date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerLedgerEntry_Balance

number

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

to_CoworkerLedgerEntry_Balance

number

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

from_CoworkerLedgerEntry_TransactionDateLocal

string

Filter by transaction date in the location’s local time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerLedgerEntry_TransactionDateLocal

string

Filter by transaction date in the location’s local time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerLedgerEntry_CreatedOn

string

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

to_CoworkerLedgerEntry_CreatedOn

string

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

from_CoworkerLedgerEntry_UpdatedOn

string

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

to_CoworkerLedgerEntry_UpdatedOn

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"

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"

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"

Response

200

Records

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: Description, 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.

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,
      "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,
      "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
}

Get one CoworkerLedgerEntryRetrieve a single CoworkerLedgerEntry record by its Id.

Search CoworkerLedgerEntries

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

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

Documentation Index

​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