> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one PayoutInvoice

> Retrieve a single PayoutInvoice record by its Id.

A **PayoutInvoice** represents an invoice generated for payout purposes, tracking payments due to or from reseller accounts or partner locations.

## Authentication

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the PayoutInvoice record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/sys/payoutinvoices/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

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

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="InvoiceId" type="integer">
  ID of the invoice linked to this record.
</ResponseField>

<ResponseField name="InvoiceInvoiceNumber" type="string">
  The invoice invoice number value for this payout invoice.
</ResponseField>

<ResponseField name="InvoiceResellerAmount" type="number">
  The invoice reseller amount value for this payout invoice.
</ResponseField>

<ResponseField name="InvoiceCreatedOn" type="string">
  The invoice created on value for this payout invoice.
</ResponseField>

<ResponseField name="InvoiceCurrencyCode" type="string">
  The invoice currency code value for this payout invoice.
</ResponseField>

<ResponseField name="InvoiceBusinessId" type="integer">
  ID of the invoice business associated with this record.
</ResponseField>

<ResponseField name="InvoiceBusinessName" type="string">
  Display name of the linked invoice business (read-only).
</ResponseField>

<ResponseField name="ResellerPayoutId" type="integer">
  ID of the reseller payout linked to this record.
</ResponseField>

<ResponseField name="Amount" type="number">
  The amount value for this payout invoice.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```