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

> Retrieve a single CoworkerInvoice record by its Id.

A **CoworkerInvoice** represents an invoice document issued to a customer. Invoices track amounts owed, payment status, billing details, and integration state with external accounting systems.

Invoices can be in draft or final state. A draft invoice (\`\`Draft` true`) can still be modified before being finalised. Once finalised, an invoice number is assigned and the invoice can be sent to the customer.

An invoice may also be a **credit note** (``CreditNote` true`), which references the original invoice via ``OriginalInvoiceGuid\`\` and represents a reversal or adjustment.

Payment status is tracked via `Paid`, `PaidAmount`, and `PaidOn`. Partial payments are possible — compare `PaidAmount` against `TotalAmount` to determine outstanding balance. Refunds are tracked separately via `Refunded`, `RefundedOn`, and `RefundedAmount`.

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

## Path Parameters

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

## Code Examples

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

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices/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/coworkerinvoices/87654321',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

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

## Response

### 200

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

<ResponseField name="CoworkerFullName" type="string">
  Full name of the invoiced customer.
</ResponseField>

<ResponseField name="CoworkerRegularPaymentContractNumber" type="string">
  Coworker Regular Payment Contract Number.
</ResponseField>

<ResponseField name="CoworkerRegularPaymentProvider" type="string">
  Coworker Regular Payment Provider.
</ResponseField>

<ResponseField name="CoworkerCardNumber" type="string">
  Coworker Card Number.
</ResponseField>

<ResponseField name="CoworkerGoCardlessContractNumber" type="string">
  Coworker Go Cardless Contract Number.
</ResponseField>

<ResponseField name="CoworkerEnableGoCardlessPayments" type="boolean">
  Coworker Enable Go Cardless Payments.
</ResponseField>

<ResponseField name="CoworkerBillingEmail" type="string">
  Billing email address of the customer.
</ResponseField>

<ResponseField name="CoworkerNotifyOnNewInvoice" type="boolean">
  Coworker Notify On New Invoice.
</ResponseField>

<ResponseField name="CoworkerNotifyOnNewPayment" type="boolean">
  Coworker Notify On New Payment.
</ResponseField>

<ResponseField name="CoworkerNotifyOnFailedPayment" type="boolean">
  Coworker Notify On Failed Payment.
</ResponseField>

<ResponseField name="CoworkerDoNotProcessInvoicesAutomatically" type="boolean">
  Coworker Do Not Process Invoices Automatically.
</ResponseField>

<ResponseField name="CoworkerCompanyName" type="string">
  Company name of the invoiced customer.
</ResponseField>

<ResponseField name="CoworkerTeamNames" type="string">
  Team names the invoiced customer belongs to.
</ResponseField>

<ResponseField name="BusinessId" type="integer">
  Business Id.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Name of the location that issued the invoice.
</ResponseField>

<ResponseField name="InvoiceNumber" type="string">
  Unique invoice number assigned when the invoice is finalised.
</ResponseField>

<ResponseField name="PaymentReference" type="string">
  Reference code used to match payments to this invoice.
</ResponseField>

<ResponseField name="BillToName" type="string">
  Name of the person or company being billed.
</ResponseField>

<ResponseField name="BillToAddress" type="string">
  Billing address on the invoice.
</ResponseField>

<ResponseField name="BillToCity" type="string">
  Billing city on the invoice.
</ResponseField>

<ResponseField name="BillToPostCode" type="string">
  Billing post code on the invoice.
</ResponseField>

<ResponseField name="BillToPhone" type="string">
  Billing phone number on the invoice.
</ResponseField>

<ResponseField name="BillToFax" type="string">
  Billing fax number on the invoice.
</ResponseField>

<ResponseField name="BillToState" type="string">
  Billing state or region on the invoice.
</ResponseField>

<ResponseField name="BillToCountryId" type="integer">
  Bill To Country Id.
</ResponseField>

<ResponseField name="BillToCountryName" type="string">
  Name of the billing country on the invoice.
</ResponseField>

<ResponseField name="BillToCountryTwoDigitsCode" type="string">
  Bill To Country Two Digits Code.
</ResponseField>

<ResponseField name="BillToBankAccount" type="string">
  Bank account number on the invoice for payment.
</ResponseField>

<ResponseField name="BillToTaxIDNumber" type="string">
  Tax identification number of the billed party.
</ResponseField>

<ResponseField name="PurchaseOrder" type="string">
  Customer purchase order number for this invoice.
</ResponseField>

<ResponseField name="Description" type="string">
  Free-text description or notes for the invoice.
</ResponseField>

<ResponseField name="DiscountAmount" type="number">
  Discount amount applied to the invoice total.
</ResponseField>

<ResponseField name="DueDate" type="string">
  Date by which payment is due.
</ResponseField>

<ResponseField name="InvoiceFromDate" type="string">
  Start date of the billing period covered by this invoice.
</ResponseField>

<ResponseField name="InvoiceToDate" type="string">
  End date of the billing period covered by this invoice.
</ResponseField>

<ResponseField name="TotalAmount" type="number">
  Total invoice amount including tax.
</ResponseField>

<ResponseField name="PaidAmount" type="number">
  Total amount paid against this invoice so far.
</ResponseField>

<ResponseField name="TransactionTotalAmount" type="number">
  Transaction Total Amount.
</ResponseField>

<ResponseField name="TransactionCurrencyId" type="integer">
  Transaction Currency Id.
</ResponseField>

<ResponseField name="TransactionCurrencyCode" type="string">
  Transaction Currency Code.
</ResponseField>

<ResponseField name="TransactionExchangeRate" type="number">
  Transaction Exchange Rate.
</ResponseField>

<ResponseField name="CurrencyId" type="integer">
  Currency Id.
</ResponseField>

<ResponseField name="CurrencyCode" type="string">
  ISO currency code (e.g. USD, EUR, GBP).
</ResponseField>

<ResponseField name="TaxAmount" type="number">
  Total tax amount on the invoice.
</ResponseField>

<ResponseField name="Draft" type="boolean">
  Whether the invoice is still a draft. Draft invoices can be modified before finalisation.
</ResponseField>

<ResponseField name="Void" type="boolean">
  Whether the invoice has been voided (cancelled without a credit note).
</ResponseField>

<ResponseField name="WaitingForInvoiceNumber" type="boolean">
  Whether the invoice is queued for invoice number assignment.
</ResponseField>

<ResponseField name="Paid" type="boolean">
  Whether the invoice has been fully paid.
</ResponseField>

<ResponseField name="Sent" type="boolean">
  Whether the invoice has been emailed to the customer.
</ResponseField>

<ResponseField name="SentOn" type="string">
  Date the invoice was emailed to the customer.
</ResponseField>

<ResponseField name="PaidOn" type="string">
  Date the invoice was marked as fully paid.
</ResponseField>

<ResponseField name="Refunded" type="boolean">
  Whether a refund has been issued for this invoice.
</ResponseField>

<ResponseField name="XeroInvoiceTransfered" type="boolean">
  Whether the invoice has been transferred to Xero.
</ResponseField>

<ResponseField name="XeroPaymentTransfered" type="boolean">
  Whether the payment has been transferred to Xero.
</ResponseField>

<ResponseField name="QuickbooksInvoiceTransfered" type="boolean">
  Whether the invoice has been transferred to QuickBooks.
</ResponseField>

<ResponseField name="QuickbooksPaymentTransfered" type="boolean">
  Whether the payment has been transferred to QuickBooks.
</ResponseField>

<ResponseField name="MoloniInvoiceTransferred" type="boolean">
  Whether the invoice has been transferred to Moloni.
</ResponseField>

<ResponseField name="MoloniPaymentTransferred" type="boolean">
  Whether the payment has been transferred to Moloni.
</ResponseField>

<ResponseField name="StorecoveInvoiceStatus" type="integer">
  Status of e-invoicing transfer via Storecove. See `eStorecoveInvoiceStatus` enum values: `1` = None, `2` = TransferFailed, `3` = Processing, `4` = ProcessingFailed, `5` = Processed.
</ResponseField>

<ResponseField name="AutoTransferToStorecove" type="boolean">
  Whether the invoice is automatically sent to Storecove for e-invoicing.
</ResponseField>

<ResponseField name="StorecoveUniqueId" type="string">
  Storecove Unique Id.
</ResponseField>

<ResponseField name="RefundedOn" type="string">
  Date the refund was issued.
</ResponseField>

<ResponseField name="CreditNote" type="boolean">
  Whether this document is a credit note rather than an invoice.
</ResponseField>

<ResponseField name="OriginalInvoiceGuid" type="string">
  GUID of the original invoice this credit note reverses.
</ResponseField>

<ResponseField name="ContractGuid" type="string">
  GUID of the contract that generated this invoice.
</ResponseField>

<ResponseField name="CustomData" type="string">
  Arbitrary custom data stored with the invoice.
</ResponseField>

<ResponseField name="GoCardlessReference" type="string">
  GoCardless payment reference for direct debit collection.
</ResponseField>

<ResponseField name="SpreedlyToken" type="string">
  Spreedly Token.
</ResponseField>

<ResponseField name="LastPaymentAttempt" type="string">
  Last Payment Attempt.
</ResponseField>

<ResponseField name="Billed" type="boolean">
  Billed.
</ResponseField>

<ResponseField name="DoNotApplyCreditAutomatically" type="boolean">
  Whether to skip automatic application of available credit to this invoice.
</ResponseField>

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

<ResponseField name="DueDateLocal" type="string">
  Due Date Local.
</ResponseField>

<ResponseField name="InvoiceFromDateLocal" type="string">
  Invoice From Date Local.
</ResponseField>

<ResponseField name="InvoiceToDateLocal" type="string">
  Invoice To Date Local.
</ResponseField>

<ResponseField name="PaidOnLocal" type="string">
  Paid On Local.
</ResponseField>

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

<ResponseField name="LastPaymentAttemptLocal" type="string">
  Last Payment Attempt Local.
</ResponseField>

<ResponseField name="ReceivedAmount" type="number">
  Total amount received via direct payments.
</ResponseField>

<ResponseField name="CreditedAmount" type="number">
  Amount paid via credit notes or account credit.
</ResponseField>

<ResponseField name="RefundedAmount" type="number">
  Total amount refunded on this invoice.
</ResponseField>

<ResponseField name="NexKioskTransactionId" type="string">
  Transaction ID from NexKiosk point-of-sale payment.
</ResponseField>

<ResponseField name="AutoTransferToXeroOrQuickBooks" type="boolean">
  Whether the invoice is automatically transferred to Xero or QuickBooks.
</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}
{
  "CoworkerId": 0,
  "CoworkerFullName": null,
  "CoworkerRegularPaymentContractNumber": null,
  "CoworkerRegularPaymentProvider": null,
  "CoworkerCardNumber": null,
  "CoworkerGoCardlessContractNumber": null,
  "CoworkerEnableGoCardlessPayments": null,
  "CoworkerBillingEmail": null,
  "CoworkerNotifyOnNewInvoice": null,
  "CoworkerNotifyOnNewPayment": null,
  "CoworkerNotifyOnFailedPayment": null,
  "CoworkerDoNotProcessInvoicesAutomatically": null,
  "CoworkerCompanyName": null,
  "CoworkerTeamNames": null,
  "BusinessId": 0,
  "BusinessName": null,
  "InvoiceNumber": "",
  "PaymentReference": null,
  "BillToName": "",
  "BillToAddress": "",
  "BillToCity": "",
  "BillToPostCode": "",
  "BillToPhone": null,
  "BillToFax": null,
  "BillToState": null,
  "BillToCountryId": 0,
  "BillToCountryName": null,
  "BillToCountryTwoDigitsCode": null,
  "BillToBankAccount": null,
  "BillToTaxIDNumber": null,
  "PurchaseOrder": null,
  "Description": null,
  "DiscountAmount": 0,
  "DueDate": null,
  "InvoiceFromDate": null,
  "InvoiceToDate": null,
  "TotalAmount": 0,
  "PaidAmount": null,
  "TransactionTotalAmount": null,
  "TransactionCurrencyId": null,
  "TransactionCurrencyCode": null,
  "TransactionExchangeRate": null,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxAmount": 0,
  "Draft": false,
  "Void": false,
  "WaitingForInvoiceNumber": false,
  "Paid": false,
  "Sent": false,
  "SentOn": null,
  "PaidOn": null,
  "Refunded": false,
  "XeroInvoiceTransfered": false,
  "XeroPaymentTransfered": false,
  "QuickbooksInvoiceTransfered": false,
  "QuickbooksPaymentTransfered": false,
  "MoloniInvoiceTransferred": false,
  "MoloniPaymentTransferred": false,
  "StorecoveInvoiceStatus": 0,
  "AutoTransferToStorecove": false,
  "StorecoveUniqueId": null,
  "RefundedOn": null,
  "CreditNote": false,
  "OriginalInvoiceGuid": null,
  "ContractGuid": null,
  "CustomData": null,
  "GoCardlessReference": null,
  "SpreedlyToken": null,
  "LastPaymentAttempt": null,
  "Billed": false,
  "DoNotApplyCreditAutomatically": false,
  "CreatedOnLocal": null,
  "DueDateLocal": null,
  "InvoiceFromDateLocal": null,
  "InvoiceToDateLocal": null,
  "PaidOnLocal": null,
  "RefundedOnLocal": null,
  "LastPaymentAttemptLocal": null,
  "ReceivedAmount": null,
  "CreditedAmount": null,
  "RefundedAmount": null,
  "NexKioskTransactionId": null,
  "AutoTransferToXeroOrQuickBooks": false,
  "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": "CoworkerInvoice Example",
  "LocalizationDetails": null,
  "CustomFields": null
}
```
