Altoviz

Altoviz Settings API

Settings API

GitHub OpenAPI

Operations 1

GET /v1/settings Get settings #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/altoviz-com/openapi/altoviz-com-settings-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/altoviz-com/json-schema/altoviz-com-invoice-schema.json
📊
JSONSchema
https://artifacts.apis.io/altoviz-com/json-schema/altoviz-com-credit-schema.json
📊
JSONSchema
https://artifacts.apis.io/altoviz-com/json-schema/altoviz-com-quote-schema.json
📊
JSONSchema
https://artifacts.apis.io/altoviz-com/json-schema/altoviz-com-product-schema.json
📊
JSONSchema
https://artifacts.apis.io/altoviz-com/json-schema/altoviz-com-bank-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/altoviz-com/json-schema/altoviz-com-bank-transaction-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/altoviz-com:altoviz-com-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

altoviz-com-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Altoviz Settings 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: Settings
  description: Settings API
paths:
  /v1/settings:
    get:
      tags:
      - Settings
      summary: Get settings
      operationId: GET_Settings_Get
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Settings'
components:
  schemas:
    SharedFileDto:
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
        externalLinkHash:
          type:
          - string
          - 'null'
        fileName:
          type:
          - string
          - 'null'
        folderId:
          type:
          - integer
          - 'null'
          format: int32
        id:
          type: integer
          format: int32
        metadatas:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        size:
          type: number
          format: double
        system:
          type: boolean
        uploadedAt:
          type: string
          format: date-time
      additionalProperties: false
    ClassificationDto:
      type: object
      properties:
        accountNumber:
          type:
          - string
          - 'null'
        defaultVat:
          $ref: '#/components/schemas/VatDto'
        defaultVatId:
          type:
          - integer
          - 'null'
          format: int32
        description:
          type:
          - string
          - 'null'
        id:
          type:
          - integer
          - 'null'
          format: int32
        isProduct:
          type: boolean
        isService:
          type: boolean
        label:
          type:
          - string
          - 'null'
        metadatas:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
        microBusinessDeclarationType:
          $ref: '#/components/schemas/MicroBusinessDeclarationTypes'
        type:
          $ref: '#/components/schemas/ClassificationType'
      additionalProperties: false
    SettlementTermConditionDto:
      type: object
      properties:
        dayOfMonth:
          type:
          - integer
          - 'null'
          format: int32
        delay:
          type: integer
          format: int32
        delayType:
          $ref: '#/components/schemas/DelayType'
        id:
          type: integer
          format: int32
        percent:
          type: number
          format: double
        type:
          $ref: '#/components/schemas/ConditionType'
      additionalProperties: false
    MicroBusinessDeclarationTypes:
      enum:
      - Products
      - Services
      - OtherServices
      - Renting
      - Cipav
      type: string
    VatMode:
      enum:
      - Auto
      - Debit
      - Collection
      type: string
    Settings:
      type: object
      properties:
        accounting:
          $ref: '#/components/schemas/AccountingSettingsDto'
        company:
          $ref: '#/components/schemas/CompanySettingsDto'
        eInvoicing:
          $ref: '#/components/schemas/EInvoicingSettingsDto'
        emailing:
          $ref: '#/components/schemas/EmailingSettingsDto'
        general:
          $ref: '#/components/schemas/GeneralSettingsDto'
        sales:
          $ref: '#/components/schemas/SalesSettingsDto'
        socials:
          $ref: '#/components/schemas/Socials'
        vat:
          $ref: '#/components/schemas/VatSettingsDto'
      additionalProperties: false
      description: Application Settings
    GeneralSettingsDto:
      type: object
      properties:
        autoCollapseMenu:
          type: boolean
        companyInfoLinkProvider:
          $ref: '#/components/schemas/CompanyInfoLinkProvider'
        contactDisplayFormat:
          $ref: '#/components/schemas/ContactNameDisplay'
        ipLinkProvider:
          $ref: '#/components/schemas/IPLinkProvider'
        mapLinkProvider:
          $ref: '#/components/schemas/MapLinkProvider'
        timezone:
          type:
          - string
          - 'null'
      additionalProperties: false
    EmailHomecareServiceSettingsDto:
      type: object
      properties:
        defaultAttachments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmailAttachmentDto'
        defaultBccEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultCcEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultContentTemplate:
          type:
          - string
          - 'null'
        defaultObjectTemplate:
          type:
          - string
          - 'null'
      additionalProperties: false
    CompanyInfoLinkProvider:
      enum:
      - Pappers
      - Infogreffe
      - Manageo
      - Verif
      type: string
    VatDeclarationPeriodicity:
      enum:
      - Monthly
      - Quarterly
      type: string
    ClassificationType:
      enum:
      - Sale
      - Expense
      - Other
      type: string
    ConditionType:
      enum:
      - Net
      - EndMonth
      type: string
    EmailQuoteSettingsDto:
      type: object
      properties:
        defaultAttachments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmailAttachmentDto'
        defaultBccEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultCcEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultContentTemplate:
          type:
          - string
          - 'null'
        defaultObjectTemplate:
          type:
          - string
          - 'null'
        includeDocumentAttachment:
          type: boolean
        showAmount:
          type: boolean
      additionalProperties: false
    IPLinkProvider:
      enum:
      - IPInfo
      - DBIP
      - IPData
      - IPGeolocation
      type: string
    AddressFields:
      type: object
      properties:
        city:
          type:
          - string
          - 'null'
        countryIso:
          type:
          - string
          - 'null'
        countryName:
          type:
          - string
          - 'null'
          readOnly: true
        formattedAddress:
          type:
          - string
          - 'null'
          readOnly: true
        inlineAddress:
          type:
          - string
          - 'null'
          readOnly: true
        street:
          type:
          - string
          - 'null'
        zipcode:
          type:
          - string
          - 'null'
      additionalProperties: false
    EmailAttachmentDto:
      type: object
      properties:
        fileId:
          type: integer
          format: int32
        fileName:
          type:
          - string
          - 'null'
        fileSize:
          type: number
          format: double
      additionalProperties: false
    ContactNameDisplay:
      enum:
      - LastNameFirstName
      - FirstNameLastName
      type: string
    PaymentMethod:
      enum:
      - Transfer
      - Order
      - Check
      - Cash
      - Card
      - Bill
      - Usec
      - Other
      type: string
    QuoteSettingsDto:
      type: object
      properties:
        depositDefaultValue:
          type: number
          format: double
        validityDuration:
          type: integer
          format: int32
      additionalProperties: false
    EmailInvoiceSettingsDto:
      type: object
      properties:
        defaultAttachments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmailAttachmentDto'
        defaultBccEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultCcEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultContentTemplate:
          type:
          - string
          - 'null'
        defaultObjectTemplate:
          type:
          - string
          - 'null'
        includeDocumentAttachment:
          type: boolean
        showAmount:
          type: boolean
      additionalProperties: false
    EmailReminderSettingsDto:
      type: object
      properties:
        defaultAttachments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmailAttachmentDto'
        defaultBccEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultCcEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultContentTemplate:
          type:
          - string
          - 'null'
        defaultObjectTemplate:
          type:
          - string
          - 'null'
        includeDocumentAttachment:
          type: boolean
      additionalProperties: false
    SalesSettingsDto:
      type: object
      properties:
        allowInlineDate:
          type: boolean
        btoBSettlementTerm:
          $ref: '#/components/schemas/SettlementTermDto'
        btoBSettlementTermId:
          type:
          - integer
          - 'null'
          format: int32
        btoCSettlementTerm:
          $ref: '#/components/schemas/SettlementTermDto'
        btoCSettlementTermId:
          type:
          - integer
          - 'null'
          format: int32
        credits:
          $ref: '#/components/schemas/CreditSettingsDto'
        customersLiableToEInvoicing:
          type: boolean
        customersLiableToVat:
          type: boolean
        defaultProductClassification:
          $ref: '#/components/schemas/ClassificationDto'
        defaultServiceClassification:
          $ref: '#/components/schemas/ClassificationDto'
        defaultShippingClassification:
          $ref: '#/components/schemas/ClassificationDto'
        generalTermsFile:
          $ref: '#/components/schemas/SharedFileDto'
        generalTermsFileId:
          type:
          - integer
          - 'null'
          format: int32
        invoices:
          $ref: '#/components/schemas/InvoiceSettingsDto'
        mainActivity:
          $ref: '#/components/schemas/ProductType'
        outstandingLimit:
          type:
          - number
          - 'null'
          format: double
        paymentMethod:
          $ref: '#/components/schemas/PaymentMethod'
        quotes:
          $ref: '#/components/schemas/QuoteSettingsDto'
        useTaxIncluded:
          type: boolean
        vatReverseCharge:
          type: boolean
      additionalProperties: false
    EInvoicingProfile:
      enum:
      - Standard
      - Advanced
      type: string
    ProductType:
      enum:
      - Product
      - Service
      - Text
      type: string
    VatSettingsDto:
      type: object
      properties:
        liableToVat:
          type: boolean
        nonLiableTextToPrint:
          type:
          - string
          - 'null'
        vatMode:
          $ref: '#/components/schemas/VatMode'
        vatPeriod:
          $ref: '#/components/schemas/VatDeclarationPeriodicity'
        vatRegime:
          $ref: '#/components/schemas/VatRegime'
      additionalProperties: false
    AccountingSettingsDto:
      type: object
      properties:
        accountNumberLength:
          type: integer
          format: int32
        customerAccountFormat:
          type:
          - string
          - 'null'
        customerCollectiveAccount:
          type:
          - string
          - 'null'
        expensesImportVatReverseAccountNumber:
          type:
          - string
          - 'null'
        expensesJournalCode:
          type:
          - string
          - 'null'
        expensesSubcontractingVatReverseAccountNumber:
          type:
          - string
          - 'null'
        feesAccountingAccountNumber:
          type:
          - string
          - 'null'
        generateCustomerAccount:
          type: boolean
        generateSupplierAccount:
          type: boolean
        miscJournalCode:
          type:
          - string
          - 'null'
        salesDepositAccountingAccountNumber:
          type:
          - string
          - 'null'
        salesJournalCode:
          type:
          - string
          - 'null'
        salesShippingAccountNumber:
          type:
          - string
          - 'null'
        salesVatCollectionAccountingAccountNumber:
          type:
          - string
          - 'null'
        supplierAccountFormat:
          type:
          - string
          - 'null'
        supplierCollectiveAccount:
          type:
          - string
          - 'null'
        uncertainAccountNumberRoot:
          type:
          - string
          - 'null'
      additionalProperties: false
    EInvoicingSettingsDto:
      type: object
      properties:
        autoAcknowledgeReceivedInvoices:
          type: boolean
        autoCreateReceiptFromIncomingPayment:
          type: boolean
        autoEmitPaymentReceived:
          type: boolean
        autoEmitPaymentSent:
          type: boolean
        autoProcessTerminalStatuses:
          type: boolean
        autoSendEReporting:
          type: boolean
        autoSubmitInvoicesOnFinalize:
          type: boolean
        includeTextLinesInXml:
          type: boolean
        profile:
          $ref: '#/components/schemas/EInvoicingProfile'
        validateAddressesBeforeSubmit:
          type: boolean
        validateBeforeSubmit:
          type: boolean
      additionalProperties: false
    VatDto:
      type: object
      properties:
        default:
          type: boolean
        id:
          type:
          - integer
          - 'null'
          format: int32
        rate:
          type:
          - number
          - 'null'
          format: double
        region:
          $ref: '#/components/schemas/VatRegion'
      additionalProperties: false
    Socials:
      type: object
      properties:
        facebook:
          type:
          - string
          - 'null'
        instagram:
          type:
          - string
          - 'null'
        linkedIn:
          type:
          - string
          - 'null'
        pinterest:
          type:
          - string
          - 'null'
        twitter:
          type:
          - string
          - 'null'
        youtube:
          type:
          - string
          - 'null'
      additionalProperties: false
    VatRegion:
      enum:
      - FR
      - EU
      - IE
      - DOM
      - Corse
      - Monaco
      type: string
    CreditSettingsDto:
      type: object
      properties:
        validityDuration:
          type:
          - integer
          - 'null'
          format: int32
      additionalProperties: false
    EmailStyleSettingsDto:
      type: object
      properties:
        backgroundColor:
          type:
          - string
          - 'null'
        buttonColor:
          type:
          - string
          - 'null'
        buttonTextColor:
          type:
          - string
          - 'null'
        headerBackgroundColor:
          type:
          - string
          - 'null'
        headerForeColor:
          type:
          - string
          - 'null'
        outerColor:
          type:
          - string
          - 'null'
        textColor:
          type:
          - string
          - 'null'
      additionalProperties: false
    SettlementTermDto:
      type: object
      properties:
        conditions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/SettlementTermConditionDto'
        id:
          type: integer
          format: int32
        isCustom:
          type: boolean
        name:
          type:
          - string
          - 'null'
      additionalProperties: false
    EmailCreditSettingsDto:
      type: object
      properties:
        defaultAttachments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmailAttachmentDto'
        defaultBccEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultCcEmails:
          type:
          - array
          - 'null'
          items:
            type: string
        defaultContentTemplate:
          type:
          - string
          - 'null'
        defaultObjectTemplate:
          type:
          - string
          - 'null'
        includeDocumentAttachment:
          type: boolean
        showAmount:
          type: boolean
      additionalProperties: false
    InvoiceSettingsDto:
      type: object
      properties:
        collectionCosts:
          type:
          - string
          - 'null'
        earlyFinalizationDuration:
          type:
          - integer
          - 'null'
          format: int32
        invoiceZeroQuantityLines:
          type: boolean
        latePaymentPenalty:
          type:
          - string
          - 'null'
        substractDepositFromTaxExcludedAmount:
          type: boolean
      additionalProperties: false
    DelayType:
      enum:
      - Days
      - Months
      type: string
    MapLinkProvider:
      enum:
      - GoogleMaps
      - BingMaps
      - OpenStreetMap
      type: string
    CompanySettingsDto:
      type: object
      properties:
        ape:
          type:
          - string
          - 'null'
        businessName:
          type:
          - string
          - 'null'
        capital:
          type:
          - number
          - 'null'
          format: double
        cgaMember:
          type: boolean
        contact:
          $ref: '#/components/schemas/ContactFields'
        electronicAddress:
          type:
          - string
          - 'null'
        emailLogoUri:
          type:
          - string
          - 'null'
        guarantees:
          type:
          - string
          - 'null'
        headOfficeAddress:
          $ref: '#/components/schemas/AddressFields'
        invoicingAddress:
          $ref: '#/components/schemas/AddressFields'
        isMicroBusiness:
          type: boolean
        legalMentions:
          type:
          - string
          - 'null'
        legalStatus:
          type:
          - string
          - 'null'
        logoUri:
          type:
          - string
          - 'null'
        mediator:
          type:
          - string
          - 'null'
        name:
          type:
          - string
          - 'null'
        registrationNumber:
          type:
          - string
          - 'null'
        reportLogoUri:
          type:
          - string
          - 'null'
        siret:
          type:
          - string
          - 'null'
        summary:
          type:
          - string
          - 'null'
        summaryHtml:
          type:
          - string
          - 'null'
        urlCompanyName:
          type:
          - string
          - 'null'
        useInvoicingAddressAsHeadOfficeAddress:
          type: boolean
        vatNumber:
          type:
          - string
          - 'null'
        website:
          type:
          - string
          - 'null'
      additionalProperties: false
    ContactFields:
      type: object
      properties:
        cellPhone:
          type:
          - string
          - 'null'
        companyName:
          type:
          - string
          - 'null'
        displayName:
          type:
          - string
          - 'null'
          readOnly: true
        email:
          type:
          - string
          - 'null'
        firstName:
          type:
          - string
          - 'null'
        function:
          type:
          - string
          - 'null'
        invertedDisplayName:
          type:
          - string
          - 'null'
          readOnly: true
        lastName:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        service:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
      additionalProperties: false
    VatRegime:
      enum:
      - Franchise
      - Simplified
      - Normal
      type: string
    EmailingSettingsDto:
      type: object
      properties:
        credits:
          $ref: '#/components/schemas/EmailCreditSettingsDto'
        homecareServices:
          $ref: '#/components/schemas/EmailHomecareServiceSettingsDto'
        invoices:
          $ref: '#/components/schemas/EmailInvoiceSettingsDto'
        quotes:
          $ref: '#/components/schemas/EmailQuoteSettingsDto'
        reminders:
          $ref: '#/components/schemas/EmailReminderSettingsDto'
        style:
          $ref: '#/components/schemas/EmailStyleSettingsDto'
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API KEY generated in application. Example: "X-API-KEY: {apiKey}"'
      name: X-API-KEY
      in: header