Search CoworkerInvoiceHistories

GET

api

billing

coworkerinvoicehistories

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the coworker invoice linked to this record.

integer

Filter by iD of the coworker invoice coworker associated with this record.

integer

Filter by iD of the coworker invoice business associated with this record.

string

Filter by the coworker invoice business currency code value for this coworker invoice history.

string

Filter by full name of the customer who owns the invoice.

string

Filter by total amount of the related customer invoice.

string

Filter by invoice number of the related customer invoice.

string

Filter by display name of the linked coworker invoice bill to (read-only).

string

Filter by whether the related customer invoice has been fully paid.

string

Filter by date/time value for coworker invoice paid on.

boolean

Filter by whether coworker invoice refunded is enabled.

string

Filter by date/time value for coworker invoice refunded on.

string

Filter by date/time value for coworker invoice due date.

string

Filter by whether the related customer invoice is still in draft.

string

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

string

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

boolean

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

boolean

Filter by whether to send a notification when this history entry is created.

Range Filters

integer

Filter by iD of the coworker invoice coworker associated with this record greater than or equal to this value.

integer

Filter by iD of the coworker invoice coworker associated with this record less than or equal to this value.

integer

Filter by iD of the coworker invoice business associated with this record greater than or equal to this value.

integer

Filter by iD of the coworker invoice business associated with this record less than or equal to this value.

string

Filter by date/time value for coworker invoice paid on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for coworker invoice paid on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for coworker invoice refunded on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for coworker invoice refunded on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for coworker invoice due date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for coworker invoice due date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?CoworkerInvoiceHistory_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?' + new URLSearchParams({
    CoworkerInvoiceHistory_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
    params={
        'CoworkerInvoiceHistory_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?from_CoworkerInvoiceHistory_UpdatedOn=2025-01-01T00:00&to_CoworkerInvoiceHistory_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories?' + new URLSearchParams({
    from_CoworkerInvoiceHistory_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerInvoiceHistory_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicehistories',
    params={
        'from_CoworkerInvoiceHistory_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerInvoiceHistory_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CoworkerInvoiceHistory[]

The list of CoworkerInvoiceHistory records matching the query. See the Get one CoworkerInvoiceHistory endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CoworkerInvoiceHistoryRetrieve a single CoworkerInvoiceHistory record by its Id.

Search CoworkerInvoiceHistories

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Search CoworkerInvoiceHistories

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200