Search CoworkerInvoiceHistories

GET

api

billing

coworkerinvoicehistories

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

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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CoworkerInvoiceHistory_CoworkerInvoice

integer

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

CoworkerInvoiceHistory_CoworkerInvoice_Coworker_Id

integer

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

CoworkerInvoiceHistory_CoworkerInvoice_Business_Id

integer

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

CoworkerInvoiceHistory_CoworkerInvoice_Business_Currency_Code

string

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

CoworkerInvoiceHistory_CoworkerInvoice_Coworker_FullName

string

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

CoworkerInvoiceHistory_CoworkerInvoice_TotalAmount

string

Filter by total amount of the related customer invoice.

CoworkerInvoiceHistory_CoworkerInvoice_InvoiceNumber

string

Filter by invoice number of the related customer invoice.

CoworkerInvoiceHistory_CoworkerInvoice_BillToName

string

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

CoworkerInvoiceHistory_CoworkerInvoice_Paid

string

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

CoworkerInvoiceHistory_CoworkerInvoice_PaidOn

string

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

CoworkerInvoiceHistory_CoworkerInvoice_Refunded

boolean

Filter by whether coworker invoice refunded is enabled.

CoworkerInvoiceHistory_CoworkerInvoice_RefundedOn

string

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

CoworkerInvoiceHistory_CoworkerInvoice_DueDate

string

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

CoworkerInvoiceHistory_CoworkerInvoice_Draft

string

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

CoworkerInvoiceHistory_Name

string

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

CoworkerInvoiceHistory_Description

string

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

CoworkerInvoiceHistory_IsProblem

boolean

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

CoworkerInvoiceHistory_Notify

boolean

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

Range Filters

from_CoworkerInvoiceHistory_CoworkerInvoiceCoworkerId

integer

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

to_CoworkerInvoiceHistory_CoworkerInvoiceCoworkerId

integer

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

from_CoworkerInvoiceHistory_CoworkerInvoiceBusinessId

integer

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

to_CoworkerInvoiceHistory_CoworkerInvoiceBusinessId

integer

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

from_CoworkerInvoiceHistory_CoworkerInvoicePaidOn

string

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

to_CoworkerInvoiceHistory_CoworkerInvoicePaidOn

string

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

from_CoworkerInvoiceHistory_CoworkerInvoiceRefundedOn

string

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

to_CoworkerInvoiceHistory_CoworkerInvoiceRefundedOn

string

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

from_CoworkerInvoiceHistory_CoworkerInvoiceDueDate

string

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

to_CoworkerInvoiceHistory_CoworkerInvoiceDueDate

string

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

from_CoworkerInvoiceHistory_CreatedOn

string

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

to_CoworkerInvoiceHistory_CreatedOn

string

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

from_CoworkerInvoiceHistory_UpdatedOn

string

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

to_CoworkerInvoiceHistory_UpdatedOn

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"

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"

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"

Response

200

Records

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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

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

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

​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