Create CoworkerInvoiceHistory

POST

api

billing

coworkerinvoicehistories

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerinvoicehistories \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerInvoiceId": 123,
  "Name": "<string>",
  "Description": "<string>"
}
'

import requests

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

payload = {
    "CoworkerInvoiceId": 123,
    "Name": "<string>",
    "Description": "<string>"
}
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({CoworkerInvoiceId: 123, Name: '<string>', Description: '<string>'})
};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoicehistories', 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 CoworkerInvoiceHistory records a history entry for a customer invoice. Each entry captures an activity or event that occurred on that invoice, such as the invoice being sent, an e-invoicing action, a payment receipt, or a payment error. Use IsProblem to flag entries that represent errors or issues (e.g. a failed payment attempt). Set Notify to trigger a notification when the history entry is created.

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 CoworkerInvoiceHistory-Create role.

Request Body

Required Fields

integer

required

ID of the coworker invoice linked to this record.

string

required

Short title of the history entry (e.g. ‘Invoice sent’, ‘Payment received’).

string

required

Detailed description of the activity or event recorded by this history entry.

Optional Fields

boolean

Flags this history entry as an error or issue (e.g. a failed payment attempt or e-invoicing error).

boolean

Whether to send a notification when this history entry is created.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerInvoiceId": 0,
    "Name": "",
    "Description": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerInvoiceId: 0,
      Name: '',
      Description: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerInvoiceId': 0,
        'Name': '',
        'Description': ''
    }
)

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 coworkerinvoicehistory was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerInvoiceHistory 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": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerInvoiceHistoryUpdate an existing CoworkerInvoiceHistory record.

Create CoworkerInvoiceHistory

curl --request POST \
  --url https://spaces.nexudus.com/api/billing/coworkerinvoicehistories \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerInvoiceId": 123,
  "Name": "<string>",
  "Description": "<string>"
}
'

import requests

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

payload = {
    "CoworkerInvoiceId": 123,
    "Name": "<string>",
    "Description": "<string>"
}
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({CoworkerInvoiceId: 123, Name: '<string>', Description: '<string>'})
};

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

Create CoworkerInvoiceHistory

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