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

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 coworker linked to this record.

string

Filter by full name of the invoiced customer.

string

Filter by the coworker regular payment contract number value for this coworker invoice.

string

Filter by the coworker regular payment provider value for this coworker invoice.

string

Filter by the coworker card number value for this coworker invoice.

string

Filter by the coworker go cardless contract number value for this coworker invoice.

boolean

Filter by whether coworker enable go cardless payments is enabled.

string

Filter by billing email address of the customer.

boolean

Filter by whether coworker notify on new invoice is enabled.

boolean

Filter by whether coworker notify on new payment is enabled.

boolean

Filter by whether coworker notify on failed payment is enabled.

boolean

Filter by whether coworker do not process invoices automatically is enabled.

string

Filter by company name of the invoiced customer.

string

Filter by team names the invoiced customer belongs to.

integer

Filter by iD of the business linked to this record.

string

Filter by name of the location that issued the invoice.

string

Filter by unique invoice number assigned when the invoice is finalised.

string

Filter by reference code used to match payments to this invoice.

string

Filter by name of the person or company being billed.

string

Filter by billing address on the invoice.

string

Filter by billing city on the invoice.

string

Filter by billing post code on the invoice.

string

Filter by billing phone number on the invoice.

string

Filter by billing fax number on the invoice.

string

Filter by billing state or region on the invoice.

integer

Filter by iD of the bill to country linked to this record.

string

Filter by name of the billing country on the invoice.

string

Filter by the bill to country two digits code value for this coworker invoice.

string

Filter by bank account number on the invoice for payment.

string

Filter by tax identification number of the billed party.

string

Filter by customer purchase order number for this invoice.

string

Filter by free-text description or notes for the invoice.

number

Filter by discount amount applied to the invoice total.

string

Filter by date by which payment is due.

string

Filter by start date of the billing period covered by this invoice.

string

Filter by end date of the billing period covered by this invoice.

number

Filter by total invoice amount including tax.

number

Filter by total amount paid against this invoice so far.

number

Filter by the transaction total amount value for this coworker invoice.

integer

Filter by iD of the transaction currency linked to this record.

string

Filter by the transaction currency code value for this coworker invoice.

number

Filter by the transaction exchange rate value for this coworker invoice.

integer

Filter by iD of the currency linked to this record.

string

Filter by iSO currency code (e.g. USD, EUR, GBP).

number

Filter by total tax amount on the invoice.

boolean

Filter by whether the invoice is still a draft. Draft invoices can be modified before finalisation.

boolean

Filter by whether the invoice has been voided (cancelled without a credit note).

boolean

Filter by whether the invoice is queued for invoice number assignment.

boolean

Filter by whether the invoice has been fully paid.

boolean

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

string

Filter by date the invoice was emailed to the customer.

string

Filter by date the invoice was marked as fully paid.

boolean

Filter by whether a refund has been issued for this invoice.

boolean

Filter by whether the invoice has been transferred to Xero.

boolean

Filter by whether the payment has been transferred to Xero.

boolean

Filter by whether the invoice has been transferred to QuickBooks.

boolean

Filter by whether the payment has been transferred to QuickBooks.

boolean

Filter by whether the invoice has been transferred to Moloni.

boolean

Filter by whether the payment has been transferred to Moloni.

integer

Filter by status of e-invoicing transfer via Storecove.

boolean

Filter by whether the invoice is automatically sent to Storecove for e-invoicing.

string

Filter by iD of the storecove unique associated with this record.

string

Filter by date the refund was issued.

boolean

Filter by whether this document is a credit note rather than an invoice.

string

Filter by gUID of the original invoice this credit note reverses.

string

Filter by gUID of the contract that generated this invoice.

string

Filter by arbitrary custom data stored with the invoice.

string

Filter by goCardless payment reference for direct debit collection.

string

Filter by the spreedly token value for this coworker invoice.

string

Filter by date/time value for last payment attempt.

boolean

Filter by whether billed is enabled.

boolean

Filter by whether to skip automatic application of available credit to this invoice.

string

Filter by date/time value for created on local.

string

Filter by date/time value for due date local.

string

Filter by date/time value for invoice from date local.

string

Filter by date/time value for invoice to date local.

string

Filter by date/time value for paid on local.

string

Filter by date/time value for refunded on local.

string

Filter by date/time value for last payment attempt local.

number

Filter by total amount received via direct payments.

number

Filter by amount paid via credit notes or account credit.

number

Filter by total amount refunded on this invoice.

string

Filter by transaction ID from NexKiosk point-of-sale payment.

boolean

Filter by whether the invoice is automatically transferred to Xero or QuickBooks.

Range Filters

number

Filter by discount amount applied to the invoice total greater than or equal to this value.

number

Filter by discount amount applied to the invoice total less than or equal to this value.

string

Filter by date by which payment is due greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date by which payment is due less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by start date of the billing period covered by this invoice greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by start date of the billing period covered by this invoice less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end date of the billing period covered by this invoice greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end date of the billing period covered by this invoice less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by total invoice amount including tax greater than or equal to this value.

number

Filter by total invoice amount including tax less than or equal to this value.

number

Filter by total amount paid against this invoice so far greater than or equal to this value.

number

Filter by total amount paid against this invoice so far less than or equal to this value.

number

Filter by the transaction total amount value for this coworker invoice greater than or equal to this value.

number

Filter by the transaction total amount value for this coworker invoice less than or equal to this value.

number

Filter by the transaction exchange rate value for this coworker invoice greater than or equal to this value.

number

Filter by the transaction exchange rate value for this coworker invoice less than or equal to this value.

number

Filter by total tax amount on the invoice greater than or equal to this value.

number

Filter by total tax amount on the invoice less than or equal to this value.

string

Filter by date the invoice was emailed to the customer greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the invoice was emailed to the customer less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the invoice was marked as fully paid greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the invoice was marked as fully paid less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the refund was issued greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date the refund was issued less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last payment attempt greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last payment attempt less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for created on local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for created on local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for due date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for due date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for invoice from date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for invoice from date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for invoice to date local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for invoice to date local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for paid on local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for paid on local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for refunded on local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for refunded on local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last payment attempt local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for last payment attempt local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

number

Filter by total amount received via direct payments greater than or equal to this value.

number

Filter by total amount received via direct payments less than or equal to this value.

number

Filter by amount paid via credit notes or account credit greater than or equal to this value.

number

Filter by amount paid via credit notes or account credit less than or equal to this value.

number

Filter by total amount refunded on this invoice greater than or equal to this value.

number

Filter by total amount refunded on this invoice 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
}

Get one CoworkerInvoiceRetrieve a single CoworkerInvoice record by its Id.

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