Zwapgrid API

openapi: 3.1.0
info:
  title: Zwapgrid API
  version: '2026-10-19'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-19: 22 operation(s) read from 16 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Zwapgrid has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 22
    pages-with-code: 0
    pages-read: 16
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-19'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.zwapgrid.com/resources/demos.md
  - https://docs.zwapgrid.com/resources/postman.md
  - https://docs.zwapgrid.com/deprecation-schedule/2026-06/removal-of-accountbalances-endpoint.md
  - https://docs.zwapgrid.com/deprecation-schedule/2025-01/deprecation-of-accountbalances-endpoint.md
  - https://docs.zwapgrid.com/security/api-security.md
  - https://docs.zwapgrid.com/client-portal/api-keys.md
  - https://docs.zwapgrid.com/client-portal/api-keys/api-key-lifecycle.md
  - https://docs.zwapgrid.com/client-portal/systems/client-managed-connection.md
  - https://docs.zwapgrid.com/api-guide
  - https://docs.zwapgrid.com/api.1/api.1.md
  - https://docs.zwapgrid.com/api.1/use-cases.md
  - https://docs.zwapgrid.com/client-portal/users.md
  - https://docs.zwapgrid.com/client-portal/systems.md
  - https://docs.zwapgrid.com/client-portal/consents.md
  - https://docs.zwapgrid.com/client-portal/onboarding.md
  - https://docs.zwapgrid.com/api.1/use-cases/invoicing.md
servers:
- url: https://apione.zwapgrid.com
paths:
  /accountBalances:
    get:
      operationId: get_accountBalances
      tags:
      - Accountbalances
      summary: Removal of accountBalances endpoint
      x-source: https://docs.zwapgrid.com/deprecation-schedule/2026-06/removal-of-accountbalances-endpoint.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api.1/api.1.md:
    get:
      operationId: get_api_1_api_1_md
      tags:
      - Api
      summary: Overview
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.zwapgrid.com/api.1/api.1.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api.1/use-cases.md:
    get:
      operationId: get_api_1_use_cases_md
      tags:
      - Api
      summary: Use Cases
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.zwapgrid.com/api.1/use-cases.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api.1/use-cases/invoicing.md:
    get:
      operationId: get_api_1_use_cases_invoicing_md
      tags:
      - Api
      summary: Invoicing
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.zwapgrid.com/api.1/use-cases/invoicing.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /client-portal/api-keys.md:
    get:
      operationId: get_client_portal_api_keys_md
      tags:
      - Client Portal
      summary: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters
      description: Retrieves the API Keys documentation page, optionally with a question and goal to get a tailored answer.
      x-source: https://docs.zwapgrid.com/client-portal/api-keys.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /client-portal/api-keys/api-key-lifecycle.md:
    get:
      operationId: get_client_portal_api_keys_api_key_lifecycle_md
      tags:
      - Client Portal
      summary: API Key Lifecycle
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.zwapgrid.com/client-portal/api-keys/api-key-lifecycle.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The broader goal the user is trying to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /client-portal/consents.md:
    get:
      operationId: get_client_portal_consents_md
      tags:
      - Client Portal
      summary: Consents
      x-source: https://docs.zwapgrid.com/client-portal/consents.md
      parameters:
      - name: ask
        in: query
        required: true
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: true
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /client-portal/onboarding.md:
    get:
      operationId: get_client_portal_onboarding_md
      tags:
      - Client Portal
      summary: Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters
      x-source: https://docs.zwapgrid.com/client-portal/onboarding.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: 'the immediate question: it should be specific, self‑contained, and written in natural language'
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: the user’s ultimate goal, describing the outcome they want to achieve
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /client-portal/systems.md:
    get:
      operationId: get_client_portal_systems_md
      tags:
      - Client Portal
      summary: Systems
      x-source: https://docs.zwapgrid.com/client-portal/systems.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question to ask the documentation.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The overall goal the user is trying to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /client-portal/systems/client-managed-connection.md:
    get:
      operationId: get_client_portal_systems_client_managed_connection_md
      tags:
      - Client Portal
      summary: Client-managed Connection
      x-source: https://docs.zwapgrid.com/client-portal/systems/client-managed-connection.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /client-portal/users.md:
    get:
      operationId: get_client_portal_users_md
      tags:
      - Client Portal
      summary: You can manage who has access to the Client Portal for your organisation.
      x-source: https://docs.zwapgrid.com/client-portal/users.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /consents/api/v1/consents:
    get:
      operationId: get_consents_api_v1_consents
      tags:
      - Consents
      summary: List consents
      x-source: https://docs.zwapgrid.com/api-guide
      parameters:
      - name: Count
        in: query
        required: false
        schema:
          type: integer
        description: Number of records to return per page.
      - name: CurrentPage
        in: query
        required: false
        schema:
          type: integer
        description: One-based index of the page to return.
      - name: CreatedOn
        in: query
        required: false
        schema:
          type: string
        description: 'Filter by creation date. Format: yyyy-MM-dd.'
      - name: UpdatedOn
        in: query
        required: false
        schema:
          type: string
        description: 'Filter by last update date. Format: yyyy-MM-dd.'
      - name: OrderBy
        in: query
        required: false
        schema:
          type: string
        description: Sort order for the results.
      - name: Status
        in: query
        required: false
        schema:
          type: string
        description: Filter by consent status. Use the status name or numeric value.
      - name: Source
        in: query
        required: false
        schema:
          type: string
        description: Filter by source (accounting system identifier).
      - name: IsTest
        in: query
        required: false
        schema:
          type: boolean
        description: When true, only test consents are returned.
      - name: SystemSettingsId
        in: query
        required: false
        schema:
          type: string
        description: Filter by the selected system settings ID.
      - name: Name
        in: query
        required: false
        schema:
          type: string
        description: Filter by consent name.
      - name: x-correlation-id
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier used to correlate and trace this request.
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: API Key generated in the Client Portal.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConsentsApiV1ConsentsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_consents_api_v1_consents
      tags:
      - Consents
      summary: Create a consent
      x-source: https://docs.zwapgrid.com/api-guide
      parameters:
      - name: x-correlation-id
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier used to correlate and trace this request.
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: API Key generated in the Client Portal.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostConsentsApiV1ConsentsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /consents/api/v1/consents/{consentid}:
    delete:
      operationId: delete_consents_api_v1_consents_consentid
      tags:
      - Consents
      summary: Delete a consent
      x-source: https://docs.zwapgrid.com/api-guide
      parameters:
      - name: consentid
        in: path
        required: true
        schema:
          type: string
      - name: x-correlation-id
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier used to correlate and trace this request.
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: API Key generated in the Client Portal.
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_consents_api_v1_consents_consentid
      tags:
      - Consents
      summary: Get a consent
      x-source: https://docs.zwapgrid.com/api-guide
      parameters:
      - name: consentid
        in: path
        required: true
        schema:
          type: string
      - name: x-correlation-id
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier used to correlate and trace this request.
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: API Key generated in the Client Portal.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConsentsApiV1ConsentsConsentidResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_consents_api_v1_consents_consentid
      tags:
      - Consents
      summary: Update a consent
      x-source: https://docs.zwapgrid.com/api-guide
      parameters:
      - name: consentid
        in: path
        required: true
        schema:
          type: string
      - name: If-Match
        in: header
        required: true
        schema:
          type: string
        description: Value of the ETag returned as a response header from the get-consent endpoint.
      - name: x-correlation-id
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier used to correlate and trace this request.
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: API Key generated in the Client Portal.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchConsentsApiV1ConsentsConsentidRequest'
      responses:
        '204':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /consents/api/v1/consents/{consentid}/otc:
    post:
      operationId: post_consents_api_v1_consents_consentid_otc
      tags:
      - Consents
      summary: Create a one-time code
      x-source: https://docs.zwapgrid.com/api-guide
      parameters:
      - name: consentid
        in: path
        required: true
        schema:
          type: string
      - name: x-correlation-id
        in: header
        required: true
        schema:
          type: string
        description: Unique identifier used to correlate and trace this request.
      - name: x-api-key
        in: header
        required: true
        schema:
          type: string
        description: API Key generated in the Client Portal.
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostConsentsApiV1ConsentsConsentidOtcResponse'
      x-evidence:
        kind: documentation
  /deprecation-schedule/2025-01/deprecation-of-accountbalances-endpoint.md:
    get:
      operationId: get_deprecation_schedule_2025_01_deprecation_of_accountbalances_endpoint_md
      tags:
      - Deprecation Schedule
      summary: Deprecation of accountbalances endpoint
      x-source: https://docs.zwapgrid.com/deprecation-schedule/2025-01/deprecation-of-accountbalances-endpoint.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /resources/demos.md:
    get:
      operationId: get_resources_demos_md
      tags:
      - Resources
      summary: Demos
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.zwapgrid.com/resources/demos.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained, written in natural language.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want to achieve.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /resources/postman.md:
    get:
      operationId: get_resources_postman_md
      tags:
      - Resources
      summary: Postman
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.zwapgrid.com/resources/postman.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: The immediate question, specific and self‑contained.
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s overall goal, describing the desired outcome.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /security/api-security.md:
    get:
      operationId: get_security_api_security_md
      tags:
      - Security
      summary: API Security
      description: Perform an HTTP GET request on the URL with the `ask` and `goal` query parameters to retrieve a direct answer and relevant
        excerpts from the documentation.
      x-source: https://docs.zwapgrid.com/security/api-security.md
      parameters:
      - name: ask
        in: query
        required: false
        schema:
          type: string
        description: 'The immediate question: it should be specific, self-contained, and written in natural language.'
      - name: goal
        in: query
        required: false
        schema:
          type: string
        description: The user’s ultimate goal, describing the outcome they want.
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /trialBalances:
    get:
      operationId: get_trialBalances
      tags:
      - Trialbalances
      summary: Removal of accountBalances endpoint
      x-source: https://docs.zwapgrid.com/deprecation-schedule/2026-06/removal-of-accountbalances-endpoint.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  schemas:
    GetConsentsApiV1ConsentsResponse:
      type: object
      properties:
        meta:
          type: object
          description: 'Metadata for a paginated result: total count and current page information.'
        data:
          type: array
          description: The list of consent items for the current page.
    PostConsentsApiV1ConsentsRequest:
      type: object
      properties:
        name:
          type: string
          description: Display name for the consent.
        systemsSettings:
          type: object
          description: Optional dictionary of available system settings for the consent.
      required:
      - name
    GetConsentsApiV1ConsentsConsentidResponse:
      type: object
      properties:
        id:
          type: string
          description: The ID of the Consent
        name:
          type: string
          description: The name of the Consent
        status:
          type: integer
          description: 'Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).'
        source:
          type: string
          description: The source of the consent (i.e. what system has been connected)
        systemSettingsId:
          type: string
          description: The selected system settings ID once the consent is accepted.
        systemSettings:
          type: object
          description: Dictionary of available system settings for the consent.
        createdOn:
          type: string
          description: The date the consent was created on
        updatedOn:
          type: string
          description: The date the consent was updated on
    PatchConsentsApiV1ConsentsConsentidRequest:
      type: object
      properties:
        status:
          type: integer
          description: 'Consent status. Values: CREATED (0), ACCEPTED (1), REVOKED (2), INACTIVE (3).'
        name:
          type: string
          description: New display name for the consent.
    PostConsentsApiV1ConsentsConsentidOtcResponse:
      type: object
      properties:
        code:
          type: string
          description: The one-time code used by the embedded client integration.
  securitySchemes:
    API_Key:
      type: apiKey
      in: header
      name: x-api-key
      x-source: https://docs.zwapgrid.com/client-portal/api-keys.md
tags:
- name: Accountbalances
- name: Api
- name: Client Portal
- name: Consents
- name: Deprecation Schedule
- name: Resources
- name: Security
- name: Trialbalances
security:
- API_Key: []