Create CoworkerInvoiceHistory

Create a new CoworkerInvoiceHistory record.

POST /api/billing/coworkerinvoicehistories

Create CoworkerInvoiceHistory

cURL

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>"
}
'

200

{
  "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

CoworkerInvoiceId · integer · required

Coworker Invoice Id.

Name · string · required

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

Description · string · required

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

Optional Fields

IsProblem · boolean

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

Notify · boolean

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

Code Examples

cURL

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": ""
}'

Response

200

Status · integer

HTTP status code. 200 on success.

Message · string

A human-readable message confirming the creation.

Value · object

Contains the Id of the newly created record.

WasSuccessful · boolean

true if the coworkerinvoicehistory was created successfully.

Errors · 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": "[e-mail]",
  "Errors": null,
  "WasSuccessful": true
}

400

Message · string

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

Value · any

null on validation failure.

Errors · object[]

Array of validation errors.

Show child attributes

AttemptedValue · any

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

Message · string

The validation error message.

PropertyName · string

The name of the property that failed validation.

WasSuccessful · 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
}