---
updatedAt: 2026-10-06T09:31:43.000Z
agentTools:
  projectIndex: https://docs.checkhq.com/llms.txt
---

# Preview an external payroll

Note: Previewing an external payroll does not update the external payroll. You must [update the external payroll](https://docs.checkhq.com/reference/update-an-external-payroll) in a separate request.

External payrolls attached to a [correction](https://docs.checkhq.com/reference/the-correction-object) as replacements reject this action with error type `payroll_managed_by_correction`. [Preview the correction](https://docs.checkhq.com/reference/preview-a-correction) instead.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "check-api",
    "version": "2025-01-01"
  },
  "servers": [
    {
      "url": "https://sandbox.checkhq.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-bearer-format": "bearer",
        "x-default": "YOUR_API_KEY"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/external_payrolls/{external_payroll}/preview": {
      "get": {
        "summary": "Preview an external payroll",
        "description": "",
        "operationId": "preview-an-external-payroll",
        "parameters": [
          {
            "name": "external_payroll",
            "in": "path",
            "description": "ID of the external payroll to preview.",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```