Reference

Reselleraccount

The reselleraccount object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this reselleraccount
Approved: bool optional read-only
AverageInvoiceAmount: decimal? optional read-only
BusinessId: Id required read-only
CanManageAccount: bool optional read-only
ComissionPercentage: decimal required read-only
ExpirationDate: DateTime? optional read-only
LastAccess: DateTime? optional read-only
LastInvoiceAmount: decimal? optional read-only
NextPayoutDate: DateTime? optional read-only
Notes: string optional
ProvidesFirstLineSupport: bool optional read-only
ResellerId: Id required read-only
ScopeOfWork: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this reselleraccount
SystemId: string optional api-only
User defined data about this reselleraccount. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Approved": false,
  "AverageInvoiceAmount": ,
  "BusinessId": 12345678,
  "CanManageAccount": false,
  "ComissionPercentage": 1.2,
  "ExpirationDate": ,
  "LastAccess": ,
  "LastInvoiceAmount": ,
  "NextPayoutDate": ,
  "Notes": "Joe",
  "ProvidesFirstLineSupport": false,
  "ResellerId": 12345678,
  "ScopeOfWork": "Joe",
  "UniqueId": "9ace0675-705c-4110-8998-46fb492a3e2a",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a ResellerAccount

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

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

πŸ”’ Requires role "ResellerAccount-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 reselleraccount records based on their different properties.
Id number
?Id=12345678
ResellerAccount_Approved bool
?ResellerAccount_Approved=...
ResellerAccount_AverageInvoiceAmount decimal?
?ResellerAccount_AverageInvoiceAmount=...
ResellerAccount_Business Business
?ResellerAccount_Business=...
ResellerAccount_CanManageAccount bool
?ResellerAccount_CanManageAccount=...
ResellerAccount_ComissionPercentage decimal
?ResellerAccount_ComissionPercentage=...
ResellerAccount_ExpirationDate DateTime?
?ResellerAccount_ExpirationDate=...
ResellerAccount_LastAccess DateTime?
?ResellerAccount_LastAccess=...
ResellerAccount_LastInvoiceAmount decimal?
?ResellerAccount_LastInvoiceAmount=...
ResellerAccount_NextPayoutDate DateTime?
?ResellerAccount_NextPayoutDate=...
ResellerAccount_Notes string
?ResellerAccount_Notes=...
ResellerAccount_ProvidesFirstLineSupport bool
?ResellerAccount_ProvidesFirstLineSupport=...
ResellerAccount_Reseller Reseller
?ResellerAccount_Reseller=...
ResellerAccount_ScopeOfWork string
?ResellerAccount_ScopeOfWork=...
ResellerAccount_ResellerCurrency_Id string
?ResellerAccount_ResellerCurrency_Id=...
ResellerAccount_ResellerCurrency_Code string
?ResellerAccount_ResellerCurrency_Code=...
ResellerAccount_BusinessName string
?ResellerAccount_BusinessName=...
ResellerAccount_BusinessPreAuthId string
?ResellerAccount_BusinessPreAuthId=...
ResellerAccount_BusinessLast4Digits string
?ResellerAccount_BusinessLast4Digits=...
ResellerAccount_BusinessPreAuthLastError string
?ResellerAccount_BusinessPreAuthLastError=...
ResellerAccount_BusinessSuspended string
?ResellerAccount_BusinessSuspended=...
ResellerAccount_BusinessNextInvoice string
?ResellerAccount_BusinessNextInvoice=...
ResellerAccount_BusinessTrialExpireDate string
?ResellerAccount_BusinessTrialExpireDate=...

Range search querystring parameters
Lets you search reselleraccount records based on a range of date or numeric values.
To_ResellerAccount_CreatedOn date
?To_ResellerAccount_CreatedOn=2010-01-01T20:32
From_ResellerAccount_CreatedOn date
?From_ResellerAccount_CreatedOn=2010-01-01T20:32
To_ResellerAccount_UpdatedOn date
?To_ResellerAccount_UpdatedOn=2010-01-01T20:32
From_ResellerAccount_UpdatedOn date
?From_ResellerAccount_UpdatedOn=2010-01-01T20:32
To_ResellerAccount_ComissionPercentage number
?To_ResellerAccount_ComissionPercentage=0
From_ResellerAccount_ComissionPercentage number
?From_ResellerAccount_ComissionPercentage=10
To_ResellerAccount_NextPayoutDate date
?To_ResellerAccount_NextPayoutDate=2010-01-01T20:32
From_ResellerAccount_NextPayoutDate date
?From_ResellerAccount_NextPayoutDate=2010-01-01T20:32
To_ResellerAccount_ExpirationDate date
?To_ResellerAccount_ExpirationDate=2010-01-01T20:32
From_ResellerAccount_ExpirationDate date
?From_ResellerAccount_ExpirationDate=2010-01-01T20:32
To_ResellerAccount_LastAccess date
?To_ResellerAccount_LastAccess=2010-01-01T20:32
From_ResellerAccount_LastAccess date
?From_ResellerAccount_LastAccess=2010-01-01T20:32
To_ResellerAccount_LastInvoiceAmount number
?To_ResellerAccount_LastInvoiceAmount=0
From_ResellerAccount_LastInvoiceAmount number
?From_ResellerAccount_LastInvoiceAmount=10
To_ResellerAccount_AverageInvoiceAmount number
?To_ResellerAccount_AverageInvoiceAmount=0
From_ResellerAccount_AverageInvoiceAmount number
?From_ResellerAccount_AverageInvoiceAmount=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Reseller": ,
        "Business": ,
        "Approved": false,
        "ComissionPercentage": 1.2,
        "NextPayoutDate": ,
        "ExpirationDate": ,
        "LastAccess": ,
        "LastInvoiceAmount": ,
        "AverageInvoiceAmount": ,
        "CanManageAccount": false,
        "ProvidesFirstLineSupport": false,
        "Notes": "Joe",
        "ScopeOfWork": "Joe",
        "ResellerAccountResellerCurrency_Id": "...",
        "ResellerAccountResellerCurrency_Code": "...",
        "ResellerAccountBusinessName": "...",
        "ResellerAccountBusinessPreAuthId": "...",
        "ResellerAccountBusinessLast4Digits": "...",
        "ResellerAccountBusinessPreAuthLastError": "...",
        "ResellerAccountBusinessSuspended": "...",
        "ResellerAccountBusinessNextInvoice": "...",
        "ResellerAccountBusinessTrialExpireDate": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "edafadd1-c9ae-4cc4-9b8c-f121e196cfa4",
        "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 ResellerAccounts by IDs

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

πŸ”’ Requires role "ResellerAccount-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Reseller": ,
        "Business": ,
        "Approved": false,
        "ComissionPercentage": 1.2,
        "NextPayoutDate": ,
        "ExpirationDate": ,
        "LastAccess": ,
        "LastInvoiceAmount": ,
        "AverageInvoiceAmount": ,
        "CanManageAccount": false,
        "ProvidesFirstLineSupport": false,
        "Notes": "Joe",
        "ScopeOfWork": "Joe",
        "ResellerAccountResellerCurrency_Id": "...",
        "ResellerAccountResellerCurrency_Code": "...",
        "ResellerAccountBusinessName": "...",
        "ResellerAccountBusinessPreAuthId": "...",
        "ResellerAccountBusinessLast4Digits": "...",
        "ResellerAccountBusinessPreAuthLastError": "...",
        "ResellerAccountBusinessSuspended": "...",
        "ResellerAccountBusinessNextInvoice": "...",
        "ResellerAccountBusinessTrialExpireDate": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "eeef76aa-2748-4eb2-b88f-fc2e9a10f9fc",
        "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 ResellerAccount by Id

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

πŸ”’ Requires role "ResellerAccount-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Approved": false,
  "AverageInvoiceAmount": ,
  "BusinessId": 12345678,
  "CanManageAccount": false,
  "ComissionPercentage": 1.2,
  "ExpirationDate": ,
  "LastAccess": ,
  "LastInvoiceAmount": ,
  "NextPayoutDate": ,
  "Notes": "Joe",
  "ProvidesFirstLineSupport": false,
  "ResellerId": 12345678,
  "ScopeOfWork": "Joe",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "68588863-7a52-4d5c-96fc-60458d9e78ea",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new ResellerAccount

Creates a new reselleraccount.
POST https://spaces.nexudus.com/api/sys/reselleraccounts

πŸ”’ Requires role "ResellerAccount-Create"

Body parameters
Notes: string optional
ScopeOfWork: string optional

Example request

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

{
    "Notes": "Joe",
    "ScopeOfWork": "Joe",
}


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 ResellerAccount

Updates an existing reselleraccount.
PUT https://spaces.nexudus.com/api/sys/reselleraccounts

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

πŸ”’ Requires role "ResellerAccount-Edit"

Body parameters
Id: number required
The unique Id of the reselleraccount to update.
Notes: string cleared if missing
ScopeOfWork: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "Notes": "Joe",
    "ScopeOfWork": "Joe",
}


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 ResellerAccount

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

πŸ”’ Requires role "ResellerAccount-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/sys/reselleraccounts/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 reselleraccount 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 reselleraccount records.
GET https://spaces.nexudus.com/api/sys/reselleraccounts/commands

Example request

GET https://spaces.nexudus.com/api/sys/reselleraccounts/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 reselleraccount record IDs.
POST https://spaces.nexudus.com/api/sys/reselleraccounts/runacommand
πŸ”’ Requires role "ResellerAccount-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/reselleraccounts/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
}


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.