Get one PayoutInvoice

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

import requests

url = "https://spaces.nexudus.com/api/sys/payoutinvoices/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/payoutinvoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/payoutinvoices/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/payoutinvoices/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the invoice linked to this record.

string

The invoice invoice number value for this payout invoice.

number

The invoice reseller amount value for this payout invoice.

string

The invoice created on value for this payout invoice.

string

The invoice currency code value for this payout invoice.

integer

ID of the invoice business associated with this record.

string

Display name of the linked invoice business (read-only).

integer

ID of the reseller payout linked to this record.

number

The amount value for this payout invoice.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple PayoutInvoicesRetrieve multiple PayoutInvoice records by their Ids in a single request.

Get one PayoutInvoice

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

import requests

url = "https://spaces.nexudus.com/api/sys/payoutinvoices/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/payoutinvoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200