Get one CoworkerInvoiceHistory

Retrieve a single CoworkerInvoiceHistory record by its Id.

GET /api/billing/coworkerinvoicehistories/{id}

Get one CoworkerInvoiceHistory

cURL

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/{id} \
  --header 'Authorization: Basic <encoded-value>'

200

{
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceCoworkerId": 123,
  "CoworkerInvoiceBusinessId": 123,
  "CoworkerInvoiceBusinessCurrencyCode": "<string>",
  "CoworkerInvoiceCoworkerFullName": "<string>",
  "CoworkerInvoiceTotalAmount": "<string>",
  "CoworkerInvoiceInvoiceNumber": "<string>",
  "CoworkerInvoiceBillToName": "<string>",
  "CoworkerInvoicePaid": "<string>",
  "CoworkerInvoicePaidOn": "<string>",
  "CoworkerInvoiceRefunded": true,
  "CoworkerInvoiceRefundedOn": "<string>",
  "CoworkerInvoiceDueDate": "<string>",
  "CoworkerInvoiceDraft": "<string>",
  "Name": "<string>",
  "Description": "<string>",
  "IsProblem": true,
  "Notify": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

Path Parameters

id · integer · required

The Id of the CoworkerInvoiceHistory record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

CoworkerInvoiceId · integer

Coworker Invoice Id.

CoworkerInvoiceCoworkerId · integer

Coworker Invoice Coworker Id.

CoworkerInvoiceBusinessId · integer

Coworker Invoice Business Id.

CoworkerInvoiceBusinessCurrencyCode · string

Coworker Invoice Business Currency Code.

CoworkerInvoiceCoworkerFullName · string

Full name of the customer who owns the invoice.

CoworkerInvoiceTotalAmount · string

Total amount of the related customer invoice.

CoworkerInvoiceInvoiceNumber · string

Invoice number of the related customer invoice.

CoworkerInvoiceBillToName · string

Coworker Invoice Bill To Name.

CoworkerInvoicePaid · string

Whether the related customer invoice has been fully paid.

CoworkerInvoicePaidOn · string

Coworker Invoice Paid On.

CoworkerInvoiceRefunded · boolean

Coworker Invoice Refunded.

CoworkerInvoiceRefundedOn · string

Coworker Invoice Refunded On.

CoworkerInvoiceDueDate · string

Coworker Invoice Due Date.

CoworkerInvoiceDraft · string

Whether the related customer invoice is still in draft.

Name · string

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

Description · string

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

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.

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "CoworkerInvoiceId": 0,
  "CoworkerInvoiceCoworkerId": null,
  "CoworkerInvoiceBusinessId": null,
  "CoworkerInvoiceBusinessCurrencyCode": null,
  "CoworkerInvoiceCoworkerFullName": null,
  "CoworkerInvoiceTotalAmount": null,
  "CoworkerInvoiceInvoiceNumber": null,
  "CoworkerInvoiceBillToName": null,
  "CoworkerInvoicePaid": null,
  "CoworkerInvoicePaidOn": null,
  "CoworkerInvoiceRefunded": null,
  "CoworkerInvoiceRefundedOn": null,
  "CoworkerInvoiceDueDate": null,
  "CoworkerInvoiceDraft": null,
  "Name": "",
  "Description": "",
  "IsProblem": false,
  "Notify": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerInvoiceHistory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}