---
title: "Create"
method: POST
path: "/workspaces/{wid}/batches/{bid}/comparisons"
tags: ["comparisons"]
---

# Create

`POST /workspaces/{wid}/batches/{bid}/comparisons`

## 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`
- Auth: none declared

## Path parameters

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

## Request body

- CreateComparison
  - `request_id` string, uuid, required
  - `base_version` integer, required
  - `schema_revision` integer, required
  - `correction_revision` integer
  - `rules` object
  - `associations` Association[], required
    - `id` string, uuid, required
    - `sources` SourceGroup[], required
      - `id` string, required
      - `members` RecordRef[], required
        - `artifact_id` string, uuid, required
        - `record_id` string, required
      - `relation` 'single' | 'split' | 'resolved' | 'absent'
      - `resolution_id` string, uuid, nullable
      - `document_id` string, uuid, nullable
      - `formats` object
      - `context_bindings` ContextBinding[]
        - `member` RecordRef, required
          - `artifact_id` string, uuid, required
          - `record_id` string, required
        - `field_id` string, uuid, required
        - `source` RecordRef, required
          - `artifact_id` string, uuid, required
          - `record_id` string, required
    - `order_id` string, uuid, nullable
  - `orders` Order[]
    - `id` string, uuid, required
    - `documents` string[], required
    - `basis` 'key' | 'reference' | 'assigned' | 'own', required
    - `scope_value` string, nullable
    - `assigned` string[]
    - `links` OrderLink[]
      - `document_id` string, uuid, required
      - `label` string, required
      - `value` string, required

## Response `201`

Successful Response

- ComparisonVersion
  - `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

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