CoworkerLedgerEntries
Get one CoworkerLedgerEntry
Retrieve a single CoworkerLedgerEntry record by its Id.
GET
Get one CoworkerLedgerEntry
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
Code Examples
Response
200
Required ledger reference code; payment and invoice workflows commonly generate codes such as PAYM-, CASH-, CRED-, REFD-, or INVC-..
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..
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..
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..
Payment-method detail supplied by the payment processor; hidden because it can contain sensitive payment information..
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..
Read-only running ledger balance calculated by the database as cumulative credits minus debits, ordered by transaction date and entry ID..
Internal flag tracking whether Nexudus has billed this transaction to the operator; hidden because it is managed by billing workflows..
Internal localized copy of TransactionDate derived using the owning location’s time zone; hidden because TransactionDate is the supported input..
Internal identifier linking related ledger transactions so that deletion can reverse the connected payment; hidden because it is managed by payment workflows..
Example Response