Get one CoworkerInvoiceHistory

GET

api

billing

coworkerinvoicehistories

{id}

Get one CoworkerInvoiceHistory

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

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

integer

required

The Id of the CoworkerInvoiceHistory record to retrieve.

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the coworker invoice linked to this record.

integer

ID of the coworker invoice coworker associated with this record.

integer

ID of the coworker invoice business associated with this record.

string

The coworker invoice business currency code value for this coworker invoice history.

string

Full name of the customer who owns the invoice.

string

Total amount of the related customer invoice.

string

Invoice number of the related customer invoice.

string

Display name of the linked coworker invoice bill to (read-only).

string

Whether the related customer invoice has been fully paid.

string

Date/time value for coworker invoice paid on.

boolean

Whether coworker invoice refunded is enabled.

string

Date/time value for coworker invoice refunded on.

string

Date/time value for coworker invoice due date.

string

Whether the related customer invoice is still in draft.

string

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

string

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

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.

integer

Unique record identifier.

string

UUID of the record.

string

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

string

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

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerInvoiceHistory Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkerInvoiceHistoriesRetrieve multiple CoworkerInvoiceHistory records by their Ids in a single request.

Get one CoworkerInvoiceHistory

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

import requests

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

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkerinvoicehistories/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Get one CoworkerInvoiceHistory

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200