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

# Preview what a consumer's sync would create

> Queues an execution that writes nothing and records every object it would create (suppliers, invoices, payments…), linked to what they need, and what would fail. Each capability the consumer chose books at most `limit` objects changed in the last 14 days, unless dates are given. Read it with `GET …/previews/{preview_id}`. Refused with a 409 while another preview of the consumer is pending.



## OpenAPI

````yaml post /consumers/{consumer_id}/syncs/{syncid}/previews
openapi: 3.1.0
info:
  title: Chift API
  description: >-
    The Chift API is a universal API giving you access to financial data from
    the software of your clients. It helps software companies to offer native
    integrations to their clients without the effort needed to maintain those
    native integrations. By using the APIs (Accounting, POS, eCommerce) of
    Chift, you connect once and allow your clients to use their software
    packages.
  version: 1.0.0
servers:
  - url: https://api.chift.eu
    description: Chift
security:
  - bearerAuth: []
paths:
  /consumers/{consumer_id}/syncs/{syncid}/previews:
    post:
      tags:
        - Syncs
      summary: Preview what a consumer's sync would create
      description: >-
        Queues an execution that writes nothing and records every object it
        would create (suppliers, invoices, payments…), linked to what they need,
        and what would fail. Each capability the consumer chose books at most
        `limit` objects changed in the last 14 days, unless dates are given.
        Read it with `GET …/previews/{preview_id}`. Refused with a 409 while
        another preview of the consumer is pending.
      operationId: agentic_syncs_start_preview
      parameters:
        - name: consumer_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Consumer Id
        - name: syncid
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Syncid
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/StartPreview'
                - type: 'null'
              title: Body
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewStarted'
        '404':
          content:
            application/json:
              examples:
                Sync not found:
                  value:
                    message: The sync does not exist
                    status: error
                Not configured:
                  value:
                    message: The consumer is not configured for this sync
                    status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Not Found
        '409':
          content:
            application/json:
              examples:
                Preview pending:
                  value:
                    message: >-
                      A preview is already pending for this consumer; cannot
                      start a new one.
                    status: error
                Execution running:
                  value:
                    message: >-
                      An execution of this flow is already running for this
                      consumer
                    status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Conflict
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    StartPreview:
      properties:
        limit:
          type: integer
          maximum: 500
          minimum: 1
          title: Limit
          description: >-
            Objects each capability the consumer chose books at most. What they
            need (their suppliers) is previewed whatever its number.
          default: 50
        force_from_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Force From Date
          description: First day the preview covers. Defaults to 14 days ago.
        force_to_date:
          anyOf:
            - type: string
              format: date
            - type: 'null'
          title: Force To Date
          description: Last day it covers. Defaults to today.
      type: object
      title: StartPreview
    PreviewStarted:
      properties:
        preview_id:
          type: string
          format: uuid
          title: Preview Id
          description: >-
            Read the preview with it: the legacy routes know it as the preview
            execution.
        status:
          type: string
          enum:
            - pending
            - ready
            - failed
          title: Status
          description: Pending while it is queued or running, then ready or failed.
      type: object
      required:
        - preview_id
        - status
      title: PreviewStarted
    ChiftError:
      properties:
        message:
          type: string
          title: Message
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          default: error
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          default: ''
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      required:
        - message
      title: ChiftError
    HTTPValidationError:
      title: Validation Error
      required:
        - message
      type: object
      properties:
        message:
          title: Message
          type: string
          default: Validation error
        status:
          title: Status
          type: string
          default: error
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This access token needs to be included in each of your request to the
        Chift API.

````

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