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

# The mapping tables a consumer's sync needs

> Every mapping table the capabilities and modes running for this consumer need, with whether it is complete and whether it can stay hidden. Reads no connection: open a table to see its rows.



## OpenAPI

````yaml get /consumers/{consumer_id}/syncs/{syncid}/mappings
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}/mappings:
    get:
      tags:
        - Syncs
      summary: The mapping tables a consumer's sync needs
      description: >-
        Every mapping table the capabilities and modes running for this consumer
        need, with whether it is complete and whether it can stay hidden. Reads
        no connection: open a table to see its rows.
      operationId: agentic_syncs_get_consumer_mappings
      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
        - name: language
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              ISO 639-1 code of the language of the texts (en, fr, nl, de, es;
              any case), falling back to English. Without it, translation keys.
            title: Language
          description: >-
            ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any
            case), falling back to English. Without it, translation keys.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MappingTables'
        '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
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MappingTables:
      properties:
        tables:
          items:
            $ref: '#/components/schemas/MappingTableItem'
          type: array
          title: Tables
          description: Every table the consumer's plan needs, in the plan's order.
      type: object
      required:
        - tables
      title: MappingTables
      description: The mapping tables a consumer's running capabilities need.
    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'
    MappingTableItem:
      properties:
        key:
          type: string
          title: Key
          description: >-
            Stable key, e.g. 'spend_to_accounting.SupplierInvoices'. Send it
            back as is.
          examples:
            - spend_to_accounting.PurchaseVatCodes
        id:
          type: string
          format: uuid
          title: Id
          description: >-
            The stable uuid derived from the key, as the legacy sync routes
            identify the same item.
        title:
          type: string
          title: Title
          description: >-
            Name to show, in the requested language; its translation key without
            one.
        description:
          type: string
          title: Description
          description: >-
            What it does, the tooltip: in the requested language, its
            translation key without one.
        used_by:
          items:
            type: string
          type: array
          title: Used By
          description: Keys of the capabilities or modes that need it.
        rows:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Rows
          description: The rows in use when only some are. Null when the whole table is.
        required:
          type: boolean
          title: Required
          description: >-
            A row without a value stops the objects that need it (an issue is
            raised).
        allow_delete:
          type: boolean
          title: Allow Delete
          description: The consumer may hide rows.
        complete:
          type: boolean
          title: Complete
          description: >-
            No known row lacks a value. Rows the source lists are known once
            ai-fill or the consumer filled the table, rows met in the data once
            an execution or a preview met them.
        hidden:
          type: boolean
          title: Hidden
          description: >-
            Nothing to show by default: the table is complete. It can still be
            opened and edited.
      type: object
      required:
        - key
        - id
        - title
        - description
        - used_by
        - rows
        - required
        - allow_delete
        - complete
        - hidden
      title: MappingTableItem
    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.