---
title: "Scope Apply"
method: POST
path: "/workspaces/{wid}/batches/{bid}/comparisons/{vid}/scope/apply"
tags: ["comparisons"]
---

# Scope Apply

`POST /workspaces/{wid}/batches/{bid}/comparisons/{vid}/scope/apply`

## Request

- Base URL: `https://app.linerecon.com` (the document declares no server; this is the origin it was published from)
- URL: `https://app.linerecon.com/workspaces/{wid}/batches/{bid}/comparisons/{vid}/scope/apply`
- Auth: none declared

## Path parameters

- `wid` string, uuid, required
- `bid` string, uuid, required
- `vid` string, uuid, required

## Request body

- ScopeApply
  - `field_ids` string[], required
  - `rules` object, required
  - `request_id` string, uuid, required
  - `preview_token` string, required

## Response `201`

Successful Response

- ScopeReceipt
  - `comparison` ComparisonVersion, required
    - `open_count` integer, required
    - `to_pair_count` integer, required
    - `accepted_count` integer, required
    - `consistent_count` integer, required
    - `disputed_count` integer, required
    - `review_mode` 'standard' | 'strict', required
    - `id` string, uuid, required
    - `version` integer, required
    - `schema_revision` integer, required
    - `created_by` string, uuid, required
    - `created_at` string, date-time, required
    - `current` boolean, required
    - `fields` SchemaField[], required
      - `id` string, uuid, required
      - `name` string, required
      - `description` string, required
      - `type` 'text' | 'identifier' | 'number' | 'money' | 'date', required
      - `scope` 'document' | 'record' | 'line_item'
      - `comparison_enabled` boolean
    - `plan` object, required
    - `result` object, required
    - `line_matching` LineMatching[]
      - `order_id` string, uuid, required
      - `run_id` string, uuid, required
      - `state` 'matching' | 'failed', required
  - `added_field_ids` string[], required
  - `removed_field_ids` string[], required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `413`: Content Too Large
- `422`: Unprocessable Content
- `429`: Too Many Requests
- `503`: Service Unavailable

---

[API](https://skmtc.dev/linerecon/apis/linerecon-api.md) · [All operations](https://skmtc.dev/linerecon/apis/linerecon-api/llms.txt) · [OpenAPI document](https://skmtc.dev/linerecon/apis/linerecon-api/revisions/0650f53a4249?raw)
