Search CoworkerInvoiceLines

Search and list CoworkerInvoiceLine records with filtering, sorting, and pagination.

GET /api/billing/coworkerinvoicelines

Search CoworkerInvoiceLines

cURL

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

200

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

A CoworkerInvoiceLine represents an individual line item on a customer invoice. Each line captures the description, quantity, amounts, tax, and an optional link to the sale item that generated it.

Properties ending in UniqueId link the line to the originating sale record using its GUID UniqueId property (not the integer ID). Only one of these will be populated per line:

UniqueId property	Source entity
CoworkerContractUniqueId	CoworkerContract
ContractDepositUniqueId	ContractDeposit
BookingUniqueId	Booking
CoworkerExtraServiceUniqueId	CoworkerExtraService
CoworkerTimePassUniqueId	CoworkerTimePass
CoworkerChargeUniqueId	Charge
CoworkerProductUniqueId	CoworkerProduct
EventAttendeeUniqueId	EventAttendee

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

CoworkerInvoiceLine_CoworkerInvoice · integer

Filter by Coworker Invoice Id.

CoworkerInvoiceLine_CoworkerInvoice_InvoiceNumber · string

Filter by invoice number of the parent invoice.

CoworkerInvoiceLine_CoworkerInvoice_Paid · string

Filter by whether the parent invoice has been fully paid.

CoworkerInvoiceLine_CoworkerInvoice_PaidOn · string

Filter by Coworker Invoice Paid On.

CoworkerInvoiceLine_CoworkerInvoice_CreditNote · string

Filter by whether the parent invoice is a credit note.

CoworkerInvoiceLine_CoworkerInvoice_Currency_Code · string

Filter by currency code of the parent invoice (e.g. USD, EUR).

CoworkerInvoiceLine_CoworkerInvoice_DueDate · string

Filter by Coworker Invoice Due Date.

CoworkerInvoiceLine_Description · string

Filter by line item description shown internally.

CoworkerInvoiceLine_DisplayAs · string

Filter by override text displayed on the printed/emailed invoice instead of the description.

CoworkerInvoiceLine_TaxCategoryName · string

Filter by name of the tax category applied to this line.

CoworkerInvoiceLine_Quantity · integer

Filter by number of units for this line item.

CoworkerInvoiceLine_SubTotal · number

Filter by line subtotal before tax (unit price x quantity).

CoworkerInvoiceLine_TaxAmount · number

Filter by tax amount calculated for this line.

CoworkerInvoiceLine_TaxRate · number

Filter by tax rate percentage applied to this line.

CoworkerInvoiceLine_CoworkerContractUniqueId · string

Filter by uniqueId (GUID) of the CoworkerContract that generated this line.

CoworkerInvoiceLine_ContractDepositUniqueId · string

Filter by uniqueId (GUID) of the ContractDeposit that generated this line.

CoworkerInvoiceLine_BookingUniqueId · string

Filter by uniqueId (GUID) of the Booking that generated this line.

CoworkerInvoiceLine_CoworkerExtraServiceUniqueId · string

Filter by uniqueId (GUID) of the CoworkerExtraService that generated this line.

CoworkerInvoiceLine_ExtraServiceUniqueId · string

Filter by uniqueId (GUID) of the base ExtraService linked to this line.

CoworkerInvoiceLine_CoworkerTimePassUniqueId · string

Filter by uniqueId (GUID) of the CoworkerTimePass that generated this line.

CoworkerInvoiceLine_CoworkerChargeUniqueId · string

Filter by uniqueId (GUID) of the Charge that generated this line.

CoworkerInvoiceLine_CoworkerProductUniqueId · string

Filter by uniqueId (GUID) of the CoworkerProduct that generated this line.

CoworkerInvoiceLine_EventAttendeeUniqueId · string

Filter by uniqueId (GUID) of the EventAttendee that generated this line.

CoworkerInvoiceLine_GroupedLineUniqueId · string

Filter by uniqueId (GUID) linking this line to a group of related invoice lines.

CoworkerInvoiceLine_RefundedAmount · number

Filter by amount that has been refunded for this line.

CoworkerInvoiceLine_Refunded · boolean

Filter by whether this line has been fully or partially refunded.

CoworkerInvoiceLine_RefundedOn · string

Filter by date and time when this line was refunded.

CoworkerInvoiceLine_SaleDate · string

Filter by date the sale occurred for this line item.

CoworkerInvoiceLine_DiscountCode · string

Filter by discount code applied to this line.

CoworkerInvoiceLine_DiscountAmount · number

Filter by discount amount deducted from this line.

CoworkerInvoiceLine_CoworkerExtraServiceName · string

Filter by name of the linked CoworkerExtraService.

CoworkerInvoiceLine_CoworkerTimePassName · string

Filter by name of the linked CoworkerTimePass.

CoworkerInvoiceLine_CoworkerProductName · string

Filter by name of the linked CoworkerProduct.

CoworkerInvoiceLine_EventAttendeeProductName · string

Filter by Event Attendee Product Name.

CoworkerInvoiceLine_TariffName · string

Filter by name of the plan (tariff) associated with this line.

CoworkerInvoiceLine_FinancialAccountCode · string

Filter by code of the financial account (revenue category) for this line.

CoworkerInvoiceLine_FinancialAccountName · string

Filter by name of the financial account (revenue category) for this line.

CoworkerInvoiceLine_IssuedByUniqueId · string

Filter by Issued By Unique Id.

CoworkerInvoiceLine_CancelledCoworkerInvoiceLineUniqueId · string

Filter by Cancelled Coworker Invoice Line Unique Id.

CoworkerInvoiceLine_CreatedOnLocal · string

Filter by Created On Local.

CoworkerInvoiceLine_RefundedOnLocal · string

Filter by Refunded On Local.

CoworkerInvoiceLine_SaleDateLocal · string

Filter by Sale Date Local.

CoworkerInvoiceLine_Position · integer

Filter by display order of this line on the invoice.

CoworkerInvoiceLine_IsHidden · boolean

Filter by whether this line is hidden from the customer-facing invoice.

CoworkerInvoiceLine_IsUniversalCredit · boolean

Filter by whether this line represents a universal credit applied to the invoice.

CoworkerInvoiceLine_PurchaseOrder · string

Filter by purchase order reference for this line.

CoworkerInvoiceLine_CreditAmount · number

Filter by credit amount applied to this line.

CoworkerInvoiceLine_IsProratedContract · boolean

Filter by whether this line is a prorated charge from a mid-cycle contract change.

CoworkerInvoiceLine_CoworkerDiscountCodeUniqueId · string

Filter by Coworker Discount Code Unique Id.

Range Filters

from_CoworkerInvoiceLine_CoworkerInvoicePaidOn · string

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

to_CoworkerInvoiceLine_CoworkerInvoicePaidOn · string

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

from_CoworkerInvoiceLine_CoworkerInvoiceDueDate · string

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

to_CoworkerInvoiceLine_CoworkerInvoiceDueDate · string

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

from_CoworkerInvoiceLine_Quantity · integer

Filter by number of units for this line item greater than or equal to this value.

to_CoworkerInvoiceLine_Quantity · integer

Filter by number of units for this line item less than or equal to this value.

from_CoworkerInvoiceLine_SubTotal · number

Filter by line subtotal before tax (unit price x quantity) greater than or equal to this value.

to_CoworkerInvoiceLine_SubTotal · number

Filter by line subtotal before tax (unit price x quantity) less than or equal to this value.

from_CoworkerInvoiceLine_TaxAmount · number

Filter by tax amount calculated for this line greater than or equal to this value.

to_CoworkerInvoiceLine_TaxAmount · number

Filter by tax amount calculated for this line less than or equal to this value.

from_CoworkerInvoiceLine_TaxRate · number

Filter by tax rate percentage applied to this line greater than or equal to this value.

to_CoworkerInvoiceLine_TaxRate · number

Filter by tax rate percentage applied to this line less than or equal to this value.

from_CoworkerInvoiceLine_RefundedAmount · number

Filter by amount that has been refunded for this line greater than or equal to this value.

to_CoworkerInvoiceLine_RefundedAmount · number

Filter by amount that has been refunded for this line less than or equal to this value.

from_CoworkerInvoiceLine_RefundedOn · string

Filter by date and time when this line was refunded greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerInvoiceLine_RefundedOn · string

Filter by date and time when this line was refunded less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerInvoiceLine_SaleDate · string

Filter by date the sale occurred for this line item greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerInvoiceLine_SaleDate · string

Filter by date the sale occurred for this line item less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerInvoiceLine_DiscountAmount · number

Filter by discount amount deducted from this line greater than or equal to this value.

to_CoworkerInvoiceLine_DiscountAmount · number

Filter by discount amount deducted from this line less than or equal to this value.

from_CoworkerInvoiceLine_CreatedOnLocal · string

Filter by created on local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerInvoiceLine_CreatedOnLocal · string

Filter by created on local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerInvoiceLine_RefundedOnLocal · string

Filter by refunded on local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerInvoiceLine_RefundedOnLocal · string

Filter by refunded on local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerInvoiceLine_SaleDateLocal · string

Filter by sale date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerInvoiceLine_SaleDateLocal · string

Filter by sale date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerInvoiceLine_Position · integer

Filter by display order of this line on the invoice greater than or equal to this value.

to_CoworkerInvoiceLine_Position · integer

Filter by display order of this line on the invoice less than or equal to this value.

from_CoworkerInvoiceLine_CreditAmount · number

Filter by credit amount applied to this line greater than or equal to this value.

to_CoworkerInvoiceLine_CreditAmount · number

Filter by credit amount applied to this line less than or equal to this value.

from_CoworkerInvoiceLine_CreatedOn · string

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

to_CoworkerInvoiceLine_CreatedOn · string

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

from_CoworkerInvoiceLine_UpdatedOn · string

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

to_CoworkerInvoiceLine_UpdatedOn · string

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

Code Examples

Simple listing

cURL

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

Filtering by Description

cURL

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

Range filters

cURL

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

Response

200

Records · CoworkerInvoiceLine[]

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

Partial records — The listing endpoint returns a summary representation of each CoworkerInvoiceLine. The following fields are not populated in the Records[] response: TaxAmount, TaxRate, PurchaseOrder, CreditAmount.

To get all fields, fetch the full record using the Get one CoworkerInvoiceLine endpoint.

Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

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,
      "CoworkerInvoiceInvoiceNumber": null,
      "CoworkerInvoicePaid": null,
      "CoworkerInvoicePaidOn": null,
      "CoworkerInvoiceCreditNote": null,
      "CoworkerInvoiceCurrencyCode": null,
      "CoworkerInvoiceDueDate": null,
      "Description": "",
      "DisplayAs": null,
      "TaxCategoryName": null,
      "Quantity": 0,
      "SubTotal": 0,
      "CoworkerContractUniqueId": null,
      "ContractDepositUniqueId": null,
      "BookingUniqueId": null,
      "CoworkerExtraServiceUniqueId": null,
      "ExtraServiceUniqueId": null,
      "CoworkerTimePassUniqueId": null,
      "CoworkerChargeUniqueId": null,
      "CoworkerProductUniqueId": null,
      "EventAttendeeUniqueId": null,
      "GroupedLineUniqueId": null,
      "RefundedAmount": null,
      "Refunded": false,
      "RefundedOn": null,
      "SaleDate": null,
      "DiscountCode": null,
      "DiscountAmount": null,
      "CoworkerExtraServiceName": null,
      "CoworkerTimePassName": null,
      "CoworkerProductName": null,
      "EventAttendeeProductName": null,
      "TariffName": null,
      "FinancialAccountCode": null,
      "FinancialAccountName": null,
      "IssuedByUniqueId": null,
      "CancelledCoworkerInvoiceLineUniqueId": null,
      "CreatedOnLocal": null,
      "RefundedOnLocal": null,
      "SaleDateLocal": null,
      "Position": 0,
      "IsHidden": false,
      "IsUniversalCredit": false,
      "IsProratedContract": false,
      "CoworkerDiscountCodeUniqueId": null,
      "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": "CoworkerInvoiceLine Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Description",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}