openapi: 3.2.0
info:
  title: Bookkeep.com Entities API
  version: '2026-10-02'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-02: 5 operation(s) read from 11 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Bookkeep.com has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 9
    documentation: -4
    pages-with-code: 10
    pages-read: 11
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-02'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://bookkeep.com/docs/bookkeep_api_v1/bookkeep-api-v-1
  - https://bookkeep.com/docs/bookkeep_api_v1/get-entity
  - https://bookkeep.com/docs/bookkeep_api_v1/get-location
  - https://bookkeep.com/docs/bookkeep_api_v1/get-connection
  - https://bookkeep.com/docs/bookkeep_api_v1/get-entity-list
  - https://bookkeep.com/docs/bookkeep_api_v1/get-notification
  - https://bookkeep.com/docs/bookkeep_api_v1/get-journal-entry
  - https://bookkeep.com/docs/bookkeep_api_v1/get-location-list
  - https://bookkeep.com/docs/bookkeep_api_v1/get-entity-summary
  - https://bookkeep.com/docs/bookkeep_api_v1/get-purchase-order
  - https://bookkeep.com/docs/bookkeep_api_v1/get-sales-tax-list
servers:
- url: https://api.bookkeep.com
security:
- basic: []
tags:
- name: Entities
paths:
  /v1/entities:
    get:
      operationId: get_v1_entities
      tags:
      - Entities
      summary: GET /v1/entities
      x-source: https://bookkeep.com/docs/bookkeep_api_v1/bookkeep-api-v-1
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1EntitiesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -L -X GET ''https://api.bookkeep.com/v1/entities'' \ -H ''Authorization: Basic ZGlsaXAuYmFpcmFnaUBib29ra2VlcC5jbzpXLlM4NVZGbkJyeEY2QmI='' Security Scheme Type: http HTTP Authorization Scheme: basic This tab covers Purchase Order endpoints only ( /v1/entities/{entity_id}/purchase_orders* ).

          They use a separate, scoped API key — not the Publishable/Secret key pair

          documented in the other Basic Auth'
  /v1/entities/{entityId}/purchase_orders:
    get:
      operationId: get_v1_entities_entityId_purchase_orders
      tags:
      - Entities
      summary: list and get purchase orders in any status, including line items and supplier…
      description: List purchase orders for the specified entity.
      x-source: https://bookkeep.com/docs/bookkeep_api_v1/bookkeep-api-v-1
      parameters:
      - name: entityId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_v1_entities_entityId_purchase_orders
      tags:
      - Entities
      summary: create and update draft purchase orders
      description: Create a new draft purchase order for the specified entity.
      x-source: https://bookkeep.com/docs/bookkeep_api_v1/bookkeep-api-v-1
      parameters:
      - name: entityId
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/entities/{entityId}/purchase_orders/{uuid}:
    patch:
      operationId: patch_v1_entities_entityId_purchase_orders_uuid
      tags:
      - Entities
      summary: create and update draft purchase orders
      description: Update an existing purchase order.
      x-source: https://bookkeep.com/docs/bookkeep_api_v1/bookkeep-api-v-1
      parameters:
      - name: entityId
        in: path
        required: true
        schema:
          type: string
      - name: uuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/entities/{entityId}/purchase_orders/{uuid}/cancel:
    patch:
      operationId: patch_v1_entities_entityId_purchase_orders_uuid_cancel
      tags:
      - Entities
      summary: create and update draft purchase orders
      description: Cancel a purchase order according to cancel rules.
      x-source: https://bookkeep.com/docs/bookkeep_api_v1/bookkeep-api-v-1
      parameters:
      - name: entityId
        in: path
        required: true
        schema:
          type: string
      - name: uuid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetV1EntitiesResponse:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    basic:
      type: http
      scheme: basic