Altoviz Colleagues API

openapi: 3.2.0
info:
  title: Altoviz Colleagues 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: Colleagues
  description: Colleagues API
paths:
  /v1/colleagues:
    get:
      tags:
      - Colleagues
      summary: List colleagues
      operationId: GET_Colleagues_List
      parameters:
      - name: PageIndex
        in: query
        schema:
          type: integer
          format: int32
      - name: PageSize
        in: query
        schema:
          type: integer
          format: int32
      - name: OrderBy
        in: query
        schema:
          type: string
      - name: query
        in: query
        description: query (full text search)
        schema:
          type: string
      responses:
        '200':
          description: OK
          headers:
            x-page-prev:
              description: Relative URL of previous page when available
              schema:
                type: string
            x-page-next:
              description: Relative URL of next page when available
              schema:
                type: string
            x-page-count:
              description: Total number of pages
              schema:
                type: integer
                format: int32
            x-record-count:
              description: Total number of matching records
              schema:
                type: integer
                format: int32
            x-page-index:
              description: Current page index
              schema:
                type: integer
                format: int32
            x-page-size:
              description: Current page size
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Colleague'
    post:
      tags:
      - Colleagues
      summary: Create a new colleague
      operationId: POST_Colleagues_Post
      requestBody:
        description: Colleague to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Colleague'
          text/json:
            schema:
              $ref: '#/components/schemas/Colleague'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Colleague'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Colleague'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /v1/colleagues/find:
    get:
      tags:
      - Colleagues
      summary: Find a colleague
      operationId: GET_Colleagues_Find
      parameters:
      - name: email
        in: query
        description: Colleague email
        schema:
          type: string
      - name: internalId
        in: query
        description: Colleague internal ID
        schema:
          type: string
      - name: number
        in: query
        description: Colleague internal ID
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Colleague'
  /v1/colleagues/getbyinternalid/{internalid}:
    get:
      tags:
      - Colleagues
      summary: Find a single colleague by its internal ID
      operationId: GET_Colleagues_GetByInternalId
      parameters:
      - name: internalId
        in: path
        description: Colleague internal ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Colleague'
  /v1/colleagues/{id}:
    get:
      tags:
      - Colleagues
      summary: Get a colleague by ID
      operationId: GET_Colleagues_Get
      parameters:
      - name: id
        in: path
        description: Colleague id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Colleague'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - Colleagues
      summary: Update a colleague
      operationId: PUT_Colleagues_Update
      parameters:
      - name: id
        in: path
        description: Colleague ID
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Colleague'
          text/json:
            schema:
              $ref: '#/components/schemas/Colleague'
          application/*+json:
            schema:
              $ref: '#/components/schemas/Colleague'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Colleague'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    delete:
      tags:
      - Colleagues
      summary: Delete a colleague
      operationId: DELETE_Colleagues_Delete
      parameters:
      - name: id
        in: path
        description: Colleague id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    Colleague:
      type: object
      properties:
        cellPhone:
          type:
          - string
          - 'null'
          description: Cell phone number
        email:
          type:
          - string
          - 'null'
          description: Email
        firstName:
          type:
          - string
          - 'null'
          description: First name
        homecareServiceNumber:
          type:
          - string
          - 'null'
          description: Homecare service number associated with the colleague
        id:
          type: integer
          description: Colleague Id
          format: int32
        initialPartnerBalance:
          type: number
          description: Initial balance for the partner
          format: double
        internalId:
          type:
          - string
          - 'null'
          description: Internal identifier for the colleague
        isPartner:
          type: boolean
          description: Indicates if the colleague is a partner
        lastName:
          type:
          - string
          - 'null'
          description: Last name
        metadatas:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: 'Metadata: free-form key/value pairs carried with the colleague, for an integration to keep

            its own identifiers and flags against it.


            Sent as a PATCH, not a replacement: keys you send are added or updated, keys you leave out

            keep whatever they held, and a key is removed only when you send it as `null`. Omitting

            the property entirely leaves the whole bag untouched, and `""` stores an empty value

            rather than removing the key.'
        name:
          type:
          - string
          - 'null'
          description: Colleague Name
        number:
          type:
          - string
          - 'null'
          description: Colleague Number
        phone:
          type:
          - string
          - 'null'
          description: Phone number
        title:
          type:
          - string
          - 'null'
          description: Title
        userId:
          type:
          - string
          - 'null'
          description: User identifier associated with the colleague
      additionalProperties: false
      description: Colleague
    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: {}
    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
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API KEY generated in application. Example: "X-API-KEY: {apiKey}"'
      name: X-API-KEY
      in: header