Update CoworkerLedgerEntry

PUT

api

billing

coworkerledgerentries

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    CoworkerId: 123,
    Description: '<string>',
    Code: '<string>',
    Debit: 123,
    Credit: 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>"
    }
  ]
}

Updates an existing CoworkerLedgerEntry record. You must include the Id of the record to update along with all required fields.

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-Edit 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
986	VirtualCard
987	PosTerminal
988	BankDraft
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

The Id of the CoworkerLedgerEntry record to update.

integer

required

ID of the location that owns this ledger entry..

integer

required

ID of the customer whose ledger contains this entry..

string

required

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

string

required

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

number

required

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

required

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

Optional Fields

integer

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

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.. See ePaymentProvider? enum above.

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

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

Code Examples

curl -X PUT \
  "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,
    "Id": 87654321
}'

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

const data = await response.json();

import requests

response = requests.put(
    '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,
        'Id': 87654321
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the coworkerledgerentry was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerLedgerEntry was successfully updated.",
  "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 CoworkerLedgerEntry

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    BusinessId: 123,
    CoworkerId: 123,
    Description: '<string>',
    Code: '<string>',
    Debit: 123,
    Credit: 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