Get one CoworkerInvoicePaymentToken

GET

api

billing

coworkerinvoicepaymenttokens

{id}

Get one CoworkerInvoicePaymentToken

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

import requests

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

{
  "CoworkerInvoiceId": 123,
  "RegularPaymentProvider": 123,
  "Token": "<string>",
  "Notes": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A CoworkerInvoicePaymentToken is an internal record of the token used to process the payment for a customer invoice. Each token links a CoworkerInvoice to the payment provider and the provider-specific token string used to authorise or capture the payment. Use the Notes field to store any additional context about the token.

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

Path Parameters

integer

required

The Id of the CoworkerInvoicePaymentToken record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the coworker invoice linked to this record.

integer

Payment provider used to process the invoice.

string

Provider-specific token used to authorise or capture the payment.

string

Additional notes about the payment token.

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

{
  "CoworkerInvoiceId": 0,
  "RegularPaymentProvider": 0,
  "Token": null,
  "Notes": null,
  "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": "CoworkerInvoicePaymentToken Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CoworkerInvoicePaymentTokensRetrieve multiple CoworkerInvoicePaymentToken records by their Ids in a single request.

Get one CoworkerInvoicePaymentToken

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

import requests

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

{
  "CoworkerInvoiceId": 123,
  "RegularPaymentProvider": 123,
  "Token": "<string>",
  "Notes": "<string>",
  "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

Get one CoworkerInvoicePaymentToken

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200