Get one ResellerPayout

GET

api

sys

resellerpayouts

{id}

Get one ResellerPayout

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

import requests

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

{
  "ResellerId": 123,
  "ResellerUserId": 123,
  "ResellerUserFullName": "<string>",
  "ResellerCurrencyId": 123,
  "ResellerCurrencyCode": "<string>",
  "Approved": true,
  "PaidOut": true,
  "PaidOutDate": "<string>",
  "PaidOutReference": "<string>",
  "Amount": 123,
  "ErrorDescription": "<string>",
  "LastPaymentAttempt": "<string>",
  "ResellerInvoiceDataFileName": "<string>",
  "NewResellerInvoiceDataUrl": "<string>",
  "ClearResellerInvoiceDataFile": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A ResellerPayout records a payment made to or received from a reseller partner, tracking payout amounts, dates, and associated invoices.

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

Path Parameters

integer

required

The Id of the ResellerPayout record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the reseller linked to this record.

integer

ID of the reseller user associated with this record.

string

Display name of the linked reseller user full (read-only).

integer

ID of the reseller currency associated with this record.

string

The reseller currency code value for this reseller payout.

boolean

Whether approved is enabled.

boolean

Whether paid out is enabled.

string

Date/time value for paid out date.

string

The paid out reference value for this reseller payout.

number

The amount value for this reseller payout.

string

The error description value for this reseller payout.

string

Date/time value for last payment attempt.

string

Current file name of the reseller invoice data (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the reseller invoice data.

boolean

Set to true to remove the current reseller invoice data file.

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

{
  "ResellerId": 0,
  "ResellerUserId": null,
  "ResellerUserFullName": null,
  "ResellerCurrencyId": null,
  "ResellerCurrencyCode": null,
  "Approved": false,
  "PaidOut": false,
  "PaidOutDate": null,
  "PaidOutReference": null,
  "Amount": 0,
  "ErrorDescription": null,
  "LastPaymentAttempt": null,
  "ResellerInvoiceDataFileName": null,
  "NewResellerInvoiceDataUrl": null,
  "ClearResellerInvoiceDataFile": 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": "ResellerPayout Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple ResellerPayoutsRetrieve multiple ResellerPayout records by their Ids in a single request.

Get one ResellerPayout

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

import requests

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

{
  "ResellerId": 123,
  "ResellerUserId": 123,
  "ResellerUserFullName": "<string>",
  "ResellerCurrencyId": 123,
  "ResellerCurrencyCode": "<string>",
  "Approved": true,
  "PaidOut": true,
  "PaidOutDate": "<string>",
  "PaidOutReference": "<string>",
  "Amount": 123,
  "ErrorDescription": "<string>",
  "LastPaymentAttempt": "<string>",
  "ResellerInvoiceDataFileName": "<string>",
  "NewResellerInvoiceDataUrl": "<string>",
  "ClearResellerInvoiceDataFile": 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