> ## 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.

# Get one CoworkerInvoiceLine

> Retrieve a single CoworkerInvoiceLine record by its Id.

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

<Note>
  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-Read`** role.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the CoworkerInvoiceLine record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerinvoicelines/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoicelines/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/billing/coworkerinvoicelines/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="CoworkerInvoiceId" type="integer">
  Coworker Invoice Id.
</ResponseField>

<ResponseField name="CoworkerInvoiceInvoiceNumber" type="string">
  Invoice number of the parent invoice.
</ResponseField>

<ResponseField name="CoworkerInvoicePaid" type="string">
  Whether the parent invoice has been fully paid.
</ResponseField>

<ResponseField name="CoworkerInvoicePaidOn" type="string">
  Coworker Invoice Paid On.
</ResponseField>

<ResponseField name="CoworkerInvoiceCreditNote" type="string">
  Whether the parent invoice is a credit note.
</ResponseField>

<ResponseField name="CoworkerInvoiceCurrencyCode" type="string">
  Currency code of the parent invoice (e.g. USD, EUR).
</ResponseField>

<ResponseField name="CoworkerInvoiceDueDate" type="string">
  Coworker Invoice Due Date.
</ResponseField>

<ResponseField name="Description" type="string">
  Line item description shown internally.
</ResponseField>

<ResponseField name="DisplayAs" type="string">
  Override text displayed on the printed/emailed invoice instead of the description.
</ResponseField>

<ResponseField name="TaxCategoryName" type="string">
  Name of the tax category applied to this line.
</ResponseField>

<ResponseField name="Quantity" type="integer">
  Number of units for this line item.
</ResponseField>

<ResponseField name="SubTotal" type="number">
  Line subtotal before tax (unit price x quantity).
</ResponseField>

<ResponseField name="TaxAmount" type="number">
  Tax amount calculated for this line.
</ResponseField>

<ResponseField name="TaxRate" type="number">
  Tax rate percentage applied to this line.
</ResponseField>

<ResponseField name="CoworkerContractUniqueId" type="string">
  UniqueId (GUID) of the CoworkerContract that generated this line.
</ResponseField>

<ResponseField name="ContractDepositUniqueId" type="string">
  UniqueId (GUID) of the ContractDeposit that generated this line.
</ResponseField>

<ResponseField name="BookingUniqueId" type="string">
  UniqueId (GUID) of the Booking that generated this line.
</ResponseField>

<ResponseField name="CoworkerExtraServiceUniqueId" type="string">
  UniqueId (GUID) of the CoworkerExtraService that generated this line.
</ResponseField>

<ResponseField name="ExtraServiceUniqueId" type="string">
  UniqueId (GUID) of the base ExtraService linked to this line.
</ResponseField>

<ResponseField name="CoworkerTimePassUniqueId" type="string">
  UniqueId (GUID) of the CoworkerTimePass that generated this line.
</ResponseField>

<ResponseField name="CoworkerChargeUniqueId" type="string">
  UniqueId (GUID) of the Charge that generated this line.
</ResponseField>

<ResponseField name="CoworkerProductUniqueId" type="string">
  UniqueId (GUID) of the CoworkerProduct that generated this line.
</ResponseField>

<ResponseField name="EventAttendeeUniqueId" type="string">
  UniqueId (GUID) of the EventAttendee that generated this line.
</ResponseField>

<ResponseField name="GroupedLineUniqueId" type="string">
  UniqueId (GUID) linking this line to a group of related invoice lines.
</ResponseField>

<ResponseField name="RefundedAmount" type="number">
  Amount that has been refunded for this line.
</ResponseField>

<ResponseField name="Refunded" type="boolean">
  Whether this line has been fully or partially refunded.
</ResponseField>

<ResponseField name="RefundedOn" type="string">
  Date and time when this line was refunded.
</ResponseField>

<ResponseField name="SaleDate" type="string">
  Date the sale occurred for this line item.
</ResponseField>

<ResponseField name="DiscountCode" type="string">
  Discount code applied to this line.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Discount amount deducted from this line.
</ResponseField>

<ResponseField name="CoworkerExtraServiceName" type="string">
  Name of the linked CoworkerExtraService.
</ResponseField>

<ResponseField name="CoworkerTimePassName" type="string">
  Name of the linked CoworkerTimePass.
</ResponseField>

<ResponseField name="CoworkerProductName" type="string">
  Name of the linked CoworkerProduct.
</ResponseField>

<ResponseField name="EventAttendeeProductName" type="string">
  Event Attendee Product Name.
</ResponseField>

<ResponseField name="TariffName" type="string">
  Name of the plan (tariff) associated with this line.
</ResponseField>

<ResponseField name="FinancialAccountCode" type="string">
  Code of the financial account (revenue category) for this line.
</ResponseField>

<ResponseField name="FinancialAccountName" type="string">
  Name of the financial account (revenue category) for this line.
</ResponseField>

<ResponseField name="IssuedByUniqueId" type="string">
  Issued By Unique Id.
</ResponseField>

<ResponseField name="CancelledCoworkerInvoiceLineUniqueId" type="string">
  Cancelled Coworker Invoice Line Unique Id.
</ResponseField>

<ResponseField name="CreatedOnLocal" type="string">
  Created On Local.
</ResponseField>

<ResponseField name="RefundedOnLocal" type="string">
  Refunded On Local.
</ResponseField>

<ResponseField name="SaleDateLocal" type="string">
  Sale Date Local.
</ResponseField>

<ResponseField name="Position" type="integer">
  Display order of this line on the invoice.
</ResponseField>

<ResponseField name="IsHidden" type="boolean">
  Whether this line is hidden from the customer-facing invoice.
</ResponseField>

<ResponseField name="IsUniversalCredit" type="boolean">
  Whether this line represents a universal credit applied to the invoice.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Purchase order reference for this line.
</ResponseField>

<ResponseField name="CreditAmount" type="number">
  Credit amount applied to this line.
</ResponseField>

<ResponseField name="IsProratedContract" type="boolean">
  Whether this line is a prorated charge from a mid-cycle contract change.
</ResponseField>

<ResponseField name="CoworkerDiscountCodeUniqueId" type="string">
  Coworker Discount Code Unique Id.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "CoworkerInvoiceId": 0,
  "CoworkerInvoiceInvoiceNumber": null,
  "CoworkerInvoicePaid": null,
  "CoworkerInvoicePaidOn": null,
  "CoworkerInvoiceCreditNote": null,
  "CoworkerInvoiceCurrencyCode": null,
  "CoworkerInvoiceDueDate": null,
  "Description": "",
  "DisplayAs": null,
  "TaxCategoryName": null,
  "Quantity": 0,
  "SubTotal": 0,
  "TaxAmount": 0,
  "TaxRate": 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,
  "PurchaseOrder": null,
  "CreditAmount": 0,
  "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
}
```
