CoworkerInvoices
Get multiple CoworkerInvoices
Retrieve multiple CoworkerInvoice records by their Ids in a single request.
GET
/
api
/
billing
/
coworkerinvoices
/
?id=[
{id1}
,
{id2}
,
{id3}
]
Get multiple CoworkerInvoices
curl --request GET \
--url 'https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=%5B{id1}%2C{id2}%2C{id3}%5D"
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=%5B{id1}%2C{id2}%2C{id3}%5D', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Fetch several CoworkerInvoice records in a single request by passing their Ids as a comma-separated list enclosed in square brackets.
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.Query Parameters
integer[]
required
A comma-separated list of CoworkerInvoice Ids enclosed in square brackets, e.g.
[123,456,789].Code Examples
curl -X GET \
"https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=[87654321,87654322,87654323]" \
-H "Authorization: Bearer YOUR_TOKEN"
const response = await fetch(
'https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=[87654321,87654322,87654323]',
{
headers: {
'Authorization': 'Bearer YOUR_TOKEN'
}
}
);
const records = await response.json();
import requests
response = requests.get(
'https://spaces.nexudus.com/api/billing/coworkerinvoices/',
params={
'id': '[87654321,87654322,87654323]'
},
headers={
'Authorization': 'Bearer YOUR_TOKEN'
}
)
records = response.json()
Response
200
Returns an array of CoworkerInvoice records. Each record has the same structure as the response from the Get one CoworkerInvoice endpoint.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
}
]
Was this page helpful?
⌘I
Get multiple CoworkerInvoices
curl --request GET \
--url 'https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=%5B{id1}%2C{id2}%2C{id3}%5D' \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://spaces.nexudus.com/api/billing/coworkerinvoices/?id=%5B{id1}%2C{id2}%2C{id3}%5D"
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=%5B{id1}%2C{id2}%2C{id3}%5D', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));