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

# Status of a statement upload

> Where an uploaded statement landed. `processing` — no outcome yet; `ingested` — the period is in the books (the `statement` object says what); `rejected` — the `rejection.reason` says why, e.g. `did_not_reconcile` (the transactions don't roll the opening balance to the printed closing — re-upload a complete, legible copy), `not_a_bank_statement`, `document_unreadable`, or `no_transactions`.



## OpenAPI

````yaml /openapi.json get /bank-statements/{documentId}
openapi: 3.0.3
info:
  title: Cherry API
  version: 1.0.0
  description: >-
    Cherry's public developer API — programmatic access to a business's books as
    Cherry keeps them: bank transactions with their categorizations, the chart
    of accounts, the double-entry journal, financial statements, legal entities,
    the tax-obligation calendar, and the fiscal health score.


    Authenticate every request with an API key: `Authorization: Bearer
    ck_live_…`. Keys are created in the Cherry app and are scoped to one
    business (tenant) — there is no tenant id in any URL. Keys carry a `read`
    and/or `write` scope; every GET needs `read`, mutations need `write`.


    Conventions: successful responses wrap the payload in `{ "data": … }`; list
    endpoints add `{ "meta": { "pagination": { limit, offset, nextOffset } } }`
    — pass `nextOffset` back as `offset` until it is null. Errors are `{
    "error": string, "reason"?: string }` with conventional status codes. Dates
    are `YYYY-MM-DD`; money amounts are numbers in the row's currency. Requests
    are rate-limited per key with token buckets (429 + `Retry-After` when
    exhausted); report generation has a smaller budget than plain reads.
servers:
  - url: https://api.trycherry.ai/v1
security:
  - bearerAuth: []
tags:
  - name: Transactions
    description: Bank feed rows and their categorizations.
  - name: Accounts
    description: The tenant's chart of accounts.
  - name: Bank accounts
    description: >-
      Connected bank accounts — Plaid-linked and manual. Manual institutions are
      how developers without a Plaid connection bring their own accounts and
      transactions.
  - name: Bank statements
    description: >-
      Statement uploads — send a statement PDF/image and Cherry transcribes it,
      verifies the balances reconcile, and lands the transactions on a manual
      bank account. The no-export alternative to pushing rows yourself.
  - name: Journal
    description: The double-entry journal (entries and lines).
  - name: Reports
    description: Trial balance and financial statements.
  - name: Entities
    description: Legal entities behind the tenant.
  - name: Obligations
    description: The tax/compliance calendar Cherry tracks.
  - name: Health
    description: Cherry's composite fiscal readiness score.
  - name: Meta
    description: The API's own machine-readable contract.
paths:
  /bank-statements/{documentId}:
    get:
      tags:
        - Bank statements
      summary: Status of a statement upload
      description: >-
        Where an uploaded statement landed. `processing` — no outcome yet;
        `ingested` — the period is in the books (the `statement` object says
        what); `rejected` — the `rejection.reason` says why, e.g.
        `did_not_reconcile` (the transactions don't roll the opening balance to
        the printed closing — re-upload a complete, legible copy),
        `not_a_bank_statement`, `document_unreadable`, or `no_transactions`.
      operationId: getBankStatementUpload
      parameters:
        - name: documentId
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: The id returned by POST /bank-statements.
      responses:
        '200':
          description: The upload's status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      documentId:
                        type: string
                        format: uuid
                      status:
                        type: string
                        enum:
                          - processing
                          - ingested
                          - rejected
                      statement:
                        $ref: '#/components/schemas/BankStatement'
                        description: Present when status is `ingested`.
                      rejection:
                        type: object
                        description: Present when status is `rejected`.
                        properties:
                          reason:
                            type: string
                          detail:
                            type: string
                            nullable: true
              example:
                data:
                  documentId: 9f8e7d6c-5b4a-4321-8765-4321fedcba98
                  status: ingested
                  statement:
                    id: 1a2b3c4d-5e6f-4a8b-9c0d-1e2f3a4b5c6d
                    documentId: 9f8e7d6c-5b4a-4321-8765-4321fedcba98
                    bankAccountId: 22222222-2222-2222-2222-222222222222
                    periodStart: '2026-07-01'
                    periodEnd: '2026-07-31'
                    currency: MXN
                    openingBalance: 128450.3
                    closingBalance: 115359.75
                    transactionCount: 42
                    continuityOk: true
                    createdAt: '2026-08-05T14:02:11.000Z'
        '400':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    BankStatement:
      type: object
      description: >-
        One ingested statement period — the provenance record behind the
        transactions a statement upload produced. `continuityOk` is null until a
        neighbouring period exists to compare against.
      properties:
        id:
          type: string
          format: uuid
        documentId:
          type: string
          format: uuid
          description: The uploaded document this period was ingested from.
        bankAccountId:
          type: string
          format: uuid
          description: Cherry's internal bank-account id (see GET /bank-accounts).
        periodStart:
          type: string
          format: date
        periodEnd:
          type: string
          format: date
        currency:
          type: string
          description: ISO 4217, read off the statement — never defaulted.
        openingBalance:
          type: number
        closingBalance:
          type: number
        transactionCount:
          type: integer
          description: Transaction lines the statement carried.
        continuityOk:
          type: boolean
          nullable: true
          description: >-
            Whether this period's opening balance joins the previous statement's
            closing balance. Null when there is no earlier statement to compare
            against. A false value raises a conflict but does not block
            ingestion.
        createdAt:
          type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Stable machine-readable error code.
        reason:
          type: string
          description: Human-readable explanation.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: ck_live_…
      description: >-
        Cherry API key, created in the app. Sent as `Authorization: Bearer
        ck_live_…`.

````