Get one CoworkerLedgerEntry

GET

api

billing

coworkerledgerentries

{id}

Get one CoworkerLedgerEntry

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceInvoiceNumber": "<string>",
  "CoworkerInvoiceTotalAmount": 123,
  "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, 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-Read role.

Path Parameters

integer

required

The Id of the CoworkerLedgerEntry record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the location that owns this ledger entry..

string

Display value for Business.Name..

string

Display value for Business.Currency.Code..

integer

ID of the customer whose ledger contains this entry..

string

Display value for Coworker.FullName..

integer

Optional ID of the invoice this payment, charge, or credit is applied to..

string

Display value for CoworkerInvoice.InvoiceNumber..

number

Display value for CoworkerInvoice.TotalAmount..

string

Display value for CoworkerInvoice.BillToName..

boolean

Display value for CoworkerInvoice.Paid..

string

Display value for CoworkerInvoice.PaidOn..

boolean

Display value for CoworkerInvoice.Refunded..

string

Display value for CoworkerInvoice.RefundedOn..

string

Display value for CoworkerInvoice.DueDate..

boolean

Display value for CoworkerInvoice.Draft..

boolean

Display value for CoworkerInvoice.WaitingForInvoiceNumber..

string

Required free-text explanation of the payment, charge, credit, or adjustment..

string

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

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

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

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

string

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

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

number

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

boolean

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

string

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

string

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

integer

Unique record identifier.

string

UUID of the record.

string

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

string

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

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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

Get one CoworkerLedgerEntry

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceInvoiceNumber": "<string>",
  "CoworkerInvoiceTotalAmount": 123,
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200