Update CoworkerInvoiceLine

PUT

api

billing

coworkerinvoicelines

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerinvoicelines \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerInvoiceId": 123,
  "Description": "<string>",
  "Quantity": 123,
  "SubTotal": 123,
  "TaxAmount": 123,
  "TaxRate": 123,
  "CreditAmount": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CoworkerInvoiceId": 123,
    "Description": "<string>",
    "Quantity": 123,
    "SubTotal": 123,
    "TaxAmount": 123,
    "TaxRate": 123,
    "CreditAmount": 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,
    CoworkerInvoiceId: 123,
    Description: '<string>',
    Quantity: 123,
    SubTotal: 123,
    TaxAmount: 123,
    TaxRate: 123,
    CreditAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoicelines', 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 CoworkerInvoiceLine 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 CoworkerInvoiceLine-Edit role.

Request Body

Required Fields

integer

required

The Id of the CoworkerInvoiceLine record to update.

integer

required

ID of the invoice that contains this line; it determines the customer, location, currency, and payment state..

string

required

Required line-item description; shown on the invoice unless DisplayAs supplies replacement printed text..

integer

required

Number of units on the line; changes the linked product quantity when the line originated from a product sale..

number

required

Net line amount before tax; changing it recalculates tax and invoice totals and may update the linked charge, pass, time credit, or product sale..

number

required

Calculated tax amount for this line, derived from SubTotal and the resolved TaxCategoryName, customer, or location tax rate; do not set directly..

number

required

Calculated tax percentage applied to this line; resolved from TaxCategoryName, the customer’s personal rate, or the location default; do not set directly..

number

required

Read-only monetary amount of the customer’s available booking credit applied to the originating product sale; copied to this line for reference and does not reduce SubTotal or TaxAmount..

Optional Fields

string

Optional customer-facing text displayed on printed and emailed invoices instead of Description..

string

Optional tax-category name used to resolve the line tax rate; otherwise the customer’s personal rate or the location default applies..

string

Financial-account code that categorises this line’s revenue for accounting..

string

Financial-account name that categorises this line’s revenue for accounting..

string

GUID of the entity that issued this line, such as the issuing contract or location; retain for provenance rather than setting manually..

string

GUID of the original line cancelled by this line; maintained by cancellation workflows and used when reversing cancellation..

string

Location-timezone mirror of CreatedOn; use the canonical CreatedOn value instead..

string

Location-timezone mirror of RefundedOn; use the canonical RefundedOn value instead..

string

Location-timezone mirror of SaleDate; use the canonical SaleDate value instead..

string

Optional purchase-order reference for this line, used when billing splits or groups items by purchase order..

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/billing/coworkerinvoicelines" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerInvoiceId": 0,
    "Description": "",
    "Quantity": 0,
    "SubTotal": 0,
    "TaxAmount": 0,
    "TaxRate": 0,
    "CreditAmount": 0,
    "Id": 87654321
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoicelines',
  {
    method: 'PUT',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerInvoiceId: 0,
      Description: '',
      Quantity: 0,
      SubTotal: 0,
      TaxAmount: 0,
      TaxRate: 0,
      CreditAmount: 0,
      Id: 87654321
    })
  }
);

const data = await response.json();

import requests

response = requests.put(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerInvoiceId': 0,
        'Description': '',
        'Quantity': 0,
        'SubTotal': 0,
        'TaxAmount': 0,
        'TaxRate': 0,
        'CreditAmount': 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 coworkerinvoiceline was updated successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerInvoiceLine 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 CoworkerInvoiceLine

curl --request PUT \
  --url https://spaces.nexudus.com/api/billing/coworkerinvoicelines \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "CoworkerInvoiceId": 123,
  "Description": "<string>",
  "Quantity": 123,
  "SubTotal": 123,
  "TaxAmount": 123,
  "TaxRate": 123,
  "CreditAmount": 123
}
'

import requests

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

payload = {
    "Id": 123,
    "CoworkerInvoiceId": 123,
    "Description": "<string>",
    "Quantity": 123,
    "SubTotal": 123,
    "TaxAmount": 123,
    "TaxRate": 123,
    "CreditAmount": 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,
    CoworkerInvoiceId: 123,
    Description: '<string>',
    Quantity: 123,
    SubTotal: 123,
    TaxAmount: 123,
    TaxRate: 123,
    CreditAmount: 123
  })
};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoicelines', 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

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400