Get one CoworkerInvoice

GET

api

billing

coworkerinvoices

{id}

Get one CoworkerInvoice

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerinvoices/{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/coworkerinvoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerRegularPaymentContractNumber": "<string>",
  "CoworkerRegularPaymentProvider": "<string>",
  "CoworkerCardNumber": "<string>",
  "CoworkerGoCardlessContractNumber": "<string>",
  "CoworkerEnableGoCardlessPayments": true,
  "CoworkerBillingEmail": "<string>",
  "CoworkerNotifyOnNewInvoice": true,
  "CoworkerNotifyOnNewPayment": true,
  "CoworkerNotifyOnFailedPayment": true,
  "CoworkerDoNotProcessInvoicesAutomatically": true,
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "InvoiceNumber": "<string>",
  "PaymentReference": "<string>",
  "BillToName": "<string>",
  "BillToAddress": "<string>",
  "BillToCity": "<string>",
  "BillToPostCode": "<string>",
  "BillToPhone": "<string>",
  "BillToFax": "<string>",
  "BillToState": "<string>",
  "BillToCountryId": 123,
  "BillToCountryName": "<string>",
  "BillToCountryTwoDigitsCode": "<string>",
  "BillToBankAccount": "<string>",
  "BillToTaxIDNumber": "<string>",
  "PurchaseOrder": "<string>",
  "Description": "<string>",
  "DiscountAmount": 123,
  "DueDate": "<string>",
  "InvoiceFromDate": "<string>",
  "InvoiceToDate": "<string>",
  "TotalAmount": 123,
  "PaidAmount": 123,
  "TransactionTotalAmount": 123,
  "TransactionCurrencyId": 123,
  "TransactionCurrencyCode": "<string>",
  "TransactionExchangeRate": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxAmount": 123,
  "Draft": true,
  "Void": true,
  "WaitingForInvoiceNumber": true,
  "Paid": true,
  "Sent": true,
  "SentOn": "<string>",
  "PaidOn": "<string>",
  "Refunded": true,
  "XeroInvoiceTransfered": true,
  "XeroPaymentTransfered": true,
  "QuickbooksInvoiceTransfered": true,
  "QuickbooksPaymentTransfered": true,
  "MoloniInvoiceTransferred": true,
  "MoloniPaymentTransferred": true,
  "StorecoveInvoiceStatus": 123,
  "AutoTransferToStorecove": true,
  "StorecoveUniqueId": "<string>",
  "RefundedOn": "<string>",
  "CreditNote": true,
  "OriginalInvoiceGuid": "<string>",
  "ContractGuid": "<string>",
  "CustomData": "<string>",
  "GoCardlessReference": "<string>",
  "SpreedlyToken": "<string>",
  "LastPaymentAttempt": "<string>",
  "Billed": true,
  "DoNotApplyCreditAutomatically": true,
  "CreatedOnLocal": "<string>",
  "DueDateLocal": "<string>",
  "InvoiceFromDateLocal": "<string>",
  "InvoiceToDateLocal": "<string>",
  "PaidOnLocal": "<string>",
  "RefundedOnLocal": "<string>",
  "LastPaymentAttemptLocal": "<string>",
  "ReceivedAmount": 123,
  "CreditedAmount": 123,
  "RefundedAmount": 123,
  "NexKioskTransactionId": "<string>",
  "AutoTransferToXeroOrQuickBooks": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A CoworkerInvoice is the bill a location issues to one of its customers (member, contact or team) for plans, bookings, products, passes and other charges, including totals, payment status, credits and invoice delivery. THIS IS THE DEFAULT INVOICE ENTITY: when an operator says ‘invoice’, ‘invoices’, ‘unpaid invoices’, ‘overdue invoices’, ‘invoice 1042’, ‘send the invoice’ or ‘credit note’, they mean a CoworkerInvoice — use the coworker_invoice_* tools and do not ask which kind of invoice they meant. The separate Invoice entity (invoice_* tools) is the platform bill Nexudus issues to the operator and is almost never what an operator is asking about. Call this record an ‘invoice’ when speaking to the operator; never say ‘CoworkerInvoice’.

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

Path Parameters

integer

required

The Id of the CoworkerInvoice record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the customer billed by this invoice..

string

Display value for Coworker.FullName..

string

Display value for Coworker.RegularPaymentContractNumber..

string

Display value for Coworker.RegularPaymentProvider..

string

Display value for Coworker.CardNumber..

string

Display value for Coworker.GoCardlessContractNumber..

boolean

Display value for Coworker.EnableGoCardlessPayments..

string

Display value for Coworker.BillingEmail..

boolean

Display value for Coworker.NotifyOnNewInvoice..

boolean

Display value for Coworker.NotifyOnNewPayment..

boolean

Display value for Coworker.NotifyOnFailedPayment..

boolean

Display value for Coworker.DoNotProcessInvoicesAutomatically..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.TeamNames..

integer

ID of the location that owns and issues this invoice..

string

Display value for Business.Name..

string

Unique invoice number, assigned when the invoice is issued..

string

Payment reference used for reconciliation; normally follows the invoice number..

string

Name of the person or organisation billed, captured on the invoice..

string

Billing street address captured on the invoice..

string

Billing city captured on the invoice..

string

Billing postal or ZIP code captured on the invoice..

string

Optional billing phone number captured on the invoice..

string

Optional billing fax number captured on the invoice..

string

Optional billing state, province, or region captured on the invoice..

integer

ID of the country in the billing address..

string

Display value for BillToCountry.Name..

string

Display value for BillToCountry.TwoDigitsCode..

string

Optional bank-account details printed for payment instructions..

string

Optional tax identification number of the billed party..

string

Optional customer purchase-order reference..

string

Read-only summary generated from the invoice lines; change lines instead..

number

Read-only stored invoice-level discount amount in the invoice currency; UpdateTotals does not recalculate it because line SubTotal values already include line discounts..

string

Optional payment due date in the location’s timezone. When an invoice is created, the system calculates it using the customer’s due day or InvoiceDueDatePeriod first, then a due-date term configured for a plan on the invoice’s contract lines, the contract-period-start setting, and finally the location default; customer and plan periods are capped at 365 days. If several plan due-date terms apply, it uses the earliest next due date..

string

Read-only start of the contract billing period, calculated from the InvoicedPeriod of the contract being invoiced..

string

Read-only end of the contract billing period, calculated from the billing period of the contract’s associated plan..

number

Read-only gross invoice total: sum of every line’s SubTotal plus TaxAmount after each line is rounded, then rounded to the location’s invoice decimal precision..

number

Read-only database total of all CoworkerLedgerEntry Credit values linked to this invoice; negative credit entries reduce the amount..

number

Stored total to collect in the payment transaction currency, set to TotalAmount multiplied by Payments.ExchangeRate and rounded to two decimals; the outstanding balance proportionally subtracts net ledger credits..

integer

ID of the currency used to collect payment; defaults to the location’s invoice currency unless Payments.Currency specifies a transaction currency..

string

Display value for TransactionCurrency.Code..

number

Fixed multiplier from invoice currency to transaction currency, copied from the location’s Payments.ExchangeRate setting when invoice totals are updated..

integer

ID of the currency used to state invoice amounts..

string

Display value for Currency.Code..

number

Read-only tax total: sum of every rounded invoice-line TaxAmount, then rounded to the location’s invoice decimal precision..

boolean

Whether this invoice remains a draft rather than a final issued invoice..

boolean

Whether this invoice has been voided or cancelled; voiding deletes all CoworkerLedgerEntry records associated with the invoice..

boolean

Whether the invoice is awaiting its final sequential number..

boolean

Whether payments have marked the invoice as paid..

boolean

Whether the invoice has been sent to the customer..

string

Read-only date and time when the invoice was sent..

string

Date and time recorded as paid; it updates payment ledger dates..

boolean

Whether all non-zero invoice lines have been refunded..

boolean

Whether the invoice has been transferred to Xero..

boolean

Whether invoice payments have been transferred to Xero..

boolean

Whether the invoice has been transferred to QuickBooks..

boolean

Whether invoice payments have been transferred to QuickBooks..

boolean

Whether the invoice has been transferred to Moloni..

boolean

Whether invoice payments have been transferred to Moloni..

integer

Read-only Storecove transfer state: None, TransferFailed, Processing, ProcessingFailed, or Processed.. See eStorecoveInvoiceStatus enum values: 1 = None, 2 = TransferFailed, 3 = Processing, 4 = ProcessingFailed, 5 = Processed.

boolean

Whether the invoice is configured for automatic Storecove transfer..

string

Read-only identifier assigned by Storecove after transfer..

string

Read-only date and time when the invoice was refunded..

boolean

Whether this invoice is a credit note..

string

Read-only unique ID of the original invoice related to this credit note..

string

Read-only unique ID of the customer plan contract that generated this invoice..

string

Internal payment-provider payload such as Stripe identifiers..

string

Internal GoCardless payment reference..

string

Sensitive payment-provider token used for Spreedly processing..

string

Read-only timestamp of the most recent automatic payment attempt..

boolean

Internal billing-processing flag..

boolean

Whether credit resulting from crediting a paid invoice must not be automatically applied to future invoices; the operator can allocate the credit manually..

string

Location-timezone mirror of the system CreatedOn timestamp..

string

Location-timezone mirror of DueDate; use DueDate instead..

string

Location-timezone mirror of InvoiceFromDate; use InvoiceFromDate instead..

string

Location-timezone mirror of InvoiceToDate; use InvoiceToDate instead..

string

Location-timezone mirror of PaidOn; use PaidOn instead..

string

Location-timezone mirror of RefundedOn; use RefundedOn instead..

string

Location-timezone mirror of LastPaymentAttempt..

number

Read-only database-maintained reporting amount for payments received; it is not calculated by invoice UpdateTotals..

number

Read-only database-maintained reporting amount for credit applied or issued; it is not calculated by invoice UpdateTotals..

number

Read-only database-maintained reporting amount for refunds; it is not calculated by invoice UpdateTotals..

string

Internal NexKiosk payment transaction identifier..

boolean

Whether the invoice is configured for automatic Xero or QuickBooks transfer..

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

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

Get one CoworkerInvoice

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerinvoices/{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/coworkerinvoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerRegularPaymentContractNumber": "<string>",
  "CoworkerRegularPaymentProvider": "<string>",
  "CoworkerCardNumber": "<string>",
  "CoworkerGoCardlessContractNumber": "<string>",
  "CoworkerEnableGoCardlessPayments": true,
  "CoworkerBillingEmail": "<string>",
  "CoworkerNotifyOnNewInvoice": true,
  "CoworkerNotifyOnNewPayment": true,
  "CoworkerNotifyOnFailedPayment": true,
  "CoworkerDoNotProcessInvoicesAutomatically": true,
  "CoworkerCompanyName": "<string>",
  "CoworkerTeamNames": "<string>",
  "BusinessId": 123,
  "BusinessName": "<string>",
  "InvoiceNumber": "<string>",
  "PaymentReference": "<string>",
  "BillToName": "<string>",
  "BillToAddress": "<string>",
  "BillToCity": "<string>",
  "BillToPostCode": "<string>",
  "BillToPhone": "<string>",
  "BillToFax": "<string>",
  "BillToState": "<string>",
  "BillToCountryId": 123,
  "BillToCountryName": "<string>",
  "BillToCountryTwoDigitsCode": "<string>",
  "BillToBankAccount": "<string>",
  "BillToTaxIDNumber": "<string>",
  "PurchaseOrder": "<string>",
  "Description": "<string>",
  "DiscountAmount": 123,
  "DueDate": "<string>",
  "InvoiceFromDate": "<string>",
  "InvoiceToDate": "<string>",
  "TotalAmount": 123,
  "PaidAmount": 123,
  "TransactionTotalAmount": 123,
  "TransactionCurrencyId": 123,
  "TransactionCurrencyCode": "<string>",
  "TransactionExchangeRate": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxAmount": 123,
  "Draft": true,
  "Void": true,
  "WaitingForInvoiceNumber": true,
  "Paid": true,
  "Sent": true,
  "SentOn": "<string>",
  "PaidOn": "<string>",
  "Refunded": true,
  "XeroInvoiceTransfered": true,
  "XeroPaymentTransfered": true,
  "QuickbooksInvoiceTransfered": true,
  "QuickbooksPaymentTransfered": true,
  "MoloniInvoiceTransferred": true,
  "MoloniPaymentTransferred": true,
  "StorecoveInvoiceStatus": 123,
  "AutoTransferToStorecove": true,
  "StorecoveUniqueId": "<string>",
  "RefundedOn": "<string>",
  "CreditNote": true,
  "OriginalInvoiceGuid": "<string>",
  "ContractGuid": "<string>",
  "CustomData": "<string>",
  "GoCardlessReference": "<string>",
  "SpreedlyToken": "<string>",
  "LastPaymentAttempt": "<string>",
  "Billed": true,
  "DoNotApplyCreditAutomatically": true,
  "CreatedOnLocal": "<string>",
  "DueDateLocal": "<string>",
  "InvoiceFromDateLocal": "<string>",
  "InvoiceToDateLocal": "<string>",
  "PaidOnLocal": "<string>",
  "RefundedOnLocal": "<string>",
  "LastPaymentAttemptLocal": "<string>",
  "ReceivedAmount": 123,
  "CreditedAmount": 123,
  "RefundedAmount": 123,
  "NexKioskTransactionId": "<string>",
  "AutoTransferToXeroOrQuickBooks": true,
  "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