Skip to main content
GET
/
api
/
sys
/
payoutinvoices
/
{id}
Get one PayoutInvoice
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/payoutinvoices/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "InvoiceId": 123,
  "InvoiceInvoiceNumber": "<string>",
  "InvoiceResellerAmount": 123,
  "InvoiceCreatedOn": "<string>",
  "InvoiceCurrencyCode": "<string>",
  "InvoiceBusinessId": 123,
  "InvoiceBusinessName": "<string>",
  "ResellerPayoutId": 123,
  "Amount": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A PayoutInvoice represents an invoice generated for payout purposes, tracking payments due to or from reseller accounts or partner locations.

​
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 PayoutInvoice-Read role.

​
Path Parameters

​
id
integer
required
The Id of the PayoutInvoice record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/payoutinvoices/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
InvoiceId
integer
ID of the invoice linked to this record.
​
InvoiceInvoiceNumber
string
The invoice invoice number value for this payout invoice.
​
InvoiceResellerAmount
number
The invoice reseller amount value for this payout invoice.
​
InvoiceCreatedOn
string
The invoice created on value for this payout invoice.
​
InvoiceCurrencyCode
string
The invoice currency code value for this payout invoice.
​
InvoiceBusinessId
integer
ID of the invoice business associated with this record.
​
InvoiceBusinessName
string
Display name of the linked invoice business (read-only).
​
ResellerPayoutId
integer
ID of the reseller payout linked to this record.
​
Amount
number
The amount value for this payout invoice.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "InvoiceId": 0,
  "InvoiceInvoiceNumber": null,
  "InvoiceResellerAmount": null,
  "InvoiceCreatedOn": null,
  "InvoiceCurrencyCode": null,
  "InvoiceBusinessId": null,
  "InvoiceBusinessName": null,
  "ResellerPayoutId": null,
  "Amount": 0,
  "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": "PayoutInvoice Example",
  "LocalizationDetails": null,
  "CustomFields": null
}