Enable API

openapi: 3.1.0
info:
  title: Enable API
  version: '2026-10-26'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-26: 9 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; Enable has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 7
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-26'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://developers.enable.com/articles/asynchronous-and-reporting-endpoints
  - https://developers.enable.com/articles/data-structure
paths:
  /v1/deals:
    get:
      operationId: get_v1_deals
      tags:
      - Deals
      summary: GET /v1/deals
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request GET \"https://api.deal-track.com/v1/deals\" --header \"Authorization: Bearer eyJhbGciOiJIUzI1....\" Endpoints\
          \ Following the version is the endpoint’s name itself. Currently, Enable supports the following top level endpoints: v1/trading-partners\
          \ \n v1/schemes \n v1/deals \n v1/items \n v1/earnings \n v1/turnover \n v1/activity \n v1/attachments \n v1/users \n v1/collaborators\
          \ \n v1/collection-item"
  /v1/deals/2Bk3:
    get:
      operationId: get_v1_deals_2Bk3
      tags:
      - Deals
      summary: Get the deal with the ID "2Bk3" along with its related items.
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/deals/Hg7f:
    get:
      operationId: get_v1_deals_Hg7f
      tags:
      - Deals
      summary: View a single deal with the ID of “Hg7f”, if one exists.
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/granular-earnings/aF3v:
    get:
      operationId: get_v1_granular_earnings_aF3v
      tags:
      - Granular Earnings
      summary: Initial request to trigger asynchronous processing for granular earnings with ID "aF3v".
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/granular-earnings/queue-jobs/p0fS:
    get:
      operationId: get_v1_granular_earnings_queue_jobs_p0fS
      tags:
      - Granular Earnings
      summary: Polling request to check the status of an asynchronous granular earnings job with ID "p0fS".
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/granular-earnings/results/p0fS:
    get:
      operationId: get_v1_granular_earnings_results_p0fS
      tags:
      - Granular Earnings
      summary: Request to retrieve the results of a completed asynchronous granular earnings job with ID "p0fS".
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/items:
    get:
      operationId: get_v1_items
      tags:
      - Items
      summary: Return a list of items (example of sparse fieldsets usage).
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/reports/deal-earnings/abc1:
    get:
      operationId: get_v1_reports_deal_earnings_abc1
      tags:
      - Reports
      summary: GET /v1/reports/deal-earnings/abc1
      x-source: https://developers.enable.com/articles/asynchronous-and-reporting-endpoints
      parameters:
      - name: include
        in: query
        required: false
        schema:
          type: string
      - name: viewBy[dimensions]
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl --request GET \"https://api.deal-track.com/v1/reports/deal-earnings/abc1?viewBy[dimensions]=prod,bran&include=items\" --header\
          \ \"Authorization: Bearer eyJh....\" The response would then return the breakdown of the deal's earnings for each Product in each Branch.\
          \ \n{\n \"data\": [\n {\n \"id\": \"abc1\",\n \"type\": \"deal-earnings\",\n \"attributes\": {\n \"actualEarnings\": 5510.5149,\n \"\
          forecastEarnings\": 5510.5149,"
  /v1/trading-partners/pL9f/schemes:
    get:
      operationId: get_v1_trading_partners_pL9f_schemes
      tags:
      - Trading Partners
      summary: View all schemes that belong to a trading partner with the ID of “pL9f”.
      x-source: https://developers.enable.com/articles/data-structure
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Deals
- name: Granular Earnings
- name: Items
- name: Reports
- name: Trading Partners