> ## 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.

# Ramp

> Ramp Scenario seeding parameters, nested fields, and examples

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

Ramp finance workspace: business, departments, locations, entities, users, spend programs, funds, virtual/physical cards, transactions, receipts, vendors, bills, reimbursements, and accounting data, purchase orders, item receipts, unified requests, vendor agreements/credits, tax and inventory fields, custom records/matrices, approvals, bank and travel reports, and AI usage.

## 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": "Ramp eval fixture",
  "twins": [
    "ramp"
  ],
  "seed_config": {
    "ramp": {
      "seed": "scenario-ramp",
      "departments": [
        {
          "alias": "engineering",
          "name": "Engineering"
        }
      ],
      "locations": [
        {
          "alias": "headquarters",
          "name": "San Francisco",
          "entity_id": {
            "$ref": "company.id"
          }
        }
      ],
      "entities": [
        {
          "alias": "company",
          "entity_name": "Example Company",
          "country": "US"
        }
      ],
      "users": [
        {
          "alias": "employee",
          "first_name": "Alex",
          "last_name": "Chen",
          "email": "alex@example.test",
          "role": "BUSINESS_USER",
          "status": "USER_ACTIVE",
          "department_id": {
            "$ref": "engineering.id"
          },
          "location_id": {
            "$ref": "headquarters.id"
          }
        }
      ],
      "funds": [
        {
          "alias": "software",
          "user_id": {
            "$ref": "employee.id"
          },
          "display_name": "Software",
          "spending_restrictions": {
            "interval": "MONTHLY",
            "limit": {
              "amount": 100000,
              "currency_code": "USD"
            }
          }
        }
      ],
      "virtual_cards": [
        {
          "alias": "software-card",
          "user_id": {
            "$ref": "employee.id"
          },
          "fund_id": {
            "$ref": "software.id"
          },
          "display_name": "Software card",
          "state": "ACTIVE"
        }
      ],
      "transactions": [
        {
          "card_id": {
            "$ref": "software-card.id"
          },
          "user_id": {
            "$ref": "employee.id"
          },
          "entity_amount": {
            "value": 12500,
            "currency": "USD"
          },
          "currency_code": "USD",
          "merchant_name": "Acme Software",
          "state": "CLEARED"
        }
      ],
      "vendors": [
        {
          "alias": "supplier",
          "name": "Acme Supplies",
          "country": "US",
          "state": "CA"
        }
      ],
      "draft_bills": [
        {
          "vendor_id": {
            "$ref": "supplier.id"
          },
          "entity_id": {
            "$ref": "company.id"
          },
          "invoice_number": "INV-1001",
          "invoice_currency": "USD",
          "issued_at": "2026-11-06",
          "due_at": "2026-12-06",
          "line_items": [
            {
              "amount": 10000,
              "memo": "Office supplies"
            }
          ]
        }
      ],
      "reimbursements": [],
      "receipts": [],
      "spend_programs": [],
      "purchase_orders": [],
      "item_receipts": [],
      "unified_requests": [],
      "vendor_agreements": [],
      "vendor_credits": [],
      "accounting_tax_codes": [],
      "accounting_tax_rates": [],
      "accounting_inventory_fields": [],
      "custom_record_tables": [],
      "custom_record_columns": [],
      "custom_record_rows": [],
      "resources": {},
      "webhooks": []
    }
  }
}
```

## Parameters

The following fields belong directly inside `seed_config.ramp`. 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 |
| - | - | - |
| `seed` | `string` | Deterministic seed used by this twin. |
| `departments` | `object[]` | Departments fixtures in provider-native format. |
| `locations` | `object[]` | Locations fixtures in provider-native format. |
| `entities` | `object[]` | Entities fixtures in provider-native format. |
| `users` | `object[]` | Users fixtures in provider-native format. |
| `funds` | `object[]` | Funds fixtures in provider-native format. |
| `virtual_cards` | `object[]` | Virtual cards fixtures in provider-native format. |
| `transactions` | `object[]` | Transactions fixtures in provider-native format. |
| `vendors` | `object[]` | Vendors fixtures in provider-native format. |
| `draft_bills` | `object[]` | Draft bills fixtures in provider-native format. |
| `reimbursements` | `array` | Reimbursements fixtures in provider-native format. |
| `receipts` | `array` | Receipts fixtures in provider-native format. |
| `spend_programs` | `array` | Spend programs fixtures in provider-native format. |
| `purchase_orders` | `array` | Purchase orders fixtures in provider-native format. |
| `item_receipts` | `array` | Item receipts fixtures in provider-native format. |
| `unified_requests` | `array` | Unified requests fixtures in provider-native format. |
| `vendor_agreements` | `array` | Vendor agreements fixtures in provider-native format. |
| `vendor_credits` | `array` | Vendor credits fixtures in provider-native format. |
| `accounting_tax_codes` | `array` | Accounting tax codes fixtures in provider-native format. |
| `accounting_tax_rates` | `array` | Accounting tax rates fixtures in provider-native format. |
| `accounting_inventory_fields` | `array` | Accounting inventory fields fixtures in provider-native format. |
| `custom_record_tables` | `array` | Custom record tables fixtures in provider-native format. |
| `custom_record_columns` | `array` | Custom record columns fixtures in provider-native format. |
| `custom_record_rows` | `array` | Custom record rows fixtures in provider-native format. |
| `resources` | `map<string, object[]>` | Provider resource collections keyed by collection name. Preserve their native record fields and references. |
| `webhooks` | `array` | Webhook subscriptions or configurations. |
| `base_time` | `string or null` | Reference clock for repeatable fixtures. Omit to use the current clock. |
| `client_id` | `string` | Test OAuth client identifier. |
| `client_secret` | `string` | Test OAuth client secret. |
| `access_token` | `string` | Synthetic access token used by the twin. |
| `redirect_uris` | `string[]` | Redirect uris fixtures in provider-native format. |
| `clients` | `OAuthClient[]` | Clients fixtures in provider-native format. |
| `client_credentials_ttl_seconds` | `integer` | Client credentials ttl seconds, in seconds. Minimum: 1. |
| `authorization_code_ttl_seconds` | `integer` | Authorization code ttl seconds, in seconds. Minimum: 1. |
| `access_token_ttl_seconds` | `integer` | Access token ttl seconds, in seconds. Minimum: 1. |
| `refresh_token_ttl_seconds` | `integer` | Refresh token ttl seconds, in seconds. Minimum: 1. |
| `rate_limiting_enabled` | `boolean` | Enable request rate limiting. |
| `requests_per_window` | `integer` | Requests per window. Minimum: 1. |
| `rate_window_seconds` | `integer` | Rate window seconds, in seconds. Minimum: 1. |
| `auto_deliver_webhooks` | `boolean` | Enable automatic delivery of configured twin webhooks. |
| `webhook_timeout_seconds` | `number` | Webhook timeout seconds, in seconds. Maximum: 10. |
| `failure_rules` | `FailureRule[]` | Deterministic failure-injection rules. |

## 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.

### `departments[]`

| Parameter | Type | Description |
| - | - | - |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `name` | `string` | Human-readable name. |

### `locations[]`

| Parameter | Type | Description |
| - | - | - |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `name` | `string` | Human-readable name. |
| `entity_id` | `object` | Entity id. |

### `entities[]`

| Parameter | Type | Description |
| - | - | - |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `entity_name` | `string` | Entity name. |
| `country` | `string` | Country. |

### `users[]`

| Parameter | Type | Description |
| - | - | - |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `first_name` | `string` | First name. |
| `last_name` | `string` | Last name. |
| `email` | `string` | Main account email address. |
| `role` | `string` | Role. |
| `status` | `string` | Status. |
| `department_id` | `object` | Department id. |
| `location_id` | `object` | Location id. |

### `funds[]`

| Parameter | Type | Description |
| - | - | - |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `user_id` | `object` | User id. |
| `display_name` | `string` | Display name. |
| `spending_restrictions` | `object` | Spending restrictions. |

### `virtual_cards[]`

| Parameter | Type | Description |
| - | - | - |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `user_id` | `object` | User id. |
| `fund_id` | `object` | Fund id. |
| `display_name` | `string` | Display name. |
| `state` | `string` | State. |

### `transactions[]`

| Parameter | Type | Description |
| - | - | - |
| `card_id` | `object` | Card id. |
| `user_id` | `object` | User id. |
| `entity_amount` | `object` | Entity amount. |
| `currency_code` | `string` | Currency code. |
| `merchant_name` | `string` | Merchant name. |
| `state` | `string` | State. |

### `vendors[]`

| Parameter | Type | Description |
| - | - | - |
| `alias` | `string` | Fixture-local name used by supported relationship references. |
| `name` | `string` | Human-readable name. |
| `country` | `string` | Country. |
| `state` | `string` | State. |

### `draft_bills[]`

| Parameter | Type | Description |
| - | - | - |
| `vendor_id` | `object` | Vendor id. |
| `entity_id` | `object` | Entity id. |
| `invoice_number` | `string` | Invoice number. |
| `invoice_currency` | `string` | Invoice currency. |
| `issued_at` | `string` | Issued at. |
| `due_at` | `string` | Due at. |
| `line_items` | `object[]` | Line items fixtures in provider-native format. |

### `draft_bills[].line_items[]`

| Parameter | Type | Description |
| - | - | - |
| `amount` | `integer` | Amount. |
| `memo` | `string` | Memo. |

## Typed configuration objects

Named object types in the parameter table use these fields.

### FailureRule

| Parameter | Type | Description |
| - | - | - |
| `method` | `string` | Method. |
| `path` | `string` | Path. |
| `status_code` | `integer` | Status code. Minimum: 400. Maximum: 599. |
| `code` | `string` | Code. |
| `message` | `string` | Message. |
| `remaining` | `integer` | Remaining. Minimum: 0. |
| `headers` | `map<string, string>` | Headers keyed by identifier or resource name. |

### OAuthClient

| Parameter | Type | Description |
| - | - | - |
| `client_id` | `string` | **Required.** Test OAuth client identifier. |
| `client_secret` | `string` | **Required.** Test OAuth client secret. |
| `scopes` | `string[]` | Scopes fixtures in provider-native format. |
| `grant_types` | `string[]` | Grant types fixtures in provider-native format. |
| `redirect_uris` | `string[]` | Redirect uris fixtures in provider-native format. |
| `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.