Reference

Resellerpayout

The resellerpayout object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this resellerpayout
Amount: decimal required read-only
Approved: bool optional read-only
ErrorDescription: string optional read-only
LastPaymentAttempt: DateTime? optional read-only
PaidOut: bool optional read-only
PaidOutDate: DateTime? optional read-only
PaidOutReference: string optional read-only
ResellerId: Id required read-only
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this resellerpayout
SystemId: string optional api-only
User defined data about this resellerpayout. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Amount": 1.2,
  "Approved": false,
  "ErrorDescription": "0",
  "LastPaymentAttempt": ,
  "PaidOut": false,
  "PaidOutDate": ,
  "PaidOutReference": "false",
  "ResellerId": 12345678,
  "UniqueId": "2bef6578-590e-4ebe-b016-18c01b235846",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a ResellerPayout

This endpoint allows you to GET a list of resellerpayouts based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/sys/resellerpayouts?...

πŸ”’ Requires role "ResellerPayout-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search resellerpayout records based on their different properties.
Id number
?Id=12345678
ResellerPayout_Amount decimal
?ResellerPayout_Amount=...
ResellerPayout_Approved bool
?ResellerPayout_Approved=...
ResellerPayout_ErrorDescription string
?ResellerPayout_ErrorDescription=...
ResellerPayout_LastPaymentAttempt DateTime?
?ResellerPayout_LastPaymentAttempt=...
ResellerPayout_PaidOut bool
?ResellerPayout_PaidOut=...
ResellerPayout_PaidOutDate DateTime?
?ResellerPayout_PaidOutDate=...
ResellerPayout_PaidOutReference string
?ResellerPayout_PaidOutReference=...
ResellerPayout_Reseller Reseller
?ResellerPayout_Reseller=...
ResellerPayout_ResellerUser_Id string
?ResellerPayout_ResellerUser_Id=...
ResellerPayout_ResellerUser_FullName string
?ResellerPayout_ResellerUser_FullName=...
ResellerPayout_ResellerCurrency_Id string
?ResellerPayout_ResellerCurrency_Id=...
ResellerPayout_ResellerCurrency_Code string
?ResellerPayout_ResellerCurrency_Code=...

Range search querystring parameters
Lets you search resellerpayout records based on a range of date or numeric values.
To_ResellerPayout_CreatedOn date
?To_ResellerPayout_CreatedOn=2010-01-01T20:32
From_ResellerPayout_CreatedOn date
?From_ResellerPayout_CreatedOn=2010-01-01T20:32
To_ResellerPayout_UpdatedOn date
?To_ResellerPayout_UpdatedOn=2010-01-01T20:32
From_ResellerPayout_UpdatedOn date
?From_ResellerPayout_UpdatedOn=2010-01-01T20:32
To_ResellerPayout_PaidOutDate date
?To_ResellerPayout_PaidOutDate=2010-01-01T20:32
From_ResellerPayout_PaidOutDate date
?From_ResellerPayout_PaidOutDate=2010-01-01T20:32
To_ResellerPayout_Amount number
?To_ResellerPayout_Amount=0
From_ResellerPayout_Amount number
?From_ResellerPayout_Amount=10
To_ResellerPayout_LastPaymentAttempt date
?To_ResellerPayout_LastPaymentAttempt=2010-01-01T20:32
From_ResellerPayout_LastPaymentAttempt date
?From_ResellerPayout_LastPaymentAttempt=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/sys/resellerpayouts?ResellerPayout_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Reseller": ,
        "Approved": false,
        "PaidOut": false,
        "PaidOutDate": ,
        "PaidOutReference": "false",
        "Amount": 1.2,
        "ErrorDescription": "0",
        "LastPaymentAttempt": ,
        "ResellerPayoutResellerUser_Id": "...",
        "ResellerPayoutResellerUser_FullName": "...",
        "ResellerPayoutResellerCurrency_Id": "...",
        "ResellerPayoutResellerCurrency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "854a7f5b-418c-4473-b70c-8469aa6e2d1e",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find ResellerPayouts by IDs

Gets one or more resellerpayout records based on their Id.
GET https://spaces.nexudus.com/api/sys/resellerpayouts?ResellerPayout_Id=[:id1,:id2,...]

πŸ”’ Requires role "ResellerPayout-List"

Querystring parameters
ResellerPayout_Id: array requried
?ResellerPayout_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/sys/resellerpayouts?ResellerPayout_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Reseller": ,
        "Approved": false,
        "PaidOut": false,
        "PaidOutDate": ,
        "PaidOutReference": "false",
        "Amount": 1.2,
        "ErrorDescription": "0",
        "LastPaymentAttempt": ,
        "ResellerPayoutResellerUser_Id": "...",
        "ResellerPayoutResellerUser_FullName": "...",
        "ResellerPayoutResellerCurrency_Id": "...",
        "ResellerPayoutResellerCurrency_Code": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b47bcb72-13a7-4918-843f-3db7df4caaaf",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single ResellerPayout by Id

Gets one resellerpayout record by its Id.
GET https://spaces.nexudus.com/api/sys/resellerpayouts/:Id

πŸ”’ Requires role "ResellerPayout-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/sys/resellerpayouts/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "Amount": 1.2,
  "Approved": false,
  "ErrorDescription": "0",
  "LastPaymentAttempt": ,
  "PaidOut": false,
  "PaidOutDate": ,
  "PaidOutReference": "false",
  "ResellerId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "7a61c038-5231-4c65-9447-5478c27dec4d",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new ResellerPayout

Creates a new resellerpayout.
POST https://spaces.nexudus.com/api/sys/resellerpayouts

πŸ”’ Requires role "ResellerPayout-Create"

Body parameters

Example request

POST https://spaces.nexudus.com/api/sys/resellerpayouts
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update ResellerPayout

Updates an existing resellerpayout.
PUT https://spaces.nexudus.com/api/sys/resellerpayouts

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "ResellerPayout-Edit"

Body parameters
Id: number required
The unique Id of the resellerpayout to update.

Example request

PUT https://spaces.nexudus.com/api/sys/resellerpayouts
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete ResellerPayout

Deletes an existing resellerpayout by its Id.
DELETE https://spaces.nexudus.com/api/sys/resellerpayouts/:Id

πŸ”’ Requires role "ResellerPayout-Delete"

URL parameters
Id: number required
The unique Id of the resellerpayout to update.

Example request

DELETE https://spaces.nexudus.com/api/sys/resellerpayouts/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more resellerpayout records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for resellerpayout records.
GET https://spaces.nexudus.com/api/sys/resellerpayouts/commands

Example request

GET https://spaces.nexudus.com/api/sys/resellerpayouts/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more resellerpayout record IDs.
POST https://spaces.nexudus.com/api/sys/resellerpayouts/runacommand
πŸ”’ Requires role "ResellerPayout-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/resellerpayouts/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

ResellerInvoiceData

GET https://spaces.nexudus.com/api/sys/resellerpayouts/getresellerinvoicedata/:id
URL parameters
Id: number required
The id of the ResellerPayout to get the resellerinvoicedata for.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.