Create CoworkerLedgerEntry

POST

api

billing

coworkerledgerentries

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerledgerentries \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "CoworkerId": 123,
  "Description": "<string>",
  "Code": "<string>",
  "Debit": 123,
  "Credit": 123,
  "Balance": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "CoworkerId": 123,
    "Description": "<string>",
    "Code": "<string>",
    "Debit": 123,
    "Credit": 123,
    "Balance": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CoworkerId: 123,
    Description: '<string>',
    Code: '<string>',
    Debit: 123,
    Credit: 123,
    Balance: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerledgerentries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

ePaymentProvider

Value	Name
1	PayPalStandard
2	PaypalStandardSubscription
3	GoCardless
4	Stripe
5	AuthorizeNetDirect
6	UsaEPay
7	AuthorizeNetSubscription
8	Adyen
9	MultiGateway
11	Manual
12	Forte
13	PayPalAdaptive
14	GoCardlessPro
15	CreditCard
16	EPay
17	Braintree
18	MidTrans
19	EziDebit
20	LiqPay
21	RazorPay
22	SquareCash
23	SquareCreditCard
24	StripeACH
25	StripeDirectDebit
26	IZettleCreditCard
27	PeachPayments
28	Klarna
29	StripeTerminal
30	PayPalStandardRest
401	HostedPaymentPage1
402	HostedPaymentPage2
403	HostedPaymentPage3
500	Xero
501	Quickbooks
989	ManualDirectDebit
990	BadDebt
991	CreditCardManual1
992	CreditCardManual2
993	CreditCardManual3
994	Credit
995	Gift
996	Bank
997	Cash
998	Check
999	Other

Request Body

Required Fields

integer

required

ID of the business linked to this record.

integer

required

ID of the coworker linked to this record.

string

required

Free-text description of this coworker ledger entry.

string

required

Ledger entry code.

number

required

Debit amount.

number

required

Credit amount.

number

required

Account balance after this transaction. Read-only.

Optional Fields

integer

ID of the coworker invoice linked to this record.

integer

Payment gateway name. See ePaymentProvider? enum above.

string

Payment method number.

string

Transaction date.

boolean

Whether this entry has been billed.

string

Transaction date in the location’s local time.

string

Connected transaction GUID.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkerledgerentries" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "CoworkerId": 0,
    "Description": "",
    "Code": "",
    "Debit": 0,
    "Credit": 0,
    "Balance": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      CoworkerId: 0,
      Description: '',
      Code: '',
      Debit: 0,
      Credit: 0,
      Balance: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerledgerentries',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'CoworkerId': 0,
        'Description': '',
        'Code': '',
        'Debit': 0,
        'Credit': 0,
        'Balance': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkerledgerentry was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerLedgerEntry was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Description: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Description"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerLedgerEntryUpdate an existing CoworkerLedgerEntry record.

Create CoworkerLedgerEntry

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerledgerentries \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "CoworkerId": 123,
  "Description": "<string>",
  "Code": "<string>",
  "Debit": 123,
  "Credit": 123,
  "Balance": 123
}
'

import requests

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

payload = {
    "BusinessId": 123,
    "CoworkerId": 123,
    "Description": "<string>",
    "Code": "<string>",
    "Debit": 123,
    "Credit": 123,
    "Balance": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    CoworkerId: 123,
    Description: '<string>',
    Code: '<string>',
    Debit: 123,
    Credit: 123,
    Balance: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerledgerentries', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400