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 coworker invoice linked to this record.

string

required

Line item description shown internally.

integer

required

Number of units for this line item.

number

required

Line subtotal before tax (unit price x quantity).

number

required

Tax amount calculated for this line.

number

required

Tax rate percentage applied to this line.

number

required

Credit amount applied to this line.

Optional Fields

string

Override text displayed on the printed/emailed invoice instead of the description.

string

Name of the tax category applied to this line.

string

Code of the financial account (revenue category) for this line.

string

Name of the financial account (revenue category) for this line.

string

ID of the issued by unique associated with this record.

string

ID of the cancelled coworker invoice line unique associated with this record.

string

Date/time value for created on local.

string

Date/time value for refunded on local.

string

Date/time value for sale date local.

string

Purchase order reference for this line.

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
}

Search CoworkerInvoicePaymentTokensSearch and list CoworkerInvoicePaymentToken records with filtering, sorting, and pagination.

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