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

# Check

> Check Scenario seeding parameters, nested fields, and examples

Use `checkhq` in `twins` and put this configuration under `seed_config.checkhq`.

Check payroll sandbox with companies, workplaces, employees, contractors, bank accounts, earning rates, pay schedules, payrolls, payroll items, contractor payments, and webhook configurations.

## Example seed

This is the complete Scenario request body for [creating a Scenario](https://docs.argalabs.com/api-reference/post-create-a-scenario.md). You can also import it with `arga test-runner scenarios import --file scenario.json`.

```json theme={null}
{
  "name": "Check eval fixture",
  "twins": [
    "checkhq"
  ],
  "seed_config": {
    "checkhq": {
      "companies": [
        {
          "legal_name": "Analytical Engines LLC",
          "alias": "analytical-engines",
          "implemented": true,
          "processing_period": "three_day",
          "workplaces": [
            {
              "name": "Headquarters",
              "alias": "headquarters",
              "primary": true,
              "address": {
                "line1": "100 Scenario Street",
                "city": "San Francisco",
                "state": "CA",
                "postal_code": "94107",
                "country": "US"
              }
            }
          ],
          "employees": [
            {
              "first_name": "Ada",
              "last_name": "Lovelace",
              "email": "ada@example.test",
              "alias": "ada",
              "onboarded": true,
              "workplace_aliases": [
                "headquarters"
              ],
              "primary_workplace_alias": "headquarters",
              "earning_rates": [
                {
                  "name": "Primary salary",
                  "amount": "120000.00",
                  "period": "annually",
                  "workweek_hours": 40,
                  "active": true,
                  "primary": true
                }
              ]
            }
          ],
          "contractors": [
            {
              "business_name": "Babbage Consulting",
              "email": "charles@example.test",
              "alias": "charles",
              "onboarded": true
            }
          ],
          "payrolls": [
            {
              "period_start": "2026-04-01",
              "period_end": "2026-04-15",
              "payday": "2026-04-20",
              "items": [
                {
                  "employee_alias": "ada",
                  "payment_method": "direct_deposit",
                  "earnings": [
                    {
                      "amount": "3000.00",
                      "type": "salary"
                    }
                  ]
                }
              ],
              "contractor_payments": [
                {
                  "contractor_alias": "charles",
                  "amount": "750.00",
                  "payment_method": "manual"
                }
              ]
            }
          ],
          "pay_schedules": [
            {
              "name": "Biweekly",
              "pay_frequency": "biweekly",
              "first_payday": "2026-01-26",
              "first_period_end": "2026-01-23",
              "paydays": [
                {
                  "payday": "2026-01-26",
                  "period_start": "2026-01-10",
                  "period_end": "2026-01-23",
                  "approval_deadline": "2026-01-21",
                  "impacted_by_weekend_or_holiday": false
                }
              ]
            }
          ]
        }
      ],
      "webhooks": [
        {
          "url": "https://example.test/check-events",
          "environment": "sandbox",
          "active": true
        }
      ]
    }
  }
}
```

## Parameters

The following fields belong directly inside `seed_config.checkhq`. Required nested fields are marked in their tables. Provider-native objects can contain service-specific fields beyond the representative record shapes below.

| Parameter | Type | Description |
| - | - | - |
| `companies` | `object[]` | Companies fixtures in provider-native format. |
| `webhooks` | `object[]` | Webhook subscriptions or configurations. |
| `tax_filings` | `object[]` | Tax filings fixtures in provider-native format. |

## Resource fields

These tables describe the record shapes used by the example. Keep native field names and casing. Map keys such as property names, IDs, and metadata keys are supplied by your fixture.

### `companies[]`

| Parameter | Type | Description |
| - | - | - |
| `legal_name` | `string` | Legal name. |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `implemented` | `boolean` | Enable or set implemented behavior. |
| `processing_period` | `string` | Processing period. |
| `workplaces` | `object[]` | Workplaces fixtures in provider-native format. |
| `employees` | `object[]` | Employees fixtures in provider-native format. |
| `contractors` | `object[]` | Contractors fixtures in provider-native format. |
| `payrolls` | `object[]` | Payrolls fixtures in provider-native format. |
| `pay_schedules` | `object[]` | Pay schedules fixtures in provider-native format. |

### `companies[].workplaces[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `primary` | `boolean` | Enable or set primary behavior. |
| `address` | `object` | Address. |

### `companies[].employees[]`

| Parameter | Type | Description |
| - | - | - |
| `first_name` | `string` | First name. |
| `last_name` | `string` | Last name. |
| `email` | `string` | Main account email address. |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `onboarded` | `boolean` | Enable or set onboarded behavior. |
| `workplace_aliases` | `string[]` | Workplace aliases fixtures in provider-native format. |
| `primary_workplace_alias` | `string` | Primary workplace alias. |
| `earning_rates` | `object[]` | Earning rates fixtures in provider-native format. |

### `companies[].employees[].earning_rates[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `amount` | `string` | Amount. |
| `period` | `string` | Period. |
| `workweek_hours` | `integer` | Workweek hours. |
| `active` | `boolean` | Enable or set active behavior. |
| `primary` | `boolean` | Enable or set primary behavior. |

### `companies[].contractors[]`

| Parameter | Type | Description |
| - | - | - |
| `business_name` | `string` | Business name. |
| `email` | `string` | Main account email address. |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `onboarded` | `boolean` | Enable or set onboarded behavior. |

### `companies[].payrolls[]`

| Parameter | Type | Description |
| - | - | - |
| `period_start` | `string` | Period start. |
| `period_end` | `string` | Period end. |
| `payday` | `string` | Payday. |
| `items` | `object[]` | Items fixtures in provider-native format. |
| `contractor_payments` | `object[]` | Contractor payments fixtures in provider-native format. |

### `companies[].payrolls[].items[]`

| Parameter | Type | Description |
| - | - | - |
| `employee_alias` | `string` | Employee alias. |
| `payment_method` | `string` | Payment method. |
| `earnings` | `object[]` | Earnings fixtures in provider-native format. |

### `companies[].payrolls[].items[].earnings[]`

| Parameter | Type | Description |
| - | - | - |
| `amount` | `string` | Amount. |
| `type` | `string` | Type. |

### `companies[].payrolls[].contractor_payments[]`

| Parameter | Type | Description |
| - | - | - |
| `contractor_alias` | `string` | Contractor alias. |
| `amount` | `string` | Amount. |
| `payment_method` | `string` | Payment method. |

### `companies[].pay_schedules[]`

| Parameter | Type | Description |
| - | - | - |
| `name` | `string` | Human-readable name. |
| `pay_frequency` | `string` | Pay frequency. |
| `first_payday` | `string` | First payday. |
| `first_period_end` | `string` | First period end. |
| `paydays` | `object[]` | Paydays fixtures in provider-native format. |

### `companies[].pay_schedules[].paydays[]`

| Parameter | Type | Description |
| - | - | - |
| `payday` | `string` | Payday. |
| `period_start` | `string` | Period start. |
| `period_end` | `string` | Period end. |
| `approval_deadline` | `string` | Approval deadline. |
| `impacted_by_weekend_or_holiday` | `boolean` | Enable or set impacted by weekend or holiday behavior. |

### `webhooks[]`

| Parameter | Type | Description |
| - | - | - |
| `url` | `string` | Url. |
| `environment` | `string` | Environment. |
| `active` | `boolean` | Enable or set active behavior. |

See [Scenario seeding](https://docs.argalabs.com/twins/seeding.md) for saving, provisioning, and resetting fixtures.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.