Get one CoworkerInvoiceLine

GET

api

billing

coworkerinvoicelines

{id}

Get one CoworkerInvoiceLine

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": "<string>",
  "CoworkerInvoicePaidOn": "<string>",
  "CoworkerInvoiceCreditNote": "<string>",
  "CoworkerInvoiceCurrencyCode": "<string>",
  "CoworkerInvoiceDueDate": "<string>",
  "Description": "<string>",
  "DisplayAs": "<string>",
  "TaxCategoryName": "<string>",
  "Quantity": 123,
  "SubTotal": 123,
  "TaxAmount": 123,
  "TaxRate": 123,
  "CoworkerContractUniqueId": "<string>",
  "ContractDepositUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "CoworkerExtraServiceUniqueId": "<string>",
  "ExtraServiceUniqueId": "<string>",
  "CoworkerTimePassUniqueId": "<string>",
  "CoworkerChargeUniqueId": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "EventAttendeeUniqueId": "<string>",
  "GroupedLineUniqueId": "<string>",
  "RefundedAmount": 123,
  "Refunded": true,
  "RefundedOn": "<string>",
  "SaleDate": "<string>",
  "DiscountCode": "<string>",
  "DiscountAmount": 123,
  "CoworkerExtraServiceName": "<string>",
  "CoworkerTimePassName": "<string>",
  "CoworkerProductName": "<string>",
  "EventAttendeeProductName": "<string>",
  "TariffName": "<string>",
  "FinancialAccountCode": "<string>",
  "FinancialAccountName": "<string>",
  "IssuedByUniqueId": "<string>",
  "CancelledCoworkerInvoiceLineUniqueId": "<string>",
  "CreatedOnLocal": "<string>",
  "RefundedOnLocal": "<string>",
  "SaleDateLocal": "<string>",
  "Position": 123,
  "IsHidden": true,
  "IsUniversalCredit": true,
  "PurchaseOrder": "<string>",
  "CreditAmount": 123,
  "IsProratedContract": true,
  "CoworkerDiscountCodeUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the CoworkerInvoiceLine record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoicelines/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the coworker invoice linked to this record.

string

Invoice number of the parent invoice.

string

Whether the parent invoice has been fully paid.

string

Date/time value for coworker invoice paid on.

string

Whether the parent invoice is a credit note.

string

Currency code of the parent invoice (e.g. USD, EUR).

string

Date/time value for coworker invoice due date.

string

Line item description shown internally.

string

Override text displayed on the printed/emailed invoice instead of the description.

string

Name of the tax category applied to this line.

integer

Number of units for this line item.

number

Line subtotal before tax (unit price x quantity).

number

Tax amount calculated for this line.

number

Tax rate percentage applied to this line.

string

UniqueId (GUID) of the CoworkerContract that generated this line.

string

UniqueId (GUID) of the ContractDeposit that generated this line.

string

UniqueId (GUID) of the Booking that generated this line.

string

UniqueId (GUID) of the CoworkerExtraService that generated this line.

string

UniqueId (GUID) of the base ExtraService linked to this line.

string

UniqueId (GUID) of the CoworkerTimePass that generated this line.

string

UniqueId (GUID) of the Charge that generated this line.

string

UniqueId (GUID) of the CoworkerProduct that generated this line.

string

UniqueId (GUID) of the EventAttendee that generated this line.

string

UniqueId (GUID) linking this line to a group of related invoice lines.

number

Amount that has been refunded for this line.

boolean

Whether this line has been fully or partially refunded.

string

Date and time when this line was refunded.

string

Date the sale occurred for this line item.

string

Discount code applied to this line.

number

Discount amount deducted from this line.

string

Name of the linked CoworkerExtraService.

string

Name of the linked CoworkerTimePass.

string

Name of the linked CoworkerProduct.

string

Display name of the linked event attendee product (read-only).

string

Name of the plan (tariff) associated with this line.

string

Code of the financial account (revenue category) for this line.

string

Name of the financial account (revenue category) for this line.

string

ID of the issued by unique associated with this record.

string

ID of the cancelled coworker invoice line unique associated with this record.

string

Date/time value for created on local.

string

Date/time value for refunded on local.

string

Date/time value for sale date local.

integer

Display order of this line on the invoice.

boolean

Whether this line is hidden from the customer-facing invoice.

boolean

Whether this line represents a universal credit applied to the invoice.

string

Purchase order reference for this line.

number

Credit amount applied to this line.

boolean

Whether this line is a prorated charge from a mid-cycle contract change.

string

ID of the coworker discount code unique associated with this record.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

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

Get multiple CoworkerInvoiceLinesRetrieve multiple CoworkerInvoiceLine records by their Ids in a single request.

Get one CoworkerInvoiceLine

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerInvoiceId": 123,
  "CoworkerInvoiceInvoiceNumber": "<string>",
  "CoworkerInvoicePaid": "<string>",
  "CoworkerInvoicePaidOn": "<string>",
  "CoworkerInvoiceCreditNote": "<string>",
  "CoworkerInvoiceCurrencyCode": "<string>",
  "CoworkerInvoiceDueDate": "<string>",
  "Description": "<string>",
  "DisplayAs": "<string>",
  "TaxCategoryName": "<string>",
  "Quantity": 123,
  "SubTotal": 123,
  "TaxAmount": 123,
  "TaxRate": 123,
  "CoworkerContractUniqueId": "<string>",
  "ContractDepositUniqueId": "<string>",
  "BookingUniqueId": "<string>",
  "CoworkerExtraServiceUniqueId": "<string>",
  "ExtraServiceUniqueId": "<string>",
  "CoworkerTimePassUniqueId": "<string>",
  "CoworkerChargeUniqueId": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "EventAttendeeUniqueId": "<string>",
  "GroupedLineUniqueId": "<string>",
  "RefundedAmount": 123,
  "Refunded": true,
  "RefundedOn": "<string>",
  "SaleDate": "<string>",
  "DiscountCode": "<string>",
  "DiscountAmount": 123,
  "CoworkerExtraServiceName": "<string>",
  "CoworkerTimePassName": "<string>",
  "CoworkerProductName": "<string>",
  "EventAttendeeProductName": "<string>",
  "TariffName": "<string>",
  "FinancialAccountCode": "<string>",
  "FinancialAccountName": "<string>",
  "IssuedByUniqueId": "<string>",
  "CancelledCoworkerInvoiceLineUniqueId": "<string>",
  "CreatedOnLocal": "<string>",
  "RefundedOnLocal": "<string>",
  "SaleDateLocal": "<string>",
  "Position": 123,
  "IsHidden": true,
  "IsUniversalCredit": true,
  "PurchaseOrder": "<string>",
  "CreditAmount": 123,
  "IsProratedContract": true,
  "CoworkerDiscountCodeUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200