openapi: 3.1.0
info:
  title: Exact Online REST / OData API
  description: >-
    Partial OpenAPI for the Exact Online REST/OData API (v1). Endpoints are
    drawn from the official documentation at
    https://start.exactonline.nl/docs/HlpRestAPIResources.aspx covering CRM,
    Sales, Purchase, Financial, Logistics, and System resources. The full API
    exposes hundreds of OData entity sets; this spec covers the most commonly
    used entities. Authentication is OAuth 2.0 with regional auth endpoints.
  version: "1.0.0"
  contact:
    name: API Evangelist
    email: kin@apievangelist.com
  license:
    name: Proprietary
servers:
  - url: https://start.exactonline.nl/api/v1
    description: Netherlands
  - url: https://start.exactonline.co.uk/api/v1
    description: United Kingdom
  - url: https://start.exactonline.be/api/v1
    description: Belgium
  - url: https://start.exactonline.de/api/v1
    description: Germany
  - url: https://start.exactonline.com/api/v1
    description: International
security:
  - oauth2: []
paths:
  /current/Me:
    get:
      summary: Get current user and division
      operationId: getCurrentMe
      tags: [System]
      responses:
        "200":
          description: Current user info
  /{division}/system/Divisions:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List divisions accessible to current user
      operationId: listDivisions
      tags: [System]
      responses:
        "200":
          description: Divisions
  /{division}/system/AllDivisions:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List all licensed divisions
      operationId: listAllDivisions
      tags: [System]
      responses:
        "200":
          description: All divisions
  /{division}/crm/Accounts:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List CRM accounts
      operationId: listAccounts
      tags: [CRM]
      parameters:
        - { name: $select, in: query, schema: { type: string } }
        - { name: $filter, in: query, schema: { type: string } }
        - { name: $top, in: query, schema: { type: integer } }
        - { name: $skip, in: query, schema: { type: integer } }
      responses:
        "200": { description: List of accounts }
    post:
      summary: Create CRM account
      operationId: createAccount
      tags: [CRM]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/Account" }
      responses:
        "201": { description: Account created }
  /{division}/crm/Accounts({id}):
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
      - { name: id, in: path, required: true, schema: { type: string, format: uuid } }
    get:
      summary: Get CRM account
      operationId: getAccount
      tags: [CRM]
      responses:
        "200":
          description: Account
          content:
            application/json:
              schema: { $ref: "#/components/schemas/Account" }
    put:
      summary: Update CRM account
      operationId: updateAccount
      tags: [CRM]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/Account" }
      responses:
        "204": { description: Updated }
    delete:
      summary: Delete CRM account
      operationId: deleteAccount
      tags: [CRM]
      responses:
        "204": { description: Deleted }
  /{division}/crm/Contacts:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List contacts
      operationId: listContacts
      tags: [CRM]
      responses:
        "200": { description: Contacts }
    post:
      summary: Create contact
      operationId: createContact
      tags: [CRM]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/Contact" }
      responses:
        "201": { description: Created }
  /{division}/crm/Contacts({id}):
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
      - { name: id, in: path, required: true, schema: { type: string, format: uuid } }
    get:
      summary: Get contact
      operationId: getContact
      tags: [CRM]
      responses:
        "200":
          description: Contact
          content:
            application/json:
              schema: { $ref: "#/components/schemas/Contact" }
    put:
      summary: Update contact
      operationId: updateContact
      tags: [CRM]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/Contact" }
      responses:
        "204": { description: Updated }
    delete:
      summary: Delete contact
      operationId: deleteContact
      tags: [CRM]
      responses:
        "204": { description: Deleted }
  /{division}/salesinvoice/SalesInvoices:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List sales invoices
      operationId: listSalesInvoices
      tags: [Sales]
      responses:
        "200": { description: Sales invoices }
    post:
      summary: Create sales invoice
      operationId: createSalesInvoice
      tags: [Sales]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/SalesInvoice" }
      responses:
        "201": { description: Created }
  /{division}/salesinvoice/SalesInvoices({id}):
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
      - { name: id, in: path, required: true, schema: { type: string, format: uuid } }
    get:
      summary: Get sales invoice
      operationId: getSalesInvoice
      tags: [Sales]
      responses:
        "200":
          description: Sales invoice
          content:
            application/json:
              schema: { $ref: "#/components/schemas/SalesInvoice" }
    put:
      summary: Update sales invoice
      operationId: updateSalesInvoice
      tags: [Sales]
      requestBody:
        required: true
        content:
          application/json:
            schema: { $ref: "#/components/schemas/SalesInvoice" }
      responses:
        "204": { description: Updated }
    delete:
      summary: Delete sales invoice
      operationId: deleteSalesInvoice
      tags: [Sales]
      responses:
        "204": { description: Deleted }
  /{division}/salesorder/SalesOrders:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List sales orders
      operationId: listSalesOrders
      tags: [Sales]
      responses:
        "200": { description: Sales orders }
    post:
      summary: Create sales order
      operationId: createSalesOrder
      tags: [Sales]
      requestBody:
        required: true
        content:
          application/json:
            schema: { type: object, additionalProperties: true }
      responses:
        "201": { description: Created }
  /{division}/purchaseorder/PurchaseOrders:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List purchase orders
      operationId: listPurchaseOrders
      tags: [Purchase]
      responses:
        "200": { description: Purchase orders }
    post:
      summary: Create purchase order
      operationId: createPurchaseOrder
      tags: [Purchase]
      requestBody:
        required: true
        content:
          application/json:
            schema: { type: object, additionalProperties: true }
      responses:
        "201": { description: Created }
  /{division}/financial/GLAccounts:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List general-ledger accounts
      operationId: listGLAccounts
      tags: [Financial]
      responses:
        "200": { description: GL accounts }
    post:
      summary: Create GL account
      operationId: createGLAccount
      tags: [Financial]
      requestBody:
        required: true
        content:
          application/json:
            schema: { type: object, additionalProperties: true }
      responses:
        "201": { description: Created }
  /{division}/logistics/Items:
    parameters:
      - { name: division, in: path, required: true, schema: { type: integer } }
    get:
      summary: List items
      operationId: listItems
      tags: [Logistics]
      responses:
        "200": { description: Items }
    post:
      summary: Create item
      operationId: createItem
      tags: [Logistics]
      requestBody:
        required: true
        content:
          application/json:
            schema: { type: object, additionalProperties: true }
      responses:
        "201": { description: Created }
components:
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://start.exactonline.nl/api/oauth2/auth
          tokenUrl: https://start.exactonline.nl/api/oauth2/token
          scopes: {}
  schemas:
    Account:
      type: object
      properties:
        ID: { type: string, format: uuid }
        Code: { type: string }
        Name: { type: string }
        Email: { type: string }
        Phone: { type: string }
        Status: { type: string }
        Type: { type: string, enum: [C, S, R] }
    Contact:
      type: object
      properties:
        ID: { type: string, format: uuid }
        Account: { type: string, format: uuid }
        FirstName: { type: string }
        LastName: { type: string }
        Email: { type: string }
        Phone: { type: string }
    SalesInvoice:
      type: object
      properties:
        InvoiceID: { type: string, format: uuid }
        InvoiceNumber: { type: integer }
        InvoiceTo: { type: string, format: uuid }
        Description: { type: string }
        AmountDC: { type: number }
        Currency: { type: string }
        Status: { type: integer }