> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one CoworkerLedgerEntry

> Retrieve a single CoworkerLedgerEntry record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CoworkerLedgerEntry record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerledgerentries/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  Business Id.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Location name.
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Location currency code.
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  Coworker Id.
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Coworker full name.
</ResponseField>

<ResponseField name="CoworkerInvoiceId" type="integer">
  Coworker Invoice Id.
</ResponseField>

<ResponseField name="CoworkerInvoiceInvoiceNumber" type="string">
  Invoice number.
</ResponseField>

<ResponseField name="CoworkerInvoiceTotalAmount" type="string">
  Invoice total amount.
</ResponseField>

<ResponseField name="CoworkerInvoiceBillToName" type="string">
  Invoice bill-to name.
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="boolean">
  Whether the invoice has been paid.
</ResponseField>

<ResponseField name="CoworkerInvoicePaidOn" type="string">
  Date the invoice was paid.
</ResponseField>

<ResponseField name="CoworkerInvoiceRefunded" type="boolean">
  Whether the invoice has been refunded.
</ResponseField>

<ResponseField name="CoworkerInvoiceRefundedOn" type="string">
  Date the invoice was refunded.
</ResponseField>

<ResponseField name="CoworkerInvoiceDueDate" type="string">
  Invoice due date.
</ResponseField>

<ResponseField name="CoworkerInvoiceDraft" type="boolean">
  Whether the invoice is a draft.
</ResponseField>

<ResponseField name="CoworkerInvoiceWaitingForInvoiceNumber" type="boolean">
  Whether the invoice is waiting to be assigned an invoice number.
</ResponseField>

<ResponseField name="Description" type="string">
  Description.
</ResponseField>

<ResponseField name="Code" type="string">
  Ledger entry code.
</ResponseField>

<ResponseField name="Debit" type="number">
  Debit amount.
</ResponseField>

<ResponseField name="Credit" type="number">
  Credit amount.
</ResponseField>

<ResponseField name="PaymentGatewayName" type="integer">
  Payment gateway name.
</ResponseField>

<ResponseField name="PaymentMethodNumber" type="string">
  Payment method number.
</ResponseField>

<ResponseField name="TransactionDate" type="string">
  Transaction date.
</ResponseField>

<ResponseField name="Balance" type="number">
  Balance.
</ResponseField>

<ResponseField name="Billed" type="boolean">
  Whether this entry has been billed.
</ResponseField>

<ResponseField name="TransactionDateLocal" type="string">
  Transaction date in the location's local time.
</ResponseField>

<ResponseField name="ConnectedTransactionGuid" type="string">
  Connected transaction GUID.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerLedgerEntry Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```
