Altoviz Webhooks API

openapi: 3.2.0
info:
  title: Altoviz Webhooks API
  description: 'RESTful APIs for the Altoviz services


    ## Deprecations


    ### Product prices


    A product now stores its sale price both excluding and including tax, so both are

    returned, along with the margin figures derived from them: `taxExcludedPrice`,

    `taxIncludedPrice`, `margin`, `markupRate` (margin over cost, FR « taux de marge ») and

    `marginRate` (margin over sale price, FR « taux de marque »).


    Two fields are deprecated as a result:


    | Deprecated | Use instead |

    | --- | --- |

    | `unitPrice` | `taxExcludedPrice` |

    | `isUnitPriceTaxIncluded` | `taxIncludedPrice`, to send a tax-included price |


    **`unitPrice` is now always the tax-excluded price.** It previously held whichever half

    the product was priced in, which `isUnitPriceTaxIncluded` told you. For a product priced

    tax-included, `unitPrice` therefore returns a different number than it used to, and

    `isUnitPriceTaxIncluded` is now always `false`. If you read the flag before using the

    price, your result is unchanged. If you assumed the price was tax-included, read

    `taxIncludedPrice`.


    Writing is unaffected. Both fields are still accepted and behave exactly as before:

    `unitPrice` alone is read as tax-excluded, and setting `isUnitPriceTaxIncluded` to `true`

    still means the price you are sending includes tax. `margin`, `markupRate` and

    `marginRate` are derived by the server and ignored if sent.'
  contact:
    name: Altoviz
    email: contact@altoviz.com
  license:
    name: Altoviz license
    url: https://altoviz.com/license
  version: v1
  x-logo:
    url: https://altoviz.com/altoviz-logo-ext-violet-262x72.png
    altText: Altoviz logo
servers:
- url: https://api.altoviz.com
  description: Altoviz
security:
- {}
tags:
- name: Webhooks
  description: Classifications API
paths:
  /v1/webhooks:
    get:
      tags:
      - Webhooks
      summary: List all webhooks
      operationId: GET_Webhooks_List
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Webhook'
    post:
      tags:
      - Webhooks
      summary: Register a new webhook
      operationId: POST_Webhooks_Post
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
          text/json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
          application/*+json:
            schema:
              $ref: '#/components/schemas/WebhookCreate'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    delete:
      tags:
      - Webhooks
      summary: Unregister a webhook
      operationId: DELETE_Webhooks_Delete
      parameters:
      - name: id
        in: query
        description: Webhook ID
        schema:
          type: integer
          format: int32
      - name: url
        in: query
        description: Webhook URL
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Webhook'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    WebhookCreate:
      required:
      - name
      - types
      - url
      type: object
      properties:
        name:
          minLength: 1
          type: string
          description: Name
        secretKey:
          type:
          - string
          - 'null'
          description: Secret key
        types:
          type: array
          items:
            $ref: '#/components/schemas/WebhookType'
          description: ''
        url:
          minLength: 1
          type: string
          description: Webhook Uri
      additionalProperties: false
      description: Wehbook
    Webhook:
      required:
      - name
      - types
      - url
      type: object
      properties:
        id:
          type: integer
          description: Webhook ID
          format: int32
        name:
          minLength: 1
          type: string
          description: Name
        secretKey:
          type:
          - string
          - 'null'
          description: Secret key
        types:
          type: array
          items:
            $ref: '#/components/schemas/WebhookType'
          description: ''
        url:
          minLength: 1
          type: string
          description: Webhook Uri
      additionalProperties: false
      description: Wehbook
    WebhookType:
      enum:
      - CustomerCreated
      - InvoiceCreated
      - CustomerDeleted
      - CustomerUpdated
      - ProductCreated
      - ProductUpdated
      - ProductDeleted
      - InvoiceUpdated
      - ContactUpdated
      - ContactCreated
      - QuoteUpdated
      - QuoteCreated
      - ContactDeleted
      - QuoteDeleted
      - InvoiceDeleted
      type: string
    Error:
      type: object
      properties:
        errors:
          type:
          - array
          - 'null'
          items:
            type: string
          description: List of error messages
        message:
          type:
          - string
          - 'null'
          description: Error message
      additionalProperties: false
      description: Error
    ProblemDetails:
      type: object
      properties:
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        title:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
      additionalProperties: {}
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API KEY generated in application. Example: "X-API-KEY: {apiKey}"'
      name: X-API-KEY
      in: header