Search ResellerPayouts - Nexudus Platform

GET

api

sys

resellerpayouts

Search ResellerPayouts

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

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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

ResellerPayout_Reseller

integer

Filter by iD of the reseller linked to this record.

ResellerPayout_Reseller_User_Id

integer

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

ResellerPayout_Reseller_User_FullName

string

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

ResellerPayout_Reseller_Currency_Id

integer

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

ResellerPayout_Reseller_Currency_Code

string

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

ResellerPayout_Approved

boolean

Filter by whether approved is enabled.

ResellerPayout_PaidOut

boolean

Filter by whether paid out is enabled.

ResellerPayout_PaidOutDate

string

Filter by date/time value for paid out date.

ResellerPayout_PaidOutReference

string

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

ResellerPayout_Amount

number

Filter by the amount value for this reseller payout.

ResellerPayout_ErrorDescription

string

Filter by the error description value for this reseller payout.

ResellerPayout_LastPaymentAttempt

string

Filter by date/time value for last payment attempt.

ResellerPayout_ResellerInvoiceDataFileName

string

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

ResellerPayout_NewResellerInvoiceDataUrl

string

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

ResellerPayout_ClearResellerInvoiceData

boolean

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

Range Filters

from_ResellerPayout_ResellerUserId

integer

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

to_ResellerPayout_ResellerUserId

integer

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

from_ResellerPayout_ResellerCurrencyId

integer

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

to_ResellerPayout_ResellerCurrencyId

integer

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

from_ResellerPayout_PaidOutDate

string

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

to_ResellerPayout_PaidOutDate

string

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

from_ResellerPayout_Amount

number

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

to_ResellerPayout_Amount

number

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

from_ResellerPayout_LastPaymentAttempt

string

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

to_ResellerPayout_LastPaymentAttempt

string

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

from_ResellerPayout_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ResellerPayout_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_ResellerPayout_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_ResellerPayout_UpdatedOn

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"

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"

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"

Response

200

Records

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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​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