Reference

Payoutinvoice

The payoutinvoice object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this payoutinvoice
Amount: decimal required read-only
InvoiceId: Id required read-only
ResellerPayoutId: Id optional read-only
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this payoutinvoice
SystemId: string optional api-only
User defined data about this payoutinvoice. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Amount": 1.2,
  "InvoiceId": 12345678,
  "ResellerPayoutId": 12345678,
  "UniqueId": "2bb3c526-4990-4e79-9a94-ec44bcfb708c",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a PayoutInvoice

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

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

πŸ”’ Requires role "PayoutInvoice-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 payoutinvoice records based on their different properties.
Id number
?Id=12345678
PayoutInvoice_Amount decimal
?PayoutInvoice_Amount=...
PayoutInvoice_Invoice Invoice
?PayoutInvoice_Invoice=...
PayoutInvoice_ResellerPayout ResellerPayout
?PayoutInvoice_ResellerPayout=...
PayoutInvoice_InvoiceInvoiceNumber string
?PayoutInvoice_InvoiceInvoiceNumber=...
PayoutInvoice_InvoiceBusiness_Id string
?PayoutInvoice_InvoiceBusiness_Id=...
PayoutInvoice_InvoiceBusiness_Name string
?PayoutInvoice_InvoiceBusiness_Name=...

Range search querystring parameters
Lets you search payoutinvoice records based on a range of date or numeric values.
To_PayoutInvoice_CreatedOn date
?To_PayoutInvoice_CreatedOn=2010-01-01T20:32
From_PayoutInvoice_CreatedOn date
?From_PayoutInvoice_CreatedOn=2010-01-01T20:32
To_PayoutInvoice_UpdatedOn date
?To_PayoutInvoice_UpdatedOn=2010-01-01T20:32
From_PayoutInvoice_UpdatedOn date
?From_PayoutInvoice_UpdatedOn=2010-01-01T20:32
To_PayoutInvoice_Amount number
?To_PayoutInvoice_Amount=0
From_PayoutInvoice_Amount number
?From_PayoutInvoice_Amount=10

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Invoice": ,
        "ResellerPayout": ,
        "Amount": 1.2,
        "PayoutInvoiceInvoiceInvoiceNumber": "...",
        "PayoutInvoiceInvoiceBusiness_Id": "...",
        "PayoutInvoiceInvoiceBusiness_Name": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "8e4ab56a-ed3f-4fd0-b947-aa285dba3eee",
        "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 PayoutInvoices by IDs

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

πŸ”’ Requires role "PayoutInvoice-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Invoice": ,
        "ResellerPayout": ,
        "Amount": 1.2,
        "PayoutInvoiceInvoiceInvoiceNumber": "...",
        "PayoutInvoiceInvoiceBusiness_Id": "...",
        "PayoutInvoiceInvoiceBusiness_Name": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "dd8df91f-cff1-422a-87e5-c8fcc73a0df6",
        "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 PayoutInvoice by Id

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

πŸ”’ Requires role "PayoutInvoice-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Amount": 1.2,
  "InvoiceId": 12345678,
  "ResellerPayoutId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "524fb872-a9d8-4787-a1bb-615e15b2cd95",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new PayoutInvoice

Creates a new payoutinvoice.
POST https://spaces.nexudus.com/api/sys/payoutinvoices

πŸ”’ Requires role "PayoutInvoice-Create"

Body parameters

Example request

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

Updates an existing payoutinvoice.
PUT https://spaces.nexudus.com/api/sys/payoutinvoices

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

πŸ”’ Requires role "PayoutInvoice-Edit"

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

Example request

PUT https://spaces.nexudus.com/api/sys/payoutinvoices
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 PayoutInvoice

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

πŸ”’ Requires role "PayoutInvoice-Delete"

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

Example request

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

Example request

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

Example request

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