Search CoworkerInvoiceLines

GET

api

billing

coworkerinvoicelines

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

import requests

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

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/coworkerinvoicelines', 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
}

An invoice line is an individual billed item on a customer invoice. It records the billed description, quantity, net amount, calculated tax, and provenance from the originating contract, booking, charge, pass, time credit, product sale, or event purchase; lines are created and removed through billing workflows, then corrected only while the invoice remains unpaid.

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

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 invoice that contains this line; it determines the customer, location, currency, and payment state..

string

Filter by display value for CoworkerInvoice.InvoiceNumber..

boolean

Filter by display value for CoworkerInvoice.Paid..

string

Filter by display value for CoworkerInvoice.PaidOn..

boolean

Filter by display value for CoworkerInvoice.CreditNote..

string

Filter by display value for CoworkerInvoice.Currency.Code..

string

Filter by display value for CoworkerInvoice.DueDate..

string

Filter by required line-item description; shown on the invoice unless DisplayAs supplies replacement printed text..

string

Filter by optional customer-facing text displayed on printed and emailed invoices instead of Description..

string

Filter by optional tax-category name used to resolve the line tax rate; otherwise the customer’s personal rate or the location default applies..

integer

Filter by number of units on the line; changes the linked product quantity when the line originated from a product sale..

number

Filter by net line amount before tax; changing it recalculates tax and invoice totals and may update the linked charge, pass, time credit, or product sale..

number

Filter by calculated tax amount for this line, derived from SubTotal and the resolved TaxCategoryName, customer, or location tax rate; do not set directly..

number

Filter by calculated tax percentage applied to this line; resolved from TaxCategoryName, the customer’s personal rate, or the location default; do not set directly..

string

Filter by read-only GUID of the contract that generated this line, when it originated from contract billing..

string

Filter by read-only GUID of the contract deposit that generated this line, when applicable..

string

Filter by read-only GUID of the booking that generated this line, when applicable..

string

Filter by read-only GUID of the customer’s time credit that generated this line, when applicable..

string

Filter by read-only GUID of the underlying booking or printing rate associated with this line, when applicable..

string

Filter by read-only GUID of the customer’s pass that generated this line, when applicable..

string

Filter by read-only GUID of the one-off charge that generated this line, when applicable..

string

Filter by read-only GUID of the customer’s product sale that generated this line, when applicable..

string

Filter by read-only GUID of the event attendance purchase that generated this line, when applicable..

string

Filter by read-only GUID linking this line to a related grouped invoice line; deleting the parent line also deletes its grouped lines..

number

Filter by read-only gross amount already refunded for this line, including tax; it limits further refunds..

boolean

Filter by whether a refund workflow has refunded this line; inspect RefundedAmount for the refunded amount..

string

Filter by read-only UTC date and time when a refund workflow refunded this line..

string

Filter by read-only UTC date and time when the underlying sale occurred..

string

Filter by read-only discount-code text applied when this line was generated..

number

Filter by read-only discount amount deducted from this line when it was generated..

string

Filter by read-only display name of the linked customer time credit..

string

Filter by read-only display name of the linked customer pass..

string

Filter by read-only display name of the linked customer product sale..

string

Filter by display name of the linked event attendee product (read-only).

string

Filter by read-only name of the plan associated with this line..

string

Filter by financial-account code that categorises this line’s revenue for accounting..

string

Filter by financial-account name that categorises this line’s revenue for accounting..

integer

Filter by type of the financial account (1 Sales, 2 Payments, 3 Deposits) captured when the line was created.

string

Filter by gUID of the entity that issued this line, such as the issuing contract or location; retain for provenance rather than setting manually..

string

Filter by gUID of the original line cancelled by this line; maintained by cancellation workflows and used when reversing cancellation..

string

Filter by location-timezone mirror of CreatedOn; use the canonical CreatedOn value instead..

string

Filter by location-timezone mirror of RefundedOn; use the canonical RefundedOn value instead..

string

Filter by location-timezone mirror of SaleDate; use the canonical SaleDate value instead..

integer

Filter by read-only display order assigned when invoice lines are ordered..

boolean

Filter by whether this system-created line is hidden from the customer-facing invoice, for example because it is grouped under another line..

boolean

Filter by whether this line represents a universal credit applied to the invoice; maintained from the originating credit configuration..

string

Filter by optional purchase-order reference for this line, used when billing splits or groups items by purchase order..

number

Filter by read-only monetary amount of the customer’s available booking credit applied to the originating product sale; copied to this line for reference and does not reduce SubTotal or TaxAmount..

boolean

Filter by whether this is a system-generated prorated contract adjustment for a mid-cycle change..

string

Filter by read-only GUID of the customer discount-code record that generated this line’s discount..

Range Filters

string

Filter by display value for CoworkerInvoice.PaidOn. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.PaidOn. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.DueDate. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by display value for CoworkerInvoice.DueDate. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by number of units on the line; changes the linked product quantity when the line originated from a product sale. greater than or equal to this value.

integer

Filter by number of units on the line; changes the linked product quantity when the line originated from a product sale. less than or equal to this value.

number

Filter by net line amount before tax; changing it recalculates tax and invoice totals and may update the linked charge, pass, time credit, or product sale. greater than or equal to this value.

number

Filter by net line amount before tax; changing it recalculates tax and invoice totals and may update the linked charge, pass, time credit, or product sale. less than or equal to this value.

number

Filter by calculated tax amount for this line, derived from SubTotal and the resolved TaxCategoryName, customer, or location tax rate; do not set directly. greater than or equal to this value.

number

Filter by calculated tax amount for this line, derived from SubTotal and the resolved TaxCategoryName, customer, or location tax rate; do not set directly. less than or equal to this value.

number

Filter by calculated tax percentage applied to this line; resolved from TaxCategoryName, the customer’s personal rate, or the location default; do not set directly. greater than or equal to this value.

number

Filter by calculated tax percentage applied to this line; resolved from TaxCategoryName, the customer’s personal rate, or the location default; do not set directly. less than or equal to this value.

number

Filter by read-only gross amount already refunded for this line, including tax; it limits further refunds. greater than or equal to this value.

number

Filter by read-only gross amount already refunded for this line, including tax; it limits further refunds. less than or equal to this value.

string

Filter by read-only UTC date and time when a refund workflow refunded this line. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when a refund workflow refunded this line. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when the underlying sale occurred. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only UTC date and time when the underlying sale occurred. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by read-only discount amount deducted from this line when it was generated. greater than or equal to this value.

number

Filter by read-only discount amount deducted from this line when it was generated. less than or equal to this value.

integer

Filter by type of the financial account (1 Sales, 2 Payments, 3 Deposits) captured when the line was created greater than or equal to this value.

integer

Filter by type of the financial account (1 Sales, 2 Payments, 3 Deposits) captured when the line was created less than or equal to this value.

string

Filter by location-timezone mirror of CreatedOn; use the canonical CreatedOn value instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of CreatedOn; use the canonical CreatedOn value instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of RefundedOn; use the canonical RefundedOn value instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of RefundedOn; use the canonical RefundedOn value instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of SaleDate; use the canonical SaleDate value instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of SaleDate; use the canonical SaleDate value instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by read-only display order assigned when invoice lines are ordered. greater than or equal to this value.

integer

Filter by read-only display order assigned when invoice lines are ordered. less than or equal to this value.

number

Filter by read-only monetary amount of the customer’s available booking credit applied to the originating product sale; copied to this line for reference and does not reduce SubTotal or TaxAmount. greater than or equal to this value.

number

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/coworkerinvoicelines?page=1&size=15&orderBy=Description&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by Description

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoicelines?' + new URLSearchParams({
    from_CoworkerInvoiceLine_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerInvoiceLine_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/coworkerinvoicelines',
    params={
        'from_CoworkerInvoiceLine_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerInvoiceLine_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

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,
      "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,
      "FinancialAccountType": 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": "admin@example.com",
      "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
}

Search CoworkerInvoiceLines

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

import requests

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

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/coworkerinvoicelines', 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

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Description

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Description

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Description

Range filters

Response

200