Altoviz Classifications API

openapi: 3.2.0
info:
  title: Altoviz Classifications 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: Classifications
  description: Classifications API
paths:
  /v1/classifications:
    get:
      tags:
      - Classifications
      summary: List all classifications
      operationId: GET_Classifications_List
      parameters:
      - name: type
        in: query
        description: Classification Type
        schema:
          $ref: '#/components/schemas/ClassificationType'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Classification'
components:
  schemas:
    Vat:
      type: object
      properties:
        default:
          type: boolean
          description: Indicatess if this is the default VAT for the region
          readOnly: true
        id:
          type:
          - integer
          - 'null'
          description: Vat ID
          format: int32
          readOnly: true
        label:
          type:
          - string
          - 'null'
          description: Label
          readOnly: true
        rate:
          type:
          - number
          - 'null'
          description: Rate
          format: double
        region:
          $ref: '#/components/schemas/VatRegion'
      additionalProperties: false
      description: Vat
    VatRegion:
      enum:
      - FR
      - EU
      - IE
      - DOM
      - Corse
      - Monaco
      type: string
    ClassificationType:
      enum:
      - Sale
      - Expense
      - Other
      type: string
    MicroBusinessDeclarationTypes:
      enum:
      - Products
      - Services
      - OtherServices
      - Renting
      - Cipav
      type: string
    Classification:
      type: object
      properties:
        accountNumber:
          type:
          - string
          - 'null'
          description: Account number
          readOnly: true
        defaultVat:
          $ref: '#/components/schemas/Vat'
        description:
          type:
          - string
          - 'null'
          description: Description
          readOnly: true
        id:
          type: integer
          description: Classification ID
          format: int32
        isProduct:
          type: boolean
          description: Indicates whether classification is product (should be defined when type is 'Sale')
          readOnly: true
        isService:
          type: boolean
          description: Indicates whether classification is service (should be defined when type is 'Sale')
          readOnly: true
        label:
          type:
          - string
          - 'null'
          description: Label
          readOnly: true
        microBusinessDeclarationType:
          $ref: '#/components/schemas/MicroBusinessDeclarationTypes'
        type:
          $ref: '#/components/schemas/ClassificationType'
      additionalProperties: false
      description: Classification
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API KEY generated in application. Example: "X-API-KEY: {apiKey}"'
      name: X-API-KEY
      in: header