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

# Get a sync item

> Entity-type-agnostic — works for expenses, bills, invoices, and every other synced entity.



## OpenAPI

````yaml /openapi/accounting.json get /sync/items/{syncItemId}
openapi: 3.1.0
info:
  title: Sync2Books Accounting API
  version: 1.0.0
  description: >-
    Write categorized expenses, bills, invoices, and payments to your customers'
    accounting systems (QuickBooks Online, Xero, Sage, Dynamics 365 Business
    Central, Odoo) through one API.


    This is a **separate product** from the [Sync2Books Compliance API
    (eTIMS)](/etims-overview) — use this one to sync bookkeeping data to an
    accounting system; use that one for KRA tax compliance in Kenya. A company
    can use either, both, or neither.


    Writes are **asynchronous**: most create endpoints queue the record and
    return a `syncBatchId` you confirm via the [Sync](#tag/Sync) endpoints — see
    [The sync model](/concepts/sync-model).
servers:
  - url: https://api.sync2books.com
    description: Production
  - url: https://sandbox-api.sync2books.com
    description: Sandbox (coming soon)
security:
  - ApiKeyAuth: []
tags:
  - name: Companies
    description: Your customers — the entities you sync data for.
  - name: Expenses
    description: Categorized expenses, receipts, and payments.
  - name: Bills
    description: Accounts-payable documents (money you owe suppliers).
  - name: Invoices
    description: Accounts-receivable documents (money customers owe you).
  - name: Bill Payments
    description: Payments applied against one or more bills.
  - name: Attachments
    description: Receipts and supporting documents on a synced transaction.
  - name: Sync
    description: Track and retry the asynchronous batches every write creates.
paths:
  /sync/items/{syncItemId}:
    get:
      tags:
        - Sync
      summary: Get a sync item
      description: >-
        Entity-type-agnostic — works for expenses, bills, invoices, and every
        other synced entity.
      parameters:
        - name: syncItemId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SyncItem'
        '404':
          description: Not found
components:
  schemas:
    SyncItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        entityId:
          type: string
        entityType:
          type: string
          enum:
            - expense
            - invoice
            - bill
            - bill-payment
            - customer
            - supplier
            - tax-rate
            - tax-code
            - payment-method
            - tracking-category
            - account
            - item
            - etims-compliance
        companyId:
          type: string
        source:
          type: string
        status:
          type: string
          enum:
            - pending
            - syncing
            - synced
            - failed
            - skipped
        syncErrorMessage:
          type:
            - string
            - 'null'
        syncedAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your application's API key (`sk_development_…` or `sk_production_…`). An
        optional `X-Signature` / `X-Timestamp` HMAC pair may additionally be
        sent for stronger security — see
        [Authentication](/concepts/authentication).

````

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