Search ResellerPayouts

GET

api

sys

resellerpayouts

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

import requests

url = "https://spaces.nexudus.com/api/sys/resellerpayouts"

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

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

integer

Filter by iD of the reseller user associated with this record.

string

Filter by display name of the linked reseller user full (read-only).

integer

Filter by iD of the reseller currency associated with this record.

string

Filter by the reseller currency code value for this reseller payout.

boolean

Filter by whether approved is enabled.

boolean

Filter by whether paid out is enabled.

string

Filter by date/time value for paid out date.

string

Filter by the paid out reference value for this reseller payout.

number

Filter by the amount value for this reseller payout.

string

Filter by the error description value for this reseller payout.

string

Filter by date/time value for last payment attempt.

string

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

string

Filter by uRL of a new file to upload as the reseller invoice data.

boolean

Filter by set to true to remove the current reseller invoice data file.

Range Filters

integer

Filter by iD of the reseller user associated with this record greater than or equal to this value.

integer

Filter by iD of the reseller user associated with this record less than or equal to this value.

integer

Filter by iD of the reseller currency associated with this record greater than or equal to this value.

integer

Filter by iD of the reseller currency associated with this record less than or equal to this value.

string

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

string

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

number

Filter by the amount value for this reseller payout greater than or equal to this value.

number

Filter by the amount value for this reseller payout less than or equal to this value.

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 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/sys/resellerpayouts?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/sys/resellerpayouts?ResellerPayout_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/resellerpayouts',
    params={
        'ResellerPayout_CreatedOn': 'example-value',
        'orderBy': 'CreatedOn',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/resellerpayouts?' + new URLSearchParams({
    from_ResellerPayout_UpdatedOn: '2025-01-01T00:00',
    to_ResellerPayout_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/sys/resellerpayouts',
    params={
        'from_ResellerPayout_UpdatedOn': '2025-01-01T00:00',
        'to_ResellerPayout_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

ResellerPayout[]

The list of ResellerPayout records matching the query. See the Get one ResellerPayout 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": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one ResellerPayoutRetrieve a single ResellerPayout record by its Id.

Search ResellerPayouts

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

import requests

url = "https://spaces.nexudus.com/api/sys/resellerpayouts"

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

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200