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

<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">
  ID of the location that owns this ledger entry..
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Display value for Business.Name..
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  Display value for Business.Currency.Code..
</ResponseField>

<ResponseField name="CoworkerId" type="integer">
  ID of the customer whose ledger contains this entry..
</ResponseField>

<ResponseField name="CoworkerFullName" type="string">
  Display value for Coworker.FullName..
</ResponseField>

<ResponseField name="CoworkerInvoiceId" type="integer">
  Optional ID of the invoice this payment, charge, or credit is applied to..
</ResponseField>

<ResponseField name="CoworkerInvoiceInvoiceNumber" type="string">
  Display value for CoworkerInvoice.InvoiceNumber..
</ResponseField>

<ResponseField name="CoworkerInvoiceTotalAmount" type="number">
  Display value for CoworkerInvoice.TotalAmount..
</ResponseField>

<ResponseField name="CoworkerInvoiceBillToName" type="string">
  Display value for CoworkerInvoice.BillToName..
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="boolean">
  Display value for CoworkerInvoice.Paid..
</ResponseField>

<ResponseField name="CoworkerInvoicePaidOn" type="string">
  Display value for CoworkerInvoice.PaidOn..
</ResponseField>

<ResponseField name="CoworkerInvoiceRefunded" type="boolean">
  Display value for CoworkerInvoice.Refunded..
</ResponseField>

<ResponseField name="CoworkerInvoiceRefundedOn" type="string">
  Display value for CoworkerInvoice.RefundedOn..
</ResponseField>

<ResponseField name="CoworkerInvoiceDueDate" type="string">
  Display value for CoworkerInvoice.DueDate..
</ResponseField>

<ResponseField name="CoworkerInvoiceDraft" type="boolean">
  Display value for CoworkerInvoice.Draft..
</ResponseField>

<ResponseField name="CoworkerInvoiceWaitingForInvoiceNumber" type="boolean">
  Display value for CoworkerInvoice.WaitingForInvoiceNumber..
</ResponseField>

<ResponseField name="Description" type="string">
  Required free-text explanation of the payment, charge, credit, or adjustment..
</ResponseField>

<ResponseField name="Code" type="string">
  Required ledger reference code; payment and invoice workflows commonly generate codes such as PAYM-, CASH-, CRED-, REFD-, or INVC-..
</ResponseField>

<ResponseField name="Debit" type="number">
  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..
</ResponseField>

<ResponseField name="Credit" type="number">
  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..
</ResponseField>

<ResponseField name="PaymentGatewayName" type="integer">
  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..
</ResponseField>

<ResponseField name="PaymentMethodNumber" type="string">
  Payment-method detail supplied by the payment processor; hidden because it can contain sensitive payment information..
</ResponseField>

<ResponseField name="TransactionDate" type="string">
  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..
</ResponseField>

<ResponseField name="Balance" type="number">
  Read-only running ledger balance calculated by the database as cumulative credits minus debits, ordered by transaction date and entry ID..
</ResponseField>

<ResponseField name="Billed" type="boolean">
  Internal flag tracking whether Nexudus has billed this transaction to the operator; hidden because it is managed by billing workflows..
</ResponseField>

<ResponseField name="TransactionDateLocal" type="string">
  Internal localized copy of TransactionDate derived using the owning location's time zone; hidden because TransactionDate is the supported input..
</ResponseField>

<ResponseField name="ConnectedTransactionGuid" type="string">
  Internal identifier linking related ledger transactions so that deletion can reverse the connected payment; hidden because it is managed by payment workflows..
</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
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.