> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search CoworkerInvoiceLines > Search and list CoworkerInvoiceLine records with filtering, sorting, and pagination. 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 The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by Coworker Invoice Id. Filter by invoice number of the parent invoice. Filter by whether the parent invoice has been fully paid. Filter by Coworker Invoice Paid On. Filter by whether the parent invoice is a credit note. Filter by currency code of the parent invoice (e.g. USD, EUR). Filter by Coworker Invoice Due Date. Filter by line item description shown internally. Filter by override text displayed on the printed/emailed invoice instead of the description. Filter by name of the tax category applied to this line. Filter by number of units for this line item. Filter by line subtotal before tax (unit price x quantity). Filter by tax amount calculated for this line. Filter by tax rate percentage applied to this line. Filter by uniqueId (GUID) of the CoworkerContract that generated this line. Filter by uniqueId (GUID) of the ContractDeposit that generated this line. Filter by uniqueId (GUID) of the Booking that generated this line. Filter by uniqueId (GUID) of the CoworkerExtraService that generated this line. Filter by uniqueId (GUID) of the base ExtraService linked to this line. Filter by uniqueId (GUID) of the CoworkerTimePass that generated this line. Filter by uniqueId (GUID) of the Charge that generated this line. Filter by uniqueId (GUID) of the CoworkerProduct that generated this line. Filter by uniqueId (GUID) of the EventAttendee that generated this line. Filter by uniqueId (GUID) linking this line to a group of related invoice lines. Filter by amount that has been refunded for this line. Filter by whether this line has been fully or partially refunded. Filter by date and time when this line was refunded. Filter by date the sale occurred for this line item. Filter by discount code applied to this line. Filter by discount amount deducted from this line. Filter by name of the linked CoworkerExtraService. Filter by name of the linked CoworkerTimePass. Filter by name of the linked CoworkerProduct. Filter by Event Attendee Product Name. Filter by name of the plan (tariff) associated with this line. Filter by code of the financial account (revenue category) for this line. Filter by name of the financial account (revenue category) for this line. Filter by Issued By Unique Id. Filter by Cancelled Coworker Invoice Line Unique Id. Filter by Created On Local. Filter by Refunded On Local. Filter by Sale Date Local. Filter by display order of this line on the invoice. Filter by whether this line is hidden from the customer-facing invoice. Filter by whether this line represents a universal credit applied to the invoice. Filter by purchase order reference for this line. Filter by credit amount applied to this line. Filter by whether this line is a prorated charge from a mid-cycle contract change. Filter by Coworker Discount Code Unique Id. ### Range Filters Filter by coworker invoice paid on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by coworker invoice paid on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by coworker invoice due date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by coworker invoice due date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by number of units for this line item greater than or equal to this value. Filter by number of units for this line item less than or equal to this value. Filter by line subtotal before tax (unit price x quantity) greater than or equal to this value. Filter by line subtotal before tax (unit price x quantity) less than or equal to this value. Filter by tax amount calculated for this line greater than or equal to this value. Filter by tax amount calculated for this line less than or equal to this value. Filter by tax rate percentage applied to this line greater than or equal to this value. Filter by tax rate percentage applied to this line less than or equal to this value. Filter by amount that has been refunded for this line greater than or equal to this value. Filter by amount that has been refunded for this line less than or equal to this value. Filter by date and time when this line was refunded greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date and time when this line was refunded less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date the sale occurred for this line item greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date the sale occurred for this line item less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by discount amount deducted from this line greater than or equal to this value. Filter by discount amount deducted from this line less than or equal to this value. Filter by created on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by created on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by refunded on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by refunded on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by sale date local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by sale date local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by display order of this line on the invoice greater than or equal to this value. Filter by display order of this line on the invoice less than or equal to this value. Filter by credit amount applied to this line greater than or equal to this value. Filter by credit amount applied to this line less than or equal to this value. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/coworkerinvoicelines?page=1&size=15&orderBy=Description&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/billing/coworkerinvoicelines?CoworkerInvoiceLine_Description=example-value&orderBy=Description&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} 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" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 The list of CoworkerInvoiceLine records matching the query. See the [Get one CoworkerInvoiceLine](/rest-api/billing/get-coworkerinvoicelines-by-id) 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](/rest-api/billing/get-coworkerinvoicelines-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "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": "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 } ```