Get one CoworkerLedgerEntry

Retrieve a single CoworkerLedgerEntry record by its Id.

GET /api/billing/coworkerledgerentries/{id}

Get one CoworkerLedgerEntry

cURL

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

200

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceInvoiceNumber": "<string>",
  "CoworkerInvoiceTotalAmount": "<string>",
  "CoworkerInvoiceBillToName": "<string>",
  "CoworkerInvoicePaid": true,
  "CoworkerInvoicePaidOn": "<string>",
  "CoworkerInvoiceRefunded": true,
  "CoworkerInvoiceRefundedOn": "<string>",
  "CoworkerInvoiceDueDate": "<string>",
  "CoworkerInvoiceDraft": true,
  "CoworkerInvoiceWaitingForInvoiceNumber": true,
  "Description": "<string>",
  "Code": "<string>",
  "Debit": 123,
  "Credit": 123,
  "PaymentGatewayName": 123,
  "PaymentMethodNumber": "<string>",
  "TransactionDate": "<string>",
  "Balance": 123,
  "Billed": true,
  "TransactionDateLocal": "<string>",
  "ConnectedTransactionGuid": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

id · integer · required

The Id of the CoworkerLedgerEntry record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

BusinessId · integer

ID of the business linked to this record.

BusinessName · string

Location name.

BusinessCurrencyCode · string

Location currency code.

CoworkerId · integer

ID of the coworker linked to this record.

CoworkerFullName · string

Coworker full name.

CoworkerInvoiceId · integer

ID of the coworker invoice linked to this record.

CoworkerInvoiceInvoiceNumber · string

Invoice number.

CoworkerInvoiceTotalAmount · string

Invoice total amount.

CoworkerInvoiceBillToName · string

Invoice bill-to name.

CoworkerInvoicePaid · boolean

Whether the invoice has been paid.

CoworkerInvoicePaidOn · string

Date the invoice was paid.

CoworkerInvoiceRefunded · boolean

Whether the invoice has been refunded.

CoworkerInvoiceRefundedOn · string

Date the invoice was refunded.

CoworkerInvoiceDueDate · string

Invoice due date.

CoworkerInvoiceDraft · boolean

Whether the invoice is a draft.

CoworkerInvoiceWaitingForInvoiceNumber · boolean

Whether the invoice is waiting to be assigned an invoice number.

Description · string

Free-text description of this coworker ledger entry.

Code · string

Ledger entry code.

Debit · number

Debit amount.

Credit · number

Credit amount.

PaymentGatewayName · integer

Payment gateway name.

PaymentMethodNumber · string

Payment method number.

TransactionDate · string

Transaction date.

Balance · number

Account balance after this transaction. Read-only.

Billed · boolean

Whether this entry has been billed.

TransactionDateLocal · string

Transaction date in the location’s local time.

ConnectedTransactionGuid · string

Connected transaction GUID.

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "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,
  "PaymentMethodNumber": null,
  "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": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerLedgerEntry Example",
  "LocalizationDetails": null,
  "CustomFields": null
}