Altoviz Bank Transactions API

openapi: 3.2.0
info:
  title: Altoviz Bank Transactions 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: Bank Transactions
  description: Bank transactions API
paths:
  /v1/banktransactions/{id}:
    get:
      tags:
      - Bank Transactions
      summary: Get a bank transaction by ID
      operationId: GET_BankTransactions_Get
      parameters:
      - name: id
        in: path
        description: Bank transaction ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankTransaction'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /v1/banktransactions/exclude/{id}:
    post:
      tags:
      - Bank Transactions
      summary: Set a transaction aside
      description: 'An excluded transaction is no longer offered for reconciliation and stops counting towards its

        account''s pending total. The transaction itself is untouched.'
      operationId: POST_BankTransactions_Exclude
      parameters:
      - name: id
        in: path
        description: Bank transaction ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankTransaction'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /v1/banktransactions/include/{id}:
    post:
      tags:
      - Bank Transactions
      summary: Put a set-aside transaction back
      operationId: POST_BankTransactions_Include
      parameters:
      - name: id
        in: path
        description: Bank transaction ID
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankTransaction'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    PaymentMethod:
      enum:
      - Transfer
      - Order
      - Check
      - Cash
      - Card
      - Bill
      - Usec
      - Other
      type: string
    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: {}
    BankTransactionNature:
      enum:
      - Transfer
      - Order
      - Check
      - CashDeposit
      - Payback
      - Withdrawal
      - Loan
      - BankFees
      - Card
      - CardSummary
      - Interest
      - Dividend
      - Other
      type: string
    BankTransaction:
      type: object
      properties:
        bankAccountId:
          type: integer
          description: Bank account ID
          format: int32
          readOnly: true
        category:
          type:
          - string
          - 'null'
          description: Category as the provider classifies it
          readOnly: true
        coming:
          type: boolean
          description: Whether the transaction is announced but not yet settled by the bank
          readOnly: true
        date:
          type: string
          description: Date the transaction counts under
          format: date-time
          readOnly: true
        fullLabel:
          type:
          - string
          - 'null'
          description: Full label as the bank sends it
          readOnly: true
        id:
          type: integer
          description: Bank transaction ID
          format: int32
          readOnly: true
        includedExternalFeesAmount:
          type: number
          description: Fees already included in Altoviz.Api.Models.BankTransaction.Value
          format: double
          readOnly: true
        isExcluded:
          type: boolean
          description: 'Whether the transaction has been set aside, so it is not offered for reconciliation and does

            not count towards the account''s pending total. Toggled by `Exclude` and `Include`.'
          readOnly: true
        isImported:
          type: boolean
          description: Whether the transaction came from a file import rather than a provider
          readOnly: true
        isReconciliated:
          type: boolean
          description: Whether the transaction is already matched to a settlement
          readOnly: true
        label:
          type:
          - string
          - 'null'
          description: Short label
          readOnly: true
        metadata:
          type:
          - object
          - 'null'
          additionalProperties:
            type:
            - string
            - 'null'
          description: Metadata carried with the transaction
          readOnly: true
        nature:
          $ref: '#/components/schemas/BankTransactionNature'
        notes:
          type:
          - string
          - 'null'
          description: Notes
          readOnly: true
        paymentMethod:
          $ref: '#/components/schemas/PaymentMethod'
        transactionId:
          type:
          - string
          - 'null'
          description: The transaction's identifier at the provider it was synchronized from
          readOnly: true
        value:
          type: number
          description: Amount. Negative for money leaving the account.
          format: double
          readOnly: true
        valueDate:
          type:
          - string
          - 'null'
          description: Value date
          format: date-time
          readOnly: true
      additionalProperties: false
      description: Bank transaction.
  securitySchemes:
    ApiKey:
      type: apiKey
      description: 'API KEY generated in application. Example: "X-API-KEY: {apiKey}"'
      name: X-API-KEY
      in: header