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": true,
  "CoworkerInvoicePaidOn": "<string>",
  "CoworkerInvoiceCreditNote": true,
  "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>",
  "FinancialAccountType": 123,
  "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>"
}

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

string

Display value for CoworkerInvoice.InvoiceNumber..

boolean

Display value for CoworkerInvoice.Paid..

string

Display value for CoworkerInvoice.PaidOn..

boolean

Display value for CoworkerInvoice.CreditNote..

string

Display value for CoworkerInvoice.Currency.Code..

string

Display value for CoworkerInvoice.DueDate..

string

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

string

Optional customer-facing text displayed on printed and emailed invoices instead of Description..

string

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

integer

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

number

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

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

number

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

string

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

string

Read-only GUID of the contract deposit that generated this line, when applicable..

string

Read-only GUID of the booking that generated this line, when applicable..

string

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

string

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

string

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

string

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

string

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

string

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

string

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

number

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

boolean

Whether a refund workflow has refunded this line; inspect RefundedAmount for the refunded amount..

string

Read-only UTC date and time when a refund workflow refunded this line..

string

Read-only UTC date and time when the underlying sale occurred..

string

Read-only discount-code text applied when this line was generated..

number

Read-only discount amount deducted from this line when it was generated..

string

Read-only display name of the linked customer time credit..

string

Read-only display name of the linked customer pass..

string

Read-only display name of the linked customer product sale..

string

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

string

Read-only name of the plan associated with this line..

string

Financial-account code that categorises this line’s revenue for accounting..

string

Financial-account name that categorises this line’s revenue for accounting..

integer

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

string

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

string

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

string

Location-timezone mirror of CreatedOn; use the canonical CreatedOn value instead..

string

Location-timezone mirror of RefundedOn; use the canonical RefundedOn value instead..

string

Location-timezone mirror of SaleDate; use the canonical SaleDate value instead..

integer

Read-only display order assigned when invoice lines are ordered..

boolean

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

boolean

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

string

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

number

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

Whether this is a system-generated prorated contract adjustment for a mid-cycle change..

string

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

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,
  "FinancialAccountType": 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 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": true,
  "CoworkerInvoicePaidOn": "<string>",
  "CoworkerInvoiceCreditNote": true,
  "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>",
  "FinancialAccountType": 123,
  "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