Search CoworkerInvoices

GET

api

billing

coworkerinvoices

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerinvoices"

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

Enums

eStorecoveInvoiceStatus — StorecoveInvoiceStatus values

Value	Name
1	None
2	TransferFailed
3	Processing
4	ProcessingFailed
5	Processed

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the customer billed by this invoice..

string

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.RegularPaymentContractNumber..

string

Filter by display value for Coworker.RegularPaymentProvider..

string

Filter by display value for Coworker.CardNumber..

string

Filter by display value for Coworker.GoCardlessContractNumber..

boolean

Filter by display value for Coworker.EnableGoCardlessPayments..

string

Filter by display value for Coworker.BillingEmail..

boolean

Filter by display value for Coworker.NotifyOnNewInvoice..

boolean

Filter by display value for Coworker.NotifyOnNewPayment..

boolean

Filter by display value for Coworker.NotifyOnFailedPayment..

boolean

Filter by display value for Coworker.DoNotProcessInvoicesAutomatically..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.TeamNames..

integer

Filter by iD of the location that owns and issues this invoice..

string

Filter by display value for Business.Name..

string

Filter by unique invoice number, assigned when the invoice is issued..

string

Filter by payment reference used for reconciliation; normally follows the invoice number..

string

Filter by name of the person or organisation billed, captured on the invoice..

string

Filter by billing street address captured on the invoice..

string

Filter by billing city captured on the invoice..

string

Filter by billing postal or ZIP code captured on the invoice..

string

Filter by optional billing phone number captured on the invoice..

string

Filter by optional billing fax number captured on the invoice..

string

Filter by optional billing state, province, or region captured on the invoice..

integer

Filter by iD of the country in the billing address..

string

Filter by display value for BillToCountry.Name..

string

Filter by display value for BillToCountry.TwoDigitsCode..

string

Filter by optional bank-account details printed for payment instructions..

string

Filter by optional tax identification number of the billed party..

string

Filter by optional customer purchase-order reference..

string

Filter by read-only summary generated from the invoice lines; change lines instead..

number

Filter by 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

Filter by 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

Filter by read-only start of the contract billing period, calculated from the InvoicedPeriod of the contract being invoiced..

string

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

number

Filter by 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

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

number

Filter by 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

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

string

Filter by display value for TransactionCurrency.Code..

number

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

integer

Filter by iD of the currency used to state invoice amounts..

string

Filter by display value for Currency.Code..

number

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

boolean

Filter by whether this invoice remains a draft rather than a final issued invoice..

boolean

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

boolean

Filter by whether the invoice is awaiting its final sequential number..

boolean

Filter by whether payments have marked the invoice as paid..

boolean

Filter by whether the invoice has been sent to the customer..

string

Filter by read-only date and time when the invoice was sent..

string

Filter by date and time recorded as paid; it updates payment ledger dates..

boolean

Filter by whether all non-zero invoice lines have been refunded..

boolean

Filter by whether the invoice has been transferred to Xero..

boolean

Filter by whether invoice payments have been transferred to Xero..

boolean

Filter by whether the invoice has been transferred to QuickBooks..

boolean

Filter by whether invoice payments have been transferred to QuickBooks..

boolean

Filter by whether the invoice has been transferred to Moloni..

boolean

Filter by whether invoice payments have been transferred to Moloni..

integer

Filter by read-only Storecove transfer state: None, TransferFailed, Processing, ProcessingFailed, or Processed..

boolean

Filter by whether the invoice is configured for automatic Storecove transfer..

string

Filter by read-only identifier assigned by Storecove after transfer..

string

Filter by read-only date and time when the invoice was refunded..

boolean

Filter by whether this invoice is a credit note..

string

Filter by read-only unique ID of the original invoice related to this credit note..

string

Filter by read-only unique ID of the customer plan contract that generated this invoice..

string

Filter by internal payment-provider payload such as Stripe identifiers..

string

Filter by internal GoCardless payment reference..

string

Filter by sensitive payment-provider token used for Spreedly processing..

string

Filter by read-only timestamp of the most recent automatic payment attempt..

boolean

Filter by internal billing-processing flag..

boolean

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

string

Filter by location-timezone mirror of the system CreatedOn timestamp..

string

Filter by location-timezone mirror of DueDate; use DueDate instead..

string

Filter by location-timezone mirror of InvoiceFromDate; use InvoiceFromDate instead..

string

Filter by location-timezone mirror of InvoiceToDate; use InvoiceToDate instead..

string

Filter by location-timezone mirror of PaidOn; use PaidOn instead..

string

Filter by location-timezone mirror of RefundedOn; use RefundedOn instead..

string

Filter by location-timezone mirror of LastPaymentAttempt..

number

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

number

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

number

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

string

Filter by internal NexKiosk payment transaction identifier..

boolean

Filter by whether the invoice is configured for automatic Xero or QuickBooks transfer..

Range Filters

number

Filter by read-only stored invoice-level discount amount in the invoice currency; UpdateTotals does not recalculate it because line SubTotal values already include line discounts. greater than or equal to this value.

number

string

Filter by read-only start of the contract billing period, calculated from the InvoicedPeriod of the contract being invoiced. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only start of the contract billing period, calculated from the InvoicedPeriod of the contract being invoiced. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only end of the contract billing period, calculated from the billing period of the contract’s associated plan. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only end of the contract billing period, calculated from the billing period of the contract’s associated plan. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by 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. greater than or equal to this value.

number

Filter by 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. less than or equal to this value.

number

Filter by read-only database total of all CoworkerLedgerEntry Credit values linked to this invoice; negative credit entries reduce the amount. greater than or equal to this value.

number

Filter by read-only database total of all CoworkerLedgerEntry Credit values linked to this invoice; negative credit entries reduce the amount. less than or equal to this value.

number

Filter by fixed multiplier from invoice currency to transaction currency, copied from the location’s Payments.ExchangeRate setting when invoice totals are updated. greater than or equal to this value.

number

Filter by fixed multiplier from invoice currency to transaction currency, copied from the location’s Payments.ExchangeRate setting when invoice totals are updated. less than or equal to this value.

number

Filter by read-only tax total: sum of every rounded invoice-line TaxAmount, then rounded to the location’s invoice decimal precision. greater than or equal to this value.

number

Filter by read-only tax total: sum of every rounded invoice-line TaxAmount, then rounded to the location’s invoice decimal precision. less than or equal to this value.

string

Filter by read-only date and time when the invoice was sent. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only date and time when the invoice was sent. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date and time recorded as paid; it updates payment ledger dates. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date and time recorded as paid; it updates payment ledger dates. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only date and time when the invoice was refunded. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only date and time when the invoice was refunded. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only timestamp of the most recent automatic payment attempt. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by read-only timestamp of the most recent automatic payment attempt. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of the system CreatedOn timestamp. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of the system CreatedOn timestamp. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of DueDate; use DueDate instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of DueDate; use DueDate instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of InvoiceFromDate; use InvoiceFromDate instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of InvoiceFromDate; use InvoiceFromDate instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of InvoiceToDate; use InvoiceToDate instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of InvoiceToDate; use InvoiceToDate instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of PaidOn; use PaidOn instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of PaidOn; use PaidOn instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of RefundedOn; use RefundedOn instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of RefundedOn; use RefundedOn instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of LastPaymentAttempt. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by location-timezone mirror of LastPaymentAttempt. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by read-only database-maintained reporting amount for payments received; it is not calculated by invoice UpdateTotals. greater than or equal to this value.

number

Filter by read-only database-maintained reporting amount for payments received; it is not calculated by invoice UpdateTotals. less than or equal to this value.

number

Filter by read-only database-maintained reporting amount for credit applied or issued; it is not calculated by invoice UpdateTotals. greater than or equal to this value.

number

Filter by read-only database-maintained reporting amount for credit applied or issued; it is not calculated by invoice UpdateTotals. less than or equal to this value.

number

Filter by read-only database-maintained reporting amount for refunds; it is not calculated by invoice UpdateTotals. greater than or equal to this value.

number

Filter by read-only database-maintained reporting amount for refunds; it is not calculated by invoice UpdateTotals. less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoices?page=1&size=15&orderBy=InvoiceNumber&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoices?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'InvoiceNumber',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'InvoiceNumber',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by InvoiceNumber

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoices?CoworkerInvoice_InvoiceNumber=example-value&orderBy=InvoiceNumber&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoices?' + new URLSearchParams({
    CoworkerInvoice_InvoiceNumber: 'example-value',
    orderBy: 'InvoiceNumber',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices',
    params={
        'CoworkerInvoice_InvoiceNumber': 'example-value',
        'orderBy': 'InvoiceNumber',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkerinvoices?from_CoworkerInvoice_UpdatedOn=2025-01-01T00:00&to_CoworkerInvoice_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerinvoices?' + new URLSearchParams({
    from_CoworkerInvoice_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerInvoice_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkerinvoices',
    params={
        'from_CoworkerInvoice_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerInvoice_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CoworkerInvoice[]

The list of CoworkerInvoice records matching the query. See the Get one CoworkerInvoice endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "InvoiceNumber",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search CoworkerInvoices

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkerinvoices"

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by InvoiceNumber

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by InvoiceNumber

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by InvoiceNumber

Range filters

Response

200