CoworkerInvoiceLines
Get one CoworkerInvoiceLine
Retrieve a single CoworkerInvoiceLine record by its Id.
GET
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
The Id of the CoworkerInvoiceLine record to retrieve.
Code Examples
Response
200
Coworker Invoice Id.
Invoice number of the parent invoice.
Whether the parent invoice has been fully paid.
Coworker Invoice Paid On.
Whether the parent invoice is a credit note.
Currency code of the parent invoice (e.g. USD, EUR).
Coworker Invoice Due Date.
Line item description shown internally.
Override text displayed on the printed/emailed invoice instead of the description.
Name of the tax category applied to this line.
Number of units for this line item.
Line subtotal before tax (unit price x quantity).
Tax amount calculated for this line.
Tax rate percentage applied to this line.
UniqueId (GUID) of the CoworkerContract that generated this line.
UniqueId (GUID) of the ContractDeposit that generated this line.
UniqueId (GUID) of the Booking that generated this line.
UniqueId (GUID) of the CoworkerExtraService that generated this line.
UniqueId (GUID) of the base ExtraService linked to this line.
UniqueId (GUID) of the CoworkerTimePass that generated this line.
UniqueId (GUID) of the Charge that generated this line.
UniqueId (GUID) of the CoworkerProduct that generated this line.
UniqueId (GUID) of the EventAttendee that generated this line.
UniqueId (GUID) linking this line to a group of related invoice lines.
Amount that has been refunded for this line.
Whether this line has been fully or partially refunded.
Date and time when this line was refunded.
Date the sale occurred for this line item.
Discount code applied to this line.
Discount amount deducted from this line.
Name of the linked CoworkerExtraService.
Name of the linked CoworkerTimePass.
Name of the linked CoworkerProduct.
Event Attendee Product Name.
Name of the plan (tariff) associated with this line.
Code of the financial account (revenue category) for this line.
Name of the financial account (revenue category) for this line.
Issued By Unique Id.
Cancelled Coworker Invoice Line Unique Id.
Created On Local.
Refunded On Local.
Sale Date Local.
Display order of this line on the invoice.
Whether this line is hidden from the customer-facing invoice.
Whether this line represents a universal credit applied to the invoice.
Purchase order reference for this line.
Credit amount applied to this line.
Whether this line is a prorated charge from a mid-cycle contract change.
Coworker Discount Code Unique Id.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response